com.google.cloud.aiplatform.v1

Class TensorboardRun.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessageV3.Builder<TensorboardRun.Builder>

com.google.cloud.aiplatform.v1.TensorboardRun.Builder

All Implemented Interfaces:

TensorboardRunOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

TensorboardRun

public static final class TensorboardRun.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<TensorboardRun.Builder>
implements TensorboardRunOrBuilder

 TensorboardRun maps to a specific execution of a training job with a given
 set of hyperparameter values, model definition, dataset, etc
 

Protobuf type google.cloud.aiplatform.v1.TensorboardRun

Method Summary

Modifier and Type	Method and Description
TensorboardRun.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
TensorboardRun	build()
TensorboardRun	buildPartial()
TensorboardRun.Builder	clear()
TensorboardRun.Builder	clearCreateTime() Output only.
TensorboardRun.Builder	clearDescription() Description of this TensorboardRun.
TensorboardRun.Builder	clearDisplayName() Required.
TensorboardRun.Builder	clearEtag() Used to perform a consistent read-modify-write updates.
TensorboardRun.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
TensorboardRun.Builder	clearLabels()
TensorboardRun.Builder	clearName() Output only.
TensorboardRun.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
TensorboardRun.Builder	clearUpdateTime() Output only.
TensorboardRun.Builder	clone()
boolean	containsLabels(String key) The labels with user-defined metadata to organize your TensorboardRuns.
com.google.protobuf.Timestamp	getCreateTime() Output only.
com.google.protobuf.Timestamp.Builder	getCreateTimeBuilder() Output only.
com.google.protobuf.TimestampOrBuilder	getCreateTimeOrBuilder() Output only.
TensorboardRun	getDefaultInstanceForType()
String	getDescription() Description of this TensorboardRun.
com.google.protobuf.ByteString	getDescriptionBytes() Description of this TensorboardRun.
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
String	getDisplayName() Required.
com.google.protobuf.ByteString	getDisplayNameBytes() Required.
String	getEtag() Used to perform a consistent read-modify-write updates.
com.google.protobuf.ByteString	getEtagBytes() Used to perform a consistent read-modify-write updates.
Map<String,String>	getLabels() Deprecated.
int	getLabelsCount() The labels with user-defined metadata to organize your TensorboardRuns.
Map<String,String>	getLabelsMap() The labels with user-defined metadata to organize your TensorboardRuns.
String	getLabelsOrDefault(String key, String defaultValue) The labels with user-defined metadata to organize your TensorboardRuns.
String	getLabelsOrThrow(String key) The labels with user-defined metadata to organize your TensorboardRuns.
Map<String,String>	getMutableLabels() Deprecated.
String	getName() Output only.
com.google.protobuf.ByteString	getNameBytes() Output only.
com.google.protobuf.Timestamp	getUpdateTime() Output only.
com.google.protobuf.Timestamp.Builder	getUpdateTimeBuilder() Output only.
com.google.protobuf.TimestampOrBuilder	getUpdateTimeOrBuilder() Output only.
boolean	hasCreateTime() Output only.
boolean	hasUpdateTime() Output only.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
protected com.google.protobuf.MapField	internalGetMapField(int number)
protected com.google.protobuf.MapField	internalGetMutableMapField(int number)
boolean	isInitialized()
TensorboardRun.Builder	mergeCreateTime(com.google.protobuf.Timestamp value) Output only.
TensorboardRun.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
TensorboardRun.Builder	mergeFrom(com.google.protobuf.Message other)
TensorboardRun.Builder	mergeFrom(TensorboardRun other)
TensorboardRun.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
TensorboardRun.Builder	mergeUpdateTime(com.google.protobuf.Timestamp value) Output only.
TensorboardRun.Builder	putAllLabels(Map<String,String> values) The labels with user-defined metadata to organize your TensorboardRuns.
TensorboardRun.Builder	putLabels(String key, String value) The labels with user-defined metadata to organize your TensorboardRuns.
TensorboardRun.Builder	removeLabels(String key) The labels with user-defined metadata to organize your TensorboardRuns.
TensorboardRun.Builder	setCreateTime(com.google.protobuf.Timestamp.Builder builderForValue) Output only.
TensorboardRun.Builder	setCreateTime(com.google.protobuf.Timestamp value) Output only.
TensorboardRun.Builder	setDescription(String value) Description of this TensorboardRun.
TensorboardRun.Builder	setDescriptionBytes(com.google.protobuf.ByteString value) Description of this TensorboardRun.
TensorboardRun.Builder	setDisplayName(String value) Required.
TensorboardRun.Builder	setDisplayNameBytes(com.google.protobuf.ByteString value) Required.
TensorboardRun.Builder	setEtag(String value) Used to perform a consistent read-modify-write updates.
TensorboardRun.Builder	setEtagBytes(com.google.protobuf.ByteString value) Used to perform a consistent read-modify-write updates.
TensorboardRun.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
TensorboardRun.Builder	setName(String value) Output only.
TensorboardRun.Builder	setNameBytes(com.google.protobuf.ByteString value) Output only.
TensorboardRun.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
TensorboardRun.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
TensorboardRun.Builder	setUpdateTime(com.google.protobuf.Timestamp.Builder builderForValue) Output only.
TensorboardRun.Builder	setUpdateTime(com.google.protobuf.Timestamp value) Output only.

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapFieldReflection, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetMapField

protected com.google.protobuf.MapField internalGetMapField(int number)

Overrides:

internalGetMapField in class com.google.protobuf.GeneratedMessageV3.Builder<TensorboardRun.Builder>

internalGetMutableMapField

protected com.google.protobuf.MapField internalGetMutableMapField(int number)

Overrides:

internalGetMutableMapField in class com.google.protobuf.GeneratedMessageV3.Builder<TensorboardRun.Builder>

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<TensorboardRun.Builder>

clear

public TensorboardRun.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<TensorboardRun.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<TensorboardRun.Builder>

getDefaultInstanceForType

public TensorboardRun getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public TensorboardRun build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public TensorboardRun buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public TensorboardRun.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<TensorboardRun.Builder>

setField

public TensorboardRun.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                       Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<TensorboardRun.Builder>

clearField

public TensorboardRun.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<TensorboardRun.Builder>

clearOneof

public TensorboardRun.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<TensorboardRun.Builder>

setRepeatedField

public TensorboardRun.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                               int index,
                                               Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<TensorboardRun.Builder>

addRepeatedField

public TensorboardRun.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                               Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<TensorboardRun.Builder>

mergeFrom

public TensorboardRun.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<TensorboardRun.Builder>

mergeFrom

public TensorboardRun.Builder mergeFrom(TensorboardRun other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<TensorboardRun.Builder>

mergeFrom

public TensorboardRun.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<TensorboardRun.Builder>

Throws:

IOException

getName

public String getName()

 Output only. Name of the TensorboardRun.
 Format:
 `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`
 

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

Specified by:

getName in interface TensorboardRunOrBuilder

Returns:

The name.

getNameBytes

public com.google.protobuf.ByteString getNameBytes()

 Output only. Name of the TensorboardRun.
 Format:
 `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`
 

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

Specified by:

getNameBytes in interface TensorboardRunOrBuilder

Returns:

The bytes for name.

setName

public TensorboardRun.Builder setName(String value)

 Output only. Name of the TensorboardRun.
 Format:
 `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`
 

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

Parameters:

value - The name to set.

Returns:

This builder for chaining.

clearName

public TensorboardRun.Builder clearName()

 Output only. Name of the TensorboardRun.
 Format:
 `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`
 

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

Returns:

This builder for chaining.

setNameBytes

public TensorboardRun.Builder setNameBytes(com.google.protobuf.ByteString value)

 Output only. Name of the TensorboardRun.
 Format:
 `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`
 

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

Parameters:

value - The bytes for name to set.

Returns:

This builder for chaining.

getDisplayName

public String getDisplayName()

 Required. User provided name of this TensorboardRun.
 This value must be unique among all TensorboardRuns
 belonging to the same parent TensorboardExperiment.
 

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getDisplayName in interface TensorboardRunOrBuilder

Returns:

The displayName.

getDisplayNameBytes

public com.google.protobuf.ByteString getDisplayNameBytes()

 Required. User provided name of this TensorboardRun.
 This value must be unique among all TensorboardRuns
 belonging to the same parent TensorboardExperiment.
 

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getDisplayNameBytes in interface TensorboardRunOrBuilder

Returns:

The bytes for displayName.

setDisplayName

public TensorboardRun.Builder setDisplayName(String value)

 Required. User provided name of this TensorboardRun.
 This value must be unique among all TensorboardRuns
 belonging to the same parent TensorboardExperiment.
 

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Parameters:

value - The displayName to set.

Returns:

This builder for chaining.

clearDisplayName

public TensorboardRun.Builder clearDisplayName()

 Required. User provided name of this TensorboardRun.
 This value must be unique among all TensorboardRuns
 belonging to the same parent TensorboardExperiment.
 

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns:

This builder for chaining.

setDisplayNameBytes

public TensorboardRun.Builder setDisplayNameBytes(com.google.protobuf.ByteString value)

 Required. User provided name of this TensorboardRun.
 This value must be unique among all TensorboardRuns
 belonging to the same parent TensorboardExperiment.
 

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Parameters:

value - The bytes for displayName to set.

Returns:

This builder for chaining.

getDescription

public String getDescription()

 Description of this TensorboardRun.
 

string description = 3;

Specified by:

getDescription in interface TensorboardRunOrBuilder

Returns:

The description.

getDescriptionBytes

public com.google.protobuf.ByteString getDescriptionBytes()

 Description of this TensorboardRun.
 

string description = 3;

Specified by:

getDescriptionBytes in interface TensorboardRunOrBuilder

Returns:

The bytes for description.

setDescription

public TensorboardRun.Builder setDescription(String value)

 Description of this TensorboardRun.
 

string description = 3;

Parameters:

value - The description to set.

Returns:

This builder for chaining.

clearDescription

public TensorboardRun.Builder clearDescription()

 Description of this TensorboardRun.
 

string description = 3;

Returns:

This builder for chaining.

setDescriptionBytes

public TensorboardRun.Builder setDescriptionBytes(com.google.protobuf.ByteString value)

 Description of this TensorboardRun.
 

string description = 3;

Parameters:

value - The bytes for description to set.

Returns:

This builder for chaining.

hasCreateTime

public boolean hasCreateTime()

 Output only. Timestamp when this TensorboardRun was created.
 

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

Specified by:

hasCreateTime in interface TensorboardRunOrBuilder

Returns:

Whether the createTime field is set.

getCreateTime

public com.google.protobuf.Timestamp getCreateTime()

 Output only. Timestamp when this TensorboardRun was created.
 

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

Specified by:

getCreateTime in interface TensorboardRunOrBuilder

Returns:

The createTime.

setCreateTime

public TensorboardRun.Builder setCreateTime(com.google.protobuf.Timestamp value)

 Output only. Timestamp when this TensorboardRun was created.
 

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

setCreateTime

public TensorboardRun.Builder setCreateTime(com.google.protobuf.Timestamp.Builder builderForValue)

 Output only. Timestamp when this TensorboardRun was created.
 

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

mergeCreateTime

public TensorboardRun.Builder mergeCreateTime(com.google.protobuf.Timestamp value)

 Output only. Timestamp when this TensorboardRun was created.
 

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

clearCreateTime

public TensorboardRun.Builder clearCreateTime()

 Output only. Timestamp when this TensorboardRun was created.
 

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

getCreateTimeBuilder

public com.google.protobuf.Timestamp.Builder getCreateTimeBuilder()

 Output only. Timestamp when this TensorboardRun was created.
 

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

getCreateTimeOrBuilder

public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()

 Output only. Timestamp when this TensorboardRun was created.
 

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

Specified by:

getCreateTimeOrBuilder in interface TensorboardRunOrBuilder

hasUpdateTime

public boolean hasUpdateTime()

 Output only. Timestamp when this TensorboardRun was last updated.
 

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

Specified by:

hasUpdateTime in interface TensorboardRunOrBuilder

Returns:

Whether the updateTime field is set.

getUpdateTime

public com.google.protobuf.Timestamp getUpdateTime()

 Output only. Timestamp when this TensorboardRun was last updated.
 

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

Specified by:

getUpdateTime in interface TensorboardRunOrBuilder

Returns:

The updateTime.

setUpdateTime

public TensorboardRun.Builder setUpdateTime(com.google.protobuf.Timestamp value)

 Output only. Timestamp when this TensorboardRun was last updated.
 

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

setUpdateTime

public TensorboardRun.Builder setUpdateTime(com.google.protobuf.Timestamp.Builder builderForValue)

 Output only. Timestamp when this TensorboardRun was last updated.
 

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

mergeUpdateTime

public TensorboardRun.Builder mergeUpdateTime(com.google.protobuf.Timestamp value)

 Output only. Timestamp when this TensorboardRun was last updated.
 

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

clearUpdateTime

public TensorboardRun.Builder clearUpdateTime()

 Output only. Timestamp when this TensorboardRun was last updated.
 

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

getUpdateTimeBuilder

public com.google.protobuf.Timestamp.Builder getUpdateTimeBuilder()

 Output only. Timestamp when this TensorboardRun was last updated.
 

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

getUpdateTimeOrBuilder

public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()

 Output only. Timestamp when this TensorboardRun was last updated.
 

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

Specified by:

getUpdateTimeOrBuilder in interface TensorboardRunOrBuilder

getLabelsCount

public int getLabelsCount()

Description copied from interface: TensorboardRunOrBuilder

 The labels with user-defined metadata to organize your TensorboardRuns.

 This field will be used to filter and visualize Runs in the Tensorboard UI.
 For example, a Vertex AI training job can set a label
 aiplatform.googleapis.com/training_job_id=xxxxx to all the runs created
 within that job. An end user can set a label experiment_id=xxxxx for all
 the runs produced in a Jupyter notebook. These runs can be grouped by a
 label value and visualized together in the Tensorboard UI.

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

 See https://goo.gl/xmQnxf for more information and examples of labels.
 System reserved label keys are prefixed with "aiplatform.googleapis.com/"
 and are immutable.
 

map<string, string> labels = 8;

Specified by:

getLabelsCount in interface TensorboardRunOrBuilder

containsLabels

public boolean containsLabels(String key)

 The labels with user-defined metadata to organize your TensorboardRuns.

 This field will be used to filter and visualize Runs in the Tensorboard UI.
 For example, a Vertex AI training job can set a label
 aiplatform.googleapis.com/training_job_id=xxxxx to all the runs created
 within that job. An end user can set a label experiment_id=xxxxx for all
 the runs produced in a Jupyter notebook. These runs can be grouped by a
 label value and visualized together in the Tensorboard UI.

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

 See https://goo.gl/xmQnxf for more information and examples of labels.
 System reserved label keys are prefixed with "aiplatform.googleapis.com/"
 and are immutable.
 

map<string, string> labels = 8;

Specified by:

containsLabels in interface TensorboardRunOrBuilder

getLabels

@Deprecated
public Map<String,String> getLabels()

Deprecated.

Use getLabelsMap() instead.

Specified by:

getLabels in interface TensorboardRunOrBuilder

getLabelsMap

public Map<String,String> getLabelsMap()

 The labels with user-defined metadata to organize your TensorboardRuns.

 This field will be used to filter and visualize Runs in the Tensorboard UI.
 For example, a Vertex AI training job can set a label
 aiplatform.googleapis.com/training_job_id=xxxxx to all the runs created
 within that job. An end user can set a label experiment_id=xxxxx for all
 the runs produced in a Jupyter notebook. These runs can be grouped by a
 label value and visualized together in the Tensorboard UI.

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

 See https://goo.gl/xmQnxf for more information and examples of labels.
 System reserved label keys are prefixed with "aiplatform.googleapis.com/"
 and are immutable.
 

map<string, string> labels = 8;

Specified by:

getLabelsMap in interface TensorboardRunOrBuilder

getLabelsOrDefault

public String getLabelsOrDefault(String key,
                                 String defaultValue)

 The labels with user-defined metadata to organize your TensorboardRuns.

 This field will be used to filter and visualize Runs in the Tensorboard UI.
 For example, a Vertex AI training job can set a label
 aiplatform.googleapis.com/training_job_id=xxxxx to all the runs created
 within that job. An end user can set a label experiment_id=xxxxx for all
 the runs produced in a Jupyter notebook. These runs can be grouped by a
 label value and visualized together in the Tensorboard UI.

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

 See https://goo.gl/xmQnxf for more information and examples of labels.
 System reserved label keys are prefixed with "aiplatform.googleapis.com/"
 and are immutable.
 

map<string, string> labels = 8;

Specified by:

getLabelsOrDefault in interface TensorboardRunOrBuilder

getLabelsOrThrow

public String getLabelsOrThrow(String key)

 The labels with user-defined metadata to organize your TensorboardRuns.

 This field will be used to filter and visualize Runs in the Tensorboard UI.
 For example, a Vertex AI training job can set a label
 aiplatform.googleapis.com/training_job_id=xxxxx to all the runs created
 within that job. An end user can set a label experiment_id=xxxxx for all
 the runs produced in a Jupyter notebook. These runs can be grouped by a
 label value and visualized together in the Tensorboard UI.

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

 See https://goo.gl/xmQnxf for more information and examples of labels.
 System reserved label keys are prefixed with "aiplatform.googleapis.com/"
 and are immutable.
 

map<string, string> labels = 8;

Specified by:

getLabelsOrThrow in interface TensorboardRunOrBuilder

clearLabels

public TensorboardRun.Builder clearLabels()

removeLabels

public TensorboardRun.Builder removeLabels(String key)

 The labels with user-defined metadata to organize your TensorboardRuns.

 This field will be used to filter and visualize Runs in the Tensorboard UI.
 For example, a Vertex AI training job can set a label
 aiplatform.googleapis.com/training_job_id=xxxxx to all the runs created
 within that job. An end user can set a label experiment_id=xxxxx for all
 the runs produced in a Jupyter notebook. These runs can be grouped by a
 label value and visualized together in the Tensorboard UI.

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

 See https://goo.gl/xmQnxf for more information and examples of labels.
 System reserved label keys are prefixed with "aiplatform.googleapis.com/"
 and are immutable.
 

map<string, string> labels = 8;

getMutableLabels

@Deprecated
public Map<String,String> getMutableLabels()

Deprecated.

Use alternate mutation accessors instead.

putLabels

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

 The labels with user-defined metadata to organize your TensorboardRuns.

 This field will be used to filter and visualize Runs in the Tensorboard UI.
 For example, a Vertex AI training job can set a label
 aiplatform.googleapis.com/training_job_id=xxxxx to all the runs created
 within that job. An end user can set a label experiment_id=xxxxx for all
 the runs produced in a Jupyter notebook. These runs can be grouped by a
 label value and visualized together in the Tensorboard UI.

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

 See https://goo.gl/xmQnxf for more information and examples of labels.
 System reserved label keys are prefixed with "aiplatform.googleapis.com/"
 and are immutable.
 

map<string, string> labels = 8;

putAllLabels

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

 The labels with user-defined metadata to organize your TensorboardRuns.

 This field will be used to filter and visualize Runs in the Tensorboard UI.
 For example, a Vertex AI training job can set a label
 aiplatform.googleapis.com/training_job_id=xxxxx to all the runs created
 within that job. An end user can set a label experiment_id=xxxxx for all
 the runs produced in a Jupyter notebook. These runs can be grouped by a
 label value and visualized together in the Tensorboard UI.

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

 See https://goo.gl/xmQnxf for more information and examples of labels.
 System reserved label keys are prefixed with "aiplatform.googleapis.com/"
 and are immutable.
 

map<string, string> labels = 8;

getEtag

public String getEtag()

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

string etag = 9;

Specified by:

getEtag in interface TensorboardRunOrBuilder

Returns:

The etag.

getEtagBytes

public com.google.protobuf.ByteString getEtagBytes()

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

string etag = 9;

Specified by:

getEtagBytes in interface TensorboardRunOrBuilder

Returns:

The bytes for etag.

setEtag

public TensorboardRun.Builder setEtag(String value)

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

string etag = 9;

Parameters:

value - The etag to set.

Returns:

This builder for chaining.

clearEtag

public TensorboardRun.Builder clearEtag()

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

string etag = 9;

Returns:

This builder for chaining.

setEtagBytes

public TensorboardRun.Builder setEtagBytes(com.google.protobuf.ByteString value)

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

string etag = 9;

Parameters:

value - The bytes for etag to set.

Returns:

This builder for chaining.

setUnknownFields

public final TensorboardRun.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<TensorboardRun.Builder>

mergeUnknownFields

public final TensorboardRun.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<TensorboardRun.Builder>