Package com.google.cloud.aiplatform.v1

Class TensorboardExperiment.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<TensorboardExperiment.Builder>
com.google.cloud.aiplatform.v1.TensorboardExperiment.Builder
All Implemented Interfaces:
TensorboardExperimentOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
TensorboardExperiment
public static final class TensorboardExperiment.Builder extends com.google.protobuf.GeneratedMessage.Builder<TensorboardExperiment.Builder> implements TensorboardExperimentOrBuilder
 A TensorboardExperiment is a group of TensorboardRuns, that are typically the
 results of a training job run, in a Tensorboard.
Protobuf type google.cloud.aiplatform.v1.TensorboardExperiment

  • 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<TensorboardExperiment.Builder>

    • internalGetMutableMapFieldReflection

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

    • internalGetFieldAccessorTable

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

    • clear

      public TensorboardExperiment.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<TensorboardExperiment.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<TensorboardExperiment.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

      public TensorboardExperiment.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<TensorboardExperiment.Builder>

    • mergeFrom

      public TensorboardExperiment.Builder mergeFrom(TensorboardExperiment other)

    • isInitialized

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

    • mergeFrom

      public TensorboardExperiment.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<TensorboardExperiment.Builder>
      Throws:
      IOException

    • getName

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

    • getNameBytes

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

    • setName

      public TensorboardExperiment.Builder setName(String value)
       Output only. Name of the TensorboardExperiment.
 Format:
 `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`
      string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      value - The name to set.
      Returns:
      This builder for chaining.

    • clearName

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

    • setNameBytes

      public TensorboardExperiment.Builder setNameBytes(com.google.protobuf.ByteString value)
       Output only. Name of the TensorboardExperiment.
 Format:
 `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`
      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()
       User provided name of this TensorboardExperiment.
      string display_name = 2;
      Specified by:
      getDisplayName in interface TensorboardExperimentOrBuilder
      Returns:
      The displayName.

    • getDisplayNameBytes

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

    • setDisplayName

      public TensorboardExperiment.Builder setDisplayName(String value)
       User provided name of this TensorboardExperiment.
      string display_name = 2;
      Parameters:
      value - The displayName to set.
      Returns:
      This builder for chaining.

    • clearDisplayName

      public TensorboardExperiment.Builder clearDisplayName()
       User provided name of this TensorboardExperiment.
      string display_name = 2;
      Returns:
      This builder for chaining.

    • setDisplayNameBytes

      public TensorboardExperiment.Builder setDisplayNameBytes(com.google.protobuf.ByteString value)
       User provided name of this TensorboardExperiment.
      string display_name = 2;
      Parameters:
      value - The bytes for displayName to set.
      Returns:
      This builder for chaining.

    • getDescription

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

    • getDescriptionBytes

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

    • setDescription

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

    • clearDescription

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

    • setDescriptionBytes

      public TensorboardExperiment.Builder setDescriptionBytes(com.google.protobuf.ByteString value)
       Description of this TensorboardExperiment.
      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 TensorboardExperiment was created.
      .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasCreateTime in interface TensorboardExperimentOrBuilder
      Returns:
      Whether the createTime field is set.

    • getCreateTime

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

    • setCreateTime

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

    • setCreateTime

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

    • mergeCreateTime

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

    • clearCreateTime

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

    • getCreateTimeBuilder

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

    • getCreateTimeOrBuilder

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

    • hasUpdateTime

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

    • getUpdateTime

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

    • setUpdateTime

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

    • setUpdateTime

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

    • mergeUpdateTime

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

    • clearUpdateTime

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

    • getUpdateTimeBuilder

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

    • getUpdateTimeOrBuilder

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

    • getLabelsCount

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

    • containsLabels

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

    • getLabels

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

    • getLabelsMap

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

    • getLabelsOrDefault

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

    • getLabelsOrThrow

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

    • clearLabels

      public TensorboardExperiment.Builder clearLabels()

    • removeLabels

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

    • getMutableLabels

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

    • putLabels

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

    • putAllLabels

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

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

    • getEtagBytes

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

    • setEtag

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

    • clearEtag

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

    • setEtagBytes

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

    • getSource

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

    • getSourceBytes

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

    • setSource

      public TensorboardExperiment.Builder setSource(String value)
       Immutable. Source of the TensorboardExperiment. Example: a custom training
 job.
      string source = 8 [(.google.api.field_behavior) = IMMUTABLE];
      Parameters:
      value - The source to set.
      Returns:
      This builder for chaining.

    • clearSource

      public TensorboardExperiment.Builder clearSource()
       Immutable. Source of the TensorboardExperiment. Example: a custom training
 job.
      string source = 8 [(.google.api.field_behavior) = IMMUTABLE];
      Returns:
      This builder for chaining.

    • setSourceBytes

      public TensorboardExperiment.Builder setSourceBytes(com.google.protobuf.ByteString value)
       Immutable. Source of the TensorboardExperiment. Example: a custom training
 job.
      string source = 8 [(.google.api.field_behavior) = IMMUTABLE];
      Parameters:
      value - The bytes for source to set.
      Returns:
      This builder for chaining.