Package com.google.cloud.documentai.v1

Class Evaluation.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<Evaluation.Builder>
com.google.cloud.documentai.v1.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.GeneratedMessage.Builder<Evaluation.Builder> implements EvaluationOrBuilder
 An evaluation of a ProcessorVersion's performance.
Protobuf type google.cloud.documentai.v1.Evaluation

  • Method Details

    • getDescriptor

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

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage.Builder<Evaluation.Builder>

    • internalGetMutableMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
      Overrides:
      internalGetMutableMapFieldReflection in class com.google.protobuf.GeneratedMessage.Builder<Evaluation.Builder>

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.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.GeneratedMessage.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.GeneratedMessage.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

    • 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>

    • mergeFrom

      public Evaluation.Builder mergeFrom(Evaluation other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.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;

    • getDocumentCountersOrBuilder

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

    • 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.

    • getAllEntitiesMetrics

      public Evaluation.MultiConfidenceMetrics getAllEntitiesMetrics()
       Metrics for all the entities in aggregate.
      .google.cloud.documentai.v1.Evaluation.MultiConfidenceMetrics all_entities_metrics = 3;
      Specified by:
      getAllEntitiesMetrics in interface EvaluationOrBuilder
      Returns:
      The allEntitiesMetrics.

    • setAllEntitiesMetrics

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

    • setAllEntitiesMetrics

      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;

    • mergeAllEntitiesMetrics

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

    • 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;

    • getAllEntitiesMetricsOrBuilder

      public Evaluation.MultiConfidenceMetricsOrBuilder getAllEntitiesMetricsOrBuilder()
       Metrics for all the entities in aggregate.
      .google.cloud.documentai.v1.Evaluation.MultiConfidenceMetrics all_entities_metrics = 3;
      Specified by:
      getAllEntitiesMetricsOrBuilder in interface EvaluationOrBuilder

    • 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

    • getEntityMetrics

      @Deprecated public Map<String,Evaluation.MultiConfidenceMetrics> getEntityMetrics()
      Deprecated.
      Use getEntityMetricsMap() instead.
      Specified by:
      getEntityMetrics in interface EvaluationOrBuilder

    • 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;
      Specified by:
      getEntityMetricsMap in interface EvaluationOrBuilder

    • getEntityMetricsOrDefault

      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;
      Specified by:
      getEntityMetricsOrDefault in interface EvaluationOrBuilder

    • getEntityMetricsOrThrow

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

    • clearEntityMetrics

      public Evaluation.Builder clearEntityMetrics()

    • 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;

    • getMutableEntityMetrics

      @Deprecated public Map<String,Evaluation.MultiConfidenceMetrics> getMutableEntityMetrics()
      Deprecated.
      Use alternate mutation accessors instead.

    • putEntityMetrics

      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;

    • putAllEntityMetrics

      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;

    • putEntityMetricsBuilderIfAbsent

      public Evaluation.MultiConfidenceMetrics.Builder putEntityMetricsBuilderIfAbsent(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.