com.google.cloud.discoveryengine.v1alpha

Class TrainCustomModelResponse

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.discoveryengine.v1alpha.TrainCustomModelResponse

All Implemented Interfaces:

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

public final class TrainCustomModelResponse
extends com.google.protobuf.GeneratedMessageV3
implements TrainCustomModelResponseOrBuilder

 Response of the
 [TrainCustomModelRequest][google.cloud.discoveryengine.v1alpha.TrainCustomModelRequest].
 This message is returned by the google.longrunning.Operations.response field.
 

Protobuf type google.cloud.discoveryengine.v1alpha.TrainCustomModelResponse

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TrainCustomModelResponse.Builder Response of the [TrainCustomModelRequest][google.cloud.discoveryengine.v1alpha.TrainCustomModelRequest].

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	ERROR_CONFIG_FIELD_NUMBER
static int	ERROR_SAMPLES_FIELD_NUMBER
static int	METRICS_FIELD_NUMBER
static int	MODEL_NAME_FIELD_NUMBER
static int	MODEL_STATUS_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	containsMetrics(String key) The metrics of the trained model.
boolean	equals(Object obj)
static TrainCustomModelResponse	getDefaultInstance()
TrainCustomModelResponse	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
ImportErrorConfig	getErrorConfig() Echoes the destination for the complete errors in the request if set.
ImportErrorConfigOrBuilder	getErrorConfigOrBuilder() Echoes the destination for the complete errors in the request if set.
com.google.rpc.Status	getErrorSamples(int index) A sample of errors encountered while processing the data.
int	getErrorSamplesCount() A sample of errors encountered while processing the data.
List<com.google.rpc.Status>	getErrorSamplesList() A sample of errors encountered while processing the data.
com.google.rpc.StatusOrBuilder	getErrorSamplesOrBuilder(int index) A sample of errors encountered while processing the data.
List<? extends com.google.rpc.StatusOrBuilder>	getErrorSamplesOrBuilderList() A sample of errors encountered while processing the data.
Map<String,Double>	getMetrics() Deprecated.
int	getMetricsCount() The metrics of the trained model.
Map<String,Double>	getMetricsMap() The metrics of the trained model.
double	getMetricsOrDefault(String key, double defaultValue) The metrics of the trained model.
double	getMetricsOrThrow(String key) The metrics of the trained model.
String	getModelName() Fully qualified name of the CustomTuningModel.
com.google.protobuf.ByteString	getModelNameBytes() Fully qualified name of the CustomTuningModel.
String	getModelStatus() The trained model status.
com.google.protobuf.ByteString	getModelStatusBytes() The trained model status.
com.google.protobuf.Parser<TrainCustomModelResponse>	getParserForType()
int	getSerializedSize()
boolean	hasErrorConfig() Echoes the destination for the complete errors in the request if set.
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
protected com.google.protobuf.MapFieldReflectionAccessor	internalGetMapFieldReflection(int number)
boolean	isInitialized()
static TrainCustomModelResponse.Builder	newBuilder()
static TrainCustomModelResponse.Builder	newBuilder(TrainCustomModelResponse prototype)
TrainCustomModelResponse.Builder	newBuilderForType()
protected TrainCustomModelResponse.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static TrainCustomModelResponse	parseDelimitedFrom(InputStream input)
static TrainCustomModelResponse	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static TrainCustomModelResponse	parseFrom(byte[] data)
static TrainCustomModelResponse	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static TrainCustomModelResponse	parseFrom(ByteBuffer data)
static TrainCustomModelResponse	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static TrainCustomModelResponse	parseFrom(com.google.protobuf.ByteString data)
static TrainCustomModelResponse	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static TrainCustomModelResponse	parseFrom(com.google.protobuf.CodedInputStream input)
static TrainCustomModelResponse	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static TrainCustomModelResponse	parseFrom(InputStream input)
static TrainCustomModelResponse	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<TrainCustomModelResponse>	parser()
TrainCustomModelResponse.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, 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

ERROR_SAMPLES_FIELD_NUMBER

public static final int ERROR_SAMPLES_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_STATUS_FIELD_NUMBER

public static final int MODEL_STATUS_FIELD_NUMBER

See Also:

Constant Field Values

METRICS_FIELD_NUMBER

public static final int METRICS_FIELD_NUMBER

See Also:

Constant Field Values

MODEL_NAME_FIELD_NUMBER

public static final int MODEL_NAME_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()

internalGetMapFieldReflection

protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)

Overrides:

internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessageV3

internalGetFieldAccessorTable

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

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getErrorSamplesList

public List<com.google.rpc.Status> getErrorSamplesList()

 A sample of errors encountered while processing the data.
 

repeated .google.rpc.Status error_samples = 1;

Specified by:

getErrorSamplesList in interface TrainCustomModelResponseOrBuilder

getErrorSamplesOrBuilderList

public List<? extends com.google.rpc.StatusOrBuilder> getErrorSamplesOrBuilderList()

 A sample of errors encountered while processing the data.
 

repeated .google.rpc.Status error_samples = 1;

Specified by:

getErrorSamplesOrBuilderList in interface TrainCustomModelResponseOrBuilder

getErrorSamplesCount

public int getErrorSamplesCount()

 A sample of errors encountered while processing the data.
 

repeated .google.rpc.Status error_samples = 1;

Specified by:

getErrorSamplesCount in interface TrainCustomModelResponseOrBuilder

getErrorSamples

public com.google.rpc.Status getErrorSamples(int index)

 A sample of errors encountered while processing the data.
 

repeated .google.rpc.Status error_samples = 1;

Specified by:

getErrorSamples in interface TrainCustomModelResponseOrBuilder

getErrorSamplesOrBuilder

public com.google.rpc.StatusOrBuilder getErrorSamplesOrBuilder(int index)

 A sample of errors encountered while processing the data.
 

repeated .google.rpc.Status error_samples = 1;

Specified by:

getErrorSamplesOrBuilder in interface TrainCustomModelResponseOrBuilder

hasErrorConfig

public boolean hasErrorConfig()

 Echoes the destination for the complete errors in the request if set.
 

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

Specified by:

hasErrorConfig in interface TrainCustomModelResponseOrBuilder

Returns:

Whether the errorConfig field is set.

getErrorConfig

public ImportErrorConfig getErrorConfig()

 Echoes the destination for the complete errors in the request if set.
 

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

Specified by:

getErrorConfig in interface TrainCustomModelResponseOrBuilder

Returns:

The errorConfig.

getErrorConfigOrBuilder

public ImportErrorConfigOrBuilder getErrorConfigOrBuilder()

 Echoes the destination for the complete errors in the request if set.
 

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

Specified by:

getErrorConfigOrBuilder in interface TrainCustomModelResponseOrBuilder

getModelStatus

public String getModelStatus()

 The trained model status. Possible values are:

  * **bad-data**: The training data quality is bad.
  * **no-improvement**: Tuning didn't improve performance. Won't deploy.
  * **in-progress**: Model training job creation is in progress.
  * **training**: Model is actively training.
  * **evaluating**: The model is evaluating trained metrics.
  * **indexing**: The model trained metrics are indexing.
  * **ready**: The model is ready for serving.
 

string model_status = 3;

Specified by:

getModelStatus in interface TrainCustomModelResponseOrBuilder

Returns:

The modelStatus.

getModelStatusBytes

public com.google.protobuf.ByteString getModelStatusBytes()

 The trained model status. Possible values are:

  * **bad-data**: The training data quality is bad.
  * **no-improvement**: Tuning didn't improve performance. Won't deploy.
  * **in-progress**: Model training job creation is in progress.
  * **training**: Model is actively training.
  * **evaluating**: The model is evaluating trained metrics.
  * **indexing**: The model trained metrics are indexing.
  * **ready**: The model is ready for serving.
 

string model_status = 3;

Specified by:

getModelStatusBytes in interface TrainCustomModelResponseOrBuilder

Returns:

The bytes for modelStatus.

getMetricsCount

public int getMetricsCount()

Description copied from interface: TrainCustomModelResponseOrBuilder

 The metrics of the trained model.
 

map<string, double> metrics = 4;

Specified by:

getMetricsCount in interface TrainCustomModelResponseOrBuilder

containsMetrics

public boolean containsMetrics(String key)

 The metrics of the trained model.
 

map<string, double> metrics = 4;

Specified by:

containsMetrics in interface TrainCustomModelResponseOrBuilder

getMetrics

@Deprecated
public Map<String,Double> getMetrics()

Deprecated.

Use getMetricsMap() instead.

Specified by:

getMetrics in interface TrainCustomModelResponseOrBuilder

getMetricsMap

public Map<String,Double> getMetricsMap()

 The metrics of the trained model.
 

map<string, double> metrics = 4;

Specified by:

getMetricsMap in interface TrainCustomModelResponseOrBuilder

getMetricsOrDefault

public double getMetricsOrDefault(String key,
                                  double defaultValue)

 The metrics of the trained model.
 

map<string, double> metrics = 4;

Specified by:

getMetricsOrDefault in interface TrainCustomModelResponseOrBuilder

getMetricsOrThrow

public double getMetricsOrThrow(String key)

 The metrics of the trained model.
 

map<string, double> metrics = 4;

Specified by:

getMetricsOrThrow in interface TrainCustomModelResponseOrBuilder

getModelName

public String getModelName()

 Fully qualified name of the CustomTuningModel.
 

string model_name = 5;

Specified by:

getModelName in interface TrainCustomModelResponseOrBuilder

Returns:

The modelName.

getModelNameBytes

public com.google.protobuf.ByteString getModelNameBytes()

 Fully qualified name of the CustomTuningModel.
 

string model_name = 5;

Specified by:

getModelNameBytes in interface TrainCustomModelResponseOrBuilder

Returns:

The bytes for modelName.

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 TrainCustomModelResponse parseFrom(ByteBuffer data)
                                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static TrainCustomModelResponse parseFrom(InputStream input)
                                          throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static TrainCustomModelResponse parseDelimitedFrom(InputStream input)
                                                   throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public TrainCustomModelResponse.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static TrainCustomModelResponse.Builder newBuilder()

newBuilder

public static TrainCustomModelResponse.Builder newBuilder(TrainCustomModelResponse prototype)

toBuilder

public TrainCustomModelResponse.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

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

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static TrainCustomModelResponse getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<TrainCustomModelResponse> 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 TrainCustomModelResponse getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder