Interface SanitizationResultOrBuilder (0.17.0) 

public interface SanitizationResultOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsFilterResults(String key)

public abstract boolean containsFilterResults(String key)

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

map<string, .google.cloud.modelarmor.v1.FilterResult> filter_results = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
key String
Returns
Type Description
boolean

getFilterMatchState()

public abstract FilterMatchState 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.

.google.cloud.modelarmor.v1.FilterMatchState filter_match_state = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
FilterMatchState

The filterMatchState.

getFilterMatchStateValue()

public abstract int getFilterMatchStateValue()

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.

.google.cloud.modelarmor.v1.FilterMatchState filter_match_state = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for filterMatchState.

getFilterResults() (deprecated)

public abstract Map<String,FilterResult> getFilterResults()

Use #getFilterResultsMap() instead.

Returns
Type Description
Map<String,FilterResult>

getFilterResultsCount()

public abstract int getFilterResultsCount()

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

map<string, .google.cloud.modelarmor.v1.FilterResult> filter_results = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

getFilterResultsMap()

public abstract Map<String,FilterResult> getFilterResultsMap()

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

map<string, .google.cloud.modelarmor.v1.FilterResult> filter_results = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Map<String,FilterResult>

getFilterResultsOrDefault(String key, FilterResult defaultValue)

public abstract FilterResult getFilterResultsOrDefault(String key, FilterResult defaultValue)

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

map<string, .google.cloud.modelarmor.v1.FilterResult> filter_results = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
key String
defaultValue FilterResult
Returns
Type Description
FilterResult

getFilterResultsOrThrow(String key)

public abstract FilterResult getFilterResultsOrThrow(String key)

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

map<string, .google.cloud.modelarmor.v1.FilterResult> filter_results = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
key String
Returns
Type Description
FilterResult

getInvocationResult()

public abstract InvocationResult 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.

.google.cloud.modelarmor.v1.InvocationResult invocation_result = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
InvocationResult

The invocationResult.

getInvocationResultValue()

public abstract int getInvocationResultValue()

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.

.google.cloud.modelarmor.v1.InvocationResult invocation_result = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for invocationResult.

getSanitizationMetadata()

public abstract SanitizationResult.SanitizationMetadata getSanitizationMetadata()

Output only. Metadata related to Sanitization.

.google.cloud.modelarmor.v1.SanitizationResult.SanitizationMetadata sanitization_metadata = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
SanitizationResult.SanitizationMetadata

The sanitizationMetadata.

getSanitizationMetadataOrBuilder()

public abstract SanitizationResult.SanitizationMetadataOrBuilder getSanitizationMetadataOrBuilder()

Output only. Metadata related to Sanitization.

.google.cloud.modelarmor.v1.SanitizationResult.SanitizationMetadata sanitization_metadata = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
SanitizationResult.SanitizationMetadataOrBuilder

hasSanitizationMetadata()

public abstract boolean hasSanitizationMetadata()

Output only. Metadata related to Sanitization.

.google.cloud.modelarmor.v1.SanitizationResult.SanitizationMetadata sanitization_metadata = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the sanitizationMetadata field is set.