com.google.cloud.aiplatform.v1beta1

Interface ExecutionOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Execution, Execution.Builder

public interface ExecutionOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	containsLabels(String key) The labels with user-defined metadata to organize your Executions.
com.google.protobuf.Timestamp	getCreateTime() Output only.
com.google.protobuf.TimestampOrBuilder	getCreateTimeOrBuilder() Output only.
String	getDescription() Description of the Execution
com.google.protobuf.ByteString	getDescriptionBytes() Description of the Execution
String	getDisplayName() User provided display name of the Execution.
com.google.protobuf.ByteString	getDisplayNameBytes() User provided display name of the Execution.
String	getEtag() An eTag used to perform consistent read-modify-write updates.
com.google.protobuf.ByteString	getEtagBytes() An eTag used to perform consistent read-modify-write updates.
Map<String,String>	getLabels() Deprecated.
int	getLabelsCount() The labels with user-defined metadata to organize your Executions.
Map<String,String>	getLabelsMap() The labels with user-defined metadata to organize your Executions.
String	getLabelsOrDefault(String key, String defaultValue) The labels with user-defined metadata to organize your Executions.
String	getLabelsOrThrow(String key) The labels with user-defined metadata to organize your Executions.
com.google.protobuf.Struct	getMetadata() Properties of the Execution.
com.google.protobuf.StructOrBuilder	getMetadataOrBuilder() Properties of the Execution.
String	getName() Output only.
com.google.protobuf.ByteString	getNameBytes() Output only.
String	getSchemaTitle() The title of the schema describing the metadata.
com.google.protobuf.ByteString	getSchemaTitleBytes() The title of the schema describing the metadata.
String	getSchemaVersion() The version of the schema in `schema_title` to use.
com.google.protobuf.ByteString	getSchemaVersionBytes() The version of the schema in `schema_title` to use.
Execution.State	getState() The state of this Execution.
int	getStateValue() The state of this Execution.
com.google.protobuf.Timestamp	getUpdateTime() Output only.
com.google.protobuf.TimestampOrBuilder	getUpdateTimeOrBuilder() Output only.
boolean	hasCreateTime() Output only.
boolean	hasMetadata() Properties of the Execution.
boolean	hasUpdateTime() Output only.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getName

String getName()

 Output only. The resource name of the Execution.
 

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The name.

getNameBytes

com.google.protobuf.ByteString getNameBytes()

 Output only. The resource name of the Execution.
 

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The bytes for name.

getDisplayName

String getDisplayName()

 User provided display name of the Execution.
 May be up to 128 Unicode characters.
 

string display_name = 2;

Returns:

The displayName.

getDisplayNameBytes

com.google.protobuf.ByteString getDisplayNameBytes()

 User provided display name of the Execution.
 May be up to 128 Unicode characters.
 

string display_name = 2;

Returns:

The bytes for displayName.

getStateValue

int getStateValue()

 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.
 

.google.cloud.aiplatform.v1beta1.Execution.State state = 6;

Returns:

The enum numeric value on the wire for state.

getState

Execution.State getState()

 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.
 

.google.cloud.aiplatform.v1beta1.Execution.State state = 6;

Returns:

The state.

getEtag

String getEtag()

 An eTag used to perform consistent read-modify-write updates. If not set, a
 blind "overwrite" update happens.
 

string etag = 9;

Returns:

The etag.

getEtagBytes

com.google.protobuf.ByteString getEtagBytes()

 An eTag used to perform consistent read-modify-write updates. If not set, a
 blind "overwrite" update happens.
 

string etag = 9;

Returns:

The bytes for etag.

getLabelsCount

int getLabelsCount()

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

map<string, string> labels = 10;

containsLabels

boolean containsLabels(String key)

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

map<string, string> labels = 10;

getLabels

@Deprecated
Map<String,String> getLabels()

Deprecated.

Use getLabelsMap() instead.

getLabelsMap

Map<String,String> getLabelsMap()

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

map<string, string> labels = 10;

getLabelsOrDefault

String getLabelsOrDefault(String key,
                          String defaultValue)

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

map<string, string> labels = 10;

getLabelsOrThrow

String getLabelsOrThrow(String key)

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

map<string, string> labels = 10;

hasCreateTime

boolean hasCreateTime()

 Output only. Timestamp when this Execution was created.
 

.google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

Whether the createTime field is set.

getCreateTime

com.google.protobuf.Timestamp getCreateTime()

 Output only. Timestamp when this Execution was created.
 

.google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The createTime.

getCreateTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()

 Output only. Timestamp when this Execution was created.
 

.google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

hasUpdateTime

boolean hasUpdateTime()

 Output only. Timestamp when this Execution was last updated.
 

.google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

Whether the updateTime field is set.

getUpdateTime

com.google.protobuf.Timestamp getUpdateTime()

 Output only. Timestamp when this Execution was last updated.
 

.google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The updateTime.

getUpdateTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()

 Output only. Timestamp when this Execution was last updated.
 

.google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

getSchemaTitle

String getSchemaTitle()

 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.
 

string schema_title = 13;

Returns:

The schemaTitle.

getSchemaTitleBytes

com.google.protobuf.ByteString getSchemaTitleBytes()

 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.
 

string schema_title = 13;

Returns:

The bytes for schemaTitle.

getSchemaVersion

String getSchemaVersion()

 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.
 

string schema_version = 14;

Returns:

The schemaVersion.

getSchemaVersionBytes

com.google.protobuf.ByteString getSchemaVersionBytes()

 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.
 

string schema_version = 14;

Returns:

The bytes for schemaVersion.

hasMetadata

boolean hasMetadata()

 Properties of the Execution.
 The size of this field should not exceed 200KB.
 

.google.protobuf.Struct metadata = 15;

Returns:

Whether the metadata field is set.

getMetadata

com.google.protobuf.Struct getMetadata()

 Properties of the Execution.
 The size of this field should not exceed 200KB.
 

.google.protobuf.Struct metadata = 15;

Returns:

The metadata.

getMetadataOrBuilder

com.google.protobuf.StructOrBuilder getMetadataOrBuilder()

 Properties of the Execution.
 The size of this field should not exceed 200KB.
 

.google.protobuf.Struct metadata = 15;

getDescription

String getDescription()

 Description of the Execution
 

string description = 16;

Returns:

The description.

getDescriptionBytes

com.google.protobuf.ByteString getDescriptionBytes()

 Description of the Execution
 

string description = 16;

Returns:

The bytes for description.