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

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

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 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/v1:MetadataSchema
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 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.

    Example

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

    var metadataSchemaResource = new GoogleNative.Aiplatform.V1.MetadataSchema("metadataSchemaResource", new()
{
    MetadataStoreId = "string",
    Schema = "string",
    Description = "string",
    Location = "string",
    MetadataSchemaId = "string",
    Project = "string",
    SchemaType = GoogleNative.Aiplatform.V1.MetadataSchemaSchemaType.MetadataSchemaTypeUnspecified,
    SchemaVersion = "string",
});

    example, err := aiplatform.NewMetadataSchema(ctx, "metadataSchemaResource", &aiplatform.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: aiplatform.MetadataSchemaSchemaTypeMetadataSchemaTypeUnspecified,
SchemaVersion: pulumi.String("string"),
})

    var metadataSchemaResource = new MetadataSchema("metadataSchemaResource", MetadataSchemaArgs.builder()        
    .metadataStoreId("string")
    .schema("string")
    .description("string")
    .location("string")
    .metadataSchemaId("string")
    .project("string")
    .schemaType("METADATA_SCHEMA_TYPE_UNSPECIFIED")
    .schemaVersion("string")
    .build());

    metadata_schema_resource = google_native.aiplatform.v1.MetadataSchema("metadataSchemaResource",
    metadata_store_id="string",
    schema="string",
    description="string",
    location="string",
    metadata_schema_id="string",
    project="string",
    schema_type=google_native.aiplatform.v1.MetadataSchemaSchemaType.METADATA_SCHEMA_TYPE_UNSPECIFIED,
    schema_version="string")

    const metadataSchemaResource = new google_native.aiplatform.v1.MetadataSchema("metadataSchemaResource", {
    metadataStoreId: "string",
    schema: "string",
    description: "string",
    location: "string",
    metadataSchemaId: "string",
    project: "string",
    schemaType: google_native.aiplatform.v1.MetadataSchemaSchemaType.MetadataSchemaTypeUnspecified,
    schemaVersion: "string",
});

    type: google-native:aiplatform/v1: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

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

    Supporting Types

    MetadataSchemaSchemaType, MetadataSchemaSchemaTypeArgs

    MetadataSchemaTypeUnspecified
    METADATA_SCHEMA_TYPE_UNSPECIFIEDUnspecified type for the MetadataSchema.
    ArtifactType
    ARTIFACT_TYPEA type indicating that the MetadataSchema will be used by Artifacts.
    ExecutionType
    EXECUTION_TYPEA typee indicating that the MetadataSchema will be used by Executions.
    ContextType
    CONTEXT_TYPEA state indicating that the MetadataSchema will be used by Contexts.
    MetadataSchemaSchemaTypeMetadataSchemaTypeUnspecified
    METADATA_SCHEMA_TYPE_UNSPECIFIEDUnspecified type for the MetadataSchema.
    MetadataSchemaSchemaTypeArtifactType
    ARTIFACT_TYPEA type indicating that the MetadataSchema will be used by Artifacts.
    MetadataSchemaSchemaTypeExecutionType
    EXECUTION_TYPEA typee indicating that the MetadataSchema will be used by Executions.
    MetadataSchemaSchemaTypeContextType
    CONTEXT_TYPEA state indicating that the MetadataSchema will be used by Contexts.
    MetadataSchemaTypeUnspecified
    METADATA_SCHEMA_TYPE_UNSPECIFIEDUnspecified type for the MetadataSchema.
    ArtifactType
    ARTIFACT_TYPEA type indicating that the MetadataSchema will be used by Artifacts.
    ExecutionType
    EXECUTION_TYPEA typee indicating that the MetadataSchema will be used by Executions.
    ContextType
    CONTEXT_TYPEA state indicating that the MetadataSchema will be used by Contexts.
    MetadataSchemaTypeUnspecified
    METADATA_SCHEMA_TYPE_UNSPECIFIEDUnspecified type for the MetadataSchema.
    ArtifactType
    ARTIFACT_TYPEA type indicating that the MetadataSchema will be used by Artifacts.
    ExecutionType
    EXECUTION_TYPEA typee indicating that the MetadataSchema will be used by Executions.
    ContextType
    CONTEXT_TYPEA state indicating that the MetadataSchema will be used by Contexts.
    METADATA_SCHEMA_TYPE_UNSPECIFIED
    METADATA_SCHEMA_TYPE_UNSPECIFIEDUnspecified type for the MetadataSchema.
    ARTIFACT_TYPE
    ARTIFACT_TYPEA type indicating that the MetadataSchema will be used by Artifacts.
    EXECUTION_TYPE
    EXECUTION_TYPEA typee indicating that the MetadataSchema will be used by Executions.
    CONTEXT_TYPE
    CONTEXT_TYPEA state indicating that the MetadataSchema will be used by Contexts.
    "METADATA_SCHEMA_TYPE_UNSPECIFIED"
    METADATA_SCHEMA_TYPE_UNSPECIFIEDUnspecified type for the MetadataSchema.
    "ARTIFACT_TYPE"
    ARTIFACT_TYPEA type indicating that the MetadataSchema will be used by Artifacts.
    "EXECUTION_TYPE"
    EXECUTION_TYPEA typee indicating that the MetadataSchema will be used by Executions.
    "CONTEXT_TYPE"
    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 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