Class EvaluationReference (2.46.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
Type Description
int

AGGREGATE_METRICS_FIELD_NUMBER

public static final int AGGREGATE_METRICS_FIELD_NUMBER
Field Value
Type Description
int

EVALUATION_FIELD_NUMBER

public static final int EVALUATION_FIELD_NUMBER
Field Value
Type Description
int

OPERATION_FIELD_NUMBER

public static final int OPERATION_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static EvaluationReference getDefaultInstance()
Returns
Type Description
EvaluationReference

getDescriptor()

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

newBuilder()

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

newBuilder(EvaluationReference prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
Evaluation.MetricsOrBuilder

getDefaultInstanceForType()

public EvaluationReference getDefaultInstanceForType()
Returns
Type Description
EvaluationReference

getEvaluation()

public String getEvaluation()

The resource name of the evaluation.

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

Returns
Type Description
String

The evaluation.

getEvaluationBytes()

public ByteString getEvaluationBytes()

The resource name of the evaluation.

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

Returns
Type Description
ByteString

The bytes for evaluation.

getOperation()

public String getOperation()

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

string operation = 1;

Returns
Type Description
String

The operation.

getOperationBytes()

public ByteString getOperationBytes()

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

string operation = 1;

Returns
Type Description
ByteString

The bytes for operation.

getParserForType()

public Parser<EvaluationReference> getParserForType()
Returns
Type Description
Parser<EvaluationReference>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
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
Type Description
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
Type Description
boolean

Whether the aggregateMetricsExact 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 EvaluationReference.Builder newBuilderForType()
Returns
Type Description
EvaluationReference.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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