Class TrainCustomModelResponse (0.39.0)

public final class TrainCustomModelResponse extends GeneratedMessageV3 implements TrainCustomModelResponseOrBuilder

Response of the TrainCustomModelRequest. This message is returned by the google.longrunning.Operations.response field.

Protobuf type google.cloud.discoveryengine.v1alpha.TrainCustomModelResponse

Inheritance

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

Static Fields

ERROR_CONFIG_FIELD_NUMBER

public static final int ERROR_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

ERROR_SAMPLES_FIELD_NUMBER

public static final int ERROR_SAMPLES_FIELD_NUMBER
Field Value
Type Description
int

METRICS_FIELD_NUMBER

public static final int METRICS_FIELD_NUMBER
Field Value
Type Description
int

MODEL_STATUS_FIELD_NUMBER

public static final int MODEL_STATUS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static TrainCustomModelResponse getDefaultInstance()
Returns
Type Description
TrainCustomModelResponse

getDescriptor()

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

newBuilder()

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

newBuilder(TrainCustomModelResponse prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

containsMetrics(String key)

public boolean containsMetrics(String key)

The metrics of the trained model.

map<string, double> metrics = 4;

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public TrainCustomModelResponse getDefaultInstanceForType()
Returns
Type Description
TrainCustomModelResponse

getErrorConfig()

public ImportErrorConfig getErrorConfig()

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

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

Returns
Type Description
ImportErrorConfig

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;

Returns
Type Description
ImportErrorConfigOrBuilder

getErrorSamples(int index)

public Status getErrorSamples(int index)

A sample of errors encountered while processing the data.

repeated .google.rpc.Status error_samples = 1;

Parameter
Name Description
index int
Returns
Type Description
com.google.rpc.Status

getErrorSamplesCount()

public int getErrorSamplesCount()

A sample of errors encountered while processing the data.

repeated .google.rpc.Status error_samples = 1;

Returns
Type Description
int

getErrorSamplesList()

public List<Status> getErrorSamplesList()

A sample of errors encountered while processing the data.

repeated .google.rpc.Status error_samples = 1;

Returns
Type Description
List<com.google.rpc.Status>

getErrorSamplesOrBuilder(int index)

public StatusOrBuilder getErrorSamplesOrBuilder(int index)

A sample of errors encountered while processing the data.

repeated .google.rpc.Status error_samples = 1;

Parameter
Name Description
index int
Returns
Type Description
com.google.rpc.StatusOrBuilder

getErrorSamplesOrBuilderList()

public List<? extends StatusOrBuilder> getErrorSamplesOrBuilderList()

A sample of errors encountered while processing the data.

repeated .google.rpc.Status error_samples = 1;

Returns
Type Description
List<? extends com.google.rpc.StatusOrBuilder>

getMetrics() (deprecated)

public Map<String,Double> getMetrics()

Use #getMetricsMap() instead.

Returns
Type Description
Map<String,Double>

getMetricsCount()

public int getMetricsCount()

The metrics of the trained model.

map<string, double> metrics = 4;

Returns
Type Description
int

getMetricsMap()

public Map<String,Double> getMetricsMap()

The metrics of the trained model.

map<string, double> metrics = 4;

Returns
Type Description
Map<String,Double>

getMetricsOrDefault(String key, double defaultValue)

public double getMetricsOrDefault(String key, double defaultValue)

The metrics of the trained model.

map<string, double> metrics = 4;

Parameters
Name Description
key String
defaultValue double
Returns
Type Description
double

getMetricsOrThrow(String key)

public double getMetricsOrThrow(String key)

The metrics of the trained model.

map<string, double> metrics = 4;

Parameter
Name Description
key String
Returns
Type Description
double

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;

Returns
Type Description
String

The modelStatus.

getModelStatusBytes()

public 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;

Returns
Type Description
ByteString

The bytes for modelStatus.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasErrorConfig()

public boolean hasErrorConfig()

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

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

Returns
Type Description
boolean

Whether the errorConfig field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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