Package com.google.cloud.discoveryengine.v1beta

Class TrainCustomModelRequest.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<TrainCustomModelRequest.Builder>
com.google.cloud.discoveryengine.v1beta.TrainCustomModelRequest.Builder
All Implemented Interfaces:
TrainCustomModelRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
TrainCustomModelRequest
public static final class TrainCustomModelRequest.Builder extends com.google.protobuf.GeneratedMessage.Builder<TrainCustomModelRequest.Builder> implements TrainCustomModelRequestOrBuilder
 Request message for
 [SearchTuningService.TrainCustomModel][google.cloud.discoveryengine.v1beta.SearchTuningService.TrainCustomModel]
 method.
Protobuf type google.cloud.discoveryengine.v1beta.TrainCustomModelRequest

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

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

    • clear

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

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

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

    • mergeFrom

      public TrainCustomModelRequest.Builder mergeFrom(TrainCustomModelRequest other)

    • isInitialized

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

    • mergeFrom

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

    • getTrainingInputCase

      public TrainCustomModelRequest.TrainingInputCase getTrainingInputCase()
      Specified by:
      getTrainingInputCase in interface TrainCustomModelRequestOrBuilder

    • clearTrainingInput

      public TrainCustomModelRequest.Builder clearTrainingInput()

    • hasGcsTrainingInput

      public boolean hasGcsTrainingInput()
       Cloud Storage training input.
      .google.cloud.discoveryengine.v1beta.TrainCustomModelRequest.GcsTrainingInput gcs_training_input = 2;
      Specified by:
      hasGcsTrainingInput in interface TrainCustomModelRequestOrBuilder
      Returns:
      Whether the gcsTrainingInput field is set.

    • getGcsTrainingInput

      public TrainCustomModelRequest.GcsTrainingInput getGcsTrainingInput()
       Cloud Storage training input.
      .google.cloud.discoveryengine.v1beta.TrainCustomModelRequest.GcsTrainingInput gcs_training_input = 2;
      Specified by:
      getGcsTrainingInput in interface TrainCustomModelRequestOrBuilder
      Returns:
      The gcsTrainingInput.

    • setGcsTrainingInput

      public TrainCustomModelRequest.Builder setGcsTrainingInput(TrainCustomModelRequest.GcsTrainingInput value)
       Cloud Storage training input.
      .google.cloud.discoveryengine.v1beta.TrainCustomModelRequest.GcsTrainingInput gcs_training_input = 2;

    • setGcsTrainingInput

      public TrainCustomModelRequest.Builder setGcsTrainingInput(TrainCustomModelRequest.GcsTrainingInput.Builder builderForValue)
       Cloud Storage training input.
      .google.cloud.discoveryengine.v1beta.TrainCustomModelRequest.GcsTrainingInput gcs_training_input = 2;

    • mergeGcsTrainingInput

      public TrainCustomModelRequest.Builder mergeGcsTrainingInput(TrainCustomModelRequest.GcsTrainingInput value)
       Cloud Storage training input.
      .google.cloud.discoveryengine.v1beta.TrainCustomModelRequest.GcsTrainingInput gcs_training_input = 2;

    • clearGcsTrainingInput

      public TrainCustomModelRequest.Builder clearGcsTrainingInput()
       Cloud Storage training input.
      .google.cloud.discoveryengine.v1beta.TrainCustomModelRequest.GcsTrainingInput gcs_training_input = 2;

    • getGcsTrainingInputBuilder

      public TrainCustomModelRequest.GcsTrainingInput.Builder getGcsTrainingInputBuilder()
       Cloud Storage training input.
      .google.cloud.discoveryengine.v1beta.TrainCustomModelRequest.GcsTrainingInput gcs_training_input = 2;

    • getGcsTrainingInputOrBuilder

      public TrainCustomModelRequest.GcsTrainingInputOrBuilder getGcsTrainingInputOrBuilder()
       Cloud Storage training input.
      .google.cloud.discoveryengine.v1beta.TrainCustomModelRequest.GcsTrainingInput gcs_training_input = 2;
      Specified by:
      getGcsTrainingInputOrBuilder in interface TrainCustomModelRequestOrBuilder

    • getDataStore

      public String getDataStore()
       Required. The resource name of the Data Store, such as
 `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`.
 This field is used to identify the data store where to train the models.
      string data_store = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getDataStore in interface TrainCustomModelRequestOrBuilder
      Returns:
      The dataStore.

    • getDataStoreBytes

      public com.google.protobuf.ByteString getDataStoreBytes()
       Required. The resource name of the Data Store, such as
 `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`.
 This field is used to identify the data store where to train the models.
      string data_store = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getDataStoreBytes in interface TrainCustomModelRequestOrBuilder
      Returns:
      The bytes for dataStore.

    • setDataStore

      public TrainCustomModelRequest.Builder setDataStore(String value)
       Required. The resource name of the Data Store, such as
 `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`.
 This field is used to identify the data store where to train the models.
      string data_store = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Parameters:
      value - The dataStore to set.
      Returns:
      This builder for chaining.

    • clearDataStore

      public TrainCustomModelRequest.Builder clearDataStore()
       Required. The resource name of the Data Store, such as
 `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`.
 This field is used to identify the data store where to train the models.
      string data_store = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      This builder for chaining.

    • setDataStoreBytes

      public TrainCustomModelRequest.Builder setDataStoreBytes(com.google.protobuf.ByteString value)
       Required. The resource name of the Data Store, such as
 `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`.
 This field is used to identify the data store where to train the models.
      string data_store = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Parameters:
      value - The bytes for dataStore to set.
      Returns:
      This builder for chaining.

    • getModelType

      public String getModelType()
       Model to be trained. Supported values are:

 * **search-tuning**: Fine tuning the search system based on data provided.
      string model_type = 3;
      Specified by:
      getModelType in interface TrainCustomModelRequestOrBuilder
      Returns:
      The modelType.

    • getModelTypeBytes

      public com.google.protobuf.ByteString getModelTypeBytes()
       Model to be trained. Supported values are:

 * **search-tuning**: Fine tuning the search system based on data provided.
      string model_type = 3;
      Specified by:
      getModelTypeBytes in interface TrainCustomModelRequestOrBuilder
      Returns:
      The bytes for modelType.

    • setModelType

      public TrainCustomModelRequest.Builder setModelType(String value)
       Model to be trained. Supported values are:

 * **search-tuning**: Fine tuning the search system based on data provided.
      string model_type = 3;
      Parameters:
      value - The modelType to set.
      Returns:
      This builder for chaining.

    • clearModelType

      public TrainCustomModelRequest.Builder clearModelType()
       Model to be trained. Supported values are:

 * **search-tuning**: Fine tuning the search system based on data provided.
      string model_type = 3;
      Returns:
      This builder for chaining.

    • setModelTypeBytes

      public TrainCustomModelRequest.Builder setModelTypeBytes(com.google.protobuf.ByteString value)
       Model to be trained. Supported values are:

 * **search-tuning**: Fine tuning the search system based on data provided.
      string model_type = 3;
      Parameters:
      value - The bytes for modelType to set.
      Returns:
      This builder for chaining.

    • hasErrorConfig

      public boolean hasErrorConfig()
       The desired location of errors incurred during the data ingestion and
 training.
      .google.cloud.discoveryengine.v1beta.ImportErrorConfig error_config = 4;
      Specified by:
      hasErrorConfig in interface TrainCustomModelRequestOrBuilder
      Returns:
      Whether the errorConfig field is set.

    • getErrorConfig

      public ImportErrorConfig getErrorConfig()
       The desired location of errors incurred during the data ingestion and
 training.
      .google.cloud.discoveryengine.v1beta.ImportErrorConfig error_config = 4;
      Specified by:
      getErrorConfig in interface TrainCustomModelRequestOrBuilder
      Returns:
      The errorConfig.

    • setErrorConfig

      public TrainCustomModelRequest.Builder setErrorConfig(ImportErrorConfig value)
       The desired location of errors incurred during the data ingestion and
 training.
      .google.cloud.discoveryengine.v1beta.ImportErrorConfig error_config = 4;

    • setErrorConfig

      public TrainCustomModelRequest.Builder setErrorConfig(ImportErrorConfig.Builder builderForValue)
       The desired location of errors incurred during the data ingestion and
 training.
      .google.cloud.discoveryengine.v1beta.ImportErrorConfig error_config = 4;

    • mergeErrorConfig

      public TrainCustomModelRequest.Builder mergeErrorConfig(ImportErrorConfig value)
       The desired location of errors incurred during the data ingestion and
 training.
      .google.cloud.discoveryengine.v1beta.ImportErrorConfig error_config = 4;

    • clearErrorConfig

      public TrainCustomModelRequest.Builder clearErrorConfig()
       The desired location of errors incurred during the data ingestion and
 training.
      .google.cloud.discoveryengine.v1beta.ImportErrorConfig error_config = 4;

    • getErrorConfigBuilder

      public ImportErrorConfig.Builder getErrorConfigBuilder()
       The desired location of errors incurred during the data ingestion and
 training.
      .google.cloud.discoveryengine.v1beta.ImportErrorConfig error_config = 4;

    • getErrorConfigOrBuilder

      public ImportErrorConfigOrBuilder getErrorConfigOrBuilder()
       The desired location of errors incurred during the data ingestion and
 training.
      .google.cloud.discoveryengine.v1beta.ImportErrorConfig error_config = 4;
      Specified by:
      getErrorConfigOrBuilder in interface TrainCustomModelRequestOrBuilder

    • getModelId

      public String getModelId()
       If not provided, a UUID will be generated.
      string model_id = 5;
      Specified by:
      getModelId in interface TrainCustomModelRequestOrBuilder
      Returns:
      The modelId.

    • getModelIdBytes

      public com.google.protobuf.ByteString getModelIdBytes()
       If not provided, a UUID will be generated.
      string model_id = 5;
      Specified by:
      getModelIdBytes in interface TrainCustomModelRequestOrBuilder
      Returns:
      The bytes for modelId.

    • setModelId

      public TrainCustomModelRequest.Builder setModelId(String value)
       If not provided, a UUID will be generated.
      string model_id = 5;
      Parameters:
      value - The modelId to set.
      Returns:
      This builder for chaining.

    • clearModelId

      public TrainCustomModelRequest.Builder clearModelId()
       If not provided, a UUID will be generated.
      string model_id = 5;
      Returns:
      This builder for chaining.

    • setModelIdBytes

      public TrainCustomModelRequest.Builder setModelIdBytes(com.google.protobuf.ByteString value)
       If not provided, a UUID will be generated.
      string model_id = 5;
      Parameters:
      value - The bytes for modelId to set.
      Returns:
      This builder for chaining.