Package com.google.cloud.aiplatform.v1

Interface TensorboardExperimentOrBuilder

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

    • Method Detail

      • getName

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

      • getNameBytes

        com.google.protobuf.ByteString getNameBytes()
         Output only. Name of the TensorboardExperiment.
 Format:
 `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The bytes for name.

      • getDisplayName

        String getDisplayName()
         User provided name of this TensorboardExperiment.
        string display_name = 2;
        Returns:
        The displayName.

      • getDisplayNameBytes

        com.google.protobuf.ByteString getDisplayNameBytes()
         User provided name of this TensorboardExperiment.
        string display_name = 2;
        Returns:
        The bytes for displayName.

      • getDescription

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

      • getDescriptionBytes

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

      • hasCreateTime

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

      • getCreateTime

        com.google.protobuf.Timestamp getCreateTime()
         Output only. Timestamp when this TensorboardExperiment was created.
        .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         Output only. Timestamp when this TensorboardExperiment was created.
        .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • hasUpdateTime

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

      • getUpdateTime

        com.google.protobuf.Timestamp getUpdateTime()
         Output only. Timestamp when this TensorboardExperiment was last updated.
        .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The updateTime.

      • getUpdateTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
         Output only. Timestamp when this TensorboardExperiment was last updated.
        .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getLabelsCount

        int getLabelsCount()
         The labels with user-defined metadata to organize your
 TensorboardExperiment.

 Label keys and values cannot be 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 Dataset (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. The following system labels exist for each Dataset:

 * `aiplatform.googleapis.com/dataset_metadata_schema`: output only. Its
    value is the
    [metadata_schema's][google.cloud.aiplatform.v1.Dataset.metadata_schema_uri]
    title.
        map<string, string> labels = 6;

      • containsLabels

        boolean containsLabels​(String key)
         The labels with user-defined metadata to organize your
 TensorboardExperiment.

 Label keys and values cannot be 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 Dataset (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. The following system labels exist for each Dataset:

 * `aiplatform.googleapis.com/dataset_metadata_schema`: output only. Its
    value is the
    [metadata_schema's][google.cloud.aiplatform.v1.Dataset.metadata_schema_uri]
    title.
        map<string, string> labels = 6;

      • getLabelsMap

        Map<String,​String> getLabelsMap()
         The labels with user-defined metadata to organize your
 TensorboardExperiment.

 Label keys and values cannot be 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 Dataset (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. The following system labels exist for each Dataset:

 * `aiplatform.googleapis.com/dataset_metadata_schema`: output only. Its
    value is the
    [metadata_schema's][google.cloud.aiplatform.v1.Dataset.metadata_schema_uri]
    title.
        map<string, string> labels = 6;

      • getLabelsOrDefault

        String getLabelsOrDefault​(String key,
                          String defaultValue)
         The labels with user-defined metadata to organize your
 TensorboardExperiment.

 Label keys and values cannot be 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 Dataset (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. The following system labels exist for each Dataset:

 * `aiplatform.googleapis.com/dataset_metadata_schema`: output only. Its
    value is the
    [metadata_schema's][google.cloud.aiplatform.v1.Dataset.metadata_schema_uri]
    title.
        map<string, string> labels = 6;

      • getLabelsOrThrow

        String getLabelsOrThrow​(String key)
         The labels with user-defined metadata to organize your
 TensorboardExperiment.

 Label keys and values cannot be 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 Dataset (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. The following system labels exist for each Dataset:

 * `aiplatform.googleapis.com/dataset_metadata_schema`: output only. Its
    value is the
    [metadata_schema's][google.cloud.aiplatform.v1.Dataset.metadata_schema_uri]
    title.
        map<string, string> labels = 6;

      • getEtag

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

      • getEtagBytes

        com.google.protobuf.ByteString getEtagBytes()
         Used to perform consistent read-modify-write updates. If not set, a blind
 "overwrite" update happens.
        string etag = 7;
        Returns:
        The bytes for etag.

      • getSource

        String getSource()
         Immutable. Source of the TensorboardExperiment. Example: a custom training
 job.
        string source = 8 [(.google.api.field_behavior) = IMMUTABLE];
        Returns:
        The source.

      • getSourceBytes

        com.google.protobuf.ByteString getSourceBytes()
         Immutable. Source of the TensorboardExperiment. Example: a custom training
 job.
        string source = 8 [(.google.api.field_behavior) = IMMUTABLE];
        Returns:
        The bytes for source.