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

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

google-native.apigeeregistry/v1.VersionArtifact

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

    Creates a specified artifact.

    Create VersionArtifact Resource

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

    Constructor syntax

    new VersionArtifact(name: string, args: VersionArtifactArgs, opts?: CustomResourceOptions);
    @overload
    def VersionArtifact(resource_name: str,
                        args: VersionArtifactArgs,
                        opts: Optional[ResourceOptions] = None)
    
    @overload
    def VersionArtifact(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        api_id: Optional[str] = None,
                        artifact_id: Optional[str] = None,
                        version_id: Optional[str] = None,
                        annotations: Optional[Mapping[str, str]] = None,
                        contents: Optional[str] = None,
                        labels: Optional[Mapping[str, str]] = None,
                        location: Optional[str] = None,
                        mime_type: Optional[str] = None,
                        name: Optional[str] = None,
                        project: Optional[str] = None)
    func NewVersionArtifact(ctx *Context, name string, args VersionArtifactArgs, opts ...ResourceOption) (*VersionArtifact, error)
    public VersionArtifact(string name, VersionArtifactArgs args, CustomResourceOptions? opts = null)
    public VersionArtifact(String name, VersionArtifactArgs args)
    public VersionArtifact(String name, VersionArtifactArgs args, CustomResourceOptions options)
    
    type: google-native:apigeeregistry/v1:VersionArtifact
    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 VersionArtifactArgs
    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 VersionArtifactArgs
    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 VersionArtifactArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VersionArtifactArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VersionArtifactArgs
    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 versionArtifactResource = new GoogleNative.ApigeeRegistry.V1.VersionArtifact("versionArtifactResource", new()
    {
        ApiId = "string",
        ArtifactId = "string",
        VersionId = "string",
        Annotations = 
        {
            { "string", "string" },
        },
        Contents = "string",
        Labels = 
        {
            { "string", "string" },
        },
        Location = "string",
        MimeType = "string",
        Name = "string",
        Project = "string",
    });
    
    example, err := apigeeregistry.NewVersionArtifact(ctx, "versionArtifactResource", &apigeeregistry.VersionArtifactArgs{
    	ApiId:      pulumi.String("string"),
    	ArtifactId: pulumi.String("string"),
    	VersionId:  pulumi.String("string"),
    	Annotations: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	Contents: pulumi.String("string"),
    	Labels: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	Location: pulumi.String("string"),
    	MimeType: pulumi.String("string"),
    	Name:     pulumi.String("string"),
    	Project:  pulumi.String("string"),
    })
    
    var versionArtifactResource = new VersionArtifact("versionArtifactResource", VersionArtifactArgs.builder()
        .apiId("string")
        .artifactId("string")
        .versionId("string")
        .annotations(Map.of("string", "string"))
        .contents("string")
        .labels(Map.of("string", "string"))
        .location("string")
        .mimeType("string")
        .name("string")
        .project("string")
        .build());
    
    version_artifact_resource = google_native.apigeeregistry.v1.VersionArtifact("versionArtifactResource",
        api_id="string",
        artifact_id="string",
        version_id="string",
        annotations={
            "string": "string",
        },
        contents="string",
        labels={
            "string": "string",
        },
        location="string",
        mime_type="string",
        name="string",
        project="string")
    
    const versionArtifactResource = new google_native.apigeeregistry.v1.VersionArtifact("versionArtifactResource", {
        apiId: "string",
        artifactId: "string",
        versionId: "string",
        annotations: {
            string: "string",
        },
        contents: "string",
        labels: {
            string: "string",
        },
        location: "string",
        mimeType: "string",
        name: "string",
        project: "string",
    });
    
    type: google-native:apigeeregistry/v1:VersionArtifact
    properties:
        annotations:
            string: string
        apiId: string
        artifactId: string
        contents: string
        labels:
            string: string
        location: string
        mimeType: string
        name: string
        project: string
        versionId: string
    

    VersionArtifact Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The VersionArtifact resource accepts the following input properties:

    ApiId string
    ArtifactId string
    Required. The ID to use for the artifact, which will become the final component of the artifact'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 artifact. Provided by API callers when artifacts are created or replaced. To access the contents of an artifact, use GetArtifactContents.
    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 "registry.googleapis.com/" and cannot be changed.
    Location string
    MimeType string
    A content type specifier for the artifact. Content type specifiers are Media Types (https://en.wikipedia.org/wiki/Media_type) with a possible "schema" parameter that specifies a schema for the stored information. Content types can specify compression. Currently only GZip compression is supported (indicated with "+gzip").
    Name string
    Resource name.
    Project string
    ApiId string
    ArtifactId string
    Required. The ID to use for the artifact, which will become the final component of the artifact'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 artifact. Provided by API callers when artifacts are created or replaced. To access the contents of an artifact, use GetArtifactContents.
    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 "registry.googleapis.com/" and cannot be changed.
    Location string
    MimeType string
    A content type specifier for the artifact. Content type specifiers are Media Types (https://en.wikipedia.org/wiki/Media_type) with a possible "schema" parameter that specifies a schema for the stored information. Content types can specify compression. Currently only GZip compression is supported (indicated with "+gzip").
    Name string
    Resource name.
    Project string
    apiId String
    artifactId String
    Required. The ID to use for the artifact, which will become the final component of the artifact'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 artifact. Provided by API callers when artifacts are created or replaced. To access the contents of an artifact, use GetArtifactContents.
    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 "registry.googleapis.com/" and cannot be changed.
    location String
    mimeType String
    A content type specifier for the artifact. Content type specifiers are Media Types (https://en.wikipedia.org/wiki/Media_type) with a possible "schema" parameter that specifies a schema for the stored information. Content types can specify compression. Currently only GZip compression is supported (indicated with "+gzip").
    name String
    Resource name.
    project String
    apiId string
    artifactId string
    Required. The ID to use for the artifact, which will become the final component of the artifact'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 artifact. Provided by API callers when artifacts are created or replaced. To access the contents of an artifact, use GetArtifactContents.
    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 "registry.googleapis.com/" and cannot be changed.
    location string
    mimeType string
    A content type specifier for the artifact. Content type specifiers are Media Types (https://en.wikipedia.org/wiki/Media_type) with a possible "schema" parameter that specifies a schema for the stored information. Content types can specify compression. Currently only GZip compression is supported (indicated with "+gzip").
    name string
    Resource name.
    project string
    api_id str
    artifact_id str
    Required. The ID to use for the artifact, which will become the final component of the artifact'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 artifact. Provided by API callers when artifacts are created or replaced. To access the contents of an artifact, use GetArtifactContents.
    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 "registry.googleapis.com/" and cannot be changed.
    location str
    mime_type str
    A content type specifier for the artifact. Content type specifiers are Media Types (https://en.wikipedia.org/wiki/Media_type) with a possible "schema" parameter that specifies a schema for the stored information. Content types can specify compression. Currently only GZip compression is supported (indicated with "+gzip").
    name str
    Resource name.
    project str
    apiId String
    artifactId String
    Required. The ID to use for the artifact, which will become the final component of the artifact'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 artifact. Provided by API callers when artifacts are created or replaced. To access the contents of an artifact, use GetArtifactContents.
    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 "registry.googleapis.com/" and cannot be changed.
    location String
    mimeType String
    A content type specifier for the artifact. Content type specifiers are Media Types (https://en.wikipedia.org/wiki/Media_type) with a possible "schema" parameter that specifies a schema for the stored information. Content types can specify compression. Currently only GZip compression is supported (indicated with "+gzip").
    name String
    Resource name.
    project String

    Outputs

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

    CreateTime string
    Creation timestamp.
    Hash string
    A SHA-256 hash of the artifact's contents. If the artifact is gzipped, this is the hash of the uncompressed artifact.
    Id string
    The provider-assigned unique ID for this managed resource.
    SizeBytes int
    The size of the artifact in bytes. If the artifact is gzipped, this is the size of the uncompressed artifact.
    UpdateTime string
    Last update timestamp.
    CreateTime string
    Creation timestamp.
    Hash string
    A SHA-256 hash of the artifact's contents. If the artifact is gzipped, this is the hash of the uncompressed artifact.
    Id string
    The provider-assigned unique ID for this managed resource.
    SizeBytes int
    The size of the artifact in bytes. If the artifact is gzipped, this is the size of the uncompressed artifact.
    UpdateTime string
    Last update timestamp.
    createTime String
    Creation timestamp.
    hash String
    A SHA-256 hash of the artifact's contents. If the artifact is gzipped, this is the hash of the uncompressed artifact.
    id String
    The provider-assigned unique ID for this managed resource.
    sizeBytes Integer
    The size of the artifact in bytes. If the artifact is gzipped, this is the size of the uncompressed artifact.
    updateTime String
    Last update timestamp.
    createTime string
    Creation timestamp.
    hash string
    A SHA-256 hash of the artifact's contents. If the artifact is gzipped, this is the hash of the uncompressed artifact.
    id string
    The provider-assigned unique ID for this managed resource.
    sizeBytes number
    The size of the artifact in bytes. If the artifact is gzipped, this is the size of the uncompressed artifact.
    updateTime string
    Last update timestamp.
    create_time str
    Creation timestamp.
    hash str
    A SHA-256 hash of the artifact's contents. If the artifact is gzipped, this is the hash of the uncompressed artifact.
    id str
    The provider-assigned unique ID for this managed resource.
    size_bytes int
    The size of the artifact in bytes. If the artifact is gzipped, this is the size of the uncompressed artifact.
    update_time str
    Last update timestamp.
    createTime String
    Creation timestamp.
    hash String
    A SHA-256 hash of the artifact's contents. If the artifact is gzipped, this is the hash of the uncompressed artifact.
    id String
    The provider-assigned unique ID for this managed resource.
    sizeBytes Number
    The size of the artifact in bytes. If the artifact is gzipped, this is the size of the uncompressed artifact.
    updateTime String
    Last update timestamp.

    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