Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::Execution (v0.61.0)

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

Instance of a general execution.

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 Execution

#description=

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

#display_name

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

#display_name=

def display_name=(value) -> ::String
Parameter
  • value (::String) — User provided display name of the Execution. May be up to 128 Unicode characters.
Returns
  • (::String) — User provided display name of the Execution. 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 Executions.

    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 Execution (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 Executions.

    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 Execution (System labels are excluded).

Returns
  • (::Google::Protobuf::Map{::String => ::String}) — The labels with user-defined metadata to organize your Executions.

    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 Execution (System labels are excluded).

#metadata

def metadata() -> ::Google::Protobuf::Struct
Returns
  • (::Google::Protobuf::Struct) — Properties of the Execution. 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 Execution. 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 Execution. 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) — Output only. The resource name of the Execution.

#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_title 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_title 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_title 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.

#state

def state() -> ::Google::Cloud::AIPlatform::V1::Execution::State
Returns
  • (::Google::Cloud::AIPlatform::V1::Execution::State) — The state of this Execution. This is a property of the Execution, and does not imply or capture any ongoing process. This property is managed by clients (such as Vertex AI Pipelines) and the system does not prescribe or check the validity of state transitions.

#state=

def state=(value) -> ::Google::Cloud::AIPlatform::V1::Execution::State
Parameter
  • value (::Google::Cloud::AIPlatform::V1::Execution::State) — The state of this Execution. This is a property of the Execution, and does not imply or capture any ongoing process. This property is managed by clients (such as Vertex AI Pipelines) and the system does not prescribe or check the validity of state transitions.
Returns
  • (::Google::Cloud::AIPlatform::V1::Execution::State) — The state of this Execution. This is a property of the Execution, and does not imply or capture any ongoing process. This property is managed by clients (such as Vertex AI Pipelines) and the system does not prescribe or check the validity of state transitions.

#update_time

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