Reference documentation and code samples for the Google Cloud Model Armor V1 Client class SdpRedactResult.
Sensitive Data Protection Redaction Result.
Generated from protobuf message google.cloud.modelarmor.v1.SdpRedactResult
Namespace
Google \ Cloud \ ModelArmor \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ execution_state |
int
Output only. Reports whether Sensitive Data Protection redaction was successfully executed or not. |
↳ message_items |
array<MessageItem>
Output only. Optional messages corresponding to the result. A message can provide warnings or error details. For example, if execution state is skipped then this field provides related reason/explanation. |
↳ match_state |
int
Output only. Match state for Sensitive Data Protection Redaction. Value is MATCH_FOUND if content is redacted. |
↳ redacted_image |
string
Output only. The redacted image. The type will be the same as the original image. |
↳ findings |
array<SdpFinding>
Output only. The findings. This field is populated in the response only when include_findings in the SDP template is set to true. |
↳ extracted_image_text |
string
The extracted text from the image. |
getExecutionState
Output only. Reports whether Sensitive Data Protection redaction was successfully executed or not.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type FilterExecutionState. |
setExecutionState
Output only. Reports whether Sensitive Data Protection redaction was successfully executed or not.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type FilterExecutionState. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMessageItems
Output only. Optional messages corresponding to the result.
A message can provide warnings or error details. For example, if execution state is skipped then this field provides related reason/explanation.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<MessageItem> |
|
setMessageItems
Output only. Optional messages corresponding to the result.
A message can provide warnings or error details. For example, if execution state is skipped then this field provides related reason/explanation.
| Parameter | |
|---|---|
| Name | Description |
var |
array<MessageItem>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMatchState
Output only. Match state for Sensitive Data Protection Redaction.
Value is MATCH_FOUND if content is redacted.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type FilterMatchState. |
setMatchState
Output only. Match state for Sensitive Data Protection Redaction.
Value is MATCH_FOUND if content is redacted.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type FilterMatchState. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRedactedImage
Output only. The redacted image. The type will be the same as the original image.
| Returns | |
|---|---|
| Type | Description |
string |
|
setRedactedImage
Output only. The redacted image. The type will be the same as the original image.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFindings
Output only. The findings. This field is populated in the response only when include_findings in the SDP template is set to true.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<SdpFinding> |
|
setFindings
Output only. The findings. This field is populated in the response only when include_findings in the SDP template is set to true.
| Parameter | |
|---|---|
| Name | Description |
var |
array<SdpFinding>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getExtractedImageText
The extracted text from the image.
| Returns | |
|---|---|
| Type | Description |
string |
|
setExtractedImageText
The extracted text from the image.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|