Package com.google.cloud.modelarmor.v1beta

Class RaiFilterResult.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<RaiFilterResult.Builder>
com.google.cloud.modelarmor.v1beta.RaiFilterResult.Builder
All Implemented Interfaces:
RaiFilterResultOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
RaiFilterResult
public static final class RaiFilterResult.Builder extends com.google.protobuf.GeneratedMessage.Builder<RaiFilterResult.Builder> implements RaiFilterResultOrBuilder
 Responsible AI Result.
Protobuf type google.cloud.modelarmor.v1beta.RaiFilterResult

  • 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.Builder<RaiFilterResult.Builder>

    • internalGetMutableMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
      Overrides:
      internalGetMutableMapFieldReflection in class com.google.protobuf.GeneratedMessage.Builder<RaiFilterResult.Builder>

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<RaiFilterResult.Builder>

    • clear

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

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<RaiFilterResult.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

      public RaiFilterResult.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<RaiFilterResult.Builder>

    • mergeFrom

      public RaiFilterResult.Builder mergeFrom(RaiFilterResult other)

    • isInitialized

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

    • mergeFrom

      public RaiFilterResult.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<RaiFilterResult.Builder>
      Throws:
      IOException

    • 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.

    • setExecutionStateValue

      public RaiFilterResult.Builder setExecutionStateValue(int value)
       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];
      Parameters:
      value - The enum numeric value on the wire for executionState to set.
      Returns:
      This builder for chaining.

    • 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.

    • setExecutionState

      public RaiFilterResult.Builder setExecutionState(FilterExecutionState value)
       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];
      Parameters:
      value - The executionState to set.
      Returns:
      This builder for chaining.

    • clearExecutionState

      public RaiFilterResult.Builder clearExecutionState()
       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:
      This builder for chaining.

    • 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

    • 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

    • setMessageItems

      public RaiFilterResult.Builder setMessageItems(int index, MessageItem value)
       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;

    • setMessageItems

      public RaiFilterResult.Builder setMessageItems(int index, MessageItem.Builder builderForValue)
       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;

    • addMessageItems

      public RaiFilterResult.Builder addMessageItems(MessageItem value)
       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;

    • addMessageItems

      public RaiFilterResult.Builder addMessageItems(int index, MessageItem value)
       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;

    • addMessageItems

      public RaiFilterResult.Builder addMessageItems(MessageItem.Builder builderForValue)
       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;

    • addMessageItems

      public RaiFilterResult.Builder addMessageItems(int index, MessageItem.Builder builderForValue)
       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;

    • addAllMessageItems

      public RaiFilterResult.Builder addAllMessageItems(Iterable<? extends MessageItem> values)
       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;

    • clearMessageItems

      public RaiFilterResult.Builder clearMessageItems()
       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;

    • removeMessageItems

      public RaiFilterResult.Builder removeMessageItems(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;

    • getMessageItemsBuilder

      public MessageItem.Builder getMessageItemsBuilder(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;

    • 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

    • 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

    • addMessageItemsBuilder

      public MessageItem.Builder addMessageItemsBuilder()
       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;

    • addMessageItemsBuilder

      public MessageItem.Builder addMessageItemsBuilder(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;

    • getMessageItemsBuilderList

      public List<MessageItem.Builder> getMessageItemsBuilderList()
       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

      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.

    • setMatchStateValue

      public RaiFilterResult.Builder setMatchStateValue(int value)
       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];
      Parameters:
      value - The enum numeric value on the wire for matchState to set.
      Returns:
      This builder for chaining.

    • 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.

    • setMatchState

      public RaiFilterResult.Builder setMatchState(FilterMatchState value)
       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];
      Parameters:
      value - The matchState to set.
      Returns:
      This builder for chaining.

    • clearMatchState

      public RaiFilterResult.Builder clearMatchState()
       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:
      This builder for chaining.

    • 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

    • clearRaiFilterTypeResults

      public RaiFilterResult.Builder clearRaiFilterTypeResults()

    • removeRaiFilterTypeResults

      public RaiFilterResult.Builder removeRaiFilterTypeResults(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;

    • getMutableRaiFilterTypeResults

      @Deprecated public Map<String,RaiFilterResult.RaiFilterTypeResult> getMutableRaiFilterTypeResults()
      Deprecated.
      Use alternate mutation accessors instead.

    • putRaiFilterTypeResults

      public RaiFilterResult.Builder putRaiFilterTypeResults(String key, RaiFilterResult.RaiFilterTypeResult value)
       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;

    • putAllRaiFilterTypeResults

      public RaiFilterResult.Builder putAllRaiFilterTypeResults(Map<String,RaiFilterResult.RaiFilterTypeResult> values)
       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;

    • putRaiFilterTypeResultsBuilderIfAbsent

      public RaiFilterResult.RaiFilterTypeResult.Builder putRaiFilterTypeResultsBuilderIfAbsent(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;