Class Evaluation.Builder (0.44.0)

public static final class Evaluation.Builder extends GeneratedMessageV3.Builder<Evaluation.Builder> implements EvaluationOrBuilder

An evaluation is a single execution (or run) of an evaluation process. It encapsulates the state of the evaluation and the resulting data.

Protobuf type google.cloud.discoveryengine.v1beta.Evaluation

Implements

EvaluationOrBuilder

Static Methods

getDescriptor()

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

Methods

addAllErrorSamples(Iterable<? extends Status> values)

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

Output only. A sample of errors encountered while processing the request.

repeated .google.rpc.Status error_samples = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

addErrorSamples(Status value)

public Evaluation.Builder addErrorSamples(Status value)

Output only. A sample of errors encountered while processing the request.

repeated .google.rpc.Status error_samples = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

addErrorSamples(Status.Builder builderForValue)

public Evaluation.Builder addErrorSamples(Status.Builder builderForValue)

Output only. A sample of errors encountered while processing the request.

repeated .google.rpc.Status error_samples = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

addErrorSamples(int index, Status value)

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

Output only. A sample of errors encountered while processing the request.

repeated .google.rpc.Status error_samples = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

addErrorSamples(int index, Status.Builder builderForValue)

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

Output only. A sample of errors encountered while processing the request.

repeated .google.rpc.Status error_samples = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

addErrorSamplesBuilder()

public Status.Builder addErrorSamplesBuilder()

Output only. A sample of errors encountered while processing the request.

repeated .google.rpc.Status error_samples = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

addErrorSamplesBuilder(int index)

public Status.Builder addErrorSamplesBuilder(int index)

Output only. A sample of errors encountered while processing the request.

repeated .google.rpc.Status error_samples = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public Evaluation build()
Returns
Type Description
Evaluation

buildPartial()

public Evaluation buildPartial()
Returns
Type Description
Evaluation

clear()

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

clearCreateTime()

public Evaluation.Builder clearCreateTime()

Output only. Timestamp the Evaluation was created at.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Evaluation.Builder

clearEndTime()

public Evaluation.Builder clearEndTime()

Output only. Timestamp the Evaluation was completed at.

.google.protobuf.Timestamp end_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Evaluation.Builder

clearError()

public Evaluation.Builder clearError()

Output only. The error that occurred during evaluation. Only populated when the evaluation's state is FAILED.

.google.rpc.Status error = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Evaluation.Builder

clearErrorSamples()

public Evaluation.Builder clearErrorSamples()

Output only. A sample of errors encountered while processing the request.

repeated .google.rpc.Status error_samples = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Evaluation.Builder

clearEvaluationSpec()

public Evaluation.Builder clearEvaluationSpec()

Required. The specification of the evaluation.

.google.cloud.discoveryengine.v1beta.Evaluation.EvaluationSpec evaluation_spec = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Evaluation.Builder

clearField(Descriptors.FieldDescriptor field)

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

clearName()

public Evaluation.Builder clearName()

Identifier. The full resource name of the Evaluation, in the format of projects/{project}/locations/{location}/evaluations/{evaluation}.

This field must be a UTF-8 encoded string with a length limit of 1024 characters.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
Evaluation.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearQualityMetrics()

public Evaluation.Builder clearQualityMetrics()

Output only. The metrics produced by the evaluation, averaged across all SampleQuerys in the SampleQuerySet.

Only populated when the evaluation's state is SUCCEEDED.

.google.cloud.discoveryengine.v1beta.QualityMetrics quality_metrics = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Evaluation.Builder

clearState()

public Evaluation.Builder clearState()

Output only. The state of the evaluation.

.google.cloud.discoveryengine.v1beta.Evaluation.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Evaluation.Builder

This builder for chaining.

clone()

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

getCreateTime()

public Timestamp getCreateTime()

Output only. Timestamp the Evaluation was created at.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. Timestamp the Evaluation was created at.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Timestamp the Evaluation was created at.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public Evaluation getDefaultInstanceForType()
Returns
Type Description
Evaluation

getDescriptorForType()

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

getEndTime()

public Timestamp getEndTime()

Output only. Timestamp the Evaluation was completed at.

.google.protobuf.Timestamp end_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The endTime.

getEndTimeBuilder()

public Timestamp.Builder getEndTimeBuilder()

Output only. Timestamp the Evaluation was completed at.

.google.protobuf.Timestamp end_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getEndTimeOrBuilder()

public TimestampOrBuilder getEndTimeOrBuilder()

Output only. Timestamp the Evaluation was completed at.

.google.protobuf.Timestamp end_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getError()

public Status getError()

Output only. The error that occurred during evaluation. Only populated when the evaluation's state is FAILED.

.google.rpc.Status error = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
com.google.rpc.Status

The error.

getErrorBuilder()

public Status.Builder getErrorBuilder()

Output only. The error that occurred during evaluation. Only populated when the evaluation's state is FAILED.

.google.rpc.Status error = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

getErrorOrBuilder()

public StatusOrBuilder getErrorOrBuilder()

Output only. The error that occurred during evaluation. Only populated when the evaluation's state is FAILED.

.google.rpc.Status error = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
com.google.rpc.StatusOrBuilder

getErrorSamples(int index)

public Status getErrorSamples(int index)

Output only. A sample of errors encountered while processing the request.

repeated .google.rpc.Status error_samples = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

getErrorSamplesBuilder(int index)

public Status.Builder getErrorSamplesBuilder(int index)

Output only. A sample of errors encountered while processing the request.

repeated .google.rpc.Status error_samples = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

getErrorSamplesBuilderList()

public List<Status.Builder> getErrorSamplesBuilderList()

Output only. A sample of errors encountered while processing the request.

repeated .google.rpc.Status error_samples = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

getErrorSamplesCount()

public int getErrorSamplesCount()

Output only. A sample of errors encountered while processing the request.

repeated .google.rpc.Status error_samples = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

getErrorSamplesList()

public List<Status> getErrorSamplesList()

Output only. A sample of errors encountered while processing the request.

repeated .google.rpc.Status error_samples = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

getErrorSamplesOrBuilder(int index)

public StatusOrBuilder getErrorSamplesOrBuilder(int index)

Output only. A sample of errors encountered while processing the request.

repeated .google.rpc.Status error_samples = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

getErrorSamplesOrBuilderList()

public List<? extends StatusOrBuilder> getErrorSamplesOrBuilderList()

Output only. A sample of errors encountered while processing the request.

repeated .google.rpc.Status error_samples = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

getEvaluationSpec()

public Evaluation.EvaluationSpec getEvaluationSpec()

Required. The specification of the evaluation.

.google.cloud.discoveryengine.v1beta.Evaluation.EvaluationSpec evaluation_spec = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Evaluation.EvaluationSpec

The evaluationSpec.

getEvaluationSpecBuilder()

public Evaluation.EvaluationSpec.Builder getEvaluationSpecBuilder()

Required. The specification of the evaluation.

.google.cloud.discoveryengine.v1beta.Evaluation.EvaluationSpec evaluation_spec = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Evaluation.EvaluationSpec.Builder

getEvaluationSpecOrBuilder()

public Evaluation.EvaluationSpecOrBuilder getEvaluationSpecOrBuilder()

Required. The specification of the evaluation.

.google.cloud.discoveryengine.v1beta.Evaluation.EvaluationSpec evaluation_spec = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Evaluation.EvaluationSpecOrBuilder

getName()

public String getName()

Identifier. The full resource name of the Evaluation, in the format of projects/{project}/locations/{location}/evaluations/{evaluation}.

This field must be a UTF-8 encoded string with a length limit of 1024 characters.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Identifier. The full resource name of the Evaluation, in the format of projects/{project}/locations/{location}/evaluations/{evaluation}.

This field must be a UTF-8 encoded string with a length limit of 1024 characters.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
ByteString

The bytes for name.

getQualityMetrics()

public QualityMetrics getQualityMetrics()

Output only. The metrics produced by the evaluation, averaged across all SampleQuerys in the SampleQuerySet.

Only populated when the evaluation's state is SUCCEEDED.

.google.cloud.discoveryengine.v1beta.QualityMetrics quality_metrics = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
QualityMetrics

The qualityMetrics.

getQualityMetricsBuilder()

public QualityMetrics.Builder getQualityMetricsBuilder()

Output only. The metrics produced by the evaluation, averaged across all SampleQuerys in the SampleQuerySet.

Only populated when the evaluation's state is SUCCEEDED.

.google.cloud.discoveryengine.v1beta.QualityMetrics quality_metrics = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
QualityMetrics.Builder

getQualityMetricsOrBuilder()

public QualityMetricsOrBuilder getQualityMetricsOrBuilder()

Output only. The metrics produced by the evaluation, averaged across all SampleQuerys in the SampleQuerySet.

Only populated when the evaluation's state is SUCCEEDED.

.google.cloud.discoveryengine.v1beta.QualityMetrics quality_metrics = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
QualityMetricsOrBuilder

getState()

public Evaluation.State getState()

Output only. The state of the evaluation.

.google.cloud.discoveryengine.v1beta.Evaluation.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Evaluation.State

The state.

getStateValue()

public int getStateValue()

Output only. The state of the evaluation.

.google.cloud.discoveryengine.v1beta.Evaluation.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for state.

hasCreateTime()

public boolean hasCreateTime()

Output only. Timestamp the Evaluation was created at.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasEndTime()

public boolean hasEndTime()

Output only. Timestamp the Evaluation was completed at.

.google.protobuf.Timestamp end_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the endTime field is set.

hasError()

public boolean hasError()

Output only. The error that occurred during evaluation. Only populated when the evaluation's state is FAILED.

.google.rpc.Status error = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the error field is set.

hasEvaluationSpec()

public boolean hasEvaluationSpec()

Required. The specification of the evaluation.

.google.cloud.discoveryengine.v1beta.Evaluation.EvaluationSpec evaluation_spec = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the evaluationSpec field is set.

hasQualityMetrics()

public boolean hasQualityMetrics()

Output only. The metrics produced by the evaluation, averaged across all SampleQuerys in the SampleQuerySet.

Only populated when the evaluation's state is SUCCEEDED.

.google.cloud.discoveryengine.v1beta.QualityMetrics quality_metrics = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the qualityMetrics field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCreateTime(Timestamp value)

public Evaluation.Builder mergeCreateTime(Timestamp value)

Output only. Timestamp the Evaluation was created at.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Evaluation.Builder

mergeEndTime(Timestamp value)

public Evaluation.Builder mergeEndTime(Timestamp value)

Output only. Timestamp the Evaluation was completed at.

.google.protobuf.Timestamp end_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Evaluation.Builder

mergeError(Status value)

public Evaluation.Builder mergeError(Status value)

Output only. The error that occurred during evaluation. Only populated when the evaluation's state is FAILED.

.google.rpc.Status error = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

mergeEvaluationSpec(Evaluation.EvaluationSpec value)

public Evaluation.Builder mergeEvaluationSpec(Evaluation.EvaluationSpec value)

Required. The specification of the evaluation.

.google.cloud.discoveryengine.v1beta.Evaluation.EvaluationSpec evaluation_spec = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value Evaluation.EvaluationSpec
Returns
Type Description
Evaluation.Builder

mergeFrom(Evaluation other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeQualityMetrics(QualityMetrics value)

public Evaluation.Builder mergeQualityMetrics(QualityMetrics value)

Output only. The metrics produced by the evaluation, averaged across all SampleQuerys in the SampleQuerySet.

Only populated when the evaluation's state is SUCCEEDED.

.google.cloud.discoveryengine.v1beta.QualityMetrics quality_metrics = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value QualityMetrics
Returns
Type Description
Evaluation.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

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

removeErrorSamples(int index)

public Evaluation.Builder removeErrorSamples(int index)

Output only. A sample of errors encountered while processing the request.

repeated .google.rpc.Status error_samples = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
Evaluation.Builder

setCreateTime(Timestamp value)

public Evaluation.Builder setCreateTime(Timestamp value)

Output only. Timestamp the Evaluation was created at.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Evaluation.Builder

setCreateTime(Timestamp.Builder builderForValue)

public Evaluation.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. Timestamp the Evaluation was created at.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Evaluation.Builder

setEndTime(Timestamp value)

public Evaluation.Builder setEndTime(Timestamp value)

Output only. Timestamp the Evaluation was completed at.

.google.protobuf.Timestamp end_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Evaluation.Builder

setEndTime(Timestamp.Builder builderForValue)

public Evaluation.Builder setEndTime(Timestamp.Builder builderForValue)

Output only. Timestamp the Evaluation was completed at.

.google.protobuf.Timestamp end_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Evaluation.Builder

setError(Status value)

public Evaluation.Builder setError(Status value)

Output only. The error that occurred during evaluation. Only populated when the evaluation's state is FAILED.

.google.rpc.Status error = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

setError(Status.Builder builderForValue)

public Evaluation.Builder setError(Status.Builder builderForValue)

Output only. The error that occurred during evaluation. Only populated when the evaluation's state is FAILED.

.google.rpc.Status error = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

setErrorSamples(int index, Status value)

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

Output only. A sample of errors encountered while processing the request.

repeated .google.rpc.Status error_samples = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

setErrorSamples(int index, Status.Builder builderForValue)

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

Output only. A sample of errors encountered while processing the request.

repeated .google.rpc.Status error_samples = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

setEvaluationSpec(Evaluation.EvaluationSpec value)

public Evaluation.Builder setEvaluationSpec(Evaluation.EvaluationSpec value)

Required. The specification of the evaluation.

.google.cloud.discoveryengine.v1beta.Evaluation.EvaluationSpec evaluation_spec = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value Evaluation.EvaluationSpec
Returns
Type Description
Evaluation.Builder

setEvaluationSpec(Evaluation.EvaluationSpec.Builder builderForValue)

public Evaluation.Builder setEvaluationSpec(Evaluation.EvaluationSpec.Builder builderForValue)

Required. The specification of the evaluation.

.google.cloud.discoveryengine.v1beta.Evaluation.EvaluationSpec evaluation_spec = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
builderForValue Evaluation.EvaluationSpec.Builder
Returns
Type Description
Evaluation.Builder

setField(Descriptors.FieldDescriptor field, Object value)

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

setName(String value)

public Evaluation.Builder setName(String value)

Identifier. The full resource name of the Evaluation, in the format of projects/{project}/locations/{location}/evaluations/{evaluation}.

This field must be a UTF-8 encoded string with a length limit of 1024 characters.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Parameter
Name Description
value String

The name to set.

Returns
Type Description
Evaluation.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Evaluation.Builder setNameBytes(ByteString value)

Identifier. The full resource name of the Evaluation, in the format of projects/{project}/locations/{location}/evaluations/{evaluation}.

This field must be a UTF-8 encoded string with a length limit of 1024 characters.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
Evaluation.Builder

This builder for chaining.

setQualityMetrics(QualityMetrics value)

public Evaluation.Builder setQualityMetrics(QualityMetrics value)

Output only. The metrics produced by the evaluation, averaged across all SampleQuerys in the SampleQuerySet.

Only populated when the evaluation's state is SUCCEEDED.

.google.cloud.discoveryengine.v1beta.QualityMetrics quality_metrics = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value QualityMetrics
Returns
Type Description
Evaluation.Builder

setQualityMetrics(QualityMetrics.Builder builderForValue)

public Evaluation.Builder setQualityMetrics(QualityMetrics.Builder builderForValue)

Output only. The metrics produced by the evaluation, averaged across all SampleQuerys in the SampleQuerySet.

Only populated when the evaluation's state is SUCCEEDED.

.google.cloud.discoveryengine.v1beta.QualityMetrics quality_metrics = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue QualityMetrics.Builder
Returns
Type Description
Evaluation.Builder

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

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

setState(Evaluation.State value)

public Evaluation.Builder setState(Evaluation.State value)

Output only. The state of the evaluation.

.google.cloud.discoveryengine.v1beta.Evaluation.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Evaluation.State

The state to set.

Returns
Type Description
Evaluation.Builder

This builder for chaining.

setStateValue(int value)

public Evaluation.Builder setStateValue(int value)

Output only. The state of the evaluation.

.google.cloud.discoveryengine.v1beta.Evaluation.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value int

The enum numeric value on the wire for state to set.

Returns
Type Description
Evaluation.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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