Package com.google.cloud.discoveryengine.v1beta

Class TrainCustomModelRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.discoveryengine.v1beta.TrainCustomModelRequest
All Implemented Interfaces:
TrainCustomModelRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class TrainCustomModelRequest extends com.google.protobuf.GeneratedMessage implements TrainCustomModelRequestOrBuilder
 Request message for
 [SearchTuningService.TrainCustomModel][google.cloud.discoveryengine.v1beta.SearchTuningService.TrainCustomModel]
 method.
Protobuf type google.cloud.discoveryengine.v1beta.TrainCustomModelRequest
See Also:

  • Field Details

    • GCS_TRAINING_INPUT_FIELD_NUMBER

      public static final int GCS_TRAINING_INPUT_FIELD_NUMBER
      See Also:

    • DATA_STORE_FIELD_NUMBER

      public static final int DATA_STORE_FIELD_NUMBER
      See Also:

    • MODEL_TYPE_FIELD_NUMBER

      public static final int MODEL_TYPE_FIELD_NUMBER
      See Also:

    • ERROR_CONFIG_FIELD_NUMBER

      public static final int ERROR_CONFIG_FIELD_NUMBER
      See Also:

    • MODEL_ID_FIELD_NUMBER

      public static final int MODEL_ID_FIELD_NUMBER
      See Also:

  • 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

    • getTrainingInputCase

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

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

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

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

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

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

    • isInitialized

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

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static TrainCustomModelRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TrainCustomModelRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TrainCustomModelRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TrainCustomModelRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TrainCustomModelRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TrainCustomModelRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TrainCustomModelRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static TrainCustomModelRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static TrainCustomModelRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static TrainCustomModelRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static TrainCustomModelRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static TrainCustomModelRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

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

    • newBuilder

      public static TrainCustomModelRequest.Builder newBuilder()

    • newBuilder

      public static TrainCustomModelRequest.Builder newBuilder(TrainCustomModelRequest prototype)

    • toBuilder

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

    • newBuilderForType

      protected TrainCustomModelRequest.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static TrainCustomModelRequest getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<TrainCustomModelRequest> parser()

    • getParserForType

      public com.google.protobuf.Parser<TrainCustomModelRequest> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

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