Class Evaluation.Builder (2.57.0)

public static final class Evaluation.Builder extends GeneratedMessageV3.Builder<Evaluation.Builder> implements EvaluationOrBuilder

An evaluation of a ProcessorVersion's performance.

Protobuf type google.cloud.documentai.v1beta3.Evaluation

Implements

EvaluationOrBuilder

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Evaluation.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Evaluation.Builder
Overrides

build()

public Evaluation build()
Returns
Type Description
Evaluation

buildPartial()

public Evaluation buildPartial()
Returns
Type Description
Evaluation

clear()

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

clearAllEntitiesMetrics()

public Evaluation.Builder clearAllEntitiesMetrics()

Metrics for all the entities in aggregate.

.google.cloud.documentai.v1beta3.Evaluation.MultiConfidenceMetrics all_entities_metrics = 3;

Returns
Type Description
Evaluation.Builder

clearCreateTime()

public Evaluation.Builder clearCreateTime()

The time that the evaluation was created.

.google.protobuf.Timestamp create_time = 2;

Returns
Type Description
Evaluation.Builder

clearDocumentCounters()

public Evaluation.Builder clearDocumentCounters()

Counters for the documents used in the evaluation.

.google.cloud.documentai.v1beta3.Evaluation.Counters document_counters = 5;

Returns
Type Description
Evaluation.Builder

clearEntityMetrics()

public Evaluation.Builder clearEntityMetrics()
Returns
Type Description
Evaluation.Builder

clearField(Descriptors.FieldDescriptor field)

public Evaluation.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Evaluation.Builder
Overrides

clearKmsKeyName()

public Evaluation.Builder clearKmsKeyName()

The KMS key name used for encryption.

string kms_key_name = 6;

Returns
Type Description
Evaluation.Builder

This builder for chaining.

clearKmsKeyVersionName()

public Evaluation.Builder clearKmsKeyVersionName()

The KMS key version with which data is encrypted.

string kms_key_version_name = 7;

Returns
Type Description
Evaluation.Builder

This builder for chaining.

clearName()

public Evaluation.Builder clearName()

The resource name of the evaluation. Format: projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}/evaluations/{evaluation}

string name = 1;

Returns
Type Description
Evaluation.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Evaluation.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Evaluation.Builder
Overrides

clone()

public Evaluation.Builder clone()
Returns
Type Description
Evaluation.Builder
Overrides

containsEntityMetrics(String key)

public boolean containsEntityMetrics(String key)

Metrics across confidence levels, for different entities.

map<string, .google.cloud.documentai.v1beta3.Evaluation.MultiConfidenceMetrics> entity_metrics = 4;

Parameter
Name Description
key String
Returns
Type Description
boolean

getAllEntitiesMetrics()

public Evaluation.MultiConfidenceMetrics getAllEntitiesMetrics()

Metrics for all the entities in aggregate.

.google.cloud.documentai.v1beta3.Evaluation.MultiConfidenceMetrics all_entities_metrics = 3;

Returns
Type Description
Evaluation.MultiConfidenceMetrics

The allEntitiesMetrics.

getAllEntitiesMetricsBuilder()

public Evaluation.MultiConfidenceMetrics.Builder getAllEntitiesMetricsBuilder()

Metrics for all the entities in aggregate.

.google.cloud.documentai.v1beta3.Evaluation.MultiConfidenceMetrics all_entities_metrics = 3;

Returns
Type Description
Evaluation.MultiConfidenceMetrics.Builder

getAllEntitiesMetricsOrBuilder()

public Evaluation.MultiConfidenceMetricsOrBuilder getAllEntitiesMetricsOrBuilder()

Metrics for all the entities in aggregate.

.google.cloud.documentai.v1beta3.Evaluation.MultiConfidenceMetrics all_entities_metrics = 3;

Returns
Type Description
Evaluation.MultiConfidenceMetricsOrBuilder

getCreateTime()

public Timestamp getCreateTime()

The time that the evaluation was created.

.google.protobuf.Timestamp create_time = 2;

Returns
Type Description
Timestamp

The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

The time that the evaluation was created.

.google.protobuf.Timestamp create_time = 2;

Returns
Type Description
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

The time that the evaluation was created.

.google.protobuf.Timestamp create_time = 2;

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public Evaluation getDefaultInstanceForType()
Returns
Type Description
Evaluation

getDescriptorForType()

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

getDocumentCounters()

public Evaluation.Counters getDocumentCounters()

Counters for the documents used in the evaluation.

.google.cloud.documentai.v1beta3.Evaluation.Counters document_counters = 5;

Returns
Type Description
Evaluation.Counters

The documentCounters.

getDocumentCountersBuilder()

public Evaluation.Counters.Builder getDocumentCountersBuilder()

Counters for the documents used in the evaluation.

.google.cloud.documentai.v1beta3.Evaluation.Counters document_counters = 5;

Returns
Type Description
Evaluation.Counters.Builder

getDocumentCountersOrBuilder()

public Evaluation.CountersOrBuilder getDocumentCountersOrBuilder()

Counters for the documents used in the evaluation.

.google.cloud.documentai.v1beta3.Evaluation.Counters document_counters = 5;

Returns
Type Description
Evaluation.CountersOrBuilder

getEntityMetrics() (deprecated)

public Map<String,Evaluation.MultiConfidenceMetrics> getEntityMetrics()
Returns
Type Description
Map<String,MultiConfidenceMetrics>

getEntityMetricsCount()

public int getEntityMetricsCount()

Metrics across confidence levels, for different entities.

map<string, .google.cloud.documentai.v1beta3.Evaluation.MultiConfidenceMetrics> entity_metrics = 4;

Returns
Type Description
int

getEntityMetricsMap()

public Map<String,Evaluation.MultiConfidenceMetrics> getEntityMetricsMap()

Metrics across confidence levels, for different entities.

map<string, .google.cloud.documentai.v1beta3.Evaluation.MultiConfidenceMetrics> entity_metrics = 4;

Returns
Type Description
Map<String,MultiConfidenceMetrics>

getEntityMetricsOrDefault(String key, Evaluation.MultiConfidenceMetrics defaultValue)

public Evaluation.MultiConfidenceMetrics getEntityMetricsOrDefault(String key, Evaluation.MultiConfidenceMetrics defaultValue)

Metrics across confidence levels, for different entities.

map<string, .google.cloud.documentai.v1beta3.Evaluation.MultiConfidenceMetrics> entity_metrics = 4;

Parameters
Name Description
key String
defaultValue Evaluation.MultiConfidenceMetrics
Returns
Type Description
Evaluation.MultiConfidenceMetrics

getEntityMetricsOrThrow(String key)

public Evaluation.MultiConfidenceMetrics getEntityMetricsOrThrow(String key)

Metrics across confidence levels, for different entities.

map<string, .google.cloud.documentai.v1beta3.Evaluation.MultiConfidenceMetrics> entity_metrics = 4;

Parameter
Name Description
key String
Returns
Type Description
Evaluation.MultiConfidenceMetrics

getKmsKeyName()

public String getKmsKeyName()

The KMS key name used for encryption.

string kms_key_name = 6;

Returns
Type Description
String

The kmsKeyName.

getKmsKeyNameBytes()

public ByteString getKmsKeyNameBytes()

The KMS key name used for encryption.

string kms_key_name = 6;

Returns
Type Description
ByteString

The bytes for kmsKeyName.

getKmsKeyVersionName()

public String getKmsKeyVersionName()

The KMS key version with which data is encrypted.

string kms_key_version_name = 7;

Returns
Type Description
String

The kmsKeyVersionName.

getKmsKeyVersionNameBytes()

public ByteString getKmsKeyVersionNameBytes()

The KMS key version with which data is encrypted.

string kms_key_version_name = 7;

Returns
Type Description
ByteString

The bytes for kmsKeyVersionName.

getMutableEntityMetrics() (deprecated)

public Map<String,Evaluation.MultiConfidenceMetrics> getMutableEntityMetrics()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,MultiConfidenceMetrics>

getName()

public String getName()

The resource name of the evaluation. Format: projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}/evaluations/{evaluation}

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

The resource name of the evaluation. Format: projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}/evaluations/{evaluation}

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

hasAllEntitiesMetrics()

public boolean hasAllEntitiesMetrics()

Metrics for all the entities in aggregate.

.google.cloud.documentai.v1beta3.Evaluation.MultiConfidenceMetrics all_entities_metrics = 3;

Returns
Type Description
boolean

Whether the allEntitiesMetrics field is set.

hasCreateTime()

public boolean hasCreateTime()

The time that the evaluation was created.

.google.protobuf.Timestamp create_time = 2;

Returns
Type Description
boolean

Whether the createTime field is set.

hasDocumentCounters()

public boolean hasDocumentCounters()

Counters for the documents used in the evaluation.

.google.cloud.documentai.v1beta3.Evaluation.Counters document_counters = 5;

Returns
Type Description
boolean

Whether the documentCounters field is set.

internalGetFieldAccessorTable()

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

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeAllEntitiesMetrics(Evaluation.MultiConfidenceMetrics value)

public Evaluation.Builder mergeAllEntitiesMetrics(Evaluation.MultiConfidenceMetrics value)

Metrics for all the entities in aggregate.

.google.cloud.documentai.v1beta3.Evaluation.MultiConfidenceMetrics all_entities_metrics = 3;

Parameter
Name Description
value Evaluation.MultiConfidenceMetrics
Returns
Type Description
Evaluation.Builder

mergeCreateTime(Timestamp value)

public Evaluation.Builder mergeCreateTime(Timestamp value)

The time that the evaluation was created.

.google.protobuf.Timestamp create_time = 2;

Parameter
Name Description
value Timestamp
Returns
Type Description
Evaluation.Builder

mergeDocumentCounters(Evaluation.Counters value)

public Evaluation.Builder mergeDocumentCounters(Evaluation.Counters value)

Counters for the documents used in the evaluation.

.google.cloud.documentai.v1beta3.Evaluation.Counters document_counters = 5;

Parameter
Name Description
value Evaluation.Counters
Returns
Type Description
Evaluation.Builder

mergeFrom(Evaluation other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Evaluation.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Evaluation.Builder
Overrides

putAllEntityMetrics(Map<String,Evaluation.MultiConfidenceMetrics> values)

public Evaluation.Builder putAllEntityMetrics(Map<String,Evaluation.MultiConfidenceMetrics> values)

Metrics across confidence levels, for different entities.

map<string, .google.cloud.documentai.v1beta3.Evaluation.MultiConfidenceMetrics> entity_metrics = 4;

Parameter
Name Description
values Map<String,MultiConfidenceMetrics>
Returns
Type Description
Evaluation.Builder

putEntityMetrics(String key, Evaluation.MultiConfidenceMetrics value)

public Evaluation.Builder putEntityMetrics(String key, Evaluation.MultiConfidenceMetrics value)

Metrics across confidence levels, for different entities.

map<string, .google.cloud.documentai.v1beta3.Evaluation.MultiConfidenceMetrics> entity_metrics = 4;

Parameters
Name Description
key String
value Evaluation.MultiConfidenceMetrics
Returns
Type Description
Evaluation.Builder

putEntityMetricsBuilderIfAbsent(String key)

public Evaluation.MultiConfidenceMetrics.Builder putEntityMetricsBuilderIfAbsent(String key)

Metrics across confidence levels, for different entities.

map<string, .google.cloud.documentai.v1beta3.Evaluation.MultiConfidenceMetrics> entity_metrics = 4;

Parameter
Name Description
key String
Returns
Type Description
Evaluation.MultiConfidenceMetrics.Builder

removeEntityMetrics(String key)

public Evaluation.Builder removeEntityMetrics(String key)

Metrics across confidence levels, for different entities.

map<string, .google.cloud.documentai.v1beta3.Evaluation.MultiConfidenceMetrics> entity_metrics = 4;

Parameter
Name Description
key String
Returns
Type Description
Evaluation.Builder

setAllEntitiesMetrics(Evaluation.MultiConfidenceMetrics value)

public Evaluation.Builder setAllEntitiesMetrics(Evaluation.MultiConfidenceMetrics value)

Metrics for all the entities in aggregate.

.google.cloud.documentai.v1beta3.Evaluation.MultiConfidenceMetrics all_entities_metrics = 3;

Parameter
Name Description
value Evaluation.MultiConfidenceMetrics
Returns
Type Description
Evaluation.Builder

setAllEntitiesMetrics(Evaluation.MultiConfidenceMetrics.Builder builderForValue)

public Evaluation.Builder setAllEntitiesMetrics(Evaluation.MultiConfidenceMetrics.Builder builderForValue)

Metrics for all the entities in aggregate.

.google.cloud.documentai.v1beta3.Evaluation.MultiConfidenceMetrics all_entities_metrics = 3;

Parameter
Name Description
builderForValue Evaluation.MultiConfidenceMetrics.Builder
Returns
Type Description
Evaluation.Builder

setCreateTime(Timestamp value)

public Evaluation.Builder setCreateTime(Timestamp value)

The time that the evaluation was created.

.google.protobuf.Timestamp create_time = 2;

Parameter
Name Description
value Timestamp
Returns
Type Description
Evaluation.Builder

setCreateTime(Timestamp.Builder builderForValue)

public Evaluation.Builder setCreateTime(Timestamp.Builder builderForValue)

The time that the evaluation was created.

.google.protobuf.Timestamp create_time = 2;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Evaluation.Builder

setDocumentCounters(Evaluation.Counters value)

public Evaluation.Builder setDocumentCounters(Evaluation.Counters value)

Counters for the documents used in the evaluation.

.google.cloud.documentai.v1beta3.Evaluation.Counters document_counters = 5;

Parameter
Name Description
value Evaluation.Counters
Returns
Type Description
Evaluation.Builder

setDocumentCounters(Evaluation.Counters.Builder builderForValue)

public Evaluation.Builder setDocumentCounters(Evaluation.Counters.Builder builderForValue)

Counters for the documents used in the evaluation.

.google.cloud.documentai.v1beta3.Evaluation.Counters document_counters = 5;

Parameter
Name Description
builderForValue Evaluation.Counters.Builder
Returns
Type Description
Evaluation.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public Evaluation.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Evaluation.Builder
Overrides

setKmsKeyName(String value)

public Evaluation.Builder setKmsKeyName(String value)

The KMS key name used for encryption.

string kms_key_name = 6;

Parameter
Name Description
value String

The kmsKeyName to set.

Returns
Type Description
Evaluation.Builder

This builder for chaining.

setKmsKeyNameBytes(ByteString value)

public Evaluation.Builder setKmsKeyNameBytes(ByteString value)

The KMS key name used for encryption.

string kms_key_name = 6;

Parameter
Name Description
value ByteString

The bytes for kmsKeyName to set.

Returns
Type Description
Evaluation.Builder

This builder for chaining.

setKmsKeyVersionName(String value)

public Evaluation.Builder setKmsKeyVersionName(String value)

The KMS key version with which data is encrypted.

string kms_key_version_name = 7;

Parameter
Name Description
value String

The kmsKeyVersionName to set.

Returns
Type Description
Evaluation.Builder

This builder for chaining.

setKmsKeyVersionNameBytes(ByteString value)

public Evaluation.Builder setKmsKeyVersionNameBytes(ByteString value)

The KMS key version with which data is encrypted.

string kms_key_version_name = 7;

Parameter
Name Description
value ByteString

The bytes for kmsKeyVersionName to set.

Returns
Type Description
Evaluation.Builder

This builder for chaining.

setName(String value)

public Evaluation.Builder setName(String value)

The resource name of the evaluation. Format: projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}/evaluations/{evaluation}

string name = 1;

Parameter
Name Description
value String

The name to set.

Returns
Type Description
Evaluation.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Evaluation.Builder setNameBytes(ByteString value)

The resource name of the evaluation. Format: projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}/evaluations/{evaluation}

string name = 1;

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
Evaluation.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Evaluation.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Evaluation.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final Evaluation.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Evaluation.Builder
Overrides