Class Evaluation.Builder (2.16.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.v1.Evaluation

Implements

EvaluationOrBuilder

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Evaluation.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Evaluation.Builder
Overrides

build()

public Evaluation build()
Returns
TypeDescription
Evaluation

buildPartial()

public Evaluation buildPartial()
Returns
TypeDescription
Evaluation

clear()

public Evaluation.Builder clear()
Returns
TypeDescription
Evaluation.Builder
Overrides

clearAllEntitiesMetrics()

public Evaluation.Builder clearAllEntitiesMetrics()

Metrics for all the entities in aggregate.

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

Returns
TypeDescription
Evaluation.Builder

clearCreateTime()

public Evaluation.Builder clearCreateTime()

The time that the evaluation was created.

.google.protobuf.Timestamp create_time = 2;

Returns
TypeDescription
Evaluation.Builder

clearDocumentCounters()

public Evaluation.Builder clearDocumentCounters()

Counters for the documents used in the evaluation.

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

Returns
TypeDescription
Evaluation.Builder

clearEntityMetrics()

public Evaluation.Builder clearEntityMetrics()
Returns
TypeDescription
Evaluation.Builder

clearField(Descriptors.FieldDescriptor field)

public Evaluation.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
Evaluation.Builder
Overrides

clearKmsKeyName()

public Evaluation.Builder clearKmsKeyName()

The KMS key name used for encryption.

string kms_key_name = 6;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
Evaluation.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Evaluation.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
Evaluation.Builder
Overrides

clone()

public Evaluation.Builder clone()
Returns
TypeDescription
Evaluation.Builder
Overrides

containsEntityMetrics(String key)

public boolean containsEntityMetrics(String key)

Metrics across confidence levels, for different entities.

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

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

getAllEntitiesMetrics()

public Evaluation.MultiConfidenceMetrics getAllEntitiesMetrics()

Metrics for all the entities in aggregate.

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

Returns
TypeDescription
Evaluation.MultiConfidenceMetrics

The allEntitiesMetrics.

getAllEntitiesMetricsBuilder()

public Evaluation.MultiConfidenceMetrics.Builder getAllEntitiesMetricsBuilder()

Metrics for all the entities in aggregate.

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

Returns
TypeDescription
Evaluation.MultiConfidenceMetrics.Builder

getAllEntitiesMetricsOrBuilder()

public Evaluation.MultiConfidenceMetricsOrBuilder getAllEntitiesMetricsOrBuilder()

Metrics for all the entities in aggregate.

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

Returns
TypeDescription
Evaluation.MultiConfidenceMetricsOrBuilder

getCreateTime()

public Timestamp getCreateTime()

The time that the evaluation was created.

.google.protobuf.Timestamp create_time = 2;

Returns
TypeDescription
Timestamp

The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

The time that the evaluation was created.

.google.protobuf.Timestamp create_time = 2;

Returns
TypeDescription
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

The time that the evaluation was created.

.google.protobuf.Timestamp create_time = 2;

Returns
TypeDescription
TimestampOrBuilder

getDefaultInstanceForType()

public Evaluation getDefaultInstanceForType()
Returns
TypeDescription
Evaluation

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getDocumentCounters()

public Evaluation.Counters getDocumentCounters()

Counters for the documents used in the evaluation.

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

Returns
TypeDescription
Evaluation.Counters

The documentCounters.

getDocumentCountersBuilder()

public Evaluation.Counters.Builder getDocumentCountersBuilder()

Counters for the documents used in the evaluation.

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

Returns
TypeDescription
Evaluation.Counters.Builder

getDocumentCountersOrBuilder()

public Evaluation.CountersOrBuilder getDocumentCountersOrBuilder()

Counters for the documents used in the evaluation.

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

Returns
TypeDescription
Evaluation.CountersOrBuilder

getEntityMetrics()

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

getEntityMetricsCount()

public int getEntityMetricsCount()

Metrics across confidence levels, for different entities.

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

Returns
TypeDescription
int

getEntityMetricsMap()

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

Metrics across confidence levels, for different entities.

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

Returns
TypeDescription
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.v1.Evaluation.MultiConfidenceMetrics> entity_metrics = 4;

Parameters
NameDescription
keyString
defaultValueEvaluation.MultiConfidenceMetrics
Returns
TypeDescription
Evaluation.MultiConfidenceMetrics

getEntityMetricsOrThrow(String key)

public Evaluation.MultiConfidenceMetrics getEntityMetricsOrThrow(String key)

Metrics across confidence levels, for different entities.

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

Parameter
NameDescription
keyString
Returns
TypeDescription
Evaluation.MultiConfidenceMetrics

getKmsKeyName()

public String getKmsKeyName()

The KMS key name used for encryption.

string kms_key_name = 6;

Returns
TypeDescription
String

The kmsKeyName.

getKmsKeyNameBytes()

public ByteString getKmsKeyNameBytes()

The KMS key name used for encryption.

string kms_key_name = 6;

Returns
TypeDescription
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
TypeDescription
String

The kmsKeyVersionName.

getKmsKeyVersionNameBytes()

public ByteString getKmsKeyVersionNameBytes()

The KMS key version with which data is encrypted.

string kms_key_version_name = 7;

Returns
TypeDescription
ByteString

The bytes for kmsKeyVersionName.

getMutableEntityMetrics()

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

Use alternate mutation accessors instead.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for name.

hasAllEntitiesMetrics()

public boolean hasAllEntitiesMetrics()

Metrics for all the entities in aggregate.

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

Returns
TypeDescription
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
TypeDescription
boolean

Whether the createTime field is set.

hasDocumentCounters()

public boolean hasDocumentCounters()

Counters for the documents used in the evaluation.

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

Returns
TypeDescription
boolean

Whether the documentCounters field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

internalGetMutableMapField(int number)

protected MapField internalGetMutableMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeAllEntitiesMetrics(Evaluation.MultiConfidenceMetrics value)

public Evaluation.Builder mergeAllEntitiesMetrics(Evaluation.MultiConfidenceMetrics value)

Metrics for all the entities in aggregate.

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

Parameter
NameDescription
valueEvaluation.MultiConfidenceMetrics
Returns
TypeDescription
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
NameDescription
valueTimestamp
Returns
TypeDescription
Evaluation.Builder

mergeDocumentCounters(Evaluation.Counters value)

public Evaluation.Builder mergeDocumentCounters(Evaluation.Counters value)

Counters for the documents used in the evaluation.

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

Parameter
NameDescription
valueEvaluation.Counters
Returns
TypeDescription
Evaluation.Builder

mergeFrom(Evaluation other)

public Evaluation.Builder mergeFrom(Evaluation other)
Parameter
NameDescription
otherEvaluation
Returns
TypeDescription
Evaluation.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Evaluation.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Evaluation.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public Evaluation.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
Evaluation.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Evaluation.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
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.v1.Evaluation.MultiConfidenceMetrics> entity_metrics = 4;

Parameter
NameDescription
valuesMap<String,MultiConfidenceMetrics>
Returns
TypeDescription
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.v1.Evaluation.MultiConfidenceMetrics> entity_metrics = 4;

Parameters
NameDescription
keyString
valueEvaluation.MultiConfidenceMetrics
Returns
TypeDescription
Evaluation.Builder

removeEntityMetrics(String key)

public Evaluation.Builder removeEntityMetrics(String key)

Metrics across confidence levels, for different entities.

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

Parameter
NameDescription
keyString
Returns
TypeDescription
Evaluation.Builder

setAllEntitiesMetrics(Evaluation.MultiConfidenceMetrics value)

public Evaluation.Builder setAllEntitiesMetrics(Evaluation.MultiConfidenceMetrics value)

Metrics for all the entities in aggregate.

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

Parameter
NameDescription
valueEvaluation.MultiConfidenceMetrics
Returns
TypeDescription
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.v1.Evaluation.MultiConfidenceMetrics all_entities_metrics = 3;

Parameter
NameDescription
builderForValueEvaluation.MultiConfidenceMetrics.Builder
Returns
TypeDescription
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
NameDescription
valueTimestamp
Returns
TypeDescription
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
NameDescription
builderForValueBuilder
Returns
TypeDescription
Evaluation.Builder

setDocumentCounters(Evaluation.Counters value)

public Evaluation.Builder setDocumentCounters(Evaluation.Counters value)

Counters for the documents used in the evaluation.

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

Parameter
NameDescription
valueEvaluation.Counters
Returns
TypeDescription
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.v1.Evaluation.Counters document_counters = 5;

Parameter
NameDescription
builderForValueEvaluation.Counters.Builder
Returns
TypeDescription
Evaluation.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public Evaluation.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
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
NameDescription
valueString

The kmsKeyName to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for kmsKeyName to set.

Returns
TypeDescription
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
NameDescription
valueString

The kmsKeyVersionName to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for kmsKeyVersionName to set.

Returns
TypeDescription
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
NameDescription
valueString

The name to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
Evaluation.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final Evaluation.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Evaluation.Builder
Overrides