com.google.cloud.discoveryengine.v1alpha

Class TrainCustomModelRequest.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessageV3.Builder<TrainCustomModelRequest.Builder>

com.google.cloud.discoveryengine.v1alpha.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.GeneratedMessageV3.Builder<TrainCustomModelRequest.Builder>
implements TrainCustomModelRequestOrBuilder

 Request message for
 [SearchTuningService.TrainCustomModel][google.cloud.discoveryengine.v1alpha.SearchTuningService.TrainCustomModel]
 method.
 

Protobuf type google.cloud.discoveryengine.v1alpha.TrainCustomModelRequest

Method Summary

Modifier and Type	Method and Description
TrainCustomModelRequest.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
TrainCustomModelRequest	build()
TrainCustomModelRequest	buildPartial()
TrainCustomModelRequest.Builder	clear()
TrainCustomModelRequest.Builder	clearDataStore() Required.
TrainCustomModelRequest.Builder	clearErrorConfig() The desired location of errors incurred during the data ingestion and training.
TrainCustomModelRequest.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
TrainCustomModelRequest.Builder	clearGcsTrainingInput() Cloud Storage training input.
TrainCustomModelRequest.Builder	clearModelId() If not provided, a UUID will be generated.
TrainCustomModelRequest.Builder	clearModelType() Model to be trained.
TrainCustomModelRequest.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
TrainCustomModelRequest.Builder	clearTrainingInput()
TrainCustomModelRequest.Builder	clone()
String	getDataStore() Required.
com.google.protobuf.ByteString	getDataStoreBytes() Required.
TrainCustomModelRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
ImportErrorConfig	getErrorConfig() The desired location of errors incurred during the data ingestion and training.
ImportErrorConfig.Builder	getErrorConfigBuilder() The desired location of errors incurred during the data ingestion and training.
ImportErrorConfigOrBuilder	getErrorConfigOrBuilder() The desired location of errors incurred during the data ingestion and training.
TrainCustomModelRequest.GcsTrainingInput	getGcsTrainingInput() Cloud Storage training input.
TrainCustomModelRequest.GcsTrainingInput.Builder	getGcsTrainingInputBuilder() Cloud Storage training input.
TrainCustomModelRequest.GcsTrainingInputOrBuilder	getGcsTrainingInputOrBuilder() Cloud Storage training input.
String	getModelId() If not provided, a UUID will be generated.
com.google.protobuf.ByteString	getModelIdBytes() If not provided, a UUID will be generated.
String	getModelType() Model to be trained.
com.google.protobuf.ByteString	getModelTypeBytes() Model to be trained.
TrainCustomModelRequest.TrainingInputCase	getTrainingInputCase()
boolean	hasErrorConfig() The desired location of errors incurred during the data ingestion and training.
boolean	hasGcsTrainingInput() Cloud Storage training input.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
TrainCustomModelRequest.Builder	mergeErrorConfig(ImportErrorConfig value) The desired location of errors incurred during the data ingestion and training.
TrainCustomModelRequest.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
TrainCustomModelRequest.Builder	mergeFrom(com.google.protobuf.Message other)
TrainCustomModelRequest.Builder	mergeFrom(TrainCustomModelRequest other)
TrainCustomModelRequest.Builder	mergeGcsTrainingInput(TrainCustomModelRequest.GcsTrainingInput value) Cloud Storage training input.
TrainCustomModelRequest.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
TrainCustomModelRequest.Builder	setDataStore(String value) Required.
TrainCustomModelRequest.Builder	setDataStoreBytes(com.google.protobuf.ByteString value) Required.
TrainCustomModelRequest.Builder	setErrorConfig(ImportErrorConfig.Builder builderForValue) The desired location of errors incurred during the data ingestion and training.
TrainCustomModelRequest.Builder	setErrorConfig(ImportErrorConfig value) The desired location of errors incurred during the data ingestion and training.
TrainCustomModelRequest.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
TrainCustomModelRequest.Builder	setGcsTrainingInput(TrainCustomModelRequest.GcsTrainingInput.Builder builderForValue) Cloud Storage training input.
TrainCustomModelRequest.Builder	setGcsTrainingInput(TrainCustomModelRequest.GcsTrainingInput value) Cloud Storage training input.
TrainCustomModelRequest.Builder	setModelId(String value) If not provided, a UUID will be generated.
TrainCustomModelRequest.Builder	setModelIdBytes(com.google.protobuf.ByteString value) If not provided, a UUID will be generated.
TrainCustomModelRequest.Builder	setModelType(String value) Model to be trained.
TrainCustomModelRequest.Builder	setModelTypeBytes(com.google.protobuf.ByteString value) Model to be trained.
TrainCustomModelRequest.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
TrainCustomModelRequest.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Method Detail

getDescriptor

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

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.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.GeneratedMessageV3.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.GeneratedMessageV3.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

clone

public TrainCustomModelRequest.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<TrainCustomModelRequest.Builder>

setField

public TrainCustomModelRequest.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<TrainCustomModelRequest.Builder>

clearField

public TrainCustomModelRequest.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<TrainCustomModelRequest.Builder>

clearOneof

public TrainCustomModelRequest.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<TrainCustomModelRequest.Builder>

setRepeatedField

public TrainCustomModelRequest.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                        int index,
                                                        Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<TrainCustomModelRequest.Builder>

addRepeatedField

public TrainCustomModelRequest.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                        Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<TrainCustomModelRequest.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.GeneratedMessageV3.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.v1alpha.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.v1alpha.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.v1alpha.TrainCustomModelRequest.GcsTrainingInput gcs_training_input = 2;

setGcsTrainingInput

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

 Cloud Storage training input.
 

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

mergeGcsTrainingInput

public TrainCustomModelRequest.Builder mergeGcsTrainingInput(TrainCustomModelRequest.GcsTrainingInput value)

 Cloud Storage training input.
 

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

clearGcsTrainingInput

public TrainCustomModelRequest.Builder clearGcsTrainingInput()

 Cloud Storage training input.
 

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

getGcsTrainingInputBuilder

public TrainCustomModelRequest.GcsTrainingInput.Builder getGcsTrainingInputBuilder()

 Cloud Storage training input.
 

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

getGcsTrainingInputOrBuilder

public TrainCustomModelRequest.GcsTrainingInputOrBuilder getGcsTrainingInputOrBuilder()

 Cloud Storage training input.
 

.google.cloud.discoveryengine.v1alpha.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.v1alpha.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.v1alpha.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.v1alpha.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.v1alpha.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.v1alpha.ImportErrorConfig error_config = 4;

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;

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;

getErrorConfigOrBuilder

public ImportErrorConfigOrBuilder getErrorConfigOrBuilder()

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

.google.cloud.discoveryengine.v1alpha.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.

setUnknownFields

public final TrainCustomModelRequest.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<TrainCustomModelRequest.Builder>

mergeUnknownFields

public final TrainCustomModelRequest.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<TrainCustomModelRequest.Builder>