Class MetricResult.Builder (3.86.0)

public static final class MetricResult.Builder extends GeneratedMessage.Builder<MetricResult.Builder> implements MetricResultOrBuilder

Result for a single metric on a single instance.

Protobuf type google.cloud.aiplatform.v1beta1.MetricResult

Static Methods

getDescriptor()

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

Methods

build()

public MetricResult build()
Returns
Type Description
MetricResult

buildPartial()

public MetricResult buildPartial()
Returns
Type Description
MetricResult

clear()

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

clearError()

public MetricResult.Builder clearError()

Output only. The error status for the metric result.

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

Returns
Type Description
MetricResult.Builder

clearExplanation()

public MetricResult.Builder clearExplanation()

Output only. The explanation for the metric result.

optional string explanation = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
MetricResult.Builder

This builder for chaining.

clearScore()

public MetricResult.Builder clearScore()

Output only. The score for the metric. Please refer to each metric's documentation for the meaning of the score.

optional float score = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
MetricResult.Builder

This builder for chaining.

getDefaultInstanceForType()

public MetricResult getDefaultInstanceForType()
Returns
Type Description
MetricResult

getDescriptorForType()

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

getError()

public Status getError()

Output only. The error status for the metric result.

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

Returns
Type Description
com.google.rpc.Status

The error.

getErrorBuilder()

public Status.Builder getErrorBuilder()

Output only. The error status for the metric result.

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

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

getErrorOrBuilder()

public StatusOrBuilder getErrorOrBuilder()

Output only. The error status for the metric result.

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

Returns
Type Description
com.google.rpc.StatusOrBuilder

getExplanation()

public String getExplanation()

Output only. The explanation for the metric result.

optional string explanation = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The explanation.

getExplanationBytes()

public ByteString getExplanationBytes()

Output only. The explanation for the metric result.

optional string explanation = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for explanation.

getScore()

public float getScore()

Output only. The score for the metric. Please refer to each metric's documentation for the meaning of the score.

optional float score = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
float

The score.

hasError()

public boolean hasError()

Output only. The error status for the metric result.

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

Returns
Type Description
boolean

Whether the error field is set.

hasExplanation()

public boolean hasExplanation()

Output only. The explanation for the metric result.

optional string explanation = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the explanation field is set.

hasScore()

public boolean hasScore()

Output only. The score for the metric. Please refer to each metric's documentation for the meaning of the score.

optional float score = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the score field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeError(Status value)

public MetricResult.Builder mergeError(Status value)

Output only. The error status for the metric result.

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

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

mergeFrom(MetricResult other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

setError(Status value)

public MetricResult.Builder setError(Status value)

Output only. The error status for the metric result.

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

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

setError(Status.Builder builderForValue)

public MetricResult.Builder setError(Status.Builder builderForValue)

Output only. The error status for the metric result.

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

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

setExplanation(String value)

public MetricResult.Builder setExplanation(String value)

Output only. The explanation for the metric result.

optional string explanation = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The explanation to set.

Returns
Type Description
MetricResult.Builder

This builder for chaining.

setExplanationBytes(ByteString value)

public MetricResult.Builder setExplanationBytes(ByteString value)

Output only. The explanation for the metric result.

optional string explanation = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for explanation to set.

Returns
Type Description
MetricResult.Builder

This builder for chaining.

setScore(float value)

public MetricResult.Builder setScore(float value)

Output only. The score for the metric. Please refer to each metric's documentation for the meaning of the score.

optional float score = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value float

The score to set.

Returns
Type Description
MetricResult.Builder

This builder for chaining.