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

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

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

    Creates a specified spec.

    Create Spec Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Spec(name: string, args: SpecArgs, opts?: CustomResourceOptions);
    @overload
def Spec(resource_name: str,
         args: SpecArgs,
         opts: Optional[ResourceOptions] = None)

@overload
def Spec(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         version_id: Optional[str] = None,
         api_id: Optional[str] = None,
         api_spec_id: Optional[str] = None,
         labels: Optional[Mapping[str, str]] = None,
         description: Optional[str] = None,
         filename: Optional[str] = None,
         annotations: Optional[Mapping[str, str]] = None,
         location: Optional[str] = None,
         mime_type: Optional[str] = None,
         name: Optional[str] = None,
         project: Optional[str] = None,
         source_uri: Optional[str] = None,
         contents: Optional[str] = None)
    func NewSpec(ctx *Context, name string, args SpecArgs, opts ...ResourceOption) (*Spec, error)
    public Spec(string name, SpecArgs args, CustomResourceOptions? opts = null)
    public Spec(String name, SpecArgs args)
public Spec(String name, SpecArgs args, CustomResourceOptions options)

    type: google-native:apigeeregistry/v1:Spec
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args SpecArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args SpecArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args SpecArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SpecArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SpecArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var specResource = new GoogleNative.ApigeeRegistry.V1.Spec("specResource", new()
{
    VersionId = "string",
    ApiId = "string",
    ApiSpecId = "string",
    Labels = 
    {
        { "string", "string" },
    },
    Description = "string",
    Filename = "string",
    Annotations = 
    {
        { "string", "string" },
    },
    Location = "string",
    MimeType = "string",
    Name = "string",
    Project = "string",
    SourceUri = "string",
    Contents = "string",
});

    example, err := apigeeregistry.NewSpec(ctx, "specResource", &apigeeregistry.SpecArgs{
VersionId: pulumi.String("string"),
ApiId: pulumi.String("string"),
ApiSpecId: pulumi.String("string"),
Labels: pulumi.StringMap{
"string": pulumi.String("string"),
},
Description: pulumi.String("string"),
Filename: pulumi.String("string"),
Annotations: pulumi.StringMap{
"string": pulumi.String("string"),
},
Location: pulumi.String("string"),
MimeType: pulumi.String("string"),
Name: pulumi.String("string"),
Project: pulumi.String("string"),
SourceUri: pulumi.String("string"),
Contents: pulumi.String("string"),
})

    var specResource = new Spec("specResource", SpecArgs.builder()
    .versionId("string")
    .apiId("string")
    .apiSpecId("string")
    .labels(Map.of("string", "string"))
    .description("string")
    .filename("string")
    .annotations(Map.of("string", "string"))
    .location("string")
    .mimeType("string")
    .name("string")
    .project("string")
    .sourceUri("string")
    .contents("string")
    .build());

    spec_resource = google_native.apigeeregistry.v1.Spec("specResource",
    version_id="string",
    api_id="string",
    api_spec_id="string",
    labels={
        "string": "string",
    },
    description="string",
    filename="string",
    annotations={
        "string": "string",
    },
    location="string",
    mime_type="string",
    name="string",
    project="string",
    source_uri="string",
    contents="string")

    const specResource = new google_native.apigeeregistry.v1.Spec("specResource", {
    versionId: "string",
    apiId: "string",
    apiSpecId: "string",
    labels: {
        string: "string",
    },
    description: "string",
    filename: "string",
    annotations: {
        string: "string",
    },
    location: "string",
    mimeType: "string",
    name: "string",
    project: "string",
    sourceUri: "string",
    contents: "string",
});

    type: google-native:apigeeregistry/v1:Spec
properties:
    annotations:
        string: string
    apiId: string
    apiSpecId: string
    contents: string
    description: string
    filename: string
    labels:
        string: string
    location: string
    mimeType: string
    name: string
    project: string
    sourceUri: string
    versionId: string

    Spec Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Spec resource accepts the following input properties:

    ApiId string
    ApiSpecId string
    Required. The ID to use for the spec, which will become the final component of the spec's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID.
    VersionId string
    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.
    Description string
    A detailed description.
    Filename string
    A possibly-hierarchical name used to refer to the spec from other specs.
    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.
    Location string
    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.
    Project string
    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.
    ApiId string
    ApiSpecId string
    Required. The ID to use for the spec, which will become the final component of the spec's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID.
    VersionId string
    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.
    Description string
    A detailed description.
    Filename string
    A possibly-hierarchical name used to refer to the spec from other specs.
    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.
    Location string
    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.
    Project string
    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.
    apiId String
    apiSpecId String
    Required. The ID to use for the spec, which will become the final component of the spec's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID.
    versionId String
    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.
    description String
    A detailed description.
    filename String
    A possibly-hierarchical name used to refer to the spec from other specs.
    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.
    location String
    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.
    project String
    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.
    apiId string
    apiSpecId string
    Required. The ID to use for the spec, which will become the final component of the spec's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID.
    versionId string
    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.
    description string
    A detailed description.
    filename string
    A possibly-hierarchical name used to refer to the spec from other specs.
    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.
    location string
    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.
    project string
    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.
    api_id str
    api_spec_id str
    Required. The ID to use for the spec, which will become the final component of the spec's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID.
    version_id str
    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.
    description str
    A detailed description.
    filename str
    A possibly-hierarchical name used to refer to the spec from other specs.
    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.
    location str
    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.
    project str
    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.
    apiId String
    apiSpecId String
    Required. The ID to use for the spec, which will become the final component of the spec's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID.
    versionId String
    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.
    description String
    A detailed description.
    filename String
    A possibly-hierarchical name used to refer to the spec from other specs.
    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.
    location String
    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.
    project String
    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.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Spec resource produces the following output properties:

    CreateTime string
    Creation timestamp; when the spec resource was created.
    Hash string
    A SHA-256 hash of the spec's contents. If the spec is gzipped, this is the hash of the uncompressed spec.
    Id string
    The provider-assigned unique ID for this managed resource.
    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.
    CreateTime string
    Creation timestamp; when the spec resource was created.
    Hash string
    A SHA-256 hash of the spec's contents. If the spec is gzipped, this is the hash of the uncompressed spec.
    Id string
    The provider-assigned unique ID for this managed resource.
    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.
    createTime String
    Creation timestamp; when the spec resource was created.
    hash String
    A SHA-256 hash of the spec's contents. If the spec is gzipped, this is the hash of the uncompressed spec.
    id String
    The provider-assigned unique ID for this managed resource.
    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.
    createTime string
    Creation timestamp; when the spec resource was created.
    hash string
    A SHA-256 hash of the spec's contents. If the spec is gzipped, this is the hash of the uncompressed spec.
    id string
    The provider-assigned unique ID for this managed resource.
    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.
    create_time str
    Creation timestamp; when the spec resource was created.
    hash str
    A SHA-256 hash of the spec's contents. If the spec is gzipped, this is the hash of the uncompressed spec.
    id str
    The provider-assigned unique ID for this managed resource.
    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.
    createTime String
    Creation timestamp; when the spec resource was created.
    hash String
    A SHA-256 hash of the spec's contents. If the spec is gzipped, this is the hash of the uncompressed spec.
    id String
    The provider-assigned unique ID for this managed resource.
    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.

    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