Class TrainCustomModelRequest.Builder (0.37.0)

public static final class TrainCustomModelRequest.Builder extends GeneratedMessageV3.Builder<TrainCustomModelRequest.Builder> implements TrainCustomModelRequestOrBuilder

Request message for SearchTuningService.TrainCustomModel method.

Protobuf type google.cloud.discoveryengine.v1beta.TrainCustomModelRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public TrainCustomModelRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
TrainCustomModelRequest.Builder
Overrides

build()

public TrainCustomModelRequest build()
Returns
TypeDescription
TrainCustomModelRequest

buildPartial()

public TrainCustomModelRequest buildPartial()
Returns
TypeDescription
TrainCustomModelRequest

clear()

public TrainCustomModelRequest.Builder clear()
Returns
TypeDescription
TrainCustomModelRequest.Builder
Overrides

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

This builder for chaining.

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;

Returns
TypeDescription
TrainCustomModelRequest.Builder

clearField(Descriptors.FieldDescriptor field)

public TrainCustomModelRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
TrainCustomModelRequest.Builder
Overrides

clearGcsTrainingInput()

public TrainCustomModelRequest.Builder clearGcsTrainingInput()

Cloud Storage training input.

.google.cloud.discoveryengine.v1beta.TrainCustomModelRequest.GcsTrainingInput gcs_training_input = 2;

Returns
TypeDescription
TrainCustomModelRequest.Builder

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

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public TrainCustomModelRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
TrainCustomModelRequest.Builder
Overrides

clearTrainingInput()

public TrainCustomModelRequest.Builder clearTrainingInput()
Returns
TypeDescription
TrainCustomModelRequest.Builder

clone()

public TrainCustomModelRequest.Builder clone()
Returns
TypeDescription
TrainCustomModelRequest.Builder
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
TypeDescription
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
TypeDescription
ByteString

The bytes for dataStore.

getDefaultInstanceForType()

public TrainCustomModelRequest getDefaultInstanceForType()
Returns
TypeDescription
TrainCustomModelRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getErrorConfig()

public ImportErrorConfig getErrorConfig()

The desired location of errors incurred during the data ingestion and training.

.google.cloud.discoveryengine.v1beta.ImportErrorConfig error_config = 4;

Returns
TypeDescription
ImportErrorConfig

The errorConfig.

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;

Returns
TypeDescription
ImportErrorConfig.Builder

getErrorConfigOrBuilder()

public ImportErrorConfigOrBuilder getErrorConfigOrBuilder()

The desired location of errors incurred during the data ingestion and training.

.google.cloud.discoveryengine.v1beta.ImportErrorConfig error_config = 4;

Returns
TypeDescription
ImportErrorConfigOrBuilder

getGcsTrainingInput()

public TrainCustomModelRequest.GcsTrainingInput getGcsTrainingInput()

Cloud Storage training input.

.google.cloud.discoveryengine.v1beta.TrainCustomModelRequest.GcsTrainingInput gcs_training_input = 2;

Returns
TypeDescription
TrainCustomModelRequest.GcsTrainingInput

The gcsTrainingInput.

getGcsTrainingInputBuilder()

public TrainCustomModelRequest.GcsTrainingInput.Builder getGcsTrainingInputBuilder()

Cloud Storage training input.

.google.cloud.discoveryengine.v1beta.TrainCustomModelRequest.GcsTrainingInput gcs_training_input = 2;

Returns
TypeDescription
TrainCustomModelRequest.GcsTrainingInput.Builder

getGcsTrainingInputOrBuilder()

public TrainCustomModelRequest.GcsTrainingInputOrBuilder getGcsTrainingInputOrBuilder()

Cloud Storage training input.

.google.cloud.discoveryengine.v1beta.TrainCustomModelRequest.GcsTrainingInput gcs_training_input = 2;

Returns
TypeDescription
TrainCustomModelRequest.GcsTrainingInputOrBuilder

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
TypeDescription
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
TypeDescription
ByteString

The bytes for modelType.

getTrainingInputCase()

public TrainCustomModelRequest.TrainingInputCase getTrainingInputCase()
Returns
TypeDescription
TrainCustomModelRequest.TrainingInputCase

hasErrorConfig()

public boolean hasErrorConfig()

The desired location of errors incurred during the data ingestion and training.

.google.cloud.discoveryengine.v1beta.ImportErrorConfig error_config = 4;

Returns
TypeDescription
boolean

Whether the errorConfig field is set.

hasGcsTrainingInput()

public boolean hasGcsTrainingInput()

Cloud Storage training input.

.google.cloud.discoveryengine.v1beta.TrainCustomModelRequest.GcsTrainingInput gcs_training_input = 2;

Returns
TypeDescription
boolean

Whether the gcsTrainingInput field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeErrorConfig(ImportErrorConfig value)

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;

Parameter
NameDescription
valueImportErrorConfig
Returns
TypeDescription
TrainCustomModelRequest.Builder

mergeFrom(TrainCustomModelRequest other)

public TrainCustomModelRequest.Builder mergeFrom(TrainCustomModelRequest other)
Parameter
NameDescription
otherTrainCustomModelRequest
Returns
TypeDescription
TrainCustomModelRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public TrainCustomModelRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TrainCustomModelRequest.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public TrainCustomModelRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
TrainCustomModelRequest.Builder
Overrides

mergeGcsTrainingInput(TrainCustomModelRequest.GcsTrainingInput value)

public TrainCustomModelRequest.Builder mergeGcsTrainingInput(TrainCustomModelRequest.GcsTrainingInput value)

Cloud Storage training input.

.google.cloud.discoveryengine.v1beta.TrainCustomModelRequest.GcsTrainingInput gcs_training_input = 2;

Parameter
NameDescription
valueTrainCustomModelRequest.GcsTrainingInput
Returns
TypeDescription
TrainCustomModelRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final TrainCustomModelRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
TrainCustomModelRequest.Builder
Overrides

setDataStore(String value)

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) = { ... }

Parameter
NameDescription
valueString

The dataStore to set.

Returns
TypeDescription
TrainCustomModelRequest.Builder

This builder for chaining.

setDataStoreBytes(ByteString value)

public TrainCustomModelRequest.Builder setDataStoreBytes(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) = { ... }

Parameter
NameDescription
valueByteString

The bytes for dataStore to set.

Returns
TypeDescription
TrainCustomModelRequest.Builder

This builder for chaining.

setErrorConfig(ImportErrorConfig value)

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;

Parameter
NameDescription
valueImportErrorConfig
Returns
TypeDescription
TrainCustomModelRequest.Builder

setErrorConfig(ImportErrorConfig.Builder builderForValue)

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;

Parameter
NameDescription
builderForValueImportErrorConfig.Builder
Returns
TypeDescription
TrainCustomModelRequest.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public TrainCustomModelRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
TrainCustomModelRequest.Builder
Overrides

setGcsTrainingInput(TrainCustomModelRequest.GcsTrainingInput value)

public TrainCustomModelRequest.Builder setGcsTrainingInput(TrainCustomModelRequest.GcsTrainingInput value)

Cloud Storage training input.

.google.cloud.discoveryengine.v1beta.TrainCustomModelRequest.GcsTrainingInput gcs_training_input = 2;

Parameter
NameDescription
valueTrainCustomModelRequest.GcsTrainingInput
Returns
TypeDescription
TrainCustomModelRequest.Builder

setGcsTrainingInput(TrainCustomModelRequest.GcsTrainingInput.Builder builderForValue)

public TrainCustomModelRequest.Builder setGcsTrainingInput(TrainCustomModelRequest.GcsTrainingInput.Builder builderForValue)

Cloud Storage training input.

.google.cloud.discoveryengine.v1beta.TrainCustomModelRequest.GcsTrainingInput gcs_training_input = 2;

Parameter
NameDescription
builderForValueTrainCustomModelRequest.GcsTrainingInput.Builder
Returns
TypeDescription
TrainCustomModelRequest.Builder

setModelType(String value)

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;

Parameter
NameDescription
valueString

The modelType to set.

Returns
TypeDescription
TrainCustomModelRequest.Builder

This builder for chaining.

setModelTypeBytes(ByteString value)

public TrainCustomModelRequest.Builder setModelTypeBytes(ByteString value)

Model to be trained. Supported values are:

  • search-tuning: Fine tuning the search system based on data provided.

string model_type = 3;

Parameter
NameDescription
valueByteString

The bytes for modelType to set.

Returns
TypeDescription
TrainCustomModelRequest.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public TrainCustomModelRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
TrainCustomModelRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final TrainCustomModelRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
TrainCustomModelRequest.Builder
Overrides