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 Google Cloud 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 |
|---|
| Type | Description |
int | |
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 ENCRYPTION_SPEC_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int ETAG_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int IS_DEFAULT_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 RUN_COUNT_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int UPDATE_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
public static Tensorboard getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static Tensorboard.Builder newBuilder()
public static Tensorboard.Builder newBuilder(Tensorboard prototype)
public static Tensorboard parseDelimitedFrom(InputStream input)
public static Tensorboard parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Tensorboard parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
public static Tensorboard parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Tensorboard parseFrom(ByteString data)
public static Tensorboard parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Tensorboard parseFrom(CodedInputStream input)
public static Tensorboard parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Tensorboard parseFrom(InputStream input)
public static Tensorboard parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Tensorboard parseFrom(ByteBuffer data)
public static Tensorboard parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<Tensorboard> parser()
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;
| Parameter |
|---|
| Name | Description |
key | String
|
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
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];
| Returns |
|---|
| 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];
| Returns |
|---|
| 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];
| Returns |
|---|
| Type | Description |
Timestamp | The createTime.
|
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()
public String getDescription()
Description of this Tensorboard.
string description = 3;
| Returns |
|---|
| Type | Description |
String | The description.
|
public ByteString getDescriptionBytes()
Description of this Tensorboard.
string description = 3;
| Returns |
|---|
| 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];
| Returns |
|---|
| Type | Description |
String | The displayName.
|
public ByteString getDisplayNameBytes()
Required. User provided name of this Tensorboard.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns |
|---|
| 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;
| 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 boolean getIsDefault()
Used to indicate if the TensorBoard instance is the default one.
Each project & region can have at most one default TensorBoard instance.
Creation of a default TensorBoard instance and updating an existing
TensorBoard instance to be default will mark all other TensorBoard
instances (if any) as non default.
bool is_default = 12;
| Returns |
|---|
| Type | Description |
boolean | The isDefault.
|
public Map<String,String> getLabels()
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;
| Returns |
|---|
| Type | Description |
int | |
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;
| Parameter |
|---|
| Name | Description |
key | String
|
Output only. Name of the Tensorboard.
Format:
projects/{project}/locations/{location}/tensorboards/{tensorboard}
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| 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];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for name.
|
public Parser<Tensorboard> getParserForType()
Overrides
Output only. The number of Runs stored in this Tensorboard.
int32 run_count = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
int | The runCount.
|
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
public final UnknownFieldSet getUnknownFields()
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];
| Returns |
|---|
| Type | Description |
Timestamp | The updateTime.
|
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];
| Returns |
|---|
| 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;
| Returns |
|---|
| 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];
| 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 Tensorboard.Builder newBuilderForType()
protected Tensorboard.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
public Tensorboard.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
