Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::Context (v0.58.0)

Reference documentation and code samples for the Vertex AI V1 API class Google::Cloud::AIPlatform::V1::Context.

Instance of a general context.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#create_time

def create_time() -> ::Google::Protobuf::Timestamp
Returns

#description

def description() -> ::String
Returns
  • (::String) — Description of the Context

#description=

def description=(value) -> ::String
Parameter
  • value (::String) — Description of the Context
Returns
  • (::String) — Description of the Context

#display_name

def display_name() -> ::String
Returns
  • (::String) — User provided display name of the Context. May be up to 128 Unicode characters.

#display_name=

def display_name=(value) -> ::String
Parameter
  • value (::String) — User provided display name of the Context. May be up to 128 Unicode characters.
Returns
  • (::String) — User provided display name of the Context. May be up to 128 Unicode characters.

#etag

def etag() -> ::String
Returns
  • (::String) — An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

#etag=

def etag=(value) -> ::String
Parameter
  • value (::String) — An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
Returns
  • (::String) — An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::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).

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::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).

Returns
  • (::Google::Protobuf::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).

#metadata

def metadata() -> ::Google::Protobuf::Struct
Returns
  • (::Google::Protobuf::Struct) — Properties of the Context. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.

#metadata=

def metadata=(value) -> ::Google::Protobuf::Struct
Parameter
  • value (::Google::Protobuf::Struct) — Properties of the Context. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.
Returns
  • (::Google::Protobuf::Struct) — 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

def name() -> ::String
Returns
  • (::String) — Immutable. The resource name of the Context.

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — Immutable. The resource name of the Context.
Returns
  • (::String) — Immutable. The resource name of the Context.

#parent_contexts

def parent_contexts() -> ::Array<::String>
Returns
  • (::Array<::String>) — Output only. A list of resource names of Contexts that are parents of this Context. A Context may have at most 10 parent_contexts.

#schema_title

def schema_title() -> ::String
Returns
  • (::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.

#schema_title=

def schema_title=(value) -> ::String
Parameter
  • value (::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.

Returns
  • (::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.

#schema_version

def schema_version() -> ::String
Returns
  • (::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.

#schema_version=

def schema_version=(value) -> ::String
Parameter
  • value (::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.

Returns
  • (::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.

#update_time

def update_time() -> ::Google::Protobuf::Timestamp
Returns