Google Cloud Model Armor V1 Client - Class SanitizationResult (0.4.0)

Reference documentation and code samples for the Google Cloud Model Armor V1 Client class SanitizationResult.

Sanitization result after applying all the filters on input content.

Generated from protobuf message google.cloud.modelarmor.v1.SanitizationResult

Namespace

Google \ Cloud \ ModelArmor \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ filter_match_state`	`int` Output only. Overall filter match state for Sanitization. The state can have below two values. 1) NO_MATCH_FOUND: No filters in configuration satisfy matching criteria. In other words, input passed all filters. 2) MATCH_FOUND: At least one filter in configuration satisfies matching. In other words, input did not pass one or more filters.
`↳ filter_results`	`array\|Google\Protobuf\Internal\MapField` Output only. Results for all filters where the key is the filter name - either of "csam", "malicious_uris", "rai", "pi_and_jailbreak" ,"sdp".
`↳ invocation_result`	`int` Output only. A field indicating the outcome of the invocation, irrespective of match status. It can have the following three values: SUCCESS: All filters were executed successfully. PARTIAL: Some filters were skipped or failed execution. FAILURE: All filters were skipped or failed execution.
`↳ sanitization_metadata`	`SanitizationResult\SanitizationMetadata` Output only. Metadata related to Sanitization.

getFilterMatchState

Output only. Overall filter match state for Sanitization.

The state can have below two values. 1) NO_MATCH_FOUND: No filters in configuration satisfy matching criteria. In other words, input passed all filters. 2) MATCH_FOUND: At least one filter in configuration satisfies matching. In other words, input did not pass one or more filters.

Returns
Type	Description
`int`

setFilterMatchState

Output only. Overall filter match state for Sanitization.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getFilterResults

Output only. Results for all filters where the key is the filter name - either of "csam", "malicious_uris", "rai", "pi_and_jailbreak" ,"sdp".

Returns
Type	Description
`Google\Protobuf\Internal\MapField`

setFilterResults

Output only. Results for all filters where the key is the filter name - either of "csam", "malicious_uris", "rai", "pi_and_jailbreak" ,"sdp".

Parameter
Name	Description
`var`	`array\|Google\Protobuf\Internal\MapField`

Returns
Type	Description
`$this`

getInvocationResult

Output only. A field indicating the outcome of the invocation, irrespective of match status. It can have the following three values: SUCCESS: All filters were executed successfully. PARTIAL: Some filters were skipped or failed execution. FAILURE: All filters were skipped or failed execution.

Returns
Type	Description
`int`

setInvocationResult

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getSanitizationMetadata

Output only. Metadata related to Sanitization.

Returns
Type	Description
`SanitizationResult\SanitizationMetadata\|null`

hasSanitizationMetadata

clearSanitizationMetadata

setSanitizationMetadata