public final class TensorboardRun extends GeneratedMessageV3 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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
public static final int CREATE_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int DESCRIPTION_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int DISPLAY_NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int ETAG_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int LABELS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int UPDATE_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
public static TensorboardRun getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static TensorboardRun.Builder newBuilder()
public static TensorboardRun.Builder newBuilder(TensorboardRun prototype)
public static TensorboardRun parseDelimitedFrom(InputStream input)
public static TensorboardRun parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static TensorboardRun parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
public static TensorboardRun parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static TensorboardRun parseFrom(ByteString data)
public static TensorboardRun parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static TensorboardRun parseFrom(CodedInputStream input)
public static TensorboardRun parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static TensorboardRun parseFrom(InputStream input)
public static TensorboardRun parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static TensorboardRun parseFrom(ByteBuffer data)
public static TensorboardRun parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<TensorboardRun> parser()
Methods
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;
| Parameter |
|---|
| Name | Description |
key | String
|
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
public Timestamp getCreateTime()
Output only. Timestamp when this TensorboardRun was created.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
Timestamp | The createTime.
|
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. Timestamp when this TensorboardRun was created.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
public TensorboardRun getDefaultInstanceForType()
public String getDescription()
Description of this TensorboardRun.
string description = 3;
| Returns |
|---|
| Type | Description |
String | The description.
|
public ByteString getDescriptionBytes()
Description of this TensorboardRun.
string description = 3;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for description.
|
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];
| Returns |
|---|
| Type | Description |
String | The displayName.
|
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];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for displayName.
|
Used to perform a consistent read-modify-write updates. If not set, a blind
"overwrite" update happens.
string etag = 9;
| Returns |
|---|
| Type | Description |
String | The etag.
|
public ByteString getEtagBytes()
Used to perform a consistent read-modify-write updates. If not set, a blind
"overwrite" update happens.
string etag = 9;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for etag.
|
public Map<String,String> getLabels()
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;
| Returns |
|---|
| Type | Description |
int | |
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;
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;
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;
| Parameter |
|---|
| Name | Description |
key | String
|
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 |
|---|
| Type | Description |
String | The name.
|
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];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for name.
|
public Parser<TensorboardRun> getParserForType()
Overrides
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
public Timestamp getUpdateTime()
Output only. Timestamp when this TensorboardRun was last updated.
.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
Timestamp | The updateTime.
|
public TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. Timestamp when this TensorboardRun was last updated.
.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
public boolean hasCreateTime()
Output only. Timestamp when this TensorboardRun was created.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
boolean | Whether the createTime field is set.
|
public boolean hasUpdateTime()
Output only. Timestamp when this TensorboardRun was last updated.
.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
boolean | Whether the updateTime field is set.
|
| Returns |
|---|
| Type | Description |
int | |
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
| Parameter |
|---|
| Name | Description |
number | int
|
| Returns |
|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor | |
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
public final boolean isInitialized()
Overrides
public TensorboardRun.Builder newBuilderForType()
protected TensorboardRun.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
public TensorboardRun.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
