Skip to main content

contexts

Overview

Namecontexts
TypeResource
Idgoogle.aiplatform.contexts

Fields

NameDatatypeDescription
namestringImmutable. The resource name of the Context.
descriptionstringDescription of the Context
createTimestringOutput only. Timestamp when this Context was created.
displayNamestringUser provided display name of the Context. May be up to 128 Unicode characters.
etagstringAn eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
labelsobjectThe 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).
metadataobjectProperties of the Context. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.
parentContextsarrayOutput only. A list of resource names of Contexts that are parents of this Context. A Context may have at most 10 parent_contexts.
schemaTitlestringThe 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.
schemaVersionstringThe 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.
updateTimestringOutput only. Timestamp when this Context was last updated.

Methods

NameAccessible byRequired ParamsDescription
getSELECTcontextsId, locationsId, metadataStoresId, projectsIdRetrieves a specific Context.
listSELECTlocationsId, metadataStoresId, projectsIdLists Contexts on the MetadataStore.
createINSERTlocationsId, metadataStoresId, projectsIdCreates a Context associated with a MetadataStore.
deleteDELETEcontextsId, locationsId, metadataStoresId, projectsIdDeletes a stored Context.
_listEXEClocationsId, metadataStoresId, projectsIdLists Contexts on the MetadataStore.
patchEXECcontextsId, locationsId, metadataStoresId, projectsIdUpdates a stored Context.
purgeEXEClocationsId, metadataStoresId, projectsIdPurges Contexts.
query_context_lineage_subgraphEXECcontextsId, locationsId, metadataStoresId, projectsIdRetrieves Artifacts and Executions within the specified Context, connected by Event edges and returned as a LineageSubgraph.