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
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 SOURCE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int UPDATE_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
public static TensorboardExperiment getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static TensorboardExperiment.Builder newBuilder()
public static TensorboardExperiment.Builder newBuilder(TensorboardExperiment prototype)
public static TensorboardExperiment parseDelimitedFrom(InputStream input)
public static TensorboardExperiment parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static TensorboardExperiment parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
public static TensorboardExperiment parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static TensorboardExperiment parseFrom(ByteString data)
public static TensorboardExperiment parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static TensorboardExperiment parseFrom(CodedInputStream input)
public static TensorboardExperiment parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static TensorboardExperiment parseFrom(InputStream input)
public static TensorboardExperiment parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static TensorboardExperiment parseFrom(ByteBuffer data)
public static TensorboardExperiment parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<TensorboardExperiment> parser()
Methods
public boolean containsLabels(String key)
The labels with user-defined metadata to organize your
TensorboardExperiment.
Label keys and values cannot be 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. The 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;
| Parameter |
|---|
| Name | Description |
key | String
|
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
public Timestamp getCreateTime()
Output only. Timestamp when this TensorboardExperiment was created.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
Timestamp | The createTime.
|
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()
public String getDescription()
Description of this TensorboardExperiment.
string description = 3;
| Returns |
|---|
| Type | Description |
String | The description.
|
public ByteString getDescriptionBytes()
Description of this TensorboardExperiment.
string description = 3;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for description.
|
public String getDisplayName()
User provided name of this TensorboardExperiment.
string display_name = 2;
| Returns |
|---|
| Type | Description |
String | The displayName.
|
public ByteString getDisplayNameBytes()
User provided name of this TensorboardExperiment.
string display_name = 2;
| Returns |
|---|
| 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;
| Returns |
|---|
| 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;
| 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
TensorboardExperiment.
Label keys and values cannot be 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. The 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;
| Returns |
|---|
| Type | Description |
int | |
public Map<String,String> getLabelsMap()
The labels with user-defined metadata to organize your
TensorboardExperiment.
Label keys and values cannot be 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. The 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
TensorboardExperiment.
Label keys and values cannot be 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. The 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
TensorboardExperiment.
Label keys and values cannot be 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. The 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;
| Parameter |
|---|
| Name | Description |
key | String
|
Output only. Name of the TensorboardExperiment.
Format:
projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| 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];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for name.
|
public Parser<TensorboardExperiment> getParserForType()
Overrides
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
public String getSource()
Immutable. Source of the TensorboardExperiment. Example: a custom training
job.
string source = 8 [(.google.api.field_behavior) = IMMUTABLE];
| Returns |
|---|
| 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];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for source.
|
public Timestamp getUpdateTime()
Output only. Timestamp when this TensorboardExperiment was last updated.
.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
Timestamp | The updateTime.
|
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];
| Returns |
|---|
| 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];
| Returns |
|---|
| Type | Description |
boolean | Whether the updateTime field is set.
|
| Returns |
|---|
| Type | Description |
int | |
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
protected MapField internalGetMapField(int number)
| Parameter |
|---|
| Name | Description |
number | int
|
Overrides
public final boolean isInitialized()
Overrides
public TensorboardExperiment.Builder newBuilderForType()
protected TensorboardExperiment.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
public TensorboardExperiment.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
