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.v1beta1.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 typegoogle.cloud.aiplatform.v1beta1.TensorboardRun
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description TensorboardRun.BuilderaddRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)TensorboardRunbuild()TensorboardRunbuildPartial()TensorboardRun.Builderclear()TensorboardRun.BuilderclearCreateTime()Output only.TensorboardRun.BuilderclearDescription()Description of this TensorboardRun.TensorboardRun.BuilderclearDisplayName()Required.TensorboardRun.BuilderclearEtag()Used to perform a consistent read-modify-write updates.TensorboardRun.BuilderclearField(com.google.protobuf.Descriptors.FieldDescriptor field)TensorboardRun.BuilderclearLabels()TensorboardRun.BuilderclearName()Output only.TensorboardRun.BuilderclearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)TensorboardRun.BuilderclearUpdateTime()Output only.TensorboardRun.Builderclone()booleancontainsLabels(String key)The labels with user-defined metadata to organize your TensorboardRuns.com.google.protobuf.TimestampgetCreateTime()Output only.com.google.protobuf.Timestamp.BuildergetCreateTimeBuilder()Output only.com.google.protobuf.TimestampOrBuildergetCreateTimeOrBuilder()Output only.TensorboardRungetDefaultInstanceForType()StringgetDescription()Description of this TensorboardRun.com.google.protobuf.ByteStringgetDescriptionBytes()Description of this TensorboardRun.static com.google.protobuf.Descriptors.DescriptorgetDescriptor()com.google.protobuf.Descriptors.DescriptorgetDescriptorForType()StringgetDisplayName()Required.com.google.protobuf.ByteStringgetDisplayNameBytes()Required.StringgetEtag()Used to perform a consistent read-modify-write updates.com.google.protobuf.ByteStringgetEtagBytes()Used to perform a consistent read-modify-write updates.Map<String,String>getLabels()Deprecated.intgetLabelsCount()The labels with user-defined metadata to organize your TensorboardRuns.Map<String,String>getLabelsMap()The labels with user-defined metadata to organize your TensorboardRuns.StringgetLabelsOrDefault(String key, String defaultValue)The labels with user-defined metadata to organize your TensorboardRuns.StringgetLabelsOrThrow(String key)The labels with user-defined metadata to organize your TensorboardRuns.Map<String,String>getMutableLabels()Deprecated.StringgetName()Output only.com.google.protobuf.ByteStringgetNameBytes()Output only.com.google.protobuf.TimestampgetUpdateTime()Output only.com.google.protobuf.Timestamp.BuildergetUpdateTimeBuilder()Output only.com.google.protobuf.TimestampOrBuildergetUpdateTimeOrBuilder()Output only.booleanhasCreateTime()Output only.booleanhasUpdateTime()Output only.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()protected com.google.protobuf.MapFieldinternalGetMapField(int number)protected com.google.protobuf.MapFieldinternalGetMutableMapField(int number)booleanisInitialized()TensorboardRun.BuildermergeCreateTime(com.google.protobuf.Timestamp value)Output only.TensorboardRun.BuildermergeFrom(TensorboardRun other)TensorboardRun.BuildermergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)TensorboardRun.BuildermergeFrom(com.google.protobuf.Message other)TensorboardRun.BuildermergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)TensorboardRun.BuildermergeUpdateTime(com.google.protobuf.Timestamp value)Output only.TensorboardRun.BuilderputAllLabels(Map<String,String> values)The labels with user-defined metadata to organize your TensorboardRuns.TensorboardRun.BuilderputLabels(String key, String value)The labels with user-defined metadata to organize your TensorboardRuns.TensorboardRun.BuilderremoveLabels(String key)The labels with user-defined metadata to organize your TensorboardRuns.TensorboardRun.BuildersetCreateTime(com.google.protobuf.Timestamp value)Output only.TensorboardRun.BuildersetCreateTime(com.google.protobuf.Timestamp.Builder builderForValue)Output only.TensorboardRun.BuildersetDescription(String value)Description of this TensorboardRun.TensorboardRun.BuildersetDescriptionBytes(com.google.protobuf.ByteString value)Description of this TensorboardRun.TensorboardRun.BuildersetDisplayName(String value)Required.TensorboardRun.BuildersetDisplayNameBytes(com.google.protobuf.ByteString value)Required.TensorboardRun.BuildersetEtag(String value)Used to perform a consistent read-modify-write updates.TensorboardRun.BuildersetEtagBytes(com.google.protobuf.ByteString value)Used to perform a consistent read-modify-write updates.TensorboardRun.BuildersetField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)TensorboardRun.BuildersetName(String value)Output only.TensorboardRun.BuildersetNameBytes(com.google.protobuf.ByteString value)Output only.TensorboardRun.BuildersetRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)TensorboardRun.BuildersetUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)TensorboardRun.BuildersetUpdateTime(com.google.protobuf.Timestamp value)Output only.TensorboardRun.BuildersetUpdateTime(com.google.protobuf.Timestamp.Builder builderForValue)Output only.-
Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, 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, mergeFrom, newUninitializedMessageException
-
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
-
-
-
Method Detail
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
-
internalGetMapField
protected com.google.protobuf.MapField internalGetMapField(int number)
- Overrides:
internalGetMapFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<TensorboardRun.Builder>
-
internalGetMutableMapField
protected com.google.protobuf.MapField internalGetMutableMapField(int number)
- Overrides:
internalGetMutableMapFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<TensorboardRun.Builder>
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessageV3.Builder<TensorboardRun.Builder>
-
clear
public TensorboardRun.Builder clear()
- Specified by:
clearin interfacecom.google.protobuf.Message.Builder- Specified by:
clearin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clearin classcom.google.protobuf.GeneratedMessageV3.Builder<TensorboardRun.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.Message.Builder- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.MessageOrBuilder- Overrides:
getDescriptorForTypein classcom.google.protobuf.GeneratedMessageV3.Builder<TensorboardRun.Builder>
-
getDefaultInstanceForType
public TensorboardRun getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
build
public TensorboardRun build()
- Specified by:
buildin interfacecom.google.protobuf.Message.Builder- Specified by:
buildin interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
public TensorboardRun buildPartial()
- Specified by:
buildPartialin interfacecom.google.protobuf.Message.Builder- Specified by:
buildPartialin interfacecom.google.protobuf.MessageLite.Builder
-
clone
public TensorboardRun.Builder clone()
- Specified by:
clonein interfacecom.google.protobuf.Message.Builder- Specified by:
clonein interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clonein classcom.google.protobuf.GeneratedMessageV3.Builder<TensorboardRun.Builder>
-
setField
public TensorboardRun.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
- Specified by:
setFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
setFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<TensorboardRun.Builder>
-
clearField
public TensorboardRun.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
- Specified by:
clearFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
clearFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<TensorboardRun.Builder>
-
clearOneof
public TensorboardRun.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
- Specified by:
clearOneofin interfacecom.google.protobuf.Message.Builder- Overrides:
clearOneofin classcom.google.protobuf.GeneratedMessageV3.Builder<TensorboardRun.Builder>
-
setRepeatedField
public TensorboardRun.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
- Specified by:
setRepeatedFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
setRepeatedFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<TensorboardRun.Builder>
-
addRepeatedField
public TensorboardRun.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
- Specified by:
addRepeatedFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
addRepeatedFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<TensorboardRun.Builder>
-
mergeFrom
public TensorboardRun.Builder mergeFrom(com.google.protobuf.Message other)
- Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<TensorboardRun.Builder>
-
mergeFrom
public TensorboardRun.Builder mergeFrom(TensorboardRun other)
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.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:
mergeFromin interfacecom.google.protobuf.Message.Builder- Specified by:
mergeFromin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
mergeFromin classcom.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:
getNamein interfaceTensorboardRunOrBuilder- 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:
getNameBytesin interfaceTensorboardRunOrBuilder- 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:
getDisplayNamein interfaceTensorboardRunOrBuilder- 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:
getDisplayNameBytesin interfaceTensorboardRunOrBuilder- 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:
getDescriptionin interfaceTensorboardRunOrBuilder- Returns:
- The description.
-
getDescriptionBytes
public com.google.protobuf.ByteString getDescriptionBytes()
Description of this TensorboardRun.
string description = 3;- Specified by:
getDescriptionBytesin interfaceTensorboardRunOrBuilder- 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:
hasCreateTimein interfaceTensorboardRunOrBuilder- 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:
getCreateTimein interfaceTensorboardRunOrBuilder- 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:
getCreateTimeOrBuilderin interfaceTensorboardRunOrBuilder
-
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:
hasUpdateTimein interfaceTensorboardRunOrBuilder- 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:
getUpdateTimein interfaceTensorboardRunOrBuilder- 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:
getUpdateTimeOrBuilderin interfaceTensorboardRunOrBuilder
-
getLabelsCount
public int getLabelsCount()
Description copied from interface:TensorboardRunOrBuilderThe 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:
getLabelsCountin interfaceTensorboardRunOrBuilder
-
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:
containsLabelsin interfaceTensorboardRunOrBuilder
-
getLabels
@Deprecated public Map<String,String> getLabels()
Deprecated.UsegetLabelsMap()instead.- Specified by:
getLabelsin interfaceTensorboardRunOrBuilder
-
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:
getLabelsMapin interfaceTensorboardRunOrBuilder
-
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:
getLabelsOrDefaultin interfaceTensorboardRunOrBuilder
-
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:
getLabelsOrThrowin interfaceTensorboardRunOrBuilder
-
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:
getEtagin interfaceTensorboardRunOrBuilder- 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:
getEtagBytesin interfaceTensorboardRunOrBuilder- 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:
setUnknownFieldsin interfacecom.google.protobuf.Message.Builder- Overrides:
setUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3.Builder<TensorboardRun.Builder>
-
mergeUnknownFields
public final TensorboardRun.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
- Specified by:
mergeUnknownFieldsin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3.Builder<TensorboardRun.Builder>
-
-