Class EvaluationReference (2.36.0)

public final class EvaluationReference extends GeneratedMessageV3 implements EvaluationReferenceOrBuilder

Gives a short summary of an evaluation, and links to the evaluation itself.

Protobuf type google.cloud.documentai.v1.EvaluationReference

Static Fields

AGGREGATE_METRICS_EXACT_FIELD_NUMBER

public static final int AGGREGATE_METRICS_EXACT_FIELD_NUMBER
Field Value
TypeDescription
int

AGGREGATE_METRICS_FIELD_NUMBER

public static final int AGGREGATE_METRICS_FIELD_NUMBER
Field Value
TypeDescription
int

EVALUATION_FIELD_NUMBER

public static final int EVALUATION_FIELD_NUMBER
Field Value
TypeDescription
int

OPERATION_FIELD_NUMBER

public static final int OPERATION_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static EvaluationReference getDefaultInstance()
Returns
TypeDescription
EvaluationReference

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static EvaluationReference.Builder newBuilder()
Returns
TypeDescription
EvaluationReference.Builder

newBuilder(EvaluationReference prototype)

public static EvaluationReference.Builder newBuilder(EvaluationReference prototype)
Parameter
NameDescription
prototypeEvaluationReference
Returns
TypeDescription
EvaluationReference.Builder

parseDelimitedFrom(InputStream input)

public static EvaluationReference parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
EvaluationReference
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static EvaluationReference parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
EvaluationReference
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static EvaluationReference parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
EvaluationReference
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static EvaluationReference parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
EvaluationReference
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static EvaluationReference parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
EvaluationReference
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static EvaluationReference parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
EvaluationReference
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static EvaluationReference parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
EvaluationReference
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static EvaluationReference parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
EvaluationReference
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static EvaluationReference parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
EvaluationReference
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static EvaluationReference parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
EvaluationReference
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static EvaluationReference parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
EvaluationReference
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static EvaluationReference parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
EvaluationReference
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<EvaluationReference> parser()
Returns
TypeDescription
Parser<EvaluationReference>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getAggregateMetrics()

public Evaluation.Metrics getAggregateMetrics()

An aggregate of the statistics for the evaluation with fuzzy matching on.

.google.cloud.documentai.v1.Evaluation.Metrics aggregate_metrics = 4;

Returns
TypeDescription
Evaluation.Metrics

The aggregateMetrics.

getAggregateMetricsExact()

public Evaluation.Metrics getAggregateMetricsExact()

An aggregate of the statistics for the evaluation with fuzzy matching off.

.google.cloud.documentai.v1.Evaluation.Metrics aggregate_metrics_exact = 5;

Returns
TypeDescription
Evaluation.Metrics

The aggregateMetricsExact.

getAggregateMetricsExactOrBuilder()

public Evaluation.MetricsOrBuilder getAggregateMetricsExactOrBuilder()

An aggregate of the statistics for the evaluation with fuzzy matching off.

.google.cloud.documentai.v1.Evaluation.Metrics aggregate_metrics_exact = 5;

Returns
TypeDescription
Evaluation.MetricsOrBuilder

getAggregateMetricsOrBuilder()

public Evaluation.MetricsOrBuilder getAggregateMetricsOrBuilder()

An aggregate of the statistics for the evaluation with fuzzy matching on.

.google.cloud.documentai.v1.Evaluation.Metrics aggregate_metrics = 4;

Returns
TypeDescription
Evaluation.MetricsOrBuilder

getDefaultInstanceForType()

public EvaluationReference getDefaultInstanceForType()
Returns
TypeDescription
EvaluationReference

getEvaluation()

public String getEvaluation()

The resource name of the evaluation.

string evaluation = 2 [(.google.api.resource_reference) = { ... }

Returns
TypeDescription
String

The evaluation.

getEvaluationBytes()

public ByteString getEvaluationBytes()

The resource name of the evaluation.

string evaluation = 2 [(.google.api.resource_reference) = { ... }

Returns
TypeDescription
ByteString

The bytes for evaluation.

getOperation()

public String getOperation()

The resource name of the Long Running Operation for the evaluation.

string operation = 1;

Returns
TypeDescription
String

The operation.

getOperationBytes()

public ByteString getOperationBytes()

The resource name of the Long Running Operation for the evaluation.

string operation = 1;

Returns
TypeDescription
ByteString

The bytes for operation.

getParserForType()

public Parser<EvaluationReference> getParserForType()
Returns
TypeDescription
Parser<EvaluationReference>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hasAggregateMetrics()

public boolean hasAggregateMetrics()

An aggregate of the statistics for the evaluation with fuzzy matching on.

.google.cloud.documentai.v1.Evaluation.Metrics aggregate_metrics = 4;

Returns
TypeDescription
boolean

Whether the aggregateMetrics field is set.

hasAggregateMetricsExact()

public boolean hasAggregateMetricsExact()

An aggregate of the statistics for the evaluation with fuzzy matching off.

.google.cloud.documentai.v1.Evaluation.Metrics aggregate_metrics_exact = 5;

Returns
TypeDescription
boolean

Whether the aggregateMetricsExact field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public EvaluationReference.Builder newBuilderForType()
Returns
TypeDescription
EvaluationReference.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected EvaluationReference.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
EvaluationReference.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public EvaluationReference.Builder toBuilder()
Returns
TypeDescription
EvaluationReference.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException