Docs Packages
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. apigeeregistry
  5. apigeeregistry/v1
  6. getSpec

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.getSpec

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 spec.

    Using getSpec

    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 getSpec(args: GetSpecArgs, opts?: InvokeOptions): Promise<GetSpecResult>
function getSpecOutput(args: GetSpecOutputArgs, opts?: InvokeOptions): Output<GetSpecResult>
    def get_spec(api_id: Optional[str] = None,
             location: Optional[str] = None,
             project: Optional[str] = None,
             spec_id: Optional[str] = None,
             version_id: Optional[str] = None,
             opts: Optional[InvokeOptions] = None) -> GetSpecResult
def get_spec_output(api_id: Optional[pulumi.Input[str]] = None,
             location: Optional[pulumi.Input[str]] = None,
             project: Optional[pulumi.Input[str]] = None,
             spec_id: Optional[pulumi.Input[str]] = None,
             version_id: Optional[pulumi.Input[str]] = None,
             opts: Optional[InvokeOptions] = None) -> Output[GetSpecResult]
    func LookupSpec(ctx *Context, args *LookupSpecArgs, opts ...InvokeOption) (*LookupSpecResult, error)
func LookupSpecOutput(ctx *Context, args *LookupSpecOutputArgs, opts ...InvokeOption) LookupSpecResultOutput

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

    public static class GetSpec 
{
    public static Task<GetSpecResult> InvokeAsync(GetSpecArgs args, InvokeOptions? opts = null)
    public static Output<GetSpecResult> Invoke(GetSpecInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetSpecResult> getSpec(GetSpecArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

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

    The following arguments are supported:

    ApiId string
    Location string
    SpecId string
    VersionId string
    Project string
    ApiId string
    Location string
    SpecId string
    VersionId string
    Project string
    apiId String
    location String
    specId String
    versionId String
    project String
    apiId string
    location string
    specId string
    versionId string
    project string
    apiId String
    location String
    specId String
    versionId String
    project String

    getSpec Result

    The following output properties are available:

    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.
    Contents string
    Input only. The contents of the spec. Provided by API callers when specs are created or updated. To access the contents of a spec, use GetApiSpecContents.
    CreateTime string
    Creation timestamp; when the spec resource was created.
    Description string
    A detailed description.
    Filename string
    A possibly-hierarchical name used to refer to the spec from other specs.
    Hash string
    A SHA-256 hash of the spec's contents. If the spec is gzipped, this is the hash of the uncompressed spec.
    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.
    MimeType string
    A style (format) descriptor for this spec that is specified as a Media Type. Possible values include application/vnd.apigee.proto, application/vnd.apigee.openapi, and application/vnd.apigee.graphql, with possible suffixes representing compression types. These hypothetical names are defined in the vendor tree defined in RFC6838 (https://tools.ietf.org/html/rfc6838) and are not final. Content types can specify compression. Currently only GZip compression is supported (indicated with "+gzip").
    Name string
    Resource name.
    RevisionCreateTime string
    Revision creation timestamp; when the represented revision was created.
    RevisionId string
    Immutable. The revision ID of the spec. A new revision is committed whenever the spec contents are changed. The format is an 8-character hexadecimal string.
    RevisionUpdateTime string
    Last update timestamp: when the represented revision was last modified.
    SizeBytes int
    The size of the spec file in bytes. If the spec is gzipped, this is the size of the uncompressed spec.
    SourceUri string
    The original source URI of the spec (if one exists). This is an external location that can be used for reference purposes but which may not be authoritative since this external resource may change after the spec is retrieved.
    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.
    Contents string
    Input only. The contents of the spec. Provided by API callers when specs are created or updated. To access the contents of a spec, use GetApiSpecContents.
    CreateTime string
    Creation timestamp; when the spec resource was created.
    Description string
    A detailed description.
    Filename string
    A possibly-hierarchical name used to refer to the spec from other specs.
    Hash string
    A SHA-256 hash of the spec's contents. If the spec is gzipped, this is the hash of the uncompressed spec.
    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.
    MimeType string
    A style (format) descriptor for this spec that is specified as a Media Type. Possible values include application/vnd.apigee.proto, application/vnd.apigee.openapi, and application/vnd.apigee.graphql, with possible suffixes representing compression types. These hypothetical names are defined in the vendor tree defined in RFC6838 (https://tools.ietf.org/html/rfc6838) and are not final. Content types can specify compression. Currently only GZip compression is supported (indicated with "+gzip").
    Name string
    Resource name.
    RevisionCreateTime string
    Revision creation timestamp; when the represented revision was created.
    RevisionId string
    Immutable. The revision ID of the spec. A new revision is committed whenever the spec contents are changed. The format is an 8-character hexadecimal string.
    RevisionUpdateTime string
    Last update timestamp: when the represented revision was last modified.
    SizeBytes int
    The size of the spec file in bytes. If the spec is gzipped, this is the size of the uncompressed spec.
    SourceUri string
    The original source URI of the spec (if one exists). This is an external location that can be used for reference purposes but which may not be authoritative since this external resource may change after the spec is retrieved.
    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.
    contents String
    Input only. The contents of the spec. Provided by API callers when specs are created or updated. To access the contents of a spec, use GetApiSpecContents.
    createTime String
    Creation timestamp; when the spec resource was created.
    description String
    A detailed description.
    filename String
    A possibly-hierarchical name used to refer to the spec from other specs.
    hash String
    A SHA-256 hash of the spec's contents. If the spec is gzipped, this is the hash of the uncompressed spec.
    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.
    mimeType String
    A style (format) descriptor for this spec that is specified as a Media Type. Possible values include application/vnd.apigee.proto, application/vnd.apigee.openapi, and application/vnd.apigee.graphql, with possible suffixes representing compression types. These hypothetical names are defined in the vendor tree defined in RFC6838 (https://tools.ietf.org/html/rfc6838) and are not final. Content types can specify compression. Currently only GZip compression is supported (indicated with "+gzip").
    name String
    Resource name.
    revisionCreateTime String
    Revision creation timestamp; when the represented revision was created.
    revisionId String
    Immutable. The revision ID of the spec. A new revision is committed whenever the spec contents are changed. The format is an 8-character hexadecimal string.
    revisionUpdateTime String
    Last update timestamp: when the represented revision was last modified.
    sizeBytes Integer
    The size of the spec file in bytes. If the spec is gzipped, this is the size of the uncompressed spec.
    sourceUri String
    The original source URI of the spec (if one exists). This is an external location that can be used for reference purposes but which may not be authoritative since this external resource may change after the spec is retrieved.
    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.
    contents string
    Input only. The contents of the spec. Provided by API callers when specs are created or updated. To access the contents of a spec, use GetApiSpecContents.
    createTime string
    Creation timestamp; when the spec resource was created.
    description string
    A detailed description.
    filename string
    A possibly-hierarchical name used to refer to the spec from other specs.
    hash string
    A SHA-256 hash of the spec's contents. If the spec is gzipped, this is the hash of the uncompressed spec.
    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.
    mimeType string
    A style (format) descriptor for this spec that is specified as a Media Type. Possible values include application/vnd.apigee.proto, application/vnd.apigee.openapi, and application/vnd.apigee.graphql, with possible suffixes representing compression types. These hypothetical names are defined in the vendor tree defined in RFC6838 (https://tools.ietf.org/html/rfc6838) and are not final. Content types can specify compression. Currently only GZip compression is supported (indicated with "+gzip").
    name string
    Resource name.
    revisionCreateTime string
    Revision creation timestamp; when the represented revision was created.
    revisionId string
    Immutable. The revision ID of the spec. A new revision is committed whenever the spec contents are changed. The format is an 8-character hexadecimal string.
    revisionUpdateTime string
    Last update timestamp: when the represented revision was last modified.
    sizeBytes number
    The size of the spec file in bytes. If the spec is gzipped, this is the size of the uncompressed spec.
    sourceUri string
    The original source URI of the spec (if one exists). This is an external location that can be used for reference purposes but which may not be authoritative since this external resource may change after the spec is retrieved.
    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.
    contents str
    Input only. The contents of the spec. Provided by API callers when specs are created or updated. To access the contents of a spec, use GetApiSpecContents.
    create_time str
    Creation timestamp; when the spec resource was created.
    description str
    A detailed description.
    filename str
    A possibly-hierarchical name used to refer to the spec from other specs.
    hash str
    A SHA-256 hash of the spec's contents. If the spec is gzipped, this is the hash of the uncompressed spec.
    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.
    mime_type str
    A style (format) descriptor for this spec that is specified as a Media Type. Possible values include application/vnd.apigee.proto, application/vnd.apigee.openapi, and application/vnd.apigee.graphql, with possible suffixes representing compression types. These hypothetical names are defined in the vendor tree defined in RFC6838 (https://tools.ietf.org/html/rfc6838) and are not final. Content types can specify compression. Currently only GZip compression is supported (indicated with "+gzip").
    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 spec. A new revision is committed whenever the spec 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.
    size_bytes int
    The size of the spec file in bytes. If the spec is gzipped, this is the size of the uncompressed spec.
    source_uri str
    The original source URI of the spec (if one exists). This is an external location that can be used for reference purposes but which may not be authoritative since this external resource may change after the spec is retrieved.
    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.
    contents String
    Input only. The contents of the spec. Provided by API callers when specs are created or updated. To access the contents of a spec, use GetApiSpecContents.
    createTime String
    Creation timestamp; when the spec resource was created.
    description String
    A detailed description.
    filename String
    A possibly-hierarchical name used to refer to the spec from other specs.
    hash String
    A SHA-256 hash of the spec's contents. If the spec is gzipped, this is the hash of the uncompressed spec.
    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.
    mimeType String
    A style (format) descriptor for this spec that is specified as a Media Type. Possible values include application/vnd.apigee.proto, application/vnd.apigee.openapi, and application/vnd.apigee.graphql, with possible suffixes representing compression types. These hypothetical names are defined in the vendor tree defined in RFC6838 (https://tools.ietf.org/html/rfc6838) and are not final. Content types can specify compression. Currently only GZip compression is supported (indicated with "+gzip").
    name String
    Resource name.
    revisionCreateTime String
    Revision creation timestamp; when the represented revision was created.
    revisionId String
    Immutable. The revision ID of the spec. A new revision is committed whenever the spec contents are changed. The format is an 8-character hexadecimal string.
    revisionUpdateTime String
    Last update timestamp: when the represented revision was last modified.
    sizeBytes Number
    The size of the spec file in bytes. If the spec is gzipped, this is the size of the uncompressed spec.
    sourceUri String
    The original source URI of the spec (if one exists). This is an external location that can be used for reference purposes but which may not be authoritative since this external resource may change after the spec is retrieved.

    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