Package com.google.cloud.modelarmor.v1beta

Interface SanitizationResultOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
SanitizationResult, SanitizationResult.Builder
@Generated public interface SanitizationResultOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getFilterMatchStateValue

      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.v1beta.FilterMatchState filter_match_state = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The enum numeric value on the wire for filterMatchState.

    • getFilterMatchState

      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.v1beta.FilterMatchState filter_match_state = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The filterMatchState.

    • getFilterResultsCount

      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.v1beta.FilterResult> filter_results = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • containsFilterResults

      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.v1beta.FilterResult> filter_results = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getFilterResults

      @Deprecated Map<String,FilterResult> getFilterResults()
      Deprecated.
      Use getFilterResultsMap() instead.

    • getFilterResultsMap

      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.v1beta.FilterResult> filter_results = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getFilterResultsOrDefault

      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.v1beta.FilterResult> filter_results = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getFilterResultsOrThrow

      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.v1beta.FilterResult> filter_results = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getInvocationResultValue

      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.v1beta.InvocationResult invocation_result = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The enum numeric value on the wire for invocationResult.

    • getInvocationResult

      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.v1beta.InvocationResult invocation_result = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The invocationResult.

    • hasSanitizationMetadata

      boolean hasSanitizationMetadata()
       Output only. Metadata related to Sanitization.
      .google.cloud.modelarmor.v1beta.SanitizationResult.SanitizationMetadata sanitization_metadata = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the sanitizationMetadata field is set.

    • getSanitizationMetadata

      SanitizationResult.SanitizationMetadata getSanitizationMetadata()
       Output only. Metadata related to Sanitization.
      .google.cloud.modelarmor.v1beta.SanitizationResult.SanitizationMetadata sanitization_metadata = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The sanitizationMetadata.

    • getSanitizationMetadataOrBuilder

      SanitizationResult.SanitizationMetadataOrBuilder getSanitizationMetadataOrBuilder()
       Output only. Metadata related to Sanitization.
      .google.cloud.modelarmor.v1beta.SanitizationResult.SanitizationMetadata sanitization_metadata = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];