Class Execution.Builder (3.54.0)

Version latest

• 3.54.0 (latest)
• 3.53.0
• 3.52.0
• 3.50.0
• 3.49.0
• 3.48.0
• 3.47.0
• 3.46.0
• 3.45.0
• 3.44.0
• 3.43.0
• 3.42.0
• 3.41.0
• 3.40.0
• 3.38.0
• 3.37.0
• 3.36.0
• 3.35.0
• 3.34.0
• 3.33.0
• 3.32.0
• 3.31.0
• 3.30.0
• 3.29.0
• 3.28.0
• 3.25.0
• 3.24.0
• 3.23.0
• 3.22.0
• 3.21.0
• 3.20.0
• 3.19.0
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.0
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.2
• 3.3.0
• 3.2.0
• 3.0.0
• 2.9.8
• 2.8.9
• 2.7.4
• 2.5.3
• 2.4.0

public static final class Execution.Builder extends GeneratedMessageV3.Builder<Execution.Builder> implements ExecutionOrBuilder

Instance of a general execution.

Protobuf type google.cloud.aiplatform.v1beta1.Execution

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Execution.Builder

Implements

ExecutionOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Execution.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
Execution.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public Execution build()

Returns
Type	Description
Execution

buildPartial()

public Execution buildPartial()

Returns
Type	Description
Execution

clear()

public Execution.Builder clear()

Returns
Type	Description
Execution.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearCreateTime()

public Execution.Builder clearCreateTime()

Output only. Timestamp when this Execution was created.

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

Returns
Type	Description
Execution.Builder

clearDescription()

public Execution.Builder clearDescription()

Description of the Execution

string description = 16;

Returns
Type	Description
Execution.Builder	This builder for chaining.

clearDisplayName()

public Execution.Builder clearDisplayName()

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

string display_name = 2;

Returns
Type	Description
Execution.Builder	This builder for chaining.

clearEtag()

public Execution.Builder clearEtag()

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

string etag = 9;

Returns
Type	Description
Execution.Builder	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Execution.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
Execution.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearLabels()

public Execution.Builder clearLabels()

Returns
Type	Description
Execution.Builder

clearMetadata()

public Execution.Builder clearMetadata()

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

.google.protobuf.Struct metadata = 15;

Returns
Type	Description
Execution.Builder

clearName()

public Execution.Builder clearName()

Output only. The resource name of the Execution.

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

Returns
Type	Description
Execution.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Execution.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
Execution.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearSchemaTitle()

public Execution.Builder clearSchemaTitle()

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
Type	Description
Execution.Builder	This builder for chaining.

clearSchemaVersion()

public Execution.Builder clearSchemaVersion()

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
Type	Description
Execution.Builder	This builder for chaining.

clearState()

public Execution.Builder clearState()

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
Type	Description
Execution.Builder	This builder for chaining.

clearUpdateTime()

public Execution.Builder clearUpdateTime()

Output only. Timestamp when this Execution was last updated.

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

Returns
Type	Description
Execution.Builder

clone()

public Execution.Builder clone()

Returns
Type	Description
Execution.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

containsLabels(String key)

public 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;

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

getCreateTime()

public Timestamp getCreateTime()

Output only. Timestamp when this Execution was created.

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

Returns
Type	Description
Timestamp	The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. Timestamp when this Execution was created.

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

Returns
Type	Description
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Timestamp when this Execution was created.

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

Returns
Type	Description
TimestampOrBuilder

getDefaultInstanceForType()

public Execution getDefaultInstanceForType()

Returns
Type	Description
Execution

getDescription()

public String getDescription()

Description of the Execution

string description = 16;

Returns
Type	Description
String	The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Description of the Execution

string description = 16;

Returns
Type	Description
ByteString	The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getDisplayName()

public String getDisplayName()

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

string display_name = 2;

Returns
Type	Description
String	The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

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

string display_name = 2;

Returns
Type	Description
ByteString	The bytes for displayName.

getEtag()

public String getEtag()

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

string etag = 9;

Returns
Type	Description
String	The etag.

getEtagBytes()

public ByteString getEtagBytes()

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

string etag = 9;

Returns
Type	Description
ByteString	The bytes for etag.

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type	Description
Map<String,String>

getLabelsCount()

public 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;

Returns
Type	Description
int

getLabelsMap()

public 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;

Returns
Type	Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public 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;

Parameters
Name	Description
key	String
defaultValue	String

Returns
Type	Description
String

getLabelsOrThrow(String key)

public 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;

Parameter
Name	Description
key	String

Returns
Type	Description
String

getMetadata()

public Struct getMetadata()

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

.google.protobuf.Struct metadata = 15;

Returns
Type	Description
Struct	The metadata.

getMetadataBuilder()

public Struct.Builder getMetadataBuilder()

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

.google.protobuf.Struct metadata = 15;

Returns
Type	Description
Builder

getMetadataOrBuilder()

public StructOrBuilder getMetadataOrBuilder()

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

.google.protobuf.Struct metadata = 15;

Returns
Type	Description
StructOrBuilder

getMutableLabels() (deprecated)

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
Type	Description
Map<String,String>

getName()

public String getName()

Output only. The resource name of the Execution.

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

Returns
Type	Description
String	The name.

getNameBytes()

public ByteString getNameBytes()

Output only. The resource name of the Execution.

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

Returns
Type	Description
ByteString	The bytes for name.

getSchemaTitle()

public 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
Type	Description
String	The schemaTitle.

getSchemaTitleBytes()

public 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
Type	Description
ByteString	The bytes for schemaTitle.

getSchemaVersion()

public 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
Type	Description
String	The schemaVersion.

getSchemaVersionBytes()

public 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
Type	Description
ByteString	The bytes for schemaVersion.

getState()

public 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
Type	Description
Execution.State	The state.

getStateValue()

public 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
Type	Description
int	The enum numeric value on the wire for state.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. Timestamp when this Execution was last updated.

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

Returns
Type	Description
Timestamp	The updateTime.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

Output only. Timestamp when this Execution was last updated.

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

Returns
Type	Description
Builder

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Timestamp when this Execution was last updated.

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

Returns
Type	Description
TimestampOrBuilder

hasCreateTime()

public boolean hasCreateTime()

Output only. Timestamp when this Execution was created.

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

Returns
Type	Description
boolean	Whether the createTime field is set.

hasMetadata()

public boolean hasMetadata()

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

.google.protobuf.Struct metadata = 15;

Returns
Type	Description
boolean	Whether the metadata field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. Timestamp when this Execution was last updated.

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

Returns
Type	Description
boolean	Whether the updateTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)

Parameter
Name	Description
number	int

Returns
Type	Description
com.google.protobuf.MapFieldReflectionAccessor

Overrides

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)

Parameter
Name	Description
number	int

Returns
Type	Description
com.google.protobuf.MapFieldReflectionAccessor

Overrides

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeCreateTime(Timestamp value)

public Execution.Builder mergeCreateTime(Timestamp value)

Output only. Timestamp when this Execution was created.

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

Parameter
Name	Description
value	Timestamp

Returns
Type	Description
Execution.Builder

mergeFrom(Execution other)

public Execution.Builder mergeFrom(Execution other)

Parameter
Name	Description
other	Execution

Returns
Type	Description
Execution.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Execution.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Execution.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public Execution.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
Execution.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeMetadata(Struct value)

public Execution.Builder mergeMetadata(Struct value)

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

.google.protobuf.Struct metadata = 15;

Parameter
Name	Description
value	Struct

Returns
Type	Description
Execution.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Execution.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
Execution.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

mergeUpdateTime(Timestamp value)

public Execution.Builder mergeUpdateTime(Timestamp value)

Output only. Timestamp when this Execution was last updated.

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

Parameter
Name	Description
value	Timestamp

Returns
Type	Description
Execution.Builder

putAllLabels(Map<String,String> values)

public Execution.Builder putAllLabels(Map<String,String> values)

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;

Parameter
Name	Description
values	Map<String,String>

Returns
Type	Description
Execution.Builder

putLabels(String key, String value)

public Execution.Builder putLabels(String key, String value)

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;

Parameters
Name	Description
key	String
value	String

Returns
Type	Description
Execution.Builder

removeLabels(String key)

public Execution.Builder removeLabels(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;

Parameter
Name	Description
key	String

Returns
Type	Description
Execution.Builder

setCreateTime(Timestamp value)

public Execution.Builder setCreateTime(Timestamp value)

Output only. Timestamp when this Execution was created.

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

Parameter
Name	Description
value	Timestamp

Returns
Type	Description
Execution.Builder

setCreateTime(Timestamp.Builder builderForValue)

public Execution.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. Timestamp when this Execution was created.

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

Parameter
Name	Description
builderForValue	Builder

Returns
Type	Description
Execution.Builder

setDescription(String value)

public Execution.Builder setDescription(String value)

Description of the Execution

string description = 16;

Parameter
Name	Description
value	String The description to set.

Returns
Type	Description
Execution.Builder	This builder for chaining.

setDescriptionBytes(ByteString value)

public Execution.Builder setDescriptionBytes(ByteString value)

Description of the Execution

string description = 16;

Parameter
Name	Description
value	ByteString The bytes for description to set.

Returns
Type	Description
Execution.Builder	This builder for chaining.

setDisplayName(String value)

public Execution.Builder setDisplayName(String value)

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

string display_name = 2;

Parameter
Name	Description
value	String The displayName to set.

Returns
Type	Description
Execution.Builder	This builder for chaining.

setDisplayNameBytes(ByteString value)

public Execution.Builder setDisplayNameBytes(ByteString value)

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

string display_name = 2;

Parameter
Name	Description
value	ByteString The bytes for displayName to set.

Returns
Type	Description
Execution.Builder	This builder for chaining.

setEtag(String value)

public Execution.Builder setEtag(String value)

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

string etag = 9;

Parameter
Name	Description
value	String The etag to set.

Returns
Type	Description
Execution.Builder	This builder for chaining.

setEtagBytes(ByteString value)

public Execution.Builder setEtagBytes(ByteString value)

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

string etag = 9;

Parameter
Name	Description
value	ByteString The bytes for etag to set.

Returns
Type	Description
Execution.Builder	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Execution.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
Execution.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setMetadata(Struct value)

public Execution.Builder setMetadata(Struct value)

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

.google.protobuf.Struct metadata = 15;

Parameter
Name	Description
value	Struct

Returns
Type	Description
Execution.Builder

setMetadata(Struct.Builder builderForValue)

public Execution.Builder setMetadata(Struct.Builder builderForValue)

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

.google.protobuf.Struct metadata = 15;

Parameter
Name	Description
builderForValue	Builder

Returns
Type	Description
Execution.Builder

setName(String value)

public Execution.Builder setName(String value)

Output only. The resource name of the Execution.

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

Parameter
Name	Description
value	String The name to set.

Returns
Type	Description
Execution.Builder	This builder for chaining.

setNameBytes(ByteString value)

public Execution.Builder setNameBytes(ByteString value)

Output only. The resource name of the Execution.

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

Parameter
Name	Description
value	ByteString The bytes for name to set.

Returns
Type	Description
Execution.Builder	This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Execution.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
Execution.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setSchemaTitle(String value)

public Execution.Builder setSchemaTitle(String value)

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;

Parameter
Name	Description
value	String The schemaTitle to set.

Returns
Type	Description
Execution.Builder	This builder for chaining.

setSchemaTitleBytes(ByteString value)

public Execution.Builder setSchemaTitleBytes(ByteString value)

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;

Parameter
Name	Description
value	ByteString The bytes for schemaTitle to set.

Returns
Type	Description
Execution.Builder	This builder for chaining.

setSchemaVersion(String value)

public Execution.Builder setSchemaVersion(String value)

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;

Parameter
Name	Description
value	String The schemaVersion to set.

Returns
Type	Description
Execution.Builder	This builder for chaining.

setSchemaVersionBytes(ByteString value)

public Execution.Builder setSchemaVersionBytes(ByteString value)

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;

Parameter
Name	Description
value	ByteString The bytes for schemaVersion to set.

Returns
Type	Description
Execution.Builder	This builder for chaining.

setState(Execution.State value)

public Execution.Builder setState(Execution.State value)

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;

Parameter
Name	Description
value	Execution.State The state to set.

Returns
Type	Description
Execution.Builder	This builder for chaining.

setStateValue(int value)

public Execution.Builder setStateValue(int value)

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;

Parameter
Name	Description
value	int The enum numeric value on the wire for state to set.

Returns
Type	Description
Execution.Builder	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Execution.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
Execution.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)

setUpdateTime(Timestamp value)

public Execution.Builder setUpdateTime(Timestamp value)

Output only. Timestamp when this Execution was last updated.

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

Parameter
Name	Description
value	Timestamp

Returns
Type	Description
Execution.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public Execution.Builder setUpdateTime(Timestamp.Builder builderForValue)

Output only. Timestamp when this Execution was last updated.

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

Parameter
Name	Description
builderForValue	Builder

Returns
Type	Description
Execution.Builder