Class TrainCustomModelRequest (0.42.0)

public final class TrainCustomModelRequest extends GeneratedMessageV3 implements TrainCustomModelRequestOrBuilder

Request message for SearchTuningService.TrainCustomModel method.

Protobuf type google.cloud.discoveryengine.v1beta.TrainCustomModelRequest

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

GCS_TRAINING_INPUT_FIELD_NUMBER

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()
Returns
Type Description
TrainCustomModelRequest

getDescriptor()

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

newBuilder()

public static TrainCustomModelRequest.Builder newBuilder()
Returns
Type Description
TrainCustomModelRequest.Builder

newBuilder(TrainCustomModelRequest prototype)

public static TrainCustomModelRequest.Builder newBuilder(TrainCustomModelRequest prototype)
Parameter
Name Description
prototype TrainCustomModelRequest
Returns
Type Description
TrainCustomModelRequest.Builder

parseDelimitedFrom(InputStream input)

public static TrainCustomModelRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
TrainCustomModelRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TrainCustomModelRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TrainCustomModelRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static TrainCustomModelRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
TrainCustomModelRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static TrainCustomModelRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TrainCustomModelRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static TrainCustomModelRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
TrainCustomModelRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static TrainCustomModelRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TrainCustomModelRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static TrainCustomModelRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
TrainCustomModelRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static TrainCustomModelRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TrainCustomModelRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static TrainCustomModelRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
TrainCustomModelRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TrainCustomModelRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TrainCustomModelRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static TrainCustomModelRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
TrainCustomModelRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static TrainCustomModelRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TrainCustomModelRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<TrainCustomModelRequest> parser()
Returns
Type Description
Parser<TrainCustomModelRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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

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
Type Description
ImportErrorConfig

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;

Returns
Type Description
ImportErrorConfigOrBuilder

getGcsTrainingInput()

public TrainCustomModelRequest.GcsTrainingInput getGcsTrainingInput()

Cloud Storage training input.

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

Returns
Type Description
TrainCustomModelRequest.GcsTrainingInput

The gcsTrainingInput.

getGcsTrainingInputOrBuilder()

public TrainCustomModelRequest.GcsTrainingInputOrBuilder getGcsTrainingInputOrBuilder()

Cloud Storage training input.

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

getParserForType()

public Parser<TrainCustomModelRequest> getParserForType()
Returns
Type Description
Parser<TrainCustomModelRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.v1beta.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.v1beta.TrainCustomModelRequest.GcsTrainingInput gcs_training_input = 2;

Returns
Type Description
boolean

Whether the gcsTrainingInput field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected TrainCustomModelRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
TrainCustomModelRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException