Package com.google.cloud.aiplatform.v1

Interface TensorboardOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    Tensorboard, Tensorboard.Builder
    public interface TensorboardOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getName

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

      • getNameBytes

        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];
        Returns:
        The bytes for name.

      • getDisplayName

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

      • getDisplayNameBytes

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

      • getDescription

        String getDescription()
         Description of this Tensorboard.
        string description = 3;
        Returns:
        The description.

      • getDescriptionBytes

        com.google.protobuf.ByteString getDescriptionBytes()
         Description of this Tensorboard.
        string description = 3;
        Returns:
        The bytes for description.

      • hasEncryptionSpec

        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:
        Whether the encryptionSpec field is set.

      • getEncryptionSpec

        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;
        Returns:
        The encryptionSpec.

      • getEncryptionSpecOrBuilder

        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;

      • getBlobStoragePathPrefix

        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:
        The blobStoragePathPrefix.

      • getBlobStoragePathPrefixBytes

        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];
        Returns:
        The bytes for blobStoragePathPrefix.

      • getRunCount

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

      • hasCreateTime

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

      • getCreateTime

        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];
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

        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];

      • hasUpdateTime

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

      • getUpdateTime

        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];
        Returns:
        The updateTime.

      • getUpdateTimeOrBuilder

        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];

      • getLabelsCount

        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;

      • containsLabels

        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;

      • getLabelsMap

        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;

      • getLabelsOrDefault

        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;

      • getLabelsOrThrow

        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;

      • getEtag

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

      • getEtagBytes

        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;
        Returns:
        The bytes for etag.

      • getIsDefault

        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:
        The isDefault.