Class TrainCustomModelRequest.Builder (0.48.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.v1alpha.TrainCustomModelRequest

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > TrainCustomModelRequest.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public TrainCustomModelRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
TrainCustomModelRequest.Builder
Overrides

build()

public TrainCustomModelRequest build()
Returns
Type Description
TrainCustomModelRequest

buildPartial()

public TrainCustomModelRequest buildPartial()
Returns
Type Description
TrainCustomModelRequest

clear()

public TrainCustomModelRequest.Builder clear()
Returns
Type Description
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
Type Description
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.v1alpha.ImportErrorConfig error_config = 4;

Returns
Type Description
TrainCustomModelRequest.Builder

clearField(Descriptors.FieldDescriptor field)

public TrainCustomModelRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
TrainCustomModelRequest.Builder
Overrides

clearGcsTrainingInput()

public TrainCustomModelRequest.Builder clearGcsTrainingInput()

Cloud Storage training input.

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

Returns
Type Description
TrainCustomModelRequest.Builder

clearModelId()

public TrainCustomModelRequest.Builder clearModelId()

If not provided, a UUID will be generated.

string model_id = 5;

Returns
Type Description
TrainCustomModelRequest.Builder

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
Type Description
TrainCustomModelRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public TrainCustomModelRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
TrainCustomModelRequest.Builder
Overrides

clearTrainingInput()

public TrainCustomModelRequest.Builder clearTrainingInput()
Returns
Type Description
TrainCustomModelRequest.Builder

clone()

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getErrorConfig()

public ImportErrorConfig getErrorConfig()

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

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

Returns
Type Description
ImportErrorConfig

The errorConfig.

getErrorConfigBuilder()

public ImportErrorConfig.Builder getErrorConfigBuilder()

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

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

Returns
Type Description
ImportErrorConfig.Builder

getErrorConfigOrBuilder()

public ImportErrorConfigOrBuilder getErrorConfigOrBuilder()

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

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

Returns
Type Description
ImportErrorConfigOrBuilder

getGcsTrainingInput()

public TrainCustomModelRequest.GcsTrainingInput getGcsTrainingInput()

Cloud Storage training input.

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

Returns
Type Description
TrainCustomModelRequest.GcsTrainingInput

The gcsTrainingInput.

getGcsTrainingInputBuilder()

public TrainCustomModelRequest.GcsTrainingInput.Builder getGcsTrainingInputBuilder()

Cloud Storage training input.

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

Returns
Type Description
TrainCustomModelRequest.GcsTrainingInput.Builder

getGcsTrainingInputOrBuilder()

public TrainCustomModelRequest.GcsTrainingInputOrBuilder getGcsTrainingInputOrBuilder()

Cloud Storage training input.

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

Returns
Type Description
TrainCustomModelRequest.GcsTrainingInputOrBuilder

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.

getTrainingInputCase()

public TrainCustomModelRequest.TrainingInputCase getTrainingInputCase()
Returns
Type Description
TrainCustomModelRequest.TrainingInputCase

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.

hasGcsTrainingInput()

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
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.v1alpha.ImportErrorConfig error_config = 4;

Parameter
Name Description
value ImportErrorConfig
Returns
Type Description
TrainCustomModelRequest.Builder

mergeFrom(TrainCustomModelRequest other)

public TrainCustomModelRequest.Builder mergeFrom(TrainCustomModelRequest other)
Parameter
Name Description
other TrainCustomModelRequest
Returns
Type Description
TrainCustomModelRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public TrainCustomModelRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TrainCustomModelRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public TrainCustomModelRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
TrainCustomModelRequest.Builder
Overrides

mergeGcsTrainingInput(TrainCustomModelRequest.GcsTrainingInput value)

public TrainCustomModelRequest.Builder mergeGcsTrainingInput(TrainCustomModelRequest.GcsTrainingInput value)

Cloud Storage training input.

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

Parameter
Name Description
value TrainCustomModelRequest.GcsTrainingInput
Returns
Type Description
TrainCustomModelRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final TrainCustomModelRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
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
Name Description
value String

The dataStore to set.
Returns
Type Description
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
Name Description
value ByteString

The bytes for dataStore to set.
Returns
Type Description
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.v1alpha.ImportErrorConfig error_config = 4;

Parameter
Name Description
value ImportErrorConfig
Returns
Type Description
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.v1alpha.ImportErrorConfig error_config = 4;

Parameter
Name Description
builderForValue ImportErrorConfig.Builder
Returns
Type Description
TrainCustomModelRequest.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public TrainCustomModelRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
TrainCustomModelRequest.Builder
Overrides

setGcsTrainingInput(TrainCustomModelRequest.GcsTrainingInput value)

public TrainCustomModelRequest.Builder setGcsTrainingInput(TrainCustomModelRequest.GcsTrainingInput value)

Cloud Storage training input.

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

Parameter
Name Description
value TrainCustomModelRequest.GcsTrainingInput
Returns
Type Description
TrainCustomModelRequest.Builder

setGcsTrainingInput(TrainCustomModelRequest.GcsTrainingInput.Builder builderForValue)

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

Cloud Storage training input.

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

Parameter
Name Description
builderForValue TrainCustomModelRequest.GcsTrainingInput.Builder
Returns
Type Description
TrainCustomModelRequest.Builder

setModelId(String value)

public TrainCustomModelRequest.Builder setModelId(String value)

If not provided, a UUID will be generated.

string model_id = 5;

Parameter
Name Description
value String

The modelId to set.
Returns
Type Description
TrainCustomModelRequest.Builder

This builder for chaining.

setModelIdBytes(ByteString value)

public TrainCustomModelRequest.Builder setModelIdBytes(ByteString value)

If not provided, a UUID will be generated.

string model_id = 5;

Parameter
Name Description
value ByteString

The bytes for modelId to set.
Returns
Type Description
TrainCustomModelRequest.Builder

This builder for chaining.

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
Name Description
value String

The modelType to set.
Returns
Type Description
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
Name Description
value ByteString

The bytes for modelType to set.
Returns
Type Description
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
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
TrainCustomModelRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final TrainCustomModelRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
TrainCustomModelRequest.Builder
Overrides