Package com.google.cloud.modelarmor.v1beta

Class RaiFilterResult

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.modelarmor.v1beta.RaiFilterResult
All Implemented Interfaces:
RaiFilterResultOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class RaiFilterResult extends com.google.protobuf.GeneratedMessage implements RaiFilterResultOrBuilder
 Responsible AI Result.
Protobuf type google.cloud.modelarmor.v1beta.RaiFilterResult
See Also:

  • Field Details

    • EXECUTION_STATE_FIELD_NUMBER

      public static final int EXECUTION_STATE_FIELD_NUMBER
      See Also:

    • MESSAGE_ITEMS_FIELD_NUMBER

      public static final int MESSAGE_ITEMS_FIELD_NUMBER
      See Also:

    • MATCH_STATE_FIELD_NUMBER

      public static final int MATCH_STATE_FIELD_NUMBER
      See Also:

    • RAI_FILTER_TYPE_RESULTS_FIELD_NUMBER

      public static final int RAI_FILTER_TYPE_RESULTS_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getExecutionStateValue

      public 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];
      Specified by:
      getExecutionStateValue in interface RaiFilterResultOrBuilder
      Returns:
      The enum numeric value on the wire for executionState.

    • getExecutionState

      public 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];
      Specified by:
      getExecutionState in interface RaiFilterResultOrBuilder
      Returns:
      The executionState.

    • getMessageItemsList

      public 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;
      Specified by:
      getMessageItemsList in interface RaiFilterResultOrBuilder

    • getMessageItemsOrBuilderList

      public 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;
      Specified by:
      getMessageItemsOrBuilderList in interface RaiFilterResultOrBuilder

    • getMessageItemsCount

      public 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;
      Specified by:
      getMessageItemsCount in interface RaiFilterResultOrBuilder

    • getMessageItems

      public 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;
      Specified by:
      getMessageItems in interface RaiFilterResultOrBuilder

    • getMessageItemsOrBuilder

      public 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;
      Specified by:
      getMessageItemsOrBuilder in interface RaiFilterResultOrBuilder

    • getMatchStateValue

      public 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];
      Specified by:
      getMatchStateValue in interface RaiFilterResultOrBuilder
      Returns:
      The enum numeric value on the wire for matchState.

    • getMatchState

      public 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];
      Specified by:
      getMatchState in interface RaiFilterResultOrBuilder
      Returns:
      The matchState.

    • getRaiFilterTypeResultsCount

      public int getRaiFilterTypeResultsCount()
      Description copied from interface: RaiFilterResultOrBuilder
       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;
      Specified by:
      getRaiFilterTypeResultsCount in interface RaiFilterResultOrBuilder

    • containsRaiFilterTypeResults

      public 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;
      Specified by:
      containsRaiFilterTypeResults in interface RaiFilterResultOrBuilder

    • getRaiFilterTypeResults

      @Deprecated public Map<String,RaiFilterResult.RaiFilterTypeResult> getRaiFilterTypeResults()
      Deprecated.
      Use getRaiFilterTypeResultsMap() instead.
      Specified by:
      getRaiFilterTypeResults in interface RaiFilterResultOrBuilder

    • getRaiFilterTypeResultsMap

      public 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;
      Specified by:
      getRaiFilterTypeResultsMap in interface RaiFilterResultOrBuilder

    • getRaiFilterTypeResultsOrDefault

      public 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;
      Specified by:
      getRaiFilterTypeResultsOrDefault in interface RaiFilterResultOrBuilder

    • getRaiFilterTypeResultsOrThrow

      public 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;
      Specified by:
      getRaiFilterTypeResultsOrThrow in interface RaiFilterResultOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static RaiFilterResult parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RaiFilterResult parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RaiFilterResult parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RaiFilterResult parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RaiFilterResult parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RaiFilterResult parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RaiFilterResult parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static RaiFilterResult parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static RaiFilterResult parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static RaiFilterResult parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static RaiFilterResult parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static RaiFilterResult parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public RaiFilterResult.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static RaiFilterResult.Builder newBuilder()

    • newBuilder

      public static RaiFilterResult.Builder newBuilder(RaiFilterResult prototype)

    • toBuilder

      public RaiFilterResult.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected RaiFilterResult.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static RaiFilterResult getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<RaiFilterResult> parser()

    • getParserForType

      public com.google.protobuf.Parser<RaiFilterResult> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public RaiFilterResult getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder