Package com.google.cloud.modelarmor.v1beta

Interface RaiFilterResultOrBuilder

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

  • Method Details

    • getExecutionStateValue

      int getExecutionStateValue()
       Output only. Reports whether the RAI filter was successfully executed or
 not.
      .google.cloud.modelarmor.v1beta.FilterExecutionState execution_state = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The enum numeric value on the wire for executionState.

    • getExecutionState

      FilterExecutionState getExecutionState()
       Output only. Reports whether the RAI filter was successfully executed or
 not.
      .google.cloud.modelarmor.v1beta.FilterExecutionState execution_state = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The executionState.

    • getMessageItemsList

      List<MessageItem> getMessageItemsList()
       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.
      repeated .google.cloud.modelarmor.v1beta.MessageItem message_items = 2;

    • getMessageItems

      MessageItem getMessageItems(int index)
       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.
      repeated .google.cloud.modelarmor.v1beta.MessageItem message_items = 2;

    • getMessageItemsCount

      int getMessageItemsCount()
       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.
      repeated .google.cloud.modelarmor.v1beta.MessageItem message_items = 2;

    • getMessageItemsOrBuilderList

      List<? extends MessageItemOrBuilder> getMessageItemsOrBuilderList()
       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.
      repeated .google.cloud.modelarmor.v1beta.MessageItem message_items = 2;

    • getMessageItemsOrBuilder

      MessageItemOrBuilder getMessageItemsOrBuilder(int index)
       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.
      repeated .google.cloud.modelarmor.v1beta.MessageItem message_items = 2;

    • getMatchStateValue

      int getMatchStateValue()
       Output only. Overall filter match state for RAI.
 Value is MATCH_FOUND if at least one RAI filter confidence level is
 equal to or higher than the confidence level defined in configuration.
      .google.cloud.modelarmor.v1beta.FilterMatchState match_state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The enum numeric value on the wire for matchState.

    • getMatchState

      FilterMatchState getMatchState()
       Output only. Overall filter match state for RAI.
 Value is MATCH_FOUND if at least one RAI filter confidence level is
 equal to or higher than the confidence level defined in configuration.
      .google.cloud.modelarmor.v1beta.FilterMatchState match_state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The matchState.

    • getRaiFilterTypeResultsCount

      int getRaiFilterTypeResultsCount()
       The map of RAI filter results where key is RAI filter type - either of
 "sexually_explicit", "hate_speech", "harassment", "dangerous", "violence",
 "sexually_suggestive".
      map<string, .google.cloud.modelarmor.v1beta.RaiFilterResult.RaiFilterTypeResult> rai_filter_type_results = 4;

    • containsRaiFilterTypeResults

      boolean containsRaiFilterTypeResults(String key)
       The map of RAI filter results where key is RAI filter type - either of
 "sexually_explicit", "hate_speech", "harassment", "dangerous", "violence",
 "sexually_suggestive".
      map<string, .google.cloud.modelarmor.v1beta.RaiFilterResult.RaiFilterTypeResult> rai_filter_type_results = 4;

    • getRaiFilterTypeResults

      @Deprecated Map<String,RaiFilterResult.RaiFilterTypeResult> getRaiFilterTypeResults()
      Deprecated.
      Use getRaiFilterTypeResultsMap() instead.

    • getRaiFilterTypeResultsMap

      Map<String,RaiFilterResult.RaiFilterTypeResult> getRaiFilterTypeResultsMap()
       The map of RAI filter results where key is RAI filter type - either of
 "sexually_explicit", "hate_speech", "harassment", "dangerous", "violence",
 "sexually_suggestive".
      map<string, .google.cloud.modelarmor.v1beta.RaiFilterResult.RaiFilterTypeResult> rai_filter_type_results = 4;

    • getRaiFilterTypeResultsOrDefault

      RaiFilterResult.RaiFilterTypeResult getRaiFilterTypeResultsOrDefault(String key, RaiFilterResult.RaiFilterTypeResult defaultValue)
       The map of RAI filter results where key is RAI filter type - either of
 "sexually_explicit", "hate_speech", "harassment", "dangerous", "violence",
 "sexually_suggestive".
      map<string, .google.cloud.modelarmor.v1beta.RaiFilterResult.RaiFilterTypeResult> rai_filter_type_results = 4;

    • getRaiFilterTypeResultsOrThrow

      RaiFilterResult.RaiFilterTypeResult getRaiFilterTypeResultsOrThrow(String key)
       The map of RAI filter results where key is RAI filter type - either of
 "sexually_explicit", "hate_speech", "harassment", "dangerous", "violence",
 "sexually_suggestive".
      map<string, .google.cloud.modelarmor.v1beta.RaiFilterResult.RaiFilterTypeResult> rai_filter_type_results = 4;