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

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

Overview

Validation result for a single validation rule.

Defined Under Namespace

Modules: ValidationResultType

Instance Attribute Summary collapse

Instance Attribute Details

#rule_description ⇒ ::String

Returns The description of the validation rule.

Returns:

  • (::String) —

    The description of the validation rule.



1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
 
# File 'proto_docs/google/cloud/documentai/v1/document.rb', line 1340

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

#rule_name ⇒ ::String

Returns The name of the validation rule.

Returns:

  • (::String) —

    The name of the validation rule.



1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
 
# File 'proto_docs/google/cloud/documentai/v1/document.rb', line 1340

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

#validation_details ⇒ ::String

Returns The detailed information of the running the validation process using the entity from the document based on the validation rule.

Returns:

  • (::String) —

    The detailed information of the running the validation process using the entity from the document based on the validation rule.



1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
 
# File 'proto_docs/google/cloud/documentai/v1/document.rb', line 1340

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

#validation_result_type ⇒ ::Google::Cloud::DocumentAI::V1::Document::EntityValidationOutput::ValidationResult::ValidationResultType

Returns The result of the validation rule.

Returns:



1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
 
# File 'proto_docs/google/cloud/documentai/v1/document.rb', line 1340

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