1. Registry
  2. Packages
  3. Google Cloud Native
  4. API Docs
  5. aiplatform
  6. aiplatform/v1beta1
  7. MetadataSchema

This package is deprecated. Active development has stopped. We recommend using the Google Cloud package instead.

Viewing docs for Google Cloud Native v0.32.0
published on Wednesday, Nov 29, 2023 by Pulumi
google-native logo Google Cloud Native

This package is deprecated. Active development has stopped. We recommend using the Google Cloud package instead.

Viewing docs for Google Cloud Native v0.32.0
published on Wednesday, Nov 29, 2023 by Pulumi

    Creates a MetadataSchema. Auto-naming is currently not supported for this resource. Note - this resource’s API doesn’t support deletion. When deleted, the resource will persist on Google Cloud even though it will be deleted from Pulumi state.

    Create MetadataSchema Resource

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

    Constructor syntax

    new MetadataSchema(name: string, args: MetadataSchemaArgs, opts?: CustomResourceOptions);
    @overload
    def MetadataSchema(resource_name: str,
                       args: MetadataSchemaArgs,
                       opts: Optional[ResourceOptions] = None)
    
    @overload
    def MetadataSchema(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       metadata_store_id: Optional[str] = None,
                       schema: Optional[str] = None,
                       description: Optional[str] = None,
                       location: Optional[str] = None,
                       metadata_schema_id: Optional[str] = None,
                       project: Optional[str] = None,
                       schema_type: Optional[MetadataSchemaSchemaType] = None,
                       schema_version: Optional[str] = None)
    func NewMetadataSchema(ctx *Context, name string, args MetadataSchemaArgs, opts ...ResourceOption) (*MetadataSchema, error)
    public MetadataSchema(string name, MetadataSchemaArgs args, CustomResourceOptions? opts = null)
    public MetadataSchema(String name, MetadataSchemaArgs args)
    public MetadataSchema(String name, MetadataSchemaArgs args, CustomResourceOptions options)
    
    type: google-native:aiplatform/v1beta1:MetadataSchema
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "google-native_aiplatform_v1beta1_metadata_schema" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args MetadataSchemaArgs
    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 MetadataSchemaArgs
    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 MetadataSchemaArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args MetadataSchemaArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args MetadataSchemaArgs
    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 google_nativeMetadataSchemaResource = new GoogleNative.Aiplatform.V1Beta1.MetadataSchema("google-nativeMetadataSchemaResource", new()
    {
        MetadataStoreId = "string",
        Schema = "string",
        Description = "string",
        Location = "string",
        MetadataSchemaId = "string",
        Project = "string",
        SchemaType = GoogleNative.Aiplatform.V1Beta1.MetadataSchemaSchemaType.MetadataSchemaTypeUnspecified,
        SchemaVersion = "string",
    });
    
    example, err := aiplatformv1beta1.NewMetadataSchema(ctx, "google-nativeMetadataSchemaResource", &aiplatformv1beta1.MetadataSchemaArgs{
    	MetadataStoreId:  pulumi.String("string"),
    	Schema:           pulumi.String("string"),
    	Description:      pulumi.String("string"),
    	Location:         pulumi.String("string"),
    	MetadataSchemaId: pulumi.String("string"),
    	Project:          pulumi.String("string"),
    	SchemaType:       aiplatformv1beta1.MetadataSchemaSchemaTypeMetadataSchemaTypeUnspecified,
    	SchemaVersion:    pulumi.String("string"),
    })
    
    resource "google-native_aiplatform_v1beta1_metadata_schema" "google-nativeMetadataSchemaResource" {
      lifecycle {
        create_before_destroy = true
      }
      metadata_store_id  = "string"
      schema             = "string"
      description        = "string"
      location           = "string"
      metadata_schema_id = "string"
      project            = "string"
      schema_type        = "METADATA_SCHEMA_TYPE_UNSPECIFIED"
      schema_version     = "string"
    }
    
    var google_nativeMetadataSchemaResource = new com.pulumi.googlenative.aiplatform_v1beta1.MetadataSchema("google-nativeMetadataSchemaResource", com.pulumi.googlenative.aiplatform_v1beta1.MetadataSchemaArgs.builder()
        .metadataStoreId("string")
        .schema("string")
        .description("string")
        .location("string")
        .metadataSchemaId("string")
        .project("string")
        .schemaType(com.pulumi.googlenative.aiplatform_v1beta1.enums.MetadataSchemaSchemaType.MetadataSchemaTypeUnspecified)
        .schemaVersion("string")
        .build());
    
    google_native_metadata_schema_resource = google_native.aiplatform.v1beta1.MetadataSchema("google-nativeMetadataSchemaResource",
        metadata_store_id="string",
        schema="string",
        description="string",
        location="string",
        metadata_schema_id="string",
        project="string",
        schema_type=google_native.aiplatform.v1beta1.MetadataSchemaSchemaType.METADATA_SCHEMA_TYPE_UNSPECIFIED,
        schema_version="string")
    
    const google_nativeMetadataSchemaResource = new google_native.aiplatform.v1beta1.MetadataSchema("google-nativeMetadataSchemaResource", {
        metadataStoreId: "string",
        schema: "string",
        description: "string",
        location: "string",
        metadataSchemaId: "string",
        project: "string",
        schemaType: google_native.aiplatform.v1beta1.MetadataSchemaSchemaType.MetadataSchemaTypeUnspecified,
        schemaVersion: "string",
    });
    
    type: google-native:aiplatform/v1beta1:MetadataSchema
    properties:
        description: string
        location: string
        metadataSchemaId: string
        metadataStoreId: string
        project: string
        schema: string
        schemaType: METADATA_SCHEMA_TYPE_UNSPECIFIED
        schemaVersion: string
    

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

    MetadataStoreId string
    Schema string
    The raw YAML string representation of the MetadataSchema. The combination of [MetadataSchema.version] and the schema name given by title in [MetadataSchema.schema] must be unique within a MetadataStore. The schema is defined as an OpenAPI 3.0.2 MetadataSchema Object
    Description string
    Description of the Metadata Schema
    Location string
    MetadataSchemaId string
    The {metadata_schema} portion of the resource name with the format: projects/{project}/locations/{location}/metadataStores/{metadatastore}/metadataSchemas/{metadataschema} If not provided, the MetadataStore'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 MetadataSchemas in the parent Location. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting MetadataSchema.)
    Project string
    SchemaType Pulumi.GoogleNative.Aiplatform.V1Beta1.MetadataSchemaSchemaType
    The type of the MetadataSchema. This is a property that identifies which metadata types will use the MetadataSchema.
    SchemaVersion string
    The version of the MetadataSchema. The version's format must match the following regular expression: ^[0-9]+.+.+$, which would allow to order/compare different versions. Example: 1.0.0, 1.0.1, etc.
    MetadataStoreId string
    Schema string
    The raw YAML string representation of the MetadataSchema. The combination of [MetadataSchema.version] and the schema name given by title in [MetadataSchema.schema] must be unique within a MetadataStore. The schema is defined as an OpenAPI 3.0.2 MetadataSchema Object
    Description string
    Description of the Metadata Schema
    Location string
    MetadataSchemaId string
    The {metadata_schema} portion of the resource name with the format: projects/{project}/locations/{location}/metadataStores/{metadatastore}/metadataSchemas/{metadataschema} If not provided, the MetadataStore'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 MetadataSchemas in the parent Location. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting MetadataSchema.)
    Project string
    SchemaType MetadataSchemaSchemaType
    The type of the MetadataSchema. This is a property that identifies which metadata types will use the MetadataSchema.
    SchemaVersion string
    The version of the MetadataSchema. The version's format must match the following regular expression: ^[0-9]+.+.+$, which would allow to order/compare different versions. Example: 1.0.0, 1.0.1, etc.
    metadata_store_id string
    schema string
    The raw YAML string representation of the MetadataSchema. The combination of [MetadataSchema.version] and the schema name given by title in [MetadataSchema.schema] must be unique within a MetadataStore. The schema is defined as an OpenAPI 3.0.2 MetadataSchema Object
    description string
    Description of the Metadata Schema
    location string
    metadata_schema_id string
    The {metadata_schema} portion of the resource name with the format: projects/{project}/locations/{location}/metadataStores/{metadatastore}/metadataSchemas/{metadataschema} If not provided, the MetadataStore'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 MetadataSchemas in the parent Location. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting MetadataSchema.)
    project string
    schema_type "METADATA_SCHEMA_TYPE_UNSPECIFIED" | "ARTIFACT_TYPE" | "EXECUTION_TYPE" | "CONTEXT_TYPE"
    The type of the MetadataSchema. This is a property that identifies which metadata types will use the MetadataSchema.
    schema_version string
    The version of the MetadataSchema. The version's format must match the following regular expression: ^[0-9]+.+.+$, which would allow to order/compare different versions. Example: 1.0.0, 1.0.1, etc.
    metadataStoreId String
    schema String
    The raw YAML string representation of the MetadataSchema. The combination of [MetadataSchema.version] and the schema name given by title in [MetadataSchema.schema] must be unique within a MetadataStore. The schema is defined as an OpenAPI 3.0.2 MetadataSchema Object
    description String
    Description of the Metadata Schema
    location String
    metadataSchemaId String
    The {metadata_schema} portion of the resource name with the format: projects/{project}/locations/{location}/metadataStores/{metadatastore}/metadataSchemas/{metadataschema} If not provided, the MetadataStore'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 MetadataSchemas in the parent Location. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting MetadataSchema.)
    project String
    schemaType MetadataSchemaSchemaType
    The type of the MetadataSchema. This is a property that identifies which metadata types will use the MetadataSchema.
    schemaVersion String
    The version of the MetadataSchema. The version's format must match the following regular expression: ^[0-9]+.+.+$, which would allow to order/compare different versions. Example: 1.0.0, 1.0.1, etc.
    metadataStoreId string
    schema string
    The raw YAML string representation of the MetadataSchema. The combination of [MetadataSchema.version] and the schema name given by title in [MetadataSchema.schema] must be unique within a MetadataStore. The schema is defined as an OpenAPI 3.0.2 MetadataSchema Object
    description string
    Description of the Metadata Schema
    location string
    metadataSchemaId string
    The {metadata_schema} portion of the resource name with the format: projects/{project}/locations/{location}/metadataStores/{metadatastore}/metadataSchemas/{metadataschema} If not provided, the MetadataStore'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 MetadataSchemas in the parent Location. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting MetadataSchema.)
    project string
    schemaType MetadataSchemaSchemaType
    The type of the MetadataSchema. This is a property that identifies which metadata types will use the MetadataSchema.
    schemaVersion string
    The version of the MetadataSchema. The version's format must match the following regular expression: ^[0-9]+.+.+$, which would allow to order/compare different versions. Example: 1.0.0, 1.0.1, etc.
    metadata_store_id str
    schema str
    The raw YAML string representation of the MetadataSchema. The combination of [MetadataSchema.version] and the schema name given by title in [MetadataSchema.schema] must be unique within a MetadataStore. The schema is defined as an OpenAPI 3.0.2 MetadataSchema Object
    description str
    Description of the Metadata Schema
    location str
    metadata_schema_id str
    The {metadata_schema} portion of the resource name with the format: projects/{project}/locations/{location}/metadataStores/{metadatastore}/metadataSchemas/{metadataschema} If not provided, the MetadataStore'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 MetadataSchemas in the parent Location. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting MetadataSchema.)
    project str
    schema_type MetadataSchemaSchemaType
    The type of the MetadataSchema. This is a property that identifies which metadata types will use the MetadataSchema.
    schema_version str
    The version of the MetadataSchema. The version's format must match the following regular expression: ^[0-9]+.+.+$, which would allow to order/compare different versions. Example: 1.0.0, 1.0.1, etc.
    metadataStoreId String
    schema String
    The raw YAML string representation of the MetadataSchema. The combination of [MetadataSchema.version] and the schema name given by title in [MetadataSchema.schema] must be unique within a MetadataStore. The schema is defined as an OpenAPI 3.0.2 MetadataSchema Object
    description String
    Description of the Metadata Schema
    location String
    metadataSchemaId String
    The {metadata_schema} portion of the resource name with the format: projects/{project}/locations/{location}/metadataStores/{metadatastore}/metadataSchemas/{metadataschema} If not provided, the MetadataStore'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 MetadataSchemas in the parent Location. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting MetadataSchema.)
    project String
    schemaType "METADATA_SCHEMA_TYPE_UNSPECIFIED" | "ARTIFACT_TYPE" | "EXECUTION_TYPE" | "CONTEXT_TYPE"
    The type of the MetadataSchema. This is a property that identifies which metadata types will use the MetadataSchema.
    schemaVersion String
    The version of the MetadataSchema. The version's format must match the following regular expression: ^[0-9]+.+.+$, which would allow to order/compare different versions. Example: 1.0.0, 1.0.1, etc.

    Outputs

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

    CreateTime string
    Timestamp when this MetadataSchema was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The resource name of the MetadataSchema.
    CreateTime string
    Timestamp when this MetadataSchema was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The resource name of the MetadataSchema.
    create_time string
    Timestamp when this MetadataSchema was created.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The resource name of the MetadataSchema.
    createTime String
    Timestamp when this MetadataSchema was created.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The resource name of the MetadataSchema.
    createTime string
    Timestamp when this MetadataSchema was created.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The resource name of the MetadataSchema.
    create_time str
    Timestamp when this MetadataSchema was created.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The resource name of the MetadataSchema.
    createTime String
    Timestamp when this MetadataSchema was created.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The resource name of the MetadataSchema.

    Look up Existing MetadataSchema Resource

    Get an existing MetadataSchema resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, opts?: CustomResourceOptions): MetadataSchema
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None) -> MetadataSchema
    func GetMetadataSchema(ctx *Context, name string, id IDInput, state *MetadataSchemaState, opts ...ResourceOption) (*MetadataSchema, error)
    public static MetadataSchema Get(string name, Input<string> id, CustomResourceOptions? opts = null)
    public static MetadataSchema get(String name, Output<String> id, CustomResourceOptions options)
    resources:  existingMetadataSchema:    type: google-native:aiplatform/v1beta1:MetadataSchema    get:      id: ${id}
    import {
      to = google-native_aiplatform_v1beta1_metadata_schema.example
      id = "${id}"
    }
    
    name string
    The unique name of the resulting resource.
    id Input<ID>
    The unique provider ID of the resource to look up.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resulting resource.
    id str
    The unique provider ID of the resource to look up.
    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 resulting resource.
    id IDInput
    The unique provider ID of the resource to look up.
    state MetadataSchemaState
    Pass nil. This resource has no state arguments.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resulting resource.
    id Input<string>
    The unique provider ID of the resource to look up.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resulting resource.
    id Output<String>
    The unique provider ID of the resource to look up.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Supporting Types

    MetadataSchemaSchemaType

    The type of the MetadataSchema. This is a property that identifies which metadata types will use the MetadataSchema.

    NameValueDescription
    MetadataSchemaTypeUnspecifiedMETADATA_SCHEMA_TYPE_UNSPECIFIEDUnspecified type for the MetadataSchema.
    ArtifactTypeARTIFACT_TYPEA type indicating that the MetadataSchema will be used by Artifacts.
    ExecutionTypeEXECUTION_TYPEA typee indicating that the MetadataSchema will be used by Executions.
    ContextTypeCONTEXT_TYPEA state indicating that the MetadataSchema will be used by Contexts.
    NameValueDescription
    MetadataSchemaSchemaTypeMetadataSchemaTypeUnspecifiedMETADATA_SCHEMA_TYPE_UNSPECIFIEDUnspecified type for the MetadataSchema.
    MetadataSchemaSchemaTypeArtifactTypeARTIFACT_TYPEA type indicating that the MetadataSchema will be used by Artifacts.
    MetadataSchemaSchemaTypeExecutionTypeEXECUTION_TYPEA typee indicating that the MetadataSchema will be used by Executions.
    MetadataSchemaSchemaTypeContextTypeCONTEXT_TYPEA state indicating that the MetadataSchema will be used by Contexts.
    ValueDescription
    METADATA_SCHEMA_TYPE_UNSPECIFIEDUnspecified type for the MetadataSchema.
    ARTIFACT_TYPEA type indicating that the MetadataSchema will be used by Artifacts.
    EXECUTION_TYPEA typee indicating that the MetadataSchema will be used by Executions.
    CONTEXT_TYPEA state indicating that the MetadataSchema will be used by Contexts.
    NameValueDescription
    MetadataSchemaTypeUnspecifiedMETADATA_SCHEMA_TYPE_UNSPECIFIEDUnspecified type for the MetadataSchema.
    ArtifactTypeARTIFACT_TYPEA type indicating that the MetadataSchema will be used by Artifacts.
    ExecutionTypeEXECUTION_TYPEA typee indicating that the MetadataSchema will be used by Executions.
    ContextTypeCONTEXT_TYPEA state indicating that the MetadataSchema will be used by Contexts.
    NameValueDescription
    MetadataSchemaTypeUnspecifiedMETADATA_SCHEMA_TYPE_UNSPECIFIEDUnspecified type for the MetadataSchema.
    ArtifactTypeARTIFACT_TYPEA type indicating that the MetadataSchema will be used by Artifacts.
    ExecutionTypeEXECUTION_TYPEA typee indicating that the MetadataSchema will be used by Executions.
    ContextTypeCONTEXT_TYPEA state indicating that the MetadataSchema will be used by Contexts.
    NameValueDescription
    METADATA_SCHEMA_TYPE_UNSPECIFIEDMETADATA_SCHEMA_TYPE_UNSPECIFIEDUnspecified type for the MetadataSchema.
    ARTIFACT_TYPEARTIFACT_TYPEA type indicating that the MetadataSchema will be used by Artifacts.
    EXECUTION_TYPEEXECUTION_TYPEA typee indicating that the MetadataSchema will be used by Executions.
    CONTEXT_TYPECONTEXT_TYPEA state indicating that the MetadataSchema will be used by Contexts.
    ValueDescription
    METADATA_SCHEMA_TYPE_UNSPECIFIEDUnspecified type for the MetadataSchema.
    ARTIFACT_TYPEA type indicating that the MetadataSchema will be used by Artifacts.
    EXECUTION_TYPEA typee indicating that the MetadataSchema will be used by Executions.
    CONTEXT_TYPEA state indicating that the MetadataSchema will be used by Contexts.

    Package Details

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

    This package is deprecated. Active development has stopped. We recommend using the Google Cloud package instead.

    Viewing docs for Google Cloud Native v0.32.0
    published on Wednesday, Nov 29, 2023 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial