Class MetricxInstance (3.55.0)

public final class MetricxInstance extends GeneratedMessageV3 implements MetricxInstanceOrBuilder

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

Protobuf type google.cloud.aiplatform.v1.MetricxInstance

Static Fields

PREDICTION_FIELD_NUMBER

public static final int PREDICTION_FIELD_NUMBER
Field Value
Type Description
int

REFERENCE_FIELD_NUMBER

public static final int REFERENCE_FIELD_NUMBER
Field Value
Type Description
int

SOURCE_FIELD_NUMBER

public static final int SOURCE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static MetricxInstance getDefaultInstance()
Returns
Type Description
MetricxInstance

getDescriptor()

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

newBuilder()

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

newBuilder(MetricxInstance prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public MetricxInstance getDefaultInstanceForType()
Returns
Type Description
MetricxInstance

getParserForType()

public Parser<MetricxInstance> getParserForType()
Returns
Type Description
Parser<MetricxInstance>
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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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