Class TrainCustomModelResponse.Builder (0.45.0)

public static final class TrainCustomModelResponse.Builder extends GeneratedMessageV3.Builder<TrainCustomModelResponse.Builder> implements TrainCustomModelResponseOrBuilder

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

Protobuf type google.cloud.discoveryengine.v1alpha.TrainCustomModelResponse

Static Methods

getDescriptor()

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

Methods

addAllErrorSamples(Iterable<? extends Status> values)

public TrainCustomModelResponse.Builder addAllErrorSamples(Iterable<? extends Status> values)

A sample of errors encountered while processing the data.

repeated .google.rpc.Status error_samples = 1;

Parameter
Name Description
values Iterable<? extends com.google.rpc.Status>
Returns
Type Description
TrainCustomModelResponse.Builder

addErrorSamples(Status value)

public TrainCustomModelResponse.Builder addErrorSamples(Status value)

A sample of errors encountered while processing the data.

repeated .google.rpc.Status error_samples = 1;

Parameter
Name Description
value com.google.rpc.Status
Returns
Type Description
TrainCustomModelResponse.Builder

addErrorSamples(Status.Builder builderForValue)

public TrainCustomModelResponse.Builder addErrorSamples(Status.Builder builderForValue)

A sample of errors encountered while processing the data.

repeated .google.rpc.Status error_samples = 1;

Parameter
Name Description
builderForValue com.google.rpc.Status.Builder
Returns
Type Description
TrainCustomModelResponse.Builder

addErrorSamples(int index, Status value)

public TrainCustomModelResponse.Builder addErrorSamples(int index, Status value)

A sample of errors encountered while processing the data.

repeated .google.rpc.Status error_samples = 1;

Parameters
Name Description
index int
value com.google.rpc.Status
Returns
Type Description
TrainCustomModelResponse.Builder

addErrorSamples(int index, Status.Builder builderForValue)

public TrainCustomModelResponse.Builder addErrorSamples(int index, Status.Builder builderForValue)

A sample of errors encountered while processing the data.

repeated .google.rpc.Status error_samples = 1;

Parameters
Name Description
index int
builderForValue com.google.rpc.Status.Builder
Returns
Type Description
TrainCustomModelResponse.Builder

addErrorSamplesBuilder()

public Status.Builder addErrorSamplesBuilder()

A sample of errors encountered while processing the data.

repeated .google.rpc.Status error_samples = 1;

Returns
Type Description
com.google.rpc.Status.Builder

addErrorSamplesBuilder(int index)

public Status.Builder addErrorSamplesBuilder(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.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public TrainCustomModelResponse.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
TrainCustomModelResponse.Builder
Overrides

build()

public TrainCustomModelResponse build()
Returns
Type Description
TrainCustomModelResponse

buildPartial()

public TrainCustomModelResponse buildPartial()
Returns
Type Description
TrainCustomModelResponse

clear()

public TrainCustomModelResponse.Builder clear()
Returns
Type Description
TrainCustomModelResponse.Builder
Overrides

clearErrorConfig()

public TrainCustomModelResponse.Builder clearErrorConfig()

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

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

Returns
Type Description
TrainCustomModelResponse.Builder

clearErrorSamples()

public TrainCustomModelResponse.Builder clearErrorSamples()

A sample of errors encountered while processing the data.

repeated .google.rpc.Status error_samples = 1;

Returns
Type Description
TrainCustomModelResponse.Builder

clearField(Descriptors.FieldDescriptor field)

public TrainCustomModelResponse.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
TrainCustomModelResponse.Builder
Overrides

clearMetrics()

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

clearModelName()

public TrainCustomModelResponse.Builder clearModelName()

Fully qualified name of the CustomTuningModel.

string model_name = 5;

Returns
Type Description
TrainCustomModelResponse.Builder

This builder for chaining.

clearModelStatus()

public TrainCustomModelResponse.Builder clearModelStatus()

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
TrainCustomModelResponse.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public TrainCustomModelResponse.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
TrainCustomModelResponse.Builder
Overrides

clone()

public TrainCustomModelResponse.Builder clone()
Returns
Type Description
TrainCustomModelResponse.Builder
Overrides

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

getDefaultInstanceForType()

public TrainCustomModelResponse getDefaultInstanceForType()
Returns
Type Description
TrainCustomModelResponse

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

getErrorConfigBuilder()

public ImportErrorConfig.Builder getErrorConfigBuilder()

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

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

Returns
Type Description
ImportErrorConfig.Builder

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

getErrorSamplesBuilder(int index)

public Status.Builder getErrorSamplesBuilder(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.Builder

getErrorSamplesBuilderList()

public List<Status.Builder> getErrorSamplesBuilderList()

A sample of errors encountered while processing the data.

repeated .google.rpc.Status error_samples = 1;

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

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

getModelName()

public String getModelName()

Fully qualified name of the CustomTuningModel.

string model_name = 5;

Returns
Type Description
String

The modelName.

getModelNameBytes()

public ByteString getModelNameBytes()

Fully qualified name of the CustomTuningModel.

string model_name = 5;

Returns
Type Description
ByteString

The bytes for modelName.

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.

getMutableMetrics() (deprecated)

public Map<String,Double> getMutableMetrics()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,Double>

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.

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.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeErrorConfig(ImportErrorConfig value)

public TrainCustomModelResponse.Builder mergeErrorConfig(ImportErrorConfig value)

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

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

Parameter
Name Description
value ImportErrorConfig
Returns
Type Description
TrainCustomModelResponse.Builder

mergeFrom(TrainCustomModelResponse other)

public TrainCustomModelResponse.Builder mergeFrom(TrainCustomModelResponse other)
Parameter
Name Description
other TrainCustomModelResponse
Returns
Type Description
TrainCustomModelResponse.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public TrainCustomModelResponse.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TrainCustomModelResponse.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public TrainCustomModelResponse.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
TrainCustomModelResponse.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final TrainCustomModelResponse.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
TrainCustomModelResponse.Builder
Overrides

putAllMetrics(Map<String,Double> values)

public TrainCustomModelResponse.Builder putAllMetrics(Map<String,Double> values)

The metrics of the trained model.

map<string, double> metrics = 4;

Parameter
Name Description
values Map<String,Double>
Returns
Type Description
TrainCustomModelResponse.Builder

putMetrics(String key, double value)

public TrainCustomModelResponse.Builder putMetrics(String key, double value)

The metrics of the trained model.

map<string, double> metrics = 4;

Parameters
Name Description
key String
value double
Returns
Type Description
TrainCustomModelResponse.Builder

removeErrorSamples(int index)

public TrainCustomModelResponse.Builder removeErrorSamples(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
TrainCustomModelResponse.Builder

removeMetrics(String key)

public TrainCustomModelResponse.Builder removeMetrics(String key)

The metrics of the trained model.

map<string, double> metrics = 4;

Parameter
Name Description
key String
Returns
Type Description
TrainCustomModelResponse.Builder

setErrorConfig(ImportErrorConfig value)

public TrainCustomModelResponse.Builder setErrorConfig(ImportErrorConfig value)

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

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

Parameter
Name Description
value ImportErrorConfig
Returns
Type Description
TrainCustomModelResponse.Builder

setErrorConfig(ImportErrorConfig.Builder builderForValue)

public TrainCustomModelResponse.Builder setErrorConfig(ImportErrorConfig.Builder builderForValue)

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

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

Parameter
Name Description
builderForValue ImportErrorConfig.Builder
Returns
Type Description
TrainCustomModelResponse.Builder

setErrorSamples(int index, Status value)

public TrainCustomModelResponse.Builder setErrorSamples(int index, Status value)

A sample of errors encountered while processing the data.

repeated .google.rpc.Status error_samples = 1;

Parameters
Name Description
index int
value com.google.rpc.Status
Returns
Type Description
TrainCustomModelResponse.Builder

setErrorSamples(int index, Status.Builder builderForValue)

public TrainCustomModelResponse.Builder setErrorSamples(int index, Status.Builder builderForValue)

A sample of errors encountered while processing the data.

repeated .google.rpc.Status error_samples = 1;

Parameters
Name Description
index int
builderForValue com.google.rpc.Status.Builder
Returns
Type Description
TrainCustomModelResponse.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public TrainCustomModelResponse.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
TrainCustomModelResponse.Builder
Overrides

setModelName(String value)

public TrainCustomModelResponse.Builder setModelName(String value)

Fully qualified name of the CustomTuningModel.

string model_name = 5;

Parameter
Name Description
value String

The modelName to set.

Returns
Type Description
TrainCustomModelResponse.Builder

This builder for chaining.

setModelNameBytes(ByteString value)

public TrainCustomModelResponse.Builder setModelNameBytes(ByteString value)

Fully qualified name of the CustomTuningModel.

string model_name = 5;

Parameter
Name Description
value ByteString

The bytes for modelName to set.

Returns
Type Description
TrainCustomModelResponse.Builder

This builder for chaining.

setModelStatus(String value)

public TrainCustomModelResponse.Builder setModelStatus(String value)

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;

Parameter
Name Description
value String

The modelStatus to set.

Returns
Type Description
TrainCustomModelResponse.Builder

This builder for chaining.

setModelStatusBytes(ByteString value)

public TrainCustomModelResponse.Builder setModelStatusBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for modelStatus to set.

Returns
Type Description
TrainCustomModelResponse.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public TrainCustomModelResponse.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
TrainCustomModelResponse.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final TrainCustomModelResponse.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
TrainCustomModelResponse.Builder
Overrides