- 3.52.0 (latest)
- 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 TensorboardRun.Builder extends GeneratedMessageV3.Builder<TensorboardRun.Builder> implements TensorboardRunOrBuilderTensorboardRun 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
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > TensorboardRun.BuilderImplements
TensorboardRunOrBuilderMethods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public TensorboardRun.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Name | Description |
| field | FieldDescriptor |
| value | Object |
| Type | Description |
| TensorboardRun.Builder |
build()
public TensorboardRun build()| Type | Description |
| TensorboardRun |
buildPartial()
public TensorboardRun buildPartial()| Type | Description |
| TensorboardRun |
clear()
public TensorboardRun.Builder clear()| Type | Description |
| TensorboardRun.Builder |
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];
| Type | Description |
| TensorboardRun.Builder |
clearDescription()
public TensorboardRun.Builder clearDescription()Description of this TensorboardRun.
string description = 3;
| Type | Description |
| TensorboardRun.Builder | 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];
| Type | Description |
| TensorboardRun.Builder | 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;
| Type | Description |
| TensorboardRun.Builder | This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public TensorboardRun.Builder clearField(Descriptors.FieldDescriptor field)| Name | Description |
| field | FieldDescriptor |
| Type | Description |
| TensorboardRun.Builder |
clearLabels()
public TensorboardRun.Builder clearLabels()| Type | Description |
| TensorboardRun.Builder |
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];
| Type | Description |
| TensorboardRun.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public TensorboardRun.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Name | Description |
| oneof | OneofDescriptor |
| Type | Description |
| TensorboardRun.Builder |
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];
| Type | Description |
| TensorboardRun.Builder |
clone()
public TensorboardRun.Builder clone()| Type | Description |
| TensorboardRun.Builder |
containsLabels(String key)
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;
| Name | Description |
| key | String |
| Type | Description |
| boolean |
getCreateTime()
public Timestamp getCreateTime()Output only. Timestamp when this TensorboardRun was created.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| Timestamp | The createTime. |
getCreateTimeBuilder()
public Timestamp.Builder getCreateTimeBuilder()Output only. Timestamp when this TensorboardRun was created.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| Builder |
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()Output only. Timestamp when this TensorboardRun was created.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| TimestampOrBuilder |
getDefaultInstanceForType()
public TensorboardRun getDefaultInstanceForType()| Type | Description |
| TensorboardRun |
getDescription()
public String getDescription()Description of this TensorboardRun.
string description = 3;
| Type | Description |
| String | The description. |
getDescriptionBytes()
public ByteString getDescriptionBytes()Description of this TensorboardRun.
string description = 3;
| Type | Description |
| ByteString | The bytes for description. |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Type | Description |
| Descriptor |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Type | Description |
| Descriptor |
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];
| Type | Description |
| String | The displayName. |
getDisplayNameBytes()
public 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];
| Type | Description |
| ByteString | The bytes for displayName. |
getEtag()
public String getEtag()Used to perform a consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
string etag = 9;
| Type | Description |
| String | The etag. |
getEtagBytes()
public ByteString getEtagBytes()Used to perform a consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
string etag = 9;
| Type | Description |
| ByteString | The bytes for etag. |
getLabels()
public Map<String,String> getLabels()Use #getLabelsMap() instead.
| Type | Description |
| Map<String,String> |
getLabelsCount()
public int getLabelsCount()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;
| Type | Description |
| int |
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;
| 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 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;
| Name | Description |
| key | String |
| defaultValue | String |
| Type | Description |
| String |
getLabelsOrThrow(String key)
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;
| Name | Description |
| key | String |
| Type | Description |
| String |
getMutableLabels()
public Map<String,String> getMutableLabels()Use alternate mutation accessors instead.
| Type | Description |
| Map<String,String> |
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];
| Type | Description |
| String | The name. |
getNameBytes()
public 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];
| Type | Description |
| ByteString | The bytes for name. |
getUpdateTime()
public Timestamp getUpdateTime()Output only. Timestamp when this TensorboardRun was last updated.
.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| Timestamp | The updateTime. |
getUpdateTimeBuilder()
public Timestamp.Builder getUpdateTimeBuilder()Output only. Timestamp when this TensorboardRun was last updated.
.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| Builder |
getUpdateTimeOrBuilder()
public TimestampOrBuilder getUpdateTimeOrBuilder()Output only. Timestamp when this TensorboardRun was last updated.
.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| TimestampOrBuilder |
hasCreateTime()
public boolean hasCreateTime()Output only. Timestamp when this TensorboardRun was created.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| boolean | Whether the createTime field is set. |
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];
| Type | Description |
| boolean | Whether the updateTime field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Type | Description |
| FieldAccessorTable |
internalGetMapField(int number)
protected MapField internalGetMapField(int number)| Name | Description |
| number | int |
| Type | Description |
| MapField |
internalGetMutableMapField(int number)
protected MapField internalGetMutableMapField(int number)| Name | Description |
| number | int |
| Type | Description |
| MapField |
isInitialized()
public final boolean isInitialized()| Type | Description |
| boolean |
mergeCreateTime(Timestamp value)
public TensorboardRun.Builder mergeCreateTime(Timestamp value)Output only. Timestamp when this TensorboardRun was created.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Name | Description |
| value | Timestamp |
| Type | Description |
| TensorboardRun.Builder |
mergeFrom(TensorboardRun other)
public TensorboardRun.Builder mergeFrom(TensorboardRun other)| Name | Description |
| other | TensorboardRun |
| Type | Description |
| TensorboardRun.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public TensorboardRun.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
| input | CodedInputStream |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| TensorboardRun.Builder |
| Type | Description |
| IOException |
mergeFrom(Message other)
public TensorboardRun.Builder mergeFrom(Message other)| Name | Description |
| other | Message |
| Type | Description |
| TensorboardRun.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final TensorboardRun.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Name | Description |
| unknownFields | UnknownFieldSet |
| Type | Description |
| TensorboardRun.Builder |
mergeUpdateTime(Timestamp value)
public TensorboardRun.Builder mergeUpdateTime(Timestamp value)Output only. Timestamp when this TensorboardRun was last updated.
.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Name | Description |
| value | Timestamp |
| Type | Description |
| TensorboardRun.Builder |
putAllLabels(Map<String,String> values)
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;
| Name | Description |
| values | Map<String,String> |
| Type | Description |
| TensorboardRun.Builder |
putLabels(String key, String value)
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;
| Name | Description |
| key | String |
| value | String |
| Type | Description |
| TensorboardRun.Builder |
removeLabels(String key)
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;
| Name | Description |
| key | String |
| Type | Description |
| TensorboardRun.Builder |
setCreateTime(Timestamp value)
public TensorboardRun.Builder setCreateTime(Timestamp value)Output only. Timestamp when this TensorboardRun was created.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Name | Description |
| value | Timestamp |
| Type | Description |
| TensorboardRun.Builder |
setCreateTime(Timestamp.Builder builderForValue)
public TensorboardRun.Builder setCreateTime(Timestamp.Builder builderForValue)Output only. Timestamp when this TensorboardRun was created.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Name | Description |
| builderForValue | Builder |
| Type | Description |
| TensorboardRun.Builder |
setDescription(String value)
public TensorboardRun.Builder setDescription(String value)Description of this TensorboardRun.
string description = 3;
| Name | Description |
| value | StringThe description to set. |
| Type | Description |
| TensorboardRun.Builder | This builder for chaining. |
setDescriptionBytes(ByteString value)
public TensorboardRun.Builder setDescriptionBytes(ByteString value)Description of this TensorboardRun.
string description = 3;
| Name | Description |
| value | ByteStringThe bytes for description to set. |
| Type | Description |
| TensorboardRun.Builder | This builder for chaining. |
setDisplayName(String value)
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];
| Name | Description |
| value | StringThe displayName to set. |
| Type | Description |
| TensorboardRun.Builder | This builder for chaining. |
setDisplayNameBytes(ByteString value)
public TensorboardRun.Builder setDisplayNameBytes(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];
| Name | Description |
| value | ByteStringThe bytes for displayName to set. |
| Type | Description |
| TensorboardRun.Builder | This builder for chaining. |
setEtag(String value)
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;
| Name | Description |
| value | StringThe etag to set. |
| Type | Description |
| TensorboardRun.Builder | This builder for chaining. |
setEtagBytes(ByteString value)
public TensorboardRun.Builder setEtagBytes(ByteString value)Used to perform a consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
string etag = 9;
| Name | Description |
| value | ByteStringThe bytes for etag to set. |
| Type | Description |
| TensorboardRun.Builder | This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public TensorboardRun.Builder setField(Descriptors.FieldDescriptor field, Object value)| Name | Description |
| field | FieldDescriptor |
| value | Object |
| Type | Description |
| TensorboardRun.Builder |
setName(String value)
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];
| Name | Description |
| value | StringThe name to set. |
| Type | Description |
| TensorboardRun.Builder | This builder for chaining. |
setNameBytes(ByteString value)
public TensorboardRun.Builder setNameBytes(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];
| Name | Description |
| value | ByteStringThe bytes for name to set. |
| Type | Description |
| TensorboardRun.Builder | This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public TensorboardRun.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Name | Description |
| field | FieldDescriptor |
| index | int |
| value | Object |
| Type | Description |
| TensorboardRun.Builder |
setUnknownFields(UnknownFieldSet unknownFields)
public final TensorboardRun.Builder setUnknownFields(UnknownFieldSet unknownFields)| Name | Description |
| unknownFields | UnknownFieldSet |
| Type | Description |
| TensorboardRun.Builder |
setUpdateTime(Timestamp value)
public TensorboardRun.Builder setUpdateTime(Timestamp value)Output only. Timestamp when this TensorboardRun was last updated.
.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Name | Description |
| value | Timestamp |
| Type | Description |
| TensorboardRun.Builder |
setUpdateTime(Timestamp.Builder builderForValue)
public TensorboardRun.Builder setUpdateTime(Timestamp.Builder builderForValue)Output only. Timestamp when this TensorboardRun was last updated.
.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Name | Description |
| builderForValue | Builder |
| Type | Description |
| TensorboardRun.Builder |