REST Resource: projects.locations.metadataStores.contexts

Resource: Context

Instance of a general context.

Fields
name string

Immutable. The resource name 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 (key: string, value: 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).

createTime string (Timestamp format)

Output only. timestamp when this Context was created.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

updateTime string (Timestamp format)

Output only. timestamp when this Context was last updated.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

parentContexts[] string

Output only. A list of resource names of contexts that are parents of this Context. A Context may have at most 10 parentContexts.

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 schemaName 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 object (Struct format)

Properties of the Context. top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.

description string

description of the Context

JSON representation
{
  "name": string,
  "displayName": string,
  "etag": string,
  "labels": {
    string: string,
    ...
  },
  "createTime": string,
  "updateTime": string,
  "parentContexts": [
    string
  ],
  "schemaTitle": string,
  "schemaVersion": string,
  "metadata": {
    object
  },
  "description": string
}

Methods

addContextArtifactsAndExecutions

Adds a set of Artifacts and Executions to a Context.

addContextChildren

Adds a set of Contexts as children to a parent Context.

create

Creates a Context associated with a MetadataStore.

delete

Deletes a stored Context.

get

Retrieves a specific Context.

list

Lists Contexts on the MetadataStore.

patch

Updates a stored Context.

purge

Purges Contexts.

queryContextLineageSubgraph

Retrieves Artifacts and Executions within the specified Context, connected by Event edges and returned as a LineageSubgraph.

removeContextChildren

Remove a set of children contexts from a parent Context.