Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. apigeeregistry
  5. apigeeregistry/v1
  6. getDeployment

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

google-native.apigeeregistry/v1.getDeployment

Explore with Pulumi AI

google-native logo

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

    Returns a specified deployment.

    Using getDeployment

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getDeployment(args: GetDeploymentArgs, opts?: InvokeOptions): Promise<GetDeploymentResult>
function getDeploymentOutput(args: GetDeploymentOutputArgs, opts?: InvokeOptions): Output<GetDeploymentResult>
    def get_deployment(api_id: Optional[str] = None,
                   deployment_id: Optional[str] = None,
                   location: Optional[str] = None,
                   project: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetDeploymentResult
def get_deployment_output(api_id: Optional[pulumi.Input[str]] = None,
                   deployment_id: Optional[pulumi.Input[str]] = None,
                   location: Optional[pulumi.Input[str]] = None,
                   project: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetDeploymentResult]
    func LookupDeployment(ctx *Context, args *LookupDeploymentArgs, opts ...InvokeOption) (*LookupDeploymentResult, error)
func LookupDeploymentOutput(ctx *Context, args *LookupDeploymentOutputArgs, opts ...InvokeOption) LookupDeploymentResultOutput

    > Note: This function is named LookupDeployment in the Go SDK.

    public static class GetDeployment 
{
    public static Task<GetDeploymentResult> InvokeAsync(GetDeploymentArgs args, InvokeOptions? opts = null)
    public static Output<GetDeploymentResult> Invoke(GetDeploymentInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetDeploymentResult> getDeployment(GetDeploymentArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: google-native:apigeeregistry/v1:getDeployment
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ApiId string
    DeploymentId string
    Location string
    Project string
    ApiId string
    DeploymentId string
    Location string
    Project string
    apiId String
    deploymentId String
    location String
    project String
    apiId string
    deploymentId string
    location string
    project string
    apiId String
    deploymentId String
    location String
    project String

    getDeployment Result

    The following output properties are available:

    AccessGuidance string
    Text briefly describing how to access the endpoint. Changes to this value will not affect the revision.
    Annotations Dictionary<string, string>
    Annotations attach non-identifying metadata to resources. Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts.
    ApiSpecRevision string
    The full resource name (including revision ID) of the spec of the API being served by the deployment. Changes to this value will update the revision. Format: projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec@revision}
    CreateTime string
    Creation timestamp; when the deployment resource was created.
    Description string
    A detailed description.
    DisplayName string
    Human-meaningful name.
    EndpointUri string
    The address where the deployment is serving. Changes to this value will update the revision.
    ExternalChannelUri string
    The address of the external channel of the API (e.g., the Developer Portal). Changes to this value will not affect the revision.
    IntendedAudience string
    Text briefly identifying the intended audience of the API. Changes to this value will not affect the revision.
    Labels Dictionary<string, string>
    Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one resource (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with apigeeregistry.googleapis.com/ and cannot be changed.
    Name string
    Resource name.
    RevisionCreateTime string
    Revision creation timestamp; when the represented revision was created.
    RevisionId string
    Immutable. The revision ID of the deployment. A new revision is committed whenever the deployment contents are changed. The format is an 8-character hexadecimal string.
    RevisionUpdateTime string
    Last update timestamp: when the represented revision was last modified.
    AccessGuidance string
    Text briefly describing how to access the endpoint. Changes to this value will not affect the revision.
    Annotations map[string]string
    Annotations attach non-identifying metadata to resources. Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts.
    ApiSpecRevision string
    The full resource name (including revision ID) of the spec of the API being served by the deployment. Changes to this value will update the revision. Format: projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec@revision}
    CreateTime string
    Creation timestamp; when the deployment resource was created.
    Description string
    A detailed description.
    DisplayName string
    Human-meaningful name.
    EndpointUri string
    The address where the deployment is serving. Changes to this value will update the revision.
    ExternalChannelUri string
    The address of the external channel of the API (e.g., the Developer Portal). Changes to this value will not affect the revision.
    IntendedAudience string
    Text briefly identifying the intended audience of the API. Changes to this value will not affect the revision.
    Labels map[string]string
    Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one resource (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with apigeeregistry.googleapis.com/ and cannot be changed.
    Name string
    Resource name.
    RevisionCreateTime string
    Revision creation timestamp; when the represented revision was created.
    RevisionId string
    Immutable. The revision ID of the deployment. A new revision is committed whenever the deployment contents are changed. The format is an 8-character hexadecimal string.
    RevisionUpdateTime string
    Last update timestamp: when the represented revision was last modified.
    accessGuidance String
    Text briefly describing how to access the endpoint. Changes to this value will not affect the revision.
    annotations Map<String,String>
    Annotations attach non-identifying metadata to resources. Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts.
    apiSpecRevision String
    The full resource name (including revision ID) of the spec of the API being served by the deployment. Changes to this value will update the revision. Format: projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec@revision}
    createTime String
    Creation timestamp; when the deployment resource was created.
    description String
    A detailed description.
    displayName String
    Human-meaningful name.
    endpointUri String
    The address where the deployment is serving. Changes to this value will update the revision.
    externalChannelUri String
    The address of the external channel of the API (e.g., the Developer Portal). Changes to this value will not affect the revision.
    intendedAudience String
    Text briefly identifying the intended audience of the API. Changes to this value will not affect the revision.
    labels Map<String,String>
    Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one resource (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with apigeeregistry.googleapis.com/ and cannot be changed.
    name String
    Resource name.
    revisionCreateTime String
    Revision creation timestamp; when the represented revision was created.
    revisionId String
    Immutable. The revision ID of the deployment. A new revision is committed whenever the deployment contents are changed. The format is an 8-character hexadecimal string.
    revisionUpdateTime String
    Last update timestamp: when the represented revision was last modified.
    accessGuidance string
    Text briefly describing how to access the endpoint. Changes to this value will not affect the revision.
    annotations {[key: string]: string}
    Annotations attach non-identifying metadata to resources. Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts.
    apiSpecRevision string
    The full resource name (including revision ID) of the spec of the API being served by the deployment. Changes to this value will update the revision. Format: projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec@revision}
    createTime string
    Creation timestamp; when the deployment resource was created.
    description string
    A detailed description.
    displayName string
    Human-meaningful name.
    endpointUri string
    The address where the deployment is serving. Changes to this value will update the revision.
    externalChannelUri string
    The address of the external channel of the API (e.g., the Developer Portal). Changes to this value will not affect the revision.
    intendedAudience string
    Text briefly identifying the intended audience of the API. Changes to this value will not affect the revision.
    labels {[key: string]: string}
    Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one resource (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with apigeeregistry.googleapis.com/ and cannot be changed.
    name string
    Resource name.
    revisionCreateTime string
    Revision creation timestamp; when the represented revision was created.
    revisionId string
    Immutable. The revision ID of the deployment. A new revision is committed whenever the deployment contents are changed. The format is an 8-character hexadecimal string.
    revisionUpdateTime string
    Last update timestamp: when the represented revision was last modified.
    access_guidance str
    Text briefly describing how to access the endpoint. Changes to this value will not affect the revision.
    annotations Mapping[str, str]
    Annotations attach non-identifying metadata to resources. Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts.
    api_spec_revision str
    The full resource name (including revision ID) of the spec of the API being served by the deployment. Changes to this value will update the revision. Format: projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec@revision}
    create_time str
    Creation timestamp; when the deployment resource was created.
    description str
    A detailed description.
    display_name str
    Human-meaningful name.
    endpoint_uri str
    The address where the deployment is serving. Changes to this value will update the revision.
    external_channel_uri str
    The address of the external channel of the API (e.g., the Developer Portal). Changes to this value will not affect the revision.
    intended_audience str
    Text briefly identifying the intended audience of the API. Changes to this value will not affect the revision.
    labels Mapping[str, str]
    Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one resource (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with apigeeregistry.googleapis.com/ and cannot be changed.
    name str
    Resource name.
    revision_create_time str
    Revision creation timestamp; when the represented revision was created.
    revision_id str
    Immutable. The revision ID of the deployment. A new revision is committed whenever the deployment contents are changed. The format is an 8-character hexadecimal string.
    revision_update_time str
    Last update timestamp: when the represented revision was last modified.
    accessGuidance String
    Text briefly describing how to access the endpoint. Changes to this value will not affect the revision.
    annotations Map<String>
    Annotations attach non-identifying metadata to resources. Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts.
    apiSpecRevision String
    The full resource name (including revision ID) of the spec of the API being served by the deployment. Changes to this value will update the revision. Format: projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec@revision}
    createTime String
    Creation timestamp; when the deployment resource was created.
    description String
    A detailed description.
    displayName String
    Human-meaningful name.
    endpointUri String
    The address where the deployment is serving. Changes to this value will update the revision.
    externalChannelUri String
    The address of the external channel of the API (e.g., the Developer Portal). Changes to this value will not affect the revision.
    intendedAudience String
    Text briefly identifying the intended audience of the API. Changes to this value will not affect the revision.
    labels Map<String>
    Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one resource (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with apigeeregistry.googleapis.com/ and cannot be changed.
    name String
    Resource name.
    revisionCreateTime String
    Revision creation timestamp; when the represented revision was created.
    revisionId String
    Immutable. The revision ID of the deployment. A new revision is committed whenever the deployment contents are changed. The format is an 8-character hexadecimal string.
    revisionUpdateTime String
    Last update timestamp: when the represented revision was last modified.

    Package Details

    Repository
    Google Cloud Native pulumi/pulumi-google-native
    License
    Apache-2.0
    google-native logo

    Google Cloud Native is in preview. Google Cloud Classic is fully supported.

    Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
    pulumi/pulumi-google-native