Class MetricxInstance.Builder (3.84.0)

public static final class MetricxInstance.Builder extends GeneratedMessage.Builder<MetricxInstance.Builder> implements MetricxInstanceOrBuilder

Spec for MetricX instance - The fields used for evaluation are dependent on the MetricX version.

Protobuf type google.cloud.aiplatform.v1beta1.MetricxInstance

Static Methods

getDescriptor()

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

Methods

build()

public MetricxInstance build()
Returns
Type Description
MetricxInstance

buildPartial()

public MetricxInstance buildPartial()
Returns
Type Description
MetricxInstance

clear()

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

clearPrediction()

public MetricxInstance.Builder clearPrediction()

Required. Output of the evaluated model.

optional string prediction = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
MetricxInstance.Builder

This builder for chaining.

clearReference()

public MetricxInstance.Builder clearReference()

Optional. Ground truth used to compare against the prediction.

optional string reference = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
MetricxInstance.Builder

This builder for chaining.

clearSource()

public MetricxInstance.Builder clearSource()

Optional. Source text in original language.

optional string source = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
MetricxInstance.Builder

This builder for chaining.

getDefaultInstanceForType()

public MetricxInstance getDefaultInstanceForType()
Returns
Type Description
MetricxInstance

getDescriptorForType()

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

getPrediction()

public String getPrediction()

Required. Output of the evaluated model.

optional string prediction = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The prediction.

getPredictionBytes()

public ByteString getPredictionBytes()

Required. Output of the evaluated model.

optional string prediction = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for prediction.

getReference()

public String getReference()

Optional. Ground truth used to compare against the prediction.

optional string reference = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The reference.

getReferenceBytes()

public ByteString getReferenceBytes()

Optional. Ground truth used to compare against the prediction.

optional string reference = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for reference.

getSource()

public String getSource()

Optional. Source text in original language.

optional string source = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The source.

getSourceBytes()

public ByteString getSourceBytes()

Optional. Source text in original language.

optional string source = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for source.

hasPrediction()

public boolean hasPrediction()

Required. Output of the evaluated model.

optional string prediction = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the prediction field is set.

hasReference()

public boolean hasReference()

Optional. Ground truth used to compare against the prediction.

optional string reference = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the reference field is set.

hasSource()

public boolean hasSource()

Optional. Source text in original language.

optional string source = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the source field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(MetricxInstance other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

setPrediction(String value)

public MetricxInstance.Builder setPrediction(String value)

Required. Output of the evaluated model.

optional string prediction = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The prediction to set.

Returns
Type Description
MetricxInstance.Builder

This builder for chaining.

setPredictionBytes(ByteString value)

public MetricxInstance.Builder setPredictionBytes(ByteString value)

Required. Output of the evaluated model.

optional string prediction = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for prediction to set.

Returns
Type Description
MetricxInstance.Builder

This builder for chaining.

setReference(String value)

public MetricxInstance.Builder setReference(String value)

Optional. Ground truth used to compare against the prediction.

optional string reference = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The reference to set.

Returns
Type Description
MetricxInstance.Builder

This builder for chaining.

setReferenceBytes(ByteString value)

public MetricxInstance.Builder setReferenceBytes(ByteString value)

Optional. Ground truth used to compare against the prediction.

optional string reference = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for reference to set.

Returns
Type Description
MetricxInstance.Builder

This builder for chaining.

setSource(String value)

public MetricxInstance.Builder setSource(String value)

Optional. Source text in original language.

optional string source = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The source to set.

Returns
Type Description
MetricxInstance.Builder

This builder for chaining.

setSourceBytes(ByteString value)

public MetricxInstance.Builder setSourceBytes(ByteString value)

Optional. Source text in original language.

optional string source = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for source to set.

Returns
Type Description
MetricxInstance.Builder

This builder for chaining.