Docs Packages
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. aiplatform
  5. aiplatform/v1
  6. Artifact

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.aiplatform/v1.Artifact

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 an Artifact associated with a MetadataStore. Auto-naming is currently not supported for this resource.

    Create Artifact Resource

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

    Constructor syntax

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

@overload
def Artifact(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             metadata_store_id: Optional[str] = None,
             metadata: Optional[Mapping[str, str]] = None,
             display_name: Optional[str] = None,
             etag: Optional[str] = None,
             labels: Optional[Mapping[str, str]] = None,
             location: Optional[str] = None,
             artifact_id: Optional[str] = None,
             description: Optional[str] = None,
             project: Optional[str] = None,
             schema_title: Optional[str] = None,
             schema_version: Optional[str] = None,
             state: Optional[ArtifactState] = None,
             uri: Optional[str] = None)
    func NewArtifact(ctx *Context, name string, args ArtifactArgs, opts ...ResourceOption) (*Artifact, error)
    public Artifact(string name, ArtifactArgs args, CustomResourceOptions? opts = null)
    public Artifact(String name, ArtifactArgs args)
public Artifact(String name, ArtifactArgs args, CustomResourceOptions options)

    type: google-native:aiplatform/v1:Artifact
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 ArtifactArgs
    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 ArtifactArgs
    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 ArtifactArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ArtifactArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ArtifactArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var artifactResource = new GoogleNative.Aiplatform.V1.Artifact("artifactResource", new()
{
    MetadataStoreId = "string",
    Metadata = 
    {
        { "string", "string" },
    },
    DisplayName = "string",
    Etag = "string",
    Labels = 
    {
        { "string", "string" },
    },
    Location = "string",
    ArtifactId = "string",
    Description = "string",
    Project = "string",
    SchemaTitle = "string",
    SchemaVersion = "string",
    State = GoogleNative.Aiplatform.V1.ArtifactState.StateUnspecified,
    Uri = "string",
});

    example, err := aiplatform.NewArtifact(ctx, "artifactResource", &aiplatform.ArtifactArgs{
MetadataStoreId: pulumi.String("string"),
Metadata: pulumi.StringMap{
"string": pulumi.String("string"),
},
DisplayName: pulumi.String("string"),
Etag: pulumi.String("string"),
Labels: pulumi.StringMap{
"string": pulumi.String("string"),
},
Location: pulumi.String("string"),
ArtifactId: pulumi.String("string"),
Description: pulumi.String("string"),
Project: pulumi.String("string"),
SchemaTitle: pulumi.String("string"),
SchemaVersion: pulumi.String("string"),
State: aiplatform.ArtifactStateStateUnspecified,
Uri: pulumi.String("string"),
})

    var artifactResource = new Artifact("artifactResource", ArtifactArgs.builder()        
    .metadataStoreId("string")
    .metadata(Map.of("string", "string"))
    .displayName("string")
    .etag("string")
    .labels(Map.of("string", "string"))
    .location("string")
    .artifactId("string")
    .description("string")
    .project("string")
    .schemaTitle("string")
    .schemaVersion("string")
    .state("STATE_UNSPECIFIED")
    .uri("string")
    .build());

    artifact_resource = google_native.aiplatform.v1.Artifact("artifactResource",
    metadata_store_id="string",
    metadata={
        "string": "string",
    },
    display_name="string",
    etag="string",
    labels={
        "string": "string",
    },
    location="string",
    artifact_id="string",
    description="string",
    project="string",
    schema_title="string",
    schema_version="string",
    state=google_native.aiplatform.v1.ArtifactState.STATE_UNSPECIFIED,
    uri="string")

    const artifactResource = new google_native.aiplatform.v1.Artifact("artifactResource", {
    metadataStoreId: "string",
    metadata: {
        string: "string",
    },
    displayName: "string",
    etag: "string",
    labels: {
        string: "string",
    },
    location: "string",
    artifactId: "string",
    description: "string",
    project: "string",
    schemaTitle: "string",
    schemaVersion: "string",
    state: google_native.aiplatform.v1.ArtifactState.StateUnspecified,
    uri: "string",
});

    type: google-native:aiplatform/v1:Artifact
properties:
    artifactId: string
    description: string
    displayName: string
    etag: string
    labels:
        string: string
    location: string
    metadata:
        string: string
    metadataStoreId: string
    project: string
    schemaTitle: string
    schemaVersion: string
    state: STATE_UNSPECIFIED
    uri: string

    Artifact 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 Artifact resource accepts the following input properties:

    MetadataStoreId string
    ArtifactId string
    The {artifact} portion of the resource name with the format: projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact} If not provided, the Artifact's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are /a-z-/. Must be unique across all Artifacts in the parent MetadataStore. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting Artifact.)
    Description string
    Description of the Artifact
    DisplayName string
    User provided display name of the Artifact. May be up to 128 Unicode characters.
    Etag string
    An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
    Labels Dictionary<string, string>
    The labels with user-defined metadata to organize your Artifacts. 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 Artifact (System labels are excluded).
    Location string
    Metadata Dictionary<string, string>
    Properties of the Artifact. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.
    Project string
    SchemaTitle string
    The title of the schema describing the metadata. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
    SchemaVersion string
    The version of the schema in schema_name to use. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
    State Pulumi.GoogleNative.Aiplatform.V1.ArtifactState
    The state of this Artifact. This is a property of the Artifact, and does not imply or capture any ongoing process. This property is managed by clients (such as Vertex AI Pipelines), and the system does not prescribe or check the validity of state transitions.
    Uri string
    The uniform resource identifier of the artifact file. May be empty if there is no actual artifact file.
    MetadataStoreId string
    ArtifactId string
    The {artifact} portion of the resource name with the format: projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact} If not provided, the Artifact's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are /a-z-/. Must be unique across all Artifacts in the parent MetadataStore. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting Artifact.)
    Description string
    Description of the Artifact
    DisplayName string
    User provided display name of the Artifact. May be up to 128 Unicode characters.
    Etag string
    An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
    Labels map[string]string
    The labels with user-defined metadata to organize your Artifacts. 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 Artifact (System labels are excluded).
    Location string
    Metadata map[string]string
    Properties of the Artifact. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.
    Project string
    SchemaTitle string
    The title of the schema describing the metadata. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
    SchemaVersion string
    The version of the schema in schema_name to use. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
    State ArtifactStateEnum
    The state of this Artifact. This is a property of the Artifact, and does not imply or capture any ongoing process. This property is managed by clients (such as Vertex AI Pipelines), and the system does not prescribe or check the validity of state transitions.
    Uri string
    The uniform resource identifier of the artifact file. May be empty if there is no actual artifact file.
    metadataStoreId String
    artifactId String
    The {artifact} portion of the resource name with the format: projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact} If not provided, the Artifact's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are /a-z-/. Must be unique across all Artifacts in the parent MetadataStore. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting Artifact.)
    description String
    Description of the Artifact
    displayName String
    User provided display name of the Artifact. May be up to 128 Unicode characters.
    etag String
    An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
    labels Map<String,String>
    The labels with user-defined metadata to organize your Artifacts. 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 Artifact (System labels are excluded).
    location String
    metadata Map<String,String>
    Properties of the Artifact. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.
    project String
    schemaTitle String
    The title of the schema describing the metadata. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
    schemaVersion String
    The version of the schema in schema_name to use. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
    state ArtifactState
    The state of this Artifact. This is a property of the Artifact, and does not imply or capture any ongoing process. This property is managed by clients (such as Vertex AI Pipelines), and the system does not prescribe or check the validity of state transitions.
    uri String
    The uniform resource identifier of the artifact file. May be empty if there is no actual artifact file.
    metadataStoreId string
    artifactId string
    The {artifact} portion of the resource name with the format: projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact} If not provided, the Artifact's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are /a-z-/. Must be unique across all Artifacts in the parent MetadataStore. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting Artifact.)
    description string
    Description of the Artifact
    displayName string
    User provided display name of the Artifact. May be up to 128 Unicode characters.
    etag string
    An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
    labels {[key: string]: string}
    The labels with user-defined metadata to organize your Artifacts. 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 Artifact (System labels are excluded).
    location string
    metadata {[key: string]: string}
    Properties of the Artifact. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.
    project string
    schemaTitle string
    The title of the schema describing the metadata. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
    schemaVersion string
    The version of the schema in schema_name to use. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
    state ArtifactState
    The state of this Artifact. This is a property of the Artifact, and does not imply or capture any ongoing process. This property is managed by clients (such as Vertex AI Pipelines), and the system does not prescribe or check the validity of state transitions.
    uri string
    The uniform resource identifier of the artifact file. May be empty if there is no actual artifact file.
    metadata_store_id str
    artifact_id str
    The {artifact} portion of the resource name with the format: projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact} If not provided, the Artifact's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are /a-z-/. Must be unique across all Artifacts in the parent MetadataStore. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting Artifact.)
    description str
    Description of the Artifact
    display_name str
    User provided display name of the Artifact. May be up to 128 Unicode characters.
    etag str
    An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
    labels Mapping[str, str]
    The labels with user-defined metadata to organize your Artifacts. 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 Artifact (System labels are excluded).
    location str
    metadata Mapping[str, str]
    Properties of the Artifact. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.
    project str
    schema_title str
    The title of the schema describing the metadata. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
    schema_version str
    The version of the schema in schema_name to use. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
    state ArtifactState
    The state of this Artifact. This is a property of the Artifact, and does not imply or capture any ongoing process. This property is managed by clients (such as Vertex AI Pipelines), and the system does not prescribe or check the validity of state transitions.
    uri str
    The uniform resource identifier of the artifact file. May be empty if there is no actual artifact file.
    metadataStoreId String
    artifactId String
    The {artifact} portion of the resource name with the format: projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact} If not provided, the Artifact's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are /a-z-/. Must be unique across all Artifacts in the parent MetadataStore. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting Artifact.)
    description String
    Description of the Artifact
    displayName String
    User provided display name of the Artifact. May be up to 128 Unicode characters.
    etag String
    An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
    labels Map<String>
    The labels with user-defined metadata to organize your Artifacts. 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 Artifact (System labels are excluded).
    location String
    metadata Map<String>
    Properties of the Artifact. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.
    project String
    schemaTitle String
    The title of the schema describing the metadata. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
    schemaVersion String
    The version of the schema in schema_name to use. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
    state "STATE_UNSPECIFIED" | "PENDING" | "LIVE"
    The state of this Artifact. This is a property of the Artifact, and does not imply or capture any ongoing process. This property is managed by clients (such as Vertex AI Pipelines), and the system does not prescribe or check the validity of state transitions.
    uri String
    The uniform resource identifier of the artifact file. May be empty if there is no actual artifact file.

    Outputs

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

    CreateTime string
    Timestamp when this Artifact was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The resource name of the Artifact.
    UpdateTime string
    Timestamp when this Artifact was last updated.
    CreateTime string
    Timestamp when this Artifact was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The resource name of the Artifact.
    UpdateTime string
    Timestamp when this Artifact was last updated.
    createTime String
    Timestamp when this Artifact was created.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The resource name of the Artifact.
    updateTime String
    Timestamp when this Artifact was last updated.
    createTime string
    Timestamp when this Artifact was created.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The resource name of the Artifact.
    updateTime string
    Timestamp when this Artifact was last updated.
    create_time str
    Timestamp when this Artifact was created.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The resource name of the Artifact.
    update_time str
    Timestamp when this Artifact was last updated.
    createTime String
    Timestamp when this Artifact was created.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The resource name of the Artifact.
    updateTime String
    Timestamp when this Artifact was last updated.

    Supporting Types

    ArtifactState, ArtifactStateArgs

    StateUnspecified
    STATE_UNSPECIFIEDUnspecified state for the Artifact.
    Pending
    PENDINGA state used by systems like Vertex AI Pipelines to indicate that the underlying data item represented by this Artifact is being created.
    Live
    LIVEA state indicating that the Artifact should exist, unless something external to the system deletes it.
    ArtifactStateStateUnspecified
    STATE_UNSPECIFIEDUnspecified state for the Artifact.
    ArtifactStatePending
    PENDINGA state used by systems like Vertex AI Pipelines to indicate that the underlying data item represented by this Artifact is being created.
    ArtifactStateLive
    LIVEA state indicating that the Artifact should exist, unless something external to the system deletes it.
    StateUnspecified
    STATE_UNSPECIFIEDUnspecified state for the Artifact.
    Pending
    PENDINGA state used by systems like Vertex AI Pipelines to indicate that the underlying data item represented by this Artifact is being created.
    Live
    LIVEA state indicating that the Artifact should exist, unless something external to the system deletes it.
    StateUnspecified
    STATE_UNSPECIFIEDUnspecified state for the Artifact.
    Pending
    PENDINGA state used by systems like Vertex AI Pipelines to indicate that the underlying data item represented by this Artifact is being created.
    Live
    LIVEA state indicating that the Artifact should exist, unless something external to the system deletes it.
    STATE_UNSPECIFIED
    STATE_UNSPECIFIEDUnspecified state for the Artifact.
    PENDING
    PENDINGA state used by systems like Vertex AI Pipelines to indicate that the underlying data item represented by this Artifact is being created.
    LIVE
    LIVEA state indicating that the Artifact should exist, unless something external to the system deletes it.
    "STATE_UNSPECIFIED"
    STATE_UNSPECIFIEDUnspecified state for the Artifact.
    "PENDING"
    PENDINGA state used by systems like Vertex AI Pipelines to indicate that the underlying data item represented by this Artifact is being created.
    "LIVE"
    LIVEA state indicating that the Artifact should exist, unless something external to the system deletes it.

    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