public final class Tensorboard extends GeneratedMessageV3 implements TensorboardOrBuilder
Tensorboard is a physical database that stores users' training metrics.
A default Tensorboard is provided in each region of a GCP project.
If needed users can also create extra Tensorboards in their projects.
Protobuf type google.cloud.aiplatform.v1.Tensorboard
Static Fields
public static final int BLOB_STORAGE_PATH_PREFIX_FIELD_NUMBER
Field Value
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 ENCRYPTION_SPEC_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 RUN_COUNT_FIELD_NUMBER
Field Value
public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Static Methods
public static Tensorboard getDefaultInstance()
Returns
public static final Descriptors.Descriptor getDescriptor()
Returns
public static Tensorboard.Builder newBuilder()
Returns
public static Tensorboard.Builder newBuilder(Tensorboard prototype)
Parameter
Returns
public static Tensorboard parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static Tensorboard parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Tensorboard parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
public static Tensorboard parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Tensorboard parseFrom(ByteString data)
Parameter
Returns
Exceptions
public static Tensorboard parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Tensorboard parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static Tensorboard parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Tensorboard parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static Tensorboard parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Tensorboard parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
public static Tensorboard parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Parser<Tensorboard> parser()
Returns
Methods
public boolean containsLabels(String key)
The labels with user-defined metadata to organize your Tensorboards.
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 Tensorboard
(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 boolean equals(Object obj)
Parameter
Returns
Overrides
public String getBlobStoragePathPrefix()
Output only. Consumer project Cloud Storage path prefix used to store blob data, which
can either be a bucket or directory. Does not end with a '/'.
string blob_storage_path_prefix = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| String | The blobStoragePathPrefix.
|
public ByteString getBlobStoragePathPrefixBytes()
Output only. Consumer project Cloud Storage path prefix used to store blob data, which
can either be a bucket or directory. Does not end with a '/'.
string blob_storage_path_prefix = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| ByteString | The bytes for blobStoragePathPrefix.
|
public Timestamp getCreateTime()
Output only. Timestamp when this Tensorboard was created.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. Timestamp when this Tensorboard was created.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Tensorboard getDefaultInstanceForType()
Returns
public String getDescription()
Description of this Tensorboard.
string description = 3;
| Type | Description |
| String | The description.
|
public ByteString getDescriptionBytes()
Description of this Tensorboard.
string description = 3;
| Type | Description |
| ByteString | The bytes for description.
|
public String getDisplayName()
Required. User provided name of this Tensorboard.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
| String | The displayName.
|
public ByteString getDisplayNameBytes()
Required. User provided name of this Tensorboard.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
| ByteString | The bytes for displayName.
|
public EncryptionSpec getEncryptionSpec()
Customer-managed encryption key spec for a Tensorboard. If set, this
Tensorboard and all sub-resources of this Tensorboard will be secured by
this key.
.google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 11;
public EncryptionSpecOrBuilder getEncryptionSpecOrBuilder()
Customer-managed encryption key spec for a Tensorboard. If set, this
Tensorboard and all sub-resources of this Tensorboard will be secured by
this key.
.google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 11;
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.
|
public ByteString getEtagBytes()
Used to perform a consistent read-modify-write updates. If not set, a blind
"overwrite" update happens.
string etag = 9;
public Map<String,String> getLabels()
Returns
public int getLabelsCount()
The labels with user-defined metadata to organize your Tensorboards.
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 Tensorboard
(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 Map<String,String> getLabelsMap()
The labels with user-defined metadata to organize your Tensorboards.
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 Tensorboard
(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 Tensorboards.
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 Tensorboard
(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 Tensorboards.
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 Tensorboard
(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;
Output only. Name of the Tensorboard.
Format:
projects/{project}/locations/{location}/tensorboards/{tensorboard}
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| String | The name.
|
public ByteString getNameBytes()
Output only. Name of the Tensorboard.
Format:
projects/{project}/locations/{location}/tensorboards/{tensorboard}
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Parser<Tensorboard> getParserForType()
Returns
Overrides
Output only. The number of Runs stored in this Tensorboard.
int32 run_count = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| int | The runCount.
|
public int getSerializedSize()
Returns
Overrides
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
public Timestamp getUpdateTime()
Output only. Timestamp when this Tensorboard was last updated.
.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
public TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. Timestamp when this Tensorboard was last updated.
.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
public boolean hasCreateTime()
Output only. Timestamp when this Tensorboard was created.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| boolean | Whether the createTime field is set.
|
public boolean hasEncryptionSpec()
Customer-managed encryption key spec for a Tensorboard. If set, this
Tensorboard and all sub-resources of this Tensorboard will be secured by
this key.
.google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 11;
| Type | Description |
| boolean | Whether the encryptionSpec field is set.
|
public boolean hasUpdateTime()
Output only. Timestamp when this Tensorboard was last updated.
.google.protobuf.Timestamp update_time = 7 [(.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 Tensorboard.Builder newBuilderForType()
Returns
protected Tensorboard.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
public Tensorboard.Builder toBuilder()
Returns
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
