Reference documentation and code samples for the Google Cloud Document Ai V1 Client class ValidationResult.
Validation result for a single validation rule.
Generated from protobuf message google.cloud.documentai.v1.Document.EntityValidationOutput.ValidationResult
Namespace
Google \ Cloud \ DocumentAI \ V1 \ Document \ EntityValidationOutputMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ rule_name |
string
The name of the validation rule. |
↳ rule_description |
string
The description of the validation rule. |
↳ validation_result_type |
int
The result of the validation rule. |
↳ validation_details |
string
The detailed information of the running the validation process using the entity from the document based on the validation rule. |
getRuleName
The name of the validation rule.
| Returns | |
|---|---|
| Type | Description |
string |
|
setRuleName
The name of the validation rule.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRuleDescription
The description of the validation rule.
| Returns | |
|---|---|
| Type | Description |
string |
|
setRuleDescription
The description of the validation rule.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getValidationResultType
The result of the validation rule.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type ValidationResultType. |
setValidationResultType
The result of the validation rule.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type ValidationResultType. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getValidationDetails
The detailed information of the running the validation process using the entity from the document based on the validation rule.
| Returns | |
|---|---|
| Type | Description |
string |
|
setValidationDetails
The detailed information of the running the validation process using the entity from the document based on the validation rule.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|