Class: Google::Cloud::DocumentAI::V1::Document::EntityValidationOutput

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/documentai/v1/document.rb

Overview

The output of the validation given the document and the validation rules.

Defined Under Namespace

Classes: ValidationResult

Instance Attribute Summary collapse

Instance Attribute Details

#pass_all_rules ⇒ ::Boolean

Returns The overall result of the validation, true if all applicable rules are valid.

Returns:

  • (::Boolean) —

    The overall result of the validation, true if all applicable rules are valid.



1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
 
# File 'proto_docs/google/cloud/documentai/v1/document.rb', line 1322

class EntityValidationOutput
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Validation result for a single validation rule.
  # @!attribute [rw] rule_name
  #   @return [::String]
  #     The name of the validation rule.
  # @!attribute [rw] rule_description
  #   @return [::String]
  #     The description of the validation rule.
  # @!attribute [rw] validation_result_type
  #   @return [::Google::Cloud::DocumentAI::V1::Document::EntityValidationOutput::ValidationResult::ValidationResultType]
  #     The result of the validation rule.
  # @!attribute [rw] validation_details
  #   @return [::String]
  #     The detailed information of the running the validation process using
  #     the entity from the document based on the validation rule.
  class ValidationResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The result of the validation rule.
    module ValidationResultType
      # The validation result type is unspecified.
      VALIDATION_RESULT_TYPE_UNSPECIFIED = 0

      # The validation is valid.
      VALIDATION_RESULT_TYPE_VALID = 1

      # The validation is invalid.
      VALIDATION_RESULT_TYPE_INVALID = 2

      # The validation is skipped.
      VALIDATION_RESULT_TYPE_SKIPPED = 3

      # The validation is not applicable.
      VALIDATION_RESULT_TYPE_NOT_APPLICABLE = 4
    end
  end
end

#validation_results ⇒ ::Array<::Google::Cloud::DocumentAI::V1::Document::EntityValidationOutput::ValidationResult>

Returns The result of each validation rule.

Returns:



1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
 
# File 'proto_docs/google/cloud/documentai/v1/document.rb', line 1322

class EntityValidationOutput
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Validation result for a single validation rule.
  # @!attribute [rw] rule_name
  #   @return [::String]
  #     The name of the validation rule.
  # @!attribute [rw] rule_description
  #   @return [::String]
  #     The description of the validation rule.
  # @!attribute [rw] validation_result_type
  #   @return [::Google::Cloud::DocumentAI::V1::Document::EntityValidationOutput::ValidationResult::ValidationResultType]
  #     The result of the validation rule.
  # @!attribute [rw] validation_details
  #   @return [::String]
  #     The detailed information of the running the validation process using
  #     the entity from the document based on the validation rule.
  class ValidationResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The result of the validation rule.
    module ValidationResultType
      # The validation result type is unspecified.
      VALIDATION_RESULT_TYPE_UNSPECIFIED = 0

      # The validation is valid.
      VALIDATION_RESULT_TYPE_VALID = 1

      # The validation is invalid.
      VALIDATION_RESULT_TYPE_INVALID = 2

      # The validation is skipped.
      VALIDATION_RESULT_TYPE_SKIPPED = 3

      # The validation is not applicable.
      VALIDATION_RESULT_TYPE_NOT_APPLICABLE = 4
    end
  end
end