Package com.google.cloud.documentai.v1

Class Evaluation.Builder

  • All Implemented Interfaces:
    EvaluationOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
    Enclosing class:
    Evaluation
    public static final class Evaluation.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<Evaluation.Builder>
implements EvaluationOrBuilder
     An evaluation of a ProcessorVersion's performance.
    Protobuf type google.cloud.documentai.v1.Evaluation

    • Method Detail

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3.Builder<Evaluation.Builder>

      • internalGetMutableMapField

        protected com.google.protobuf.MapField internalGetMutableMapField​(int number)
        Overrides:
        internalGetMutableMapField in class com.google.protobuf.GeneratedMessageV3.Builder<Evaluation.Builder>

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<Evaluation.Builder>

      • clear

        public Evaluation.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<Evaluation.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Evaluation.Builder>

      • getDefaultInstanceForType

        public Evaluation getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

      • build

        public Evaluation build()
        Specified by:
        build in interface com.google.protobuf.Message.Builder
        Specified by:
        build in interface com.google.protobuf.MessageLite.Builder

      • buildPartial

        public Evaluation buildPartial()
        Specified by:
        buildPartial in interface com.google.protobuf.Message.Builder
        Specified by:
        buildPartial in interface com.google.protobuf.MessageLite.Builder

      • clone

        public Evaluation.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<Evaluation.Builder>

      • setField

        public Evaluation.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                   Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<Evaluation.Builder>

      • clearField

        public Evaluation.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<Evaluation.Builder>

      • clearOneof

        public Evaluation.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Evaluation.Builder>

      • setRepeatedField

        public Evaluation.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                           int index,
                                           Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Evaluation.Builder>

      • addRepeatedField

        public Evaluation.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                           Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Evaluation.Builder>

      • mergeFrom

        public Evaluation.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Evaluation.Builder>

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Evaluation.Builder>

      • mergeFrom

        public Evaluation.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Evaluation.Builder>
        Throws:
        IOException

      • 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;
        Specified by:
        getName in interface EvaluationOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         The resource name of the evaluation.
 Format:
 `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}/evaluations/{evaluation}`
        string name = 1;
        Specified by:
        getNameBytes in interface EvaluationOrBuilder
        Returns:
        The bytes for name.

      • setName

        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;
        Parameters:
        value - The name to set.
        Returns:
        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:
        This builder for chaining.

      • setNameBytes

        public Evaluation.Builder setNameBytes​(com.google.protobuf.ByteString value)
         The resource name of the evaluation.
 Format:
 `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}/evaluations/{evaluation}`
        string name = 1;
        Parameters:
        value - The bytes for name to set.
        Returns:
        This builder for chaining.

      • hasCreateTime

        public boolean hasCreateTime()
         The time that the evaluation was created.
        .google.protobuf.Timestamp create_time = 2;
        Specified by:
        hasCreateTime in interface EvaluationOrBuilder
        Returns:
        Whether the createTime field is set.

      • getCreateTime

        public com.google.protobuf.Timestamp getCreateTime()
         The time that the evaluation was created.
        .google.protobuf.Timestamp create_time = 2;
        Specified by:
        getCreateTime in interface EvaluationOrBuilder
        Returns:
        The createTime.

      • setCreateTime

        public Evaluation.Builder setCreateTime​(com.google.protobuf.Timestamp value)
         The time that the evaluation was created.
        .google.protobuf.Timestamp create_time = 2;

      • setCreateTime

        public Evaluation.Builder setCreateTime​(com.google.protobuf.Timestamp.Builder builderForValue)
         The time that the evaluation was created.
        .google.protobuf.Timestamp create_time = 2;

      • mergeCreateTime

        public Evaluation.Builder mergeCreateTime​(com.google.protobuf.Timestamp value)
         The time that the evaluation was created.
        .google.protobuf.Timestamp create_time = 2;

      • clearCreateTime

        public Evaluation.Builder clearCreateTime()
         The time that the evaluation was created.
        .google.protobuf.Timestamp create_time = 2;

      • getCreateTimeBuilder

        public com.google.protobuf.Timestamp.Builder getCreateTimeBuilder()
         The time that the evaluation was created.
        .google.protobuf.Timestamp create_time = 2;

      • getCreateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         The time that the evaluation was created.
        .google.protobuf.Timestamp create_time = 2;
        Specified by:
        getCreateTimeOrBuilder in interface EvaluationOrBuilder

      • hasDocumentCounters

        public boolean hasDocumentCounters()
         Counters for the documents used in the evaluation.
        .google.cloud.documentai.v1.Evaluation.Counters document_counters = 5;
        Specified by:
        hasDocumentCounters in interface EvaluationOrBuilder
        Returns:
        Whether the documentCounters field is set.

      • getDocumentCounters

        public Evaluation.Counters getDocumentCounters()
         Counters for the documents used in the evaluation.
        .google.cloud.documentai.v1.Evaluation.Counters document_counters = 5;
        Specified by:
        getDocumentCounters in interface EvaluationOrBuilder
        Returns:
        The documentCounters.

      • setDocumentCounters

        public Evaluation.Builder setDocumentCounters​(Evaluation.Counters value)
         Counters for the documents used in the evaluation.
        .google.cloud.documentai.v1.Evaluation.Counters document_counters = 5;

      • setDocumentCounters

        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;

      • mergeDocumentCounters

        public Evaluation.Builder mergeDocumentCounters​(Evaluation.Counters value)
         Counters for the documents used in the evaluation.
        .google.cloud.documentai.v1.Evaluation.Counters document_counters = 5;

      • clearDocumentCounters

        public Evaluation.Builder clearDocumentCounters()
         Counters for the documents used in the evaluation.
        .google.cloud.documentai.v1.Evaluation.Counters document_counters = 5;

      • getDocumentCountersBuilder

        public Evaluation.Counters.Builder getDocumentCountersBuilder()
         Counters for the documents used in the evaluation.
        .google.cloud.documentai.v1.Evaluation.Counters document_counters = 5;

      • hasAllEntitiesMetrics

        public boolean hasAllEntitiesMetrics()
         Metrics for all the entities in aggregate.
        .google.cloud.documentai.v1.Evaluation.MultiConfidenceMetrics all_entities_metrics = 3;
        Specified by:
        hasAllEntitiesMetrics in interface EvaluationOrBuilder
        Returns:
        Whether the allEntitiesMetrics field is set.

      • clearAllEntitiesMetrics

        public Evaluation.Builder clearAllEntitiesMetrics()
         Metrics for all the entities in aggregate.
        .google.cloud.documentai.v1.Evaluation.MultiConfidenceMetrics all_entities_metrics = 3;

      • getAllEntitiesMetricsBuilder

        public Evaluation.MultiConfidenceMetrics.Builder getAllEntitiesMetricsBuilder()
         Metrics for all the entities in aggregate.
        .google.cloud.documentai.v1.Evaluation.MultiConfidenceMetrics all_entities_metrics = 3;

      • getEntityMetricsCount

        public int getEntityMetricsCount()
        Description copied from interface: EvaluationOrBuilder
         Metrics across confidence levels, for different entities.
        map<string, .google.cloud.documentai.v1.Evaluation.MultiConfidenceMetrics> entity_metrics = 4;
        Specified by:
        getEntityMetricsCount in interface EvaluationOrBuilder

      • containsEntityMetrics

        public boolean containsEntityMetrics​(String key)
         Metrics across confidence levels, for different entities.
        map<string, .google.cloud.documentai.v1.Evaluation.MultiConfidenceMetrics> entity_metrics = 4;
        Specified by:
        containsEntityMetrics in interface EvaluationOrBuilder

      • removeEntityMetrics

        public Evaluation.Builder removeEntityMetrics​(String key)
         Metrics across confidence levels, for different entities.
        map<string, .google.cloud.documentai.v1.Evaluation.MultiConfidenceMetrics> entity_metrics = 4;

      • getKmsKeyName

        public String getKmsKeyName()
         The KMS key name used for encryption.
        string kms_key_name = 6;
        Specified by:
        getKmsKeyName in interface EvaluationOrBuilder
        Returns:
        The kmsKeyName.

      • getKmsKeyNameBytes

        public com.google.protobuf.ByteString getKmsKeyNameBytes()
         The KMS key name used for encryption.
        string kms_key_name = 6;
        Specified by:
        getKmsKeyNameBytes in interface EvaluationOrBuilder
        Returns:
        The bytes for kmsKeyName.

      • setKmsKeyName

        public Evaluation.Builder setKmsKeyName​(String value)
         The KMS key name used for encryption.
        string kms_key_name = 6;
        Parameters:
        value - The kmsKeyName to set.
        Returns:
        This builder for chaining.

      • clearKmsKeyName

        public Evaluation.Builder clearKmsKeyName()
         The KMS key name used for encryption.
        string kms_key_name = 6;
        Returns:
        This builder for chaining.

      • setKmsKeyNameBytes

        public Evaluation.Builder setKmsKeyNameBytes​(com.google.protobuf.ByteString value)
         The KMS key name used for encryption.
        string kms_key_name = 6;
        Parameters:
        value - The bytes for kmsKeyName to set.
        Returns:
        This builder for chaining.

      • getKmsKeyVersionName

        public String getKmsKeyVersionName()
         The KMS key version with which data is encrypted.
        string kms_key_version_name = 7;
        Specified by:
        getKmsKeyVersionName in interface EvaluationOrBuilder
        Returns:
        The kmsKeyVersionName.

      • getKmsKeyVersionNameBytes

        public com.google.protobuf.ByteString getKmsKeyVersionNameBytes()
         The KMS key version with which data is encrypted.
        string kms_key_version_name = 7;
        Specified by:
        getKmsKeyVersionNameBytes in interface EvaluationOrBuilder
        Returns:
        The bytes for kmsKeyVersionName.

      • setKmsKeyVersionName

        public Evaluation.Builder setKmsKeyVersionName​(String value)
         The KMS key version with which data is encrypted.
        string kms_key_version_name = 7;
        Parameters:
        value - The kmsKeyVersionName to set.
        Returns:
        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:
        This builder for chaining.

      • setKmsKeyVersionNameBytes

        public Evaluation.Builder setKmsKeyVersionNameBytes​(com.google.protobuf.ByteString value)
         The KMS key version with which data is encrypted.
        string kms_key_version_name = 7;
        Parameters:
        value - The bytes for kmsKeyVersionName to set.
        Returns:
        This builder for chaining.

      • setUnknownFields

        public final Evaluation.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Evaluation.Builder>

      • mergeUnknownFields

        public final Evaluation.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Evaluation.Builder>