Package com.google.cloud.aiplatform.v1

Class TensorboardRun.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<TensorboardRun.Builder>
com.google.cloud.aiplatform.v1.TensorboardRun.Builder
All Implemented Interfaces:
TensorboardRunOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
TensorboardRun
public static final class TensorboardRun.Builder extends com.google.protobuf.GeneratedMessage.Builder<TensorboardRun.Builder> implements TensorboardRunOrBuilder
 TensorboardRun maps to a specific execution of a training job with a given
 set of hyperparameter values, model definition, dataset, etc
Protobuf type google.cloud.aiplatform.v1.TensorboardRun

  • Method Details

    • getDescriptor

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

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage.Builder<TensorboardRun.Builder>

    • internalGetMutableMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
      Overrides:
      internalGetMutableMapFieldReflection in class com.google.protobuf.GeneratedMessage.Builder<TensorboardRun.Builder>

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<TensorboardRun.Builder>

    • clear

      public TensorboardRun.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<TensorboardRun.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<TensorboardRun.Builder>

    • getDefaultInstanceForType

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

    • build

      public TensorboardRun build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public TensorboardRun buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • mergeFrom

      public TensorboardRun.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<TensorboardRun.Builder>

    • mergeFrom

      public TensorboardRun.Builder mergeFrom(TensorboardRun other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<TensorboardRun.Builder>

    • mergeFrom

      public TensorboardRun.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<TensorboardRun.Builder>
      Throws:
      IOException

    • getName

      public 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];
      Specified by:
      getName in interface TensorboardRunOrBuilder
      Returns:
      The name.

    • getNameBytes

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

    • setName

      public TensorboardRun.Builder setName(String value)
       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];
      Parameters:
      value - The name to set.
      Returns:
      This builder for chaining.

    • clearName

      public TensorboardRun.Builder clearName()
       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:
      This builder for chaining.

    • setNameBytes

      public TensorboardRun.Builder setNameBytes(com.google.protobuf.ByteString value)
       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];
      Parameters:
      value - The bytes for name to set.
      Returns:
      This builder for chaining.

    • getDisplayName

      public 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];
      Specified by:
      getDisplayName in interface TensorboardRunOrBuilder
      Returns:
      The displayName.

    • getDisplayNameBytes

      public 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];
      Specified by:
      getDisplayNameBytes in interface TensorboardRunOrBuilder
      Returns:
      The bytes for displayName.

    • setDisplayName

      public TensorboardRun.Builder setDisplayName(String value)
       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];
      Parameters:
      value - The displayName to set.
      Returns:
      This builder for chaining.

    • clearDisplayName

      public TensorboardRun.Builder clearDisplayName()
       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:
      This builder for chaining.

    • setDisplayNameBytes

      public TensorboardRun.Builder setDisplayNameBytes(com.google.protobuf.ByteString value)
       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];
      Parameters:
      value - The bytes for displayName to set.
      Returns:
      This builder for chaining.

    • getDescription

      public String getDescription()
       Description of this TensorboardRun.
      string description = 3;
      Specified by:
      getDescription in interface TensorboardRunOrBuilder
      Returns:
      The description.

    • getDescriptionBytes

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

    • setDescription

      public TensorboardRun.Builder setDescription(String value)
       Description of this TensorboardRun.
      string description = 3;
      Parameters:
      value - The description to set.
      Returns:
      This builder for chaining.

    • clearDescription

      public TensorboardRun.Builder clearDescription()
       Description of this TensorboardRun.
      string description = 3;
      Returns:
      This builder for chaining.

    • setDescriptionBytes

      public TensorboardRun.Builder setDescriptionBytes(com.google.protobuf.ByteString value)
       Description of this TensorboardRun.
      string description = 3;
      Parameters:
      value - The bytes for description to set.
      Returns:
      This builder for chaining.

    • hasCreateTime

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

    • getCreateTime

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

    • setCreateTime

      public TensorboardRun.Builder setCreateTime(com.google.protobuf.Timestamp value)
       Output only. Timestamp when this TensorboardRun was created.
      .google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • setCreateTime

      public TensorboardRun.Builder setCreateTime(com.google.protobuf.Timestamp.Builder builderForValue)
       Output only. Timestamp when this TensorboardRun was created.
      .google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • mergeCreateTime

      public TensorboardRun.Builder mergeCreateTime(com.google.protobuf.Timestamp value)
       Output only. Timestamp when this TensorboardRun was created.
      .google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • clearCreateTime

      public TensorboardRun.Builder clearCreateTime()
       Output only. Timestamp when this TensorboardRun was created.
      .google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getCreateTimeBuilder

      public com.google.protobuf.Timestamp.Builder getCreateTimeBuilder()
       Output only. Timestamp when this TensorboardRun was created.
      .google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getCreateTimeOrBuilder

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

    • hasUpdateTime

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

    • getUpdateTime

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

    • setUpdateTime

      public TensorboardRun.Builder setUpdateTime(com.google.protobuf.Timestamp value)
       Output only. Timestamp when this TensorboardRun was last updated.
      .google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • setUpdateTime

      public TensorboardRun.Builder setUpdateTime(com.google.protobuf.Timestamp.Builder builderForValue)
       Output only. Timestamp when this TensorboardRun was last updated.
      .google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • mergeUpdateTime

      public TensorboardRun.Builder mergeUpdateTime(com.google.protobuf.Timestamp value)
       Output only. Timestamp when this TensorboardRun was last updated.
      .google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • clearUpdateTime

      public TensorboardRun.Builder clearUpdateTime()
       Output only. Timestamp when this TensorboardRun was last updated.
      .google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getUpdateTimeBuilder

      public com.google.protobuf.Timestamp.Builder getUpdateTimeBuilder()
       Output only. Timestamp when this TensorboardRun was last updated.
      .google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getUpdateTimeOrBuilder

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

    • getLabelsCount

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

    • containsLabels

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

    • getLabels

      @Deprecated public Map<String,String> getLabels()
      Deprecated.
      Use getLabelsMap() instead.
      Specified by:
      getLabels in interface TensorboardRunOrBuilder

    • getLabelsMap

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

    • getLabelsOrDefault

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

    • getLabelsOrThrow

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

    • clearLabels

      public TensorboardRun.Builder clearLabels()

    • removeLabels

      public TensorboardRun.Builder removeLabels(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;

    • getMutableLabels

      @Deprecated public Map<String,String> getMutableLabels()
      Deprecated.
      Use alternate mutation accessors instead.

    • putLabels

      public TensorboardRun.Builder putLabels(String key, String value)
       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;

    • putAllLabels

      public TensorboardRun.Builder putAllLabels(Map<String,String> values)
       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

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

    • setEtag

      public TensorboardRun.Builder setEtag(String value)
       Used to perform a consistent read-modify-write updates. If not set, a blind
 "overwrite" update happens.
      string etag = 9;
      Parameters:
      value - The etag to set.
      Returns:
      This builder for chaining.

    • clearEtag

      public TensorboardRun.Builder clearEtag()
       Used to perform a consistent read-modify-write updates. If not set, a blind
 "overwrite" update happens.
      string etag = 9;
      Returns:
      This builder for chaining.

    • setEtagBytes

      public TensorboardRun.Builder setEtagBytes(com.google.protobuf.ByteString value)
       Used to perform a consistent read-modify-write updates. If not set, a blind
 "overwrite" update happens.
      string etag = 9;
      Parameters:
      value - The bytes for etag to set.
      Returns:
      This builder for chaining.