public final class TensorboardExperiment extends GeneratedMessageV3 implements TensorboardExperimentOrBuilder
A TensorboardExperiment is a group of TensorboardRuns, that are typically the
results of a training job run, in a Tensorboard.
Protobuf type google.cloud.aiplatform.v1.TensorboardExperiment
Static Fields
public static final int CREATE_TIME_FIELD_NUMBER
Field Value
public static final int DESCRIPTION_FIELD_NUMBER
Field Value
public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
public static final int ETAG_FIELD_NUMBER
Field Value
public static final int LABELS_FIELD_NUMBER
Field Value
public static final int NAME_FIELD_NUMBER
Field Value
public static final int SOURCE_FIELD_NUMBER
Field Value
public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Static Methods
public static TensorboardExperiment getDefaultInstance()
Returns
public static final Descriptors.Descriptor getDescriptor()
Returns
public static TensorboardExperiment.Builder newBuilder()
Returns
public static TensorboardExperiment.Builder newBuilder(TensorboardExperiment prototype)
Parameter
Returns
public static TensorboardExperiment parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static TensorboardExperiment parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static TensorboardExperiment parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
public static TensorboardExperiment parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static TensorboardExperiment parseFrom(ByteString data)
Parameter
Returns
Exceptions
public static TensorboardExperiment parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static TensorboardExperiment parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static TensorboardExperiment parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static TensorboardExperiment parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static TensorboardExperiment parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static TensorboardExperiment parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
public static TensorboardExperiment parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Parser<TensorboardExperiment> parser()
Returns
Methods
public boolean containsLabels(String key)
The labels with user-defined metadata to organize your Datasets.
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 Dataset (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. Following system labels exist for each Dataset:
- "aiplatform.googleapis.com/dataset_metadata_schema":
- output only, its value is the
metadata_schema's title.
map<string, string> labels = 6;
public boolean equals(Object obj)
Parameter
Returns
Overrides
public Timestamp getCreateTime()
Output only. Timestamp when this TensorboardExperiment was created.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. Timestamp when this TensorboardExperiment was created.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
public TensorboardExperiment getDefaultInstanceForType()
Returns
public String getDescription()
Description of this TensorboardExperiment.
string description = 3;
| Type | Description |
| String | The description.
|
public ByteString getDescriptionBytes()
Description of this TensorboardExperiment.
string description = 3;
| Type | Description |
| ByteString | The bytes for description.
|
public String getDisplayName()
User provided name of this TensorboardExperiment.
string display_name = 2;
| Type | Description |
| String | The displayName.
|
public ByteString getDisplayNameBytes()
User provided name of this TensorboardExperiment.
string display_name = 2;
| Type | Description |
| ByteString | The bytes for displayName.
|
Used to perform consistent read-modify-write updates. If not set, a blind
"overwrite" update happens.
string etag = 7;
| Type | Description |
| String | The etag.
|
public ByteString getEtagBytes()
Used to perform consistent read-modify-write updates. If not set, a blind
"overwrite" update happens.
string etag = 7;
public Map<String,String> getLabels()
Returns
public int getLabelsCount()
The labels with user-defined metadata to organize your Datasets.
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 Dataset (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. Following system labels exist for each Dataset:
- "aiplatform.googleapis.com/dataset_metadata_schema":
- output only, its value is the
metadata_schema's title.
map<string, string> labels = 6;
public Map<String,String> getLabelsMap()
The labels with user-defined metadata to organize your Datasets.
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 Dataset (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. Following system labels exist for each Dataset:
- "aiplatform.googleapis.com/dataset_metadata_schema":
- output only, its value is the
metadata_schema's title.
map<string, string> labels = 6;
public String getLabelsOrDefault(String key, String defaultValue)
The labels with user-defined metadata to organize your Datasets.
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 Dataset (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. Following system labels exist for each Dataset:
- "aiplatform.googleapis.com/dataset_metadata_schema":
- output only, its value is the
metadata_schema's title.
map<string, string> labels = 6;
public String getLabelsOrThrow(String key)
The labels with user-defined metadata to organize your Datasets.
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 Dataset (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. Following system labels exist for each Dataset:
- "aiplatform.googleapis.com/dataset_metadata_schema":
- output only, its value is the
metadata_schema's title.
map<string, string> labels = 6;
Output only. Name of the TensorboardExperiment.
Format:
projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| String | The name.
|
public ByteString getNameBytes()
Output only. Name of the TensorboardExperiment.
Format:
projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Parser<TensorboardExperiment> getParserForType()
Returns
Overrides
public int getSerializedSize()
Returns
Overrides
public String getSource()
Immutable. Source of the TensorboardExperiment. Example: a custom training job.
string source = 8 [(.google.api.field_behavior) = IMMUTABLE];
| Type | Description |
| String | The source.
|
public ByteString getSourceBytes()
Immutable. Source of the TensorboardExperiment. Example: a custom training job.
string source = 8 [(.google.api.field_behavior) = IMMUTABLE];
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
public Timestamp getUpdateTime()
Output only. Timestamp when this TensorboardExperiment was last updated.
.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
public TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. Timestamp when this TensorboardExperiment was last updated.
.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
public boolean hasCreateTime()
Output only. Timestamp when this TensorboardExperiment was created.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| boolean | Whether the createTime field is set.
|
public boolean hasUpdateTime()
Output only. Timestamp when this TensorboardExperiment was last updated.
.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| boolean | Whether the updateTime field is set.
|
Returns
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
protected MapField internalGetMapField(int number)
Parameter
Returns
Overrides
public final boolean isInitialized()
Returns
Overrides
public TensorboardExperiment.Builder newBuilderForType()
Returns
protected TensorboardExperiment.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
public TensorboardExperiment.Builder toBuilder()
Returns
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
