Package com.google.cloud.aiplatform.v1beta1

Interface TensorboardRunOrBuilder

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

    • Method Detail

      • getName

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

      • getNameBytes

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

      • getDisplayName

        String getDisplayName()
         Required. User provided name of this TensorboardRun.
 This value must be unique among all TensorboardRuns
 belonging to the same parent TensorboardExperiment.
        string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The displayName.

      • getDisplayNameBytes

        com.google.protobuf.ByteString getDisplayNameBytes()
         Required. User provided name of this TensorboardRun.
 This value must be unique among all TensorboardRuns
 belonging to the same parent TensorboardExperiment.
        string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The bytes for displayName.

      • getDescription

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

      • getDescriptionBytes

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

      • hasCreateTime

        boolean hasCreateTime()
         Output only. Timestamp when this TensorboardRun 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 TensorboardRun 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 TensorboardRun was created.
        .google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • hasUpdateTime

        boolean hasUpdateTime()
         Output only. Timestamp when this TensorboardRun 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 TensorboardRun 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 TensorboardRun 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 TensorboardRuns.

 This field will be used to filter and visualize Runs in the Tensorboard UI.
 For example, a Vertex AI training job can set a label
 aiplatform.googleapis.com/training_job_id=xxxxx to all the runs created
 within that job. An end user can set a label experiment_id=xxxxx for all
 the runs produced in a Jupyter notebook. These runs can be grouped by a
 label value and visualized together in the Tensorboard UI.

 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 TensorboardRun
 (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 TensorboardRuns.

 This field will be used to filter and visualize Runs in the Tensorboard UI.
 For example, a Vertex AI training job can set a label
 aiplatform.googleapis.com/training_job_id=xxxxx to all the runs created
 within that job. An end user can set a label experiment_id=xxxxx for all
 the runs produced in a Jupyter notebook. These runs can be grouped by a
 label value and visualized together in the Tensorboard UI.

 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 TensorboardRun
 (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 TensorboardRuns.

 This field will be used to filter and visualize Runs in the Tensorboard UI.
 For example, a Vertex AI training job can set a label
 aiplatform.googleapis.com/training_job_id=xxxxx to all the runs created
 within that job. An end user can set a label experiment_id=xxxxx for all
 the runs produced in a Jupyter notebook. These runs can be grouped by a
 label value and visualized together in the Tensorboard UI.

 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 TensorboardRun
 (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 TensorboardRuns.

 This field will be used to filter and visualize Runs in the Tensorboard UI.
 For example, a Vertex AI training job can set a label
 aiplatform.googleapis.com/training_job_id=xxxxx to all the runs created
 within that job. An end user can set a label experiment_id=xxxxx for all
 the runs produced in a Jupyter notebook. These runs can be grouped by a
 label value and visualized together in the Tensorboard UI.

 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 TensorboardRun
 (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 TensorboardRuns.

 This field will be used to filter and visualize Runs in the Tensorboard UI.
 For example, a Vertex AI training job can set a label
 aiplatform.googleapis.com/training_job_id=xxxxx to all the runs created
 within that job. An end user can set a label experiment_id=xxxxx for all
 the runs produced in a Jupyter notebook. These runs can be grouped by a
 label value and visualized together in the Tensorboard UI.

 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 TensorboardRun
 (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.