Send feedback
  
   
 
  
    
      Class TrainCustomModelRequest (0.74.0) 
  
  
  
   
  
    
  
  
    
    
    
    
    
  Version latestkeyboard_arrow_down  
  
 
    
    
    
    
      
  
  
  
    
public   final   class  TrainCustomModelRequest   extends   GeneratedMessageV3   implements   TrainCustomModelRequestOrBuilder  
   Request message for
 SearchTuningService.TrainCustomModel 
 method.
 Protobuf type google.cloud.discoveryengine.v1alpha.TrainCustomModelRequest
    Inherited Members 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
      com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT) 
    
    
      com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int) 
    
    
    
    
    
    
    
    
      com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>) 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
      com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int) 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
   
  Static Fields
   
  DATA_STORE_FIELD_NUMBER 
  
    
public   static   final   int   DATA_STORE_FIELD_NUMBER  
  
    
      
        Field Value  
      
        Type Description  
      
        int  
     
  
  ERROR_CONFIG_FIELD_NUMBER 
  
    
public   static   final   int   ERROR_CONFIG_FIELD_NUMBER  
  
    
      
        Field Value  
      
        Type Description  
      
        int  
     
  
  
  
    
public   static   final   int   GCS_TRAINING_INPUT_FIELD_NUMBER  
  
    
      
        Field Value  
      
        Type Description  
      
        int  
     
  
  MODEL_ID_FIELD_NUMBER 
  
    
public   static   final   int   MODEL_ID_FIELD_NUMBER  
  
    
      
        Field Value  
      
        Type Description  
      
        int  
     
  
  MODEL_TYPE_FIELD_NUMBER 
  
    
public   static   final   int   MODEL_TYPE_FIELD_NUMBER  
  
    
      
        Field Value  
      
        Type Description  
      
        int  
     
  
  Static Methods
   
  getDefaultInstance() 
  
    
public   static   TrainCustomModelRequest   getDefaultInstance ()  
  
  getDescriptor() 
  
    
public   static   final   Descriptors . Descriptor   getDescriptor ()  
  
  newBuilder() 
  
    
public   static   TrainCustomModelRequest . Builder   newBuilder ()  
  
  newBuilder(TrainCustomModelRequest prototype) 
  
    
public   static   TrainCustomModelRequest . Builder   newBuilder ( TrainCustomModelRequest   prototype )  
  
  
  
    
public   static   TrainCustomModelRequest   parseDelimitedFrom ( InputStream   input )  
  
  
  
  
    
public   static   TrainCustomModelRequest   parseDelimitedFrom ( InputStream   input ,   ExtensionRegistryLite   extensionRegistry )  
  
  
  
  parseFrom(byte[] data) 
  
    
public   static   TrainCustomModelRequest   parseFrom ( byte []   data )  
  
    
      
        Parameter  
      
        Name Description  
      
        databyte [] 
     
  
  
  
  parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry) 
  
    
public   static   TrainCustomModelRequest   parseFrom ( byte []   data ,   ExtensionRegistryLite   extensionRegistry )  
  
  
  
  parseFrom(ByteString data) 
  
    
public   static   TrainCustomModelRequest   parseFrom ( ByteString   data )  
  
  
  
  parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry) 
  
    
public   static   TrainCustomModelRequest   parseFrom ( ByteString   data ,   ExtensionRegistryLite   extensionRegistry )  
  
  
  
  
    
public   static   TrainCustomModelRequest   parseFrom ( CodedInputStream   input )  
  
  
  
  
    
public   static   TrainCustomModelRequest   parseFrom ( CodedInputStream   input ,   ExtensionRegistryLite   extensionRegistry )  
  
  
  
  
    
public   static   TrainCustomModelRequest   parseFrom ( InputStream   input )  
  
  
  
  
    
public   static   TrainCustomModelRequest   parseFrom ( InputStream   input ,   ExtensionRegistryLite   extensionRegistry )  
  
  
  
  parseFrom(ByteBuffer data) 
  
    
public   static   TrainCustomModelRequest   parseFrom ( ByteBuffer   data )  
  
  
  
  parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry) 
  
    
public   static   TrainCustomModelRequest   parseFrom ( ByteBuffer   data ,   ExtensionRegistryLite   extensionRegistry )  
  
  
  
  parser() 
  
    
public   static   Parser<TrainCustomModelRequest>   parser ()  
  
  Methods
   
  equals(Object obj) 
  
    
public   boolean   equals ( Object   obj )  
  
    
      
        Parameter  
      
        Name Description  
      
        objObject  
     
  
  
  Overrides 
  
  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) = { ... }
 
    
      
        Returns  
      
        Type Description  
      
        String The dataStore.
 
     
  
  getDataStoreBytes() 
  
    
public   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) = { ... }
 
    
      
        Returns  
      
        Type Description  
      
        ByteString The bytes for dataStore.
 
     
  
  getDefaultInstanceForType() 
  
    
public   TrainCustomModelRequest   getDefaultInstanceForType ()  
  
  getErrorConfig() 
  
    
public   ImportErrorConfig   getErrorConfig ()  
   The desired location of errors incurred during the data ingestion and
 training.
 .google.cloud.discoveryengine.v1alpha.ImportErrorConfig error_config = 4;
getErrorConfigOrBuilder() 
  
    
public   ImportErrorConfigOrBuilder   getErrorConfigOrBuilder ()  
   The desired location of errors incurred during the data ingestion and
 training.
 .google.cloud.discoveryengine.v1alpha.ImportErrorConfig error_config = 4;
    
public   TrainCustomModelRequest . GcsTrainingInput   getGcsTrainingInput ()  
   Cloud Storage training input.
 
 .google.cloud.discoveryengine.v1alpha.TrainCustomModelRequest.GcsTrainingInput gcs_training_input = 2;
 
    
public   TrainCustomModelRequest . GcsTrainingInputOrBuilder   getGcsTrainingInputOrBuilder ()  
   Cloud Storage training input.
 
 .google.cloud.discoveryengine.v1alpha.TrainCustomModelRequest.GcsTrainingInput gcs_training_input = 2;
 
getModelId() 
  
    
public   String   getModelId ()  
   If not provided, a UUID will be generated.
 string model_id = 5;
    
      
        Returns  
      
        Type Description  
      
        String The modelId.
 
     
  
  getModelIdBytes() 
  
    
public   ByteString   getModelIdBytes ()  
   If not provided, a UUID will be generated.
 string model_id = 5;
    
      
        Returns  
      
        Type Description  
      
        ByteString The bytes for modelId.
 
     
  
  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;
    
      
        Returns  
      
        Type Description  
      
        String The modelType.
 
     
  
  getModelTypeBytes() 
  
    
public   ByteString   getModelTypeBytes ()  
   Model to be trained. Supported values are:
search-tuning : Fine tuning the search system based on data provided. 
 string model_type = 3;
    
      
        Returns  
      
        Type Description  
      
        ByteString The bytes for modelType.
 
     
  
  getParserForType() 
  
    
public   Parser<TrainCustomModelRequest>   getParserForType ()  
  
  Overrides 
  
  getSerializedSize() 
  
    
public   int   getSerializedSize ()  
  
    
      
        Returns  
      
        Type Description  
      
        int  
     
  
  Overrides 
  
  
    
public   TrainCustomModelRequest . TrainingInputCase   getTrainingInputCase ()  
  
  hasErrorConfig() 
  
    
public   boolean   hasErrorConfig ()  
   The desired location of errors incurred during the data ingestion and
 training.
 .google.cloud.discoveryengine.v1alpha.ImportErrorConfig error_config = 4;
    
      
        Returns  
      
        Type Description  
      
        boolean Whether the errorConfig field is set.
 
     
  
  
    
public   boolean   hasGcsTrainingInput ()  
   Cloud Storage training input.
 
 .google.cloud.discoveryengine.v1alpha.TrainCustomModelRequest.GcsTrainingInput gcs_training_input = 2;
 
    
      
        Returns  
      
        Type Description  
      
        boolean Whether the gcsTrainingInput field is set.
 
     
  
  hashCode() 
  
  
    
      
        Returns  
      
        Type Description  
      
        int  
     
  
  Overrides 
  
  internalGetFieldAccessorTable() 
  
    
protected   GeneratedMessageV3 . FieldAccessorTable   internalGetFieldAccessorTable ()  
  
  Overrides 
  
  isInitialized() 
  
    
public   final   boolean   isInitialized ()  
  
  Overrides 
  
  newBuilderForType() 
  
    
public   TrainCustomModelRequest . Builder   newBuilderForType ()  
  
  newBuilderForType(GeneratedMessageV3.BuilderParent parent) 
  
    
protected   TrainCustomModelRequest . Builder   newBuilderForType ( GeneratedMessageV3 . BuilderParent   parent )  
  
  
  Overrides 
  
  newInstance(GeneratedMessageV3.UnusedPrivateParameter unused) 
  
    
protected   Object   newInstance ( GeneratedMessageV3 . UnusedPrivateParameter   unused )  
  
  
    
      
        Returns  
      
        Type Description  
      
        Object  
     
  
  Overrides 
  
  toBuilder() 
  
    
public   TrainCustomModelRequest . Builder   toBuilder ()  
  
  writeTo(CodedOutputStream output) 
  
    
public   void   writeTo ( CodedOutputStream   output )  
  
  Overrides 
  
  
 
     
    
  
  
  
     
  
    
    
      
       
         
  
  
    
    Send feedback
  
   
 
       
    
    
  
  
 
  Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
  Last updated 2025-10-29 UTC.
 
 
  
  
    
    
    
      
  
  
    Need to tell us more?
  
   
 
     
  
  
    
      [[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-29 UTC."],[],[]]