Package com.google.cloud.discoveryengine.v1beta

Class CustomTuningModel.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<CustomTuningModel.Builder>
com.google.cloud.discoveryengine.v1beta.CustomTuningModel.Builder
All Implemented Interfaces:
CustomTuningModelOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
CustomTuningModel
public static final class CustomTuningModel.Builder extends com.google.protobuf.GeneratedMessage.Builder<CustomTuningModel.Builder> implements CustomTuningModelOrBuilder
 Metadata that describes a custom tuned model.
Protobuf type google.cloud.discoveryengine.v1beta.CustomTuningModel

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

    • internalGetMutableMapFieldReflection

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

    • internalGetFieldAccessorTable

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

    • clear

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

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

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

    • mergeFrom

      public CustomTuningModel.Builder mergeFrom(CustomTuningModel other)

    • isInitialized

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

    • mergeFrom

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

    • getName

      public String getName()
       Required. The fully qualified resource name of the model.

 Format:
 `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}`.

 Model must be an alpha-numerical string with limit of 40 characters.
      string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getName in interface CustomTuningModelOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Required. The fully qualified resource name of the model.

 Format:
 `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}`.

 Model must be an alpha-numerical string with limit of 40 characters.
      string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getNameBytes in interface CustomTuningModelOrBuilder
      Returns:
      The bytes for name.

    • setName

      public CustomTuningModel.Builder setName(String value)
       Required. The fully qualified resource name of the model.

 Format:
 `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}`.

 Model must be an alpha-numerical string with limit of 40 characters.
      string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Parameters:
      value - The name to set.
      Returns:
      This builder for chaining.

    • clearName

      public CustomTuningModel.Builder clearName()
       Required. The fully qualified resource name of the model.

 Format:
 `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}`.

 Model must be an alpha-numerical string with limit of 40 characters.
      string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      This builder for chaining.

    • setNameBytes

      public CustomTuningModel.Builder setNameBytes(com.google.protobuf.ByteString value)
       Required. The fully qualified resource name of the model.

 Format:
 `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}`.

 Model must be an alpha-numerical string with limit of 40 characters.
      string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Parameters:
      value - The bytes for name to set.
      Returns:
      This builder for chaining.

    • getDisplayName

      public String getDisplayName()
       The display name of the model.
      string display_name = 2;
      Specified by:
      getDisplayName in interface CustomTuningModelOrBuilder
      Returns:
      The displayName.

    • getDisplayNameBytes

      public com.google.protobuf.ByteString getDisplayNameBytes()
       The display name of the model.
      string display_name = 2;
      Specified by:
      getDisplayNameBytes in interface CustomTuningModelOrBuilder
      Returns:
      The bytes for displayName.

    • setDisplayName

      public CustomTuningModel.Builder setDisplayName(String value)
       The display name of the model.
      string display_name = 2;
      Parameters:
      value - The displayName to set.
      Returns:
      This builder for chaining.

    • clearDisplayName

      public CustomTuningModel.Builder clearDisplayName()
       The display name of the model.
      string display_name = 2;
      Returns:
      This builder for chaining.

    • setDisplayNameBytes

      public CustomTuningModel.Builder setDisplayNameBytes(com.google.protobuf.ByteString value)
       The display name of the model.
      string display_name = 2;
      Parameters:
      value - The bytes for displayName to set.
      Returns:
      This builder for chaining.

    • getModelVersion

      public long getModelVersion()
       The version of the model.
      int64 model_version = 3;
      Specified by:
      getModelVersion in interface CustomTuningModelOrBuilder
      Returns:
      The modelVersion.

    • setModelVersion

      public CustomTuningModel.Builder setModelVersion(long value)
       The version of the model.
      int64 model_version = 3;
      Parameters:
      value - The modelVersion to set.
      Returns:
      This builder for chaining.

    • clearModelVersion

      public CustomTuningModel.Builder clearModelVersion()
       The version of the model.
      int64 model_version = 3;
      Returns:
      This builder for chaining.

    • getModelStateValue

      public int getModelStateValue()
       The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`).
      .google.cloud.discoveryengine.v1beta.CustomTuningModel.ModelState model_state = 4;
      Specified by:
      getModelStateValue in interface CustomTuningModelOrBuilder
      Returns:
      The enum numeric value on the wire for modelState.

    • setModelStateValue

      public CustomTuningModel.Builder setModelStateValue(int value)
       The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`).
      .google.cloud.discoveryengine.v1beta.CustomTuningModel.ModelState model_state = 4;
      Parameters:
      value - The enum numeric value on the wire for modelState to set.
      Returns:
      This builder for chaining.

    • getModelState

      public CustomTuningModel.ModelState getModelState()
       The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`).
      .google.cloud.discoveryengine.v1beta.CustomTuningModel.ModelState model_state = 4;
      Specified by:
      getModelState in interface CustomTuningModelOrBuilder
      Returns:
      The modelState.

    • setModelState

      public CustomTuningModel.Builder setModelState(CustomTuningModel.ModelState value)
       The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`).
      .google.cloud.discoveryengine.v1beta.CustomTuningModel.ModelState model_state = 4;
      Parameters:
      value - The modelState to set.
      Returns:
      This builder for chaining.

    • clearModelState

      public CustomTuningModel.Builder clearModelState()
       The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`).
      .google.cloud.discoveryengine.v1beta.CustomTuningModel.ModelState model_state = 4;
      Returns:
      This builder for chaining.

    • hasCreateTime

      @Deprecated public boolean hasCreateTime()
      Deprecated.
      google.cloud.discoveryengine.v1beta.CustomTuningModel.create_time is deprecated. See google/cloud/discoveryengine/v1beta/custom_tuning_model.proto;l=89
       Deprecated: Timestamp the Model was created at.
      .google.protobuf.Timestamp create_time = 5 [deprecated = true];
      Specified by:
      hasCreateTime in interface CustomTuningModelOrBuilder
      Returns:
      Whether the createTime field is set.

    • getCreateTime

      @Deprecated public com.google.protobuf.Timestamp getCreateTime()
      Deprecated.
      google.cloud.discoveryengine.v1beta.CustomTuningModel.create_time is deprecated. See google/cloud/discoveryengine/v1beta/custom_tuning_model.proto;l=89
       Deprecated: Timestamp the Model was created at.
      .google.protobuf.Timestamp create_time = 5 [deprecated = true];
      Specified by:
      getCreateTime in interface CustomTuningModelOrBuilder
      Returns:
      The createTime.

    • setCreateTime

      @Deprecated public CustomTuningModel.Builder setCreateTime(com.google.protobuf.Timestamp value)
      Deprecated.
       Deprecated: Timestamp the Model was created at.
      .google.protobuf.Timestamp create_time = 5 [deprecated = true];

    • setCreateTime

      @Deprecated public CustomTuningModel.Builder setCreateTime(com.google.protobuf.Timestamp.Builder builderForValue)
      Deprecated.
       Deprecated: Timestamp the Model was created at.
      .google.protobuf.Timestamp create_time = 5 [deprecated = true];

    • mergeCreateTime

      @Deprecated public CustomTuningModel.Builder mergeCreateTime(com.google.protobuf.Timestamp value)
      Deprecated.
       Deprecated: Timestamp the Model was created at.
      .google.protobuf.Timestamp create_time = 5 [deprecated = true];

    • clearCreateTime

      @Deprecated public CustomTuningModel.Builder clearCreateTime()
      Deprecated.
       Deprecated: Timestamp the Model was created at.
      .google.protobuf.Timestamp create_time = 5 [deprecated = true];

    • getCreateTimeBuilder

      @Deprecated public com.google.protobuf.Timestamp.Builder getCreateTimeBuilder()
      Deprecated.
       Deprecated: Timestamp the Model was created at.
      .google.protobuf.Timestamp create_time = 5 [deprecated = true];

    • getCreateTimeOrBuilder

      @Deprecated public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
      Deprecated.
       Deprecated: Timestamp the Model was created at.
      .google.protobuf.Timestamp create_time = 5 [deprecated = true];
      Specified by:
      getCreateTimeOrBuilder in interface CustomTuningModelOrBuilder

    • hasTrainingStartTime

      public boolean hasTrainingStartTime()
       Timestamp the model training was initiated.
      .google.protobuf.Timestamp training_start_time = 6;
      Specified by:
      hasTrainingStartTime in interface CustomTuningModelOrBuilder
      Returns:
      Whether the trainingStartTime field is set.

    • getTrainingStartTime

      public com.google.protobuf.Timestamp getTrainingStartTime()
       Timestamp the model training was initiated.
      .google.protobuf.Timestamp training_start_time = 6;
      Specified by:
      getTrainingStartTime in interface CustomTuningModelOrBuilder
      Returns:
      The trainingStartTime.

    • setTrainingStartTime

      public CustomTuningModel.Builder setTrainingStartTime(com.google.protobuf.Timestamp value)
       Timestamp the model training was initiated.
      .google.protobuf.Timestamp training_start_time = 6;

    • setTrainingStartTime

      public CustomTuningModel.Builder setTrainingStartTime(com.google.protobuf.Timestamp.Builder builderForValue)
       Timestamp the model training was initiated.
      .google.protobuf.Timestamp training_start_time = 6;

    • mergeTrainingStartTime

      public CustomTuningModel.Builder mergeTrainingStartTime(com.google.protobuf.Timestamp value)
       Timestamp the model training was initiated.
      .google.protobuf.Timestamp training_start_time = 6;

    • clearTrainingStartTime

      public CustomTuningModel.Builder clearTrainingStartTime()
       Timestamp the model training was initiated.
      .google.protobuf.Timestamp training_start_time = 6;

    • getTrainingStartTimeBuilder

      public com.google.protobuf.Timestamp.Builder getTrainingStartTimeBuilder()
       Timestamp the model training was initiated.
      .google.protobuf.Timestamp training_start_time = 6;

    • getTrainingStartTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getTrainingStartTimeOrBuilder()
       Timestamp the model training was initiated.
      .google.protobuf.Timestamp training_start_time = 6;
      Specified by:
      getTrainingStartTimeOrBuilder in interface CustomTuningModelOrBuilder

    • getMetricsCount

      public int getMetricsCount()
      Description copied from interface: CustomTuningModelOrBuilder
       The metrics of the trained model.
      map<string, double> metrics = 7;
      Specified by:
      getMetricsCount in interface CustomTuningModelOrBuilder

    • containsMetrics

      public boolean containsMetrics(String key)
       The metrics of the trained model.
      map<string, double> metrics = 7;
      Specified by:
      containsMetrics in interface CustomTuningModelOrBuilder

    • getMetrics

      @Deprecated public Map<String,Double> getMetrics()
      Deprecated.
      Use getMetricsMap() instead.
      Specified by:
      getMetrics in interface CustomTuningModelOrBuilder

    • getMetricsMap

      public Map<String,Double> getMetricsMap()
       The metrics of the trained model.
      map<string, double> metrics = 7;
      Specified by:
      getMetricsMap in interface CustomTuningModelOrBuilder

    • getMetricsOrDefault

      public double getMetricsOrDefault(String key, double defaultValue)
       The metrics of the trained model.
      map<string, double> metrics = 7;
      Specified by:
      getMetricsOrDefault in interface CustomTuningModelOrBuilder

    • getMetricsOrThrow

      public double getMetricsOrThrow(String key)
       The metrics of the trained model.
      map<string, double> metrics = 7;
      Specified by:
      getMetricsOrThrow in interface CustomTuningModelOrBuilder

    • clearMetrics

      public CustomTuningModel.Builder clearMetrics()

    • removeMetrics

      public CustomTuningModel.Builder removeMetrics(String key)
       The metrics of the trained model.
      map<string, double> metrics = 7;

    • getMutableMetrics

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

    • putMetrics

      public CustomTuningModel.Builder putMetrics(String key, double value)
       The metrics of the trained model.
      map<string, double> metrics = 7;

    • putAllMetrics

      public CustomTuningModel.Builder putAllMetrics(Map<String,Double> values)
       The metrics of the trained model.
      map<string, double> metrics = 7;

    • getErrorMessage

      public String getErrorMessage()
       Currently this is only populated if the model state is
 `INPUT_VALIDATION_FAILED`.
      string error_message = 8;
      Specified by:
      getErrorMessage in interface CustomTuningModelOrBuilder
      Returns:
      The errorMessage.

    • getErrorMessageBytes

      public com.google.protobuf.ByteString getErrorMessageBytes()
       Currently this is only populated if the model state is
 `INPUT_VALIDATION_FAILED`.
      string error_message = 8;
      Specified by:
      getErrorMessageBytes in interface CustomTuningModelOrBuilder
      Returns:
      The bytes for errorMessage.

    • setErrorMessage

      public CustomTuningModel.Builder setErrorMessage(String value)
       Currently this is only populated if the model state is
 `INPUT_VALIDATION_FAILED`.
      string error_message = 8;
      Parameters:
      value - The errorMessage to set.
      Returns:
      This builder for chaining.

    • clearErrorMessage

      public CustomTuningModel.Builder clearErrorMessage()
       Currently this is only populated if the model state is
 `INPUT_VALIDATION_FAILED`.
      string error_message = 8;
      Returns:
      This builder for chaining.

    • setErrorMessageBytes

      public CustomTuningModel.Builder setErrorMessageBytes(com.google.protobuf.ByteString value)
       Currently this is only populated if the model state is
 `INPUT_VALIDATION_FAILED`.
      string error_message = 8;
      Parameters:
      value - The bytes for errorMessage to set.
      Returns:
      This builder for chaining.