public final class Tensorboard extends com.google.protobuf.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| Modifier and Type | Class and Description |
|---|---|
static class |
Tensorboard.Builder
Tensorboard is a physical database that stores users' training metrics.
|
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter| Modifier and Type | Field and Description |
|---|---|
static int |
BLOB_STORAGE_PATH_PREFIX_FIELD_NUMBER |
static int |
CREATE_TIME_FIELD_NUMBER |
static int |
DESCRIPTION_FIELD_NUMBER |
static int |
DISPLAY_NAME_FIELD_NUMBER |
static int |
ENCRYPTION_SPEC_FIELD_NUMBER |
static int |
ETAG_FIELD_NUMBER |
static int |
IS_DEFAULT_FIELD_NUMBER |
static int |
LABELS_FIELD_NUMBER |
static int |
NAME_FIELD_NUMBER |
static int |
RUN_COUNT_FIELD_NUMBER |
static int |
UPDATE_TIME_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
containsLabels(String key)
The labels with user-defined metadata to organize your Tensorboards.
|
boolean |
equals(Object obj) |
String |
getBlobStoragePathPrefix()
Output only.
|
com.google.protobuf.ByteString |
getBlobStoragePathPrefixBytes()
Output only.
|
com.google.protobuf.Timestamp |
getCreateTime()
Output only.
|
com.google.protobuf.TimestampOrBuilder |
getCreateTimeOrBuilder()
Output only.
|
static Tensorboard |
getDefaultInstance() |
Tensorboard |
getDefaultInstanceForType() |
String |
getDescription()
Description of this Tensorboard.
|
com.google.protobuf.ByteString |
getDescriptionBytes()
Description of this Tensorboard.
|
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
String |
getDisplayName()
Required.
|
com.google.protobuf.ByteString |
getDisplayNameBytes()
Required.
|
EncryptionSpec |
getEncryptionSpec()
Customer-managed encryption key spec for a Tensorboard.
|
EncryptionSpecOrBuilder |
getEncryptionSpecOrBuilder()
Customer-managed encryption key spec for a Tensorboard.
|
String |
getEtag()
Used to perform a consistent read-modify-write updates.
|
com.google.protobuf.ByteString |
getEtagBytes()
Used to perform a consistent read-modify-write updates.
|
boolean |
getIsDefault()
Used to indicate if the TensorBoard instance is the default one.
|
Map<String,String> |
getLabels()
Deprecated.
|
int |
getLabelsCount()
The labels with user-defined metadata to organize your Tensorboards.
|
Map<String,String> |
getLabelsMap()
The labels with user-defined metadata to organize your Tensorboards.
|
String |
getLabelsOrDefault(String key,
String defaultValue)
The labels with user-defined metadata to organize your Tensorboards.
|
String |
getLabelsOrThrow(String key)
The labels with user-defined metadata to organize your Tensorboards.
|
String |
getName()
Output only.
|
com.google.protobuf.ByteString |
getNameBytes()
Output only.
|
com.google.protobuf.Parser<Tensorboard> |
getParserForType() |
int |
getRunCount()
Output only.
|
int |
getSerializedSize() |
com.google.protobuf.Timestamp |
getUpdateTime()
Output only.
|
com.google.protobuf.TimestampOrBuilder |
getUpdateTimeOrBuilder()
Output only.
|
boolean |
hasCreateTime()
Output only.
|
boolean |
hasEncryptionSpec()
Customer-managed encryption key spec for a Tensorboard.
|
int |
hashCode() |
boolean |
hasUpdateTime()
Output only.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
protected com.google.protobuf.MapFieldReflectionAccessor |
internalGetMapFieldReflection(int number) |
boolean |
isInitialized() |
static Tensorboard.Builder |
newBuilder() |
static Tensorboard.Builder |
newBuilder(Tensorboard prototype) |
Tensorboard.Builder |
newBuilderForType() |
protected Tensorboard.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static Tensorboard |
parseDelimitedFrom(InputStream input) |
static Tensorboard |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Tensorboard |
parseFrom(byte[] data) |
static Tensorboard |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Tensorboard |
parseFrom(ByteBuffer data) |
static Tensorboard |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Tensorboard |
parseFrom(com.google.protobuf.ByteString data) |
static Tensorboard |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Tensorboard |
parseFrom(com.google.protobuf.CodedInputStream input) |
static Tensorboard |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Tensorboard |
parseFrom(InputStream input) |
static Tensorboard |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<Tensorboard> |
parser() |
Tensorboard.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
public static final int ENCRYPTION_SPEC_FIELD_NUMBER
public static final int BLOB_STORAGE_PATH_PREFIX_FIELD_NUMBER
public static final int RUN_COUNT_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
public static final int ETAG_FIELD_NUMBER
public static final int IS_DEFAULT_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessageV3protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public String getName()
Output only. Name of the Tensorboard.
Format:
`projects/{project}/locations/{location}/tensorboards/{tensorboard}`
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];getName in interface TensorboardOrBuilderpublic com.google.protobuf.ByteString getNameBytes()
Output only. Name of the Tensorboard.
Format:
`projects/{project}/locations/{location}/tensorboards/{tensorboard}`
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];getNameBytes in interface TensorboardOrBuilderpublic String getDisplayName()
Required. User provided name of this Tensorboard.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];getDisplayName in interface TensorboardOrBuilderpublic com.google.protobuf.ByteString getDisplayNameBytes()
Required. User provided name of this Tensorboard.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];getDisplayNameBytes in interface TensorboardOrBuilderpublic String getDescription()
Description of this Tensorboard.
string description = 3;getDescription in interface TensorboardOrBuilderpublic com.google.protobuf.ByteString getDescriptionBytes()
Description of this Tensorboard.
string description = 3;getDescriptionBytes in interface TensorboardOrBuilderpublic 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;hasEncryptionSpec in interface TensorboardOrBuilderpublic 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;getEncryptionSpec in interface TensorboardOrBuilderpublic 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;getEncryptionSpecOrBuilder in interface TensorboardOrBuilderpublic 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];getBlobStoragePathPrefix in interface TensorboardOrBuilderpublic com.google.protobuf.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];getBlobStoragePathPrefixBytes in interface TensorboardOrBuilderpublic int getRunCount()
Output only. The number of Runs stored in this Tensorboard.
int32 run_count = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];getRunCount in interface TensorboardOrBuilderpublic boolean hasCreateTime()
Output only. Timestamp when this Tensorboard was created.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasCreateTime in interface TensorboardOrBuilderpublic com.google.protobuf.Timestamp getCreateTime()
Output only. Timestamp when this Tensorboard was created.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
getCreateTime in interface TensorboardOrBuilderpublic com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
Output only. Timestamp when this Tensorboard was created.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
getCreateTimeOrBuilder in interface TensorboardOrBuilderpublic boolean hasUpdateTime()
Output only. Timestamp when this Tensorboard was last updated.
.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasUpdateTime in interface TensorboardOrBuilderpublic com.google.protobuf.Timestamp getUpdateTime()
Output only. Timestamp when this Tensorboard was last updated.
.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
getUpdateTime in interface TensorboardOrBuilderpublic com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. Timestamp when this Tensorboard was last updated.
.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
getUpdateTimeOrBuilder in interface TensorboardOrBuilderpublic int getLabelsCount()
TensorboardOrBuilderThe 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;getLabelsCount in interface TensorboardOrBuilderpublic 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;containsLabels in interface TensorboardOrBuilder@Deprecated public Map<String,String> getLabels()
getLabelsMap() instead.getLabels in interface TensorboardOrBuilderpublic 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;getLabelsMap in interface TensorboardOrBuilderpublic 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;getLabelsOrDefault in interface TensorboardOrBuilderpublic 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;getLabelsOrThrow in interface TensorboardOrBuilderpublic String getEtag()
Used to perform a consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
string etag = 9;getEtag in interface TensorboardOrBuilderpublic com.google.protobuf.ByteString getEtagBytes()
Used to perform a consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
string etag = 9;getEtagBytes in interface TensorboardOrBuilderpublic 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;getIsDefault in interface TensorboardOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static Tensorboard parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Tensorboard parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Tensorboard parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Tensorboard parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Tensorboard parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Tensorboard parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Tensorboard parseFrom(InputStream input) throws IOException
IOExceptionpublic static Tensorboard parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static Tensorboard parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static Tensorboard parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static Tensorboard parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static Tensorboard parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic Tensorboard.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static Tensorboard.Builder newBuilder()
public static Tensorboard.Builder newBuilder(Tensorboard prototype)
public Tensorboard.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected Tensorboard.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static Tensorboard getDefaultInstance()
public static com.google.protobuf.Parser<Tensorboard> parser()
public com.google.protobuf.Parser<Tensorboard> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public Tensorboard getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2024 Google LLC. All rights reserved.