Package com.google.cloud.aiplatform.v1

Class Tensorboard

  • All Implemented Interfaces:
    TensorboardOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    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
    See Also:
    Serialized Form

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getName

        public String getName()
         Output only. Name of the Tensorboard.
 Format:
 `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getName in interface TensorboardOrBuilder
        Returns:
        The name.

      • getNameBytes

        public 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];
        Specified by:
        getNameBytes in interface TensorboardOrBuilder
        Returns:
        The bytes for name.

      • getDisplayName

        public String getDisplayName()
         Required. User provided name of this Tensorboard.
        string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getDisplayName in interface TensorboardOrBuilder
        Returns:
        The displayName.

      • getDisplayNameBytes

        public com.google.protobuf.ByteString getDisplayNameBytes()
         Required. User provided name of this Tensorboard.
        string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getDisplayNameBytes in interface TensorboardOrBuilder
        Returns:
        The bytes for displayName.

      • getDescriptionBytes

        public com.google.protobuf.ByteString getDescriptionBytes()
         Description of this Tensorboard.
        string description = 3;
        Specified by:
        getDescriptionBytes in interface TensorboardOrBuilder
        Returns:
        The bytes for description.

      • hasEncryptionSpec

        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;
        Specified by:
        hasEncryptionSpec in interface TensorboardOrBuilder
        Returns:
        Whether the encryptionSpec field is set.

      • getEncryptionSpec

        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;
        Specified by:
        getEncryptionSpec in interface TensorboardOrBuilder
        Returns:
        The encryptionSpec.

      • getEncryptionSpecOrBuilder

        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;
        Specified by:
        getEncryptionSpecOrBuilder in interface TensorboardOrBuilder

      • getBlobStoragePathPrefix

        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];
        Specified by:
        getBlobStoragePathPrefix in interface TensorboardOrBuilder
        Returns:
        The blobStoragePathPrefix.

      • getBlobStoragePathPrefixBytes

        public 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];
        Specified by:
        getBlobStoragePathPrefixBytes in interface TensorboardOrBuilder
        Returns:
        The bytes for blobStoragePathPrefix.

      • getRunCount

        public int getRunCount()
         Output only. The number of Runs stored in this Tensorboard.
        int32 run_count = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getRunCount in interface TensorboardOrBuilder
        Returns:
        The runCount.

      • hasCreateTime

        public boolean hasCreateTime()
         Output only. Timestamp when this Tensorboard was created.
        .google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasCreateTime in interface TensorboardOrBuilder
        Returns:
        Whether the createTime field is set.

      • getCreateTime

        public 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];
        Specified by:
        getCreateTime in interface TensorboardOrBuilder
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

        public 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];
        Specified by:
        getCreateTimeOrBuilder in interface TensorboardOrBuilder

      • hasUpdateTime

        public boolean hasUpdateTime()
         Output only. Timestamp when this Tensorboard was last updated.
        .google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasUpdateTime in interface TensorboardOrBuilder
        Returns:
        Whether the updateTime field is set.

      • getUpdateTime

        public 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];
        Specified by:
        getUpdateTime in interface TensorboardOrBuilder
        Returns:
        The updateTime.

      • getUpdateTimeOrBuilder

        public 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];
        Specified by:
        getUpdateTimeOrBuilder in interface TensorboardOrBuilder

      • getLabelsCount

        public int getLabelsCount()
        Description copied from interface: TensorboardOrBuilder
         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;
        Specified by:
        getLabelsCount in interface TensorboardOrBuilder

      • containsLabels

        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;
        Specified by:
        containsLabels in interface TensorboardOrBuilder

      • getLabelsMap

        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;
        Specified by:
        getLabelsMap in interface TensorboardOrBuilder

      • getLabelsOrDefault

        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;
        Specified by:
        getLabelsOrDefault in interface TensorboardOrBuilder

      • getLabelsOrThrow

        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;
        Specified by:
        getLabelsOrThrow in interface TensorboardOrBuilder

      • getEtag

        public String getEtag()
         Used to perform a consistent read-modify-write updates. If not set, a blind
 "overwrite" update happens.
        string etag = 9;
        Specified by:
        getEtag in interface TensorboardOrBuilder
        Returns:
        The etag.

      • getEtagBytes

        public 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;
        Specified by:
        getEtagBytes in interface TensorboardOrBuilder
        Returns:
        The bytes for etag.

      • getIsDefault

        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;
        Specified by:
        getIsDefault in interface TensorboardOrBuilder
        Returns:
        The isDefault.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static Tensorboard parseFrom​(ByteBuffer data)
                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Tensorboard parseFrom​(ByteBuffer data,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Tensorboard parseFrom​(com.google.protobuf.ByteString data)
                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Tensorboard parseFrom​(com.google.protobuf.ByteString data,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Tensorboard parseFrom​(byte[] data)
                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Tensorboard parseFrom​(byte[] data,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Tensorboard parseFrom​(com.google.protobuf.CodedInputStream input,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws IOException
        Throws:
        IOException

      • newBuilderForType

        public Tensorboard.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public Tensorboard.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected Tensorboard.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static Tensorboard getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<Tensorboard> parser()

      • getParserForType

        public com.google.protobuf.Parser<Tensorboard> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public Tensorboard getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder