com.google.cloud.discoveryengine.v1alpha

Class TrainCustomModelRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.discoveryengine.v1alpha.TrainCustomModelRequest

All Implemented Interfaces:

TrainCustomModelRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class TrainCustomModelRequest
extends com.google.protobuf.GeneratedMessageV3
implements TrainCustomModelRequestOrBuilder

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

Protobuf type google.cloud.discoveryengine.v1alpha.TrainCustomModelRequest

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TrainCustomModelRequest.Builder Request message for [SearchTuningService.TrainCustomModel][google.cloud.discoveryengine.v1alpha.SearchTuningService.TrainCustomModel] method.
static class	TrainCustomModelRequest.GcsTrainingInput Cloud Storage training data input.
static interface	TrainCustomModelRequest.GcsTrainingInputOrBuilder
static class	TrainCustomModelRequest.TrainingInputCase

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	DATA_STORE_FIELD_NUMBER
static int	ERROR_CONFIG_FIELD_NUMBER
static int	GCS_TRAINING_INPUT_FIELD_NUMBER
static int	MODEL_ID_FIELD_NUMBER
static int	MODEL_TYPE_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getDataStore() Required.
com.google.protobuf.ByteString	getDataStoreBytes() Required.
static TrainCustomModelRequest	getDefaultInstance()
TrainCustomModelRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
ImportErrorConfig	getErrorConfig() 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.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.
com.google.protobuf.Parser<TrainCustomModelRequest>	getParserForType()
int	getSerializedSize()
TrainCustomModelRequest.TrainingInputCase	getTrainingInputCase()
boolean	hasErrorConfig() The desired location of errors incurred during the data ingestion and training.
boolean	hasGcsTrainingInput() Cloud Storage training input.
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static TrainCustomModelRequest.Builder	newBuilder()
static TrainCustomModelRequest.Builder	newBuilder(TrainCustomModelRequest prototype)
TrainCustomModelRequest.Builder	newBuilderForType()
protected TrainCustomModelRequest.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static TrainCustomModelRequest	parseDelimitedFrom(InputStream input)
static TrainCustomModelRequest	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static TrainCustomModelRequest	parseFrom(byte[] data)
static TrainCustomModelRequest	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static TrainCustomModelRequest	parseFrom(ByteBuffer data)
static TrainCustomModelRequest	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static TrainCustomModelRequest	parseFrom(com.google.protobuf.ByteString data)
static TrainCustomModelRequest	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static TrainCustomModelRequest	parseFrom(com.google.protobuf.CodedInputStream input)
static TrainCustomModelRequest	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static TrainCustomModelRequest	parseFrom(InputStream input)
static TrainCustomModelRequest	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<TrainCustomModelRequest>	parser()
TrainCustomModelRequest.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

GCS_TRAINING_INPUT_FIELD_NUMBER

public static final int GCS_TRAINING_INPUT_FIELD_NUMBER

See Also:

Constant Field Values

DATA_STORE_FIELD_NUMBER

public static final int DATA_STORE_FIELD_NUMBER

See Also:

Constant Field Values

MODEL_TYPE_FIELD_NUMBER

public static final int MODEL_TYPE_FIELD_NUMBER

See Also:

Constant Field Values

ERROR_CONFIG_FIELD_NUMBER

public static final int ERROR_CONFIG_FIELD_NUMBER

See Also:

Constant Field Values

MODEL_ID_FIELD_NUMBER

public static final int MODEL_ID_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

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

getTrainingInputCase

public TrainCustomModelRequest.TrainingInputCase getTrainingInputCase()

Specified by:

getTrainingInputCase in interface TrainCustomModelRequestOrBuilder

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.

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.

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.

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.

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.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static TrainCustomModelRequest parseFrom(ByteBuffer data)
                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static TrainCustomModelRequest parseFrom(ByteBuffer data,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static TrainCustomModelRequest parseFrom(com.google.protobuf.ByteString data)
                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static TrainCustomModelRequest parseFrom(com.google.protobuf.ByteString data,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static TrainCustomModelRequest parseFrom(byte[] data)
                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static TrainCustomModelRequest parseFrom(byte[] data,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static TrainCustomModelRequest parseFrom(InputStream input)
                                         throws IOException

Throws:

IOException

parseFrom

public static TrainCustomModelRequest parseFrom(InputStream input,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws IOException

Throws:

IOException

parseDelimitedFrom

public static TrainCustomModelRequest parseDelimitedFrom(InputStream input)
                                                  throws IOException

Throws:

IOException

parseDelimitedFrom

public static TrainCustomModelRequest parseDelimitedFrom(InputStream input,
                                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                  throws IOException

Throws:

IOException

parseFrom

public static TrainCustomModelRequest parseFrom(com.google.protobuf.CodedInputStream input)
                                         throws IOException

Throws:

IOException

parseFrom

public static TrainCustomModelRequest parseFrom(com.google.protobuf.CodedInputStream input,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws IOException

Throws:

IOException

newBuilderForType

public TrainCustomModelRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static TrainCustomModelRequest.Builder newBuilder()

newBuilder

public static TrainCustomModelRequest.Builder newBuilder(TrainCustomModelRequest prototype)

toBuilder

public TrainCustomModelRequest.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected TrainCustomModelRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static TrainCustomModelRequest getDefaultInstance()

parser

public static com.google.protobuf.Parser<TrainCustomModelRequest> parser()

getParserForType

public com.google.protobuf.Parser<TrainCustomModelRequest> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public TrainCustomModelRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder