Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. aiplatform
  5. aiplatform/v1
  6. Context

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

Explore with Pulumi AI

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 Context associated with a MetadataStore.

Create Context Resource

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

Constructor syntax

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

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

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

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ContextArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. ContextArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. ContextArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ContextArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ContextArgs
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 contextResource = new GoogleNative.Aiplatform.V1.Context("contextResource", new()
{
    MetadataStoreId = "string",
    ContextId = "string",
    Description = "string",
    DisplayName = "string",
    Etag = "string",
    Labels = 
    {
        { "string", "string" },
    },
    Location = "string",
    Metadata = 
    {
        { "string", "string" },
    },
    Name = "string",
    Project = "string",
    SchemaTitle = "string",
    SchemaVersion = "string",
});
Copy
example, err := aiplatform.NewContext(ctx, "contextResource", &aiplatform.ContextArgs{
	MetadataStoreId: pulumi.String("string"),
	ContextId:       pulumi.String("string"),
	Description:     pulumi.String("string"),
	DisplayName:     pulumi.String("string"),
	Etag:            pulumi.String("string"),
	Labels: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Location: pulumi.String("string"),
	Metadata: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Name:          pulumi.String("string"),
	Project:       pulumi.String("string"),
	SchemaTitle:   pulumi.String("string"),
	SchemaVersion: pulumi.String("string"),
})
Copy
var contextResource = new com.pulumi.googlenative.aiplatform_v1.Context("contextResource", com.pulumi.googlenative.aiplatform_v1.ContextArgs.builder()
    .metadataStoreId("string")
    .contextId("string")
    .description("string")
    .displayName("string")
    .etag("string")
    .labels(Map.of("string", "string"))
    .location("string")
    .metadata(Map.of("string", "string"))
    .name("string")
    .project("string")
    .schemaTitle("string")
    .schemaVersion("string")
    .build());
Copy
context_resource = google_native.aiplatform.v1.Context("contextResource",
    metadata_store_id="string",
    context_id="string",
    description="string",
    display_name="string",
    etag="string",
    labels={
        "string": "string",
    },
    location="string",
    metadata={
        "string": "string",
    },
    name="string",
    project="string",
    schema_title="string",
    schema_version="string")
Copy
const contextResource = new google_native.aiplatform.v1.Context("contextResource", {
    metadataStoreId: "string",
    contextId: "string",
    description: "string",
    displayName: "string",
    etag: "string",
    labels: {
        string: "string",
    },
    location: "string",
    metadata: {
        string: "string",
    },
    name: "string",
    project: "string",
    schemaTitle: "string",
    schemaVersion: "string",
});
Copy
type: google-native:aiplatform/v1:Context
properties:
    contextId: string
    description: string
    displayName: string
    etag: string
    labels:
        string: string
    location: string
    metadata:
        string: string
    metadataStoreId: string
    name: string
    project: string
    schemaTitle: string
    schemaVersion: string
Copy

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

MetadataStoreId
This property is required.
Changes to this property will trigger replacement.
string
ContextId string
The {context} portion of the resource name with the format: projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}. If not provided, the Context'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 Contexts in the parent MetadataStore. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting Context.)
Description string
Description of the Context
DisplayName string
User provided display name of the Context. 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 Contexts. 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 Context (System labels are excluded).
Location Changes to this property will trigger replacement. string
Metadata Dictionary<string, string>
Properties of the Context. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.
Name string
Immutable. The resource name of the Context.
Project Changes to this property will trigger replacement. 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.
MetadataStoreId
This property is required.
Changes to this property will trigger replacement.
string
ContextId string
The {context} portion of the resource name with the format: projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}. If not provided, the Context'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 Contexts in the parent MetadataStore. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting Context.)
Description string
Description of the Context
DisplayName string
User provided display name of the Context. 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 Contexts. 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 Context (System labels are excluded).
Location Changes to this property will trigger replacement. string
Metadata map[string]string
Properties of the Context. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.
Name string
Immutable. The resource name of the Context.
Project Changes to this property will trigger replacement. 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.
metadataStoreId
This property is required.
Changes to this property will trigger replacement.
String
contextId String
The {context} portion of the resource name with the format: projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}. If not provided, the Context'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 Contexts in the parent MetadataStore. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting Context.)
description String
Description of the Context
displayName String
User provided display name of the Context. 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 Contexts. 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 Context (System labels are excluded).
location Changes to this property will trigger replacement. String
metadata Map<String,String>
Properties of the Context. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.
name String
Immutable. The resource name of the Context.
project Changes to this property will trigger replacement. 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.
metadataStoreId
This property is required.
Changes to this property will trigger replacement.
string
contextId string
The {context} portion of the resource name with the format: projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}. If not provided, the Context'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 Contexts in the parent MetadataStore. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting Context.)
description string
Description of the Context
displayName string
User provided display name of the Context. 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 Contexts. 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 Context (System labels are excluded).
location Changes to this property will trigger replacement. string
metadata {[key: string]: string}
Properties of the Context. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.
name string
Immutable. The resource name of the Context.
project Changes to this property will trigger replacement. 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.
metadata_store_id
This property is required.
Changes to this property will trigger replacement.
str
context_id str
The {context} portion of the resource name with the format: projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}. If not provided, the Context'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 Contexts in the parent MetadataStore. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting Context.)
description str
Description of the Context
display_name str
User provided display name of the Context. 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 Contexts. 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 Context (System labels are excluded).
location Changes to this property will trigger replacement. str
metadata Mapping[str, str]
Properties of the Context. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.
name str
Immutable. The resource name of the Context.
project Changes to this property will trigger replacement. 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.
metadataStoreId
This property is required.
Changes to this property will trigger replacement.
String
contextId String
The {context} portion of the resource name with the format: projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}. If not provided, the Context'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 Contexts in the parent MetadataStore. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting Context.)
description String
Description of the Context
displayName String
User provided display name of the Context. 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 Contexts. 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 Context (System labels are excluded).
location Changes to this property will trigger replacement. String
metadata Map<String>
Properties of the Context. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.
name String
Immutable. The resource name of the Context.
project Changes to this property will trigger replacement. 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.

Outputs

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

CreateTime string
Timestamp when this Context was created.
Id string
The provider-assigned unique ID for this managed resource.
ParentContexts List<string>
A list of resource names of Contexts that are parents of this Context. A Context may have at most 10 parent_contexts.
UpdateTime string
Timestamp when this Context was last updated.
CreateTime string
Timestamp when this Context was created.
Id string
The provider-assigned unique ID for this managed resource.
ParentContexts []string
A list of resource names of Contexts that are parents of this Context. A Context may have at most 10 parent_contexts.
UpdateTime string
Timestamp when this Context was last updated.
createTime String
Timestamp when this Context was created.
id String
The provider-assigned unique ID for this managed resource.
parentContexts List<String>
A list of resource names of Contexts that are parents of this Context. A Context may have at most 10 parent_contexts.
updateTime String
Timestamp when this Context was last updated.
createTime string
Timestamp when this Context was created.
id string
The provider-assigned unique ID for this managed resource.
parentContexts string[]
A list of resource names of Contexts that are parents of this Context. A Context may have at most 10 parent_contexts.
updateTime string
Timestamp when this Context was last updated.
create_time str
Timestamp when this Context was created.
id str
The provider-assigned unique ID for this managed resource.
parent_contexts Sequence[str]
A list of resource names of Contexts that are parents of this Context. A Context may have at most 10 parent_contexts.
update_time str
Timestamp when this Context was last updated.
createTime String
Timestamp when this Context was created.
id String
The provider-assigned unique ID for this managed resource.
parentContexts List<String>
A list of resource names of Contexts that are parents of this Context. A Context may have at most 10 parent_contexts.
updateTime String
Timestamp when this Context was last updated.

Package Details

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

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