Class TrainCustomModelRequest (0.43.0)

Version 0.43.0

• 0.51.0 (latest)
• 0.50.0
• 0.49.0
• 0.48.0
• 0.47.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

public final class TrainCustomModelRequest extends GeneratedMessageV3 implements TrainCustomModelRequestOrBuilder

Request message for SearchTuningService.TrainCustomModel method.

Protobuf type google.cloud.discoveryengine.v1beta.TrainCustomModelRequest

Inheritance

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

Implements

TrainCustomModelRequestOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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

AbstractMessage.equals(Object other)

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

GeneratedMessageV3.getParserForType()

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

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

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

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

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
unused	UnusedPrivateParameter

Returns
Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public TrainCustomModelRequest.Builder toBuilder()

Returns
Type	Description
TrainCustomModelRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException