Package com.google.cloud.modelarmor.v1beta

Class SanitizationResult

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.modelarmor.v1beta.SanitizationResult
All Implemented Interfaces:
SanitizationResultOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class SanitizationResult extends com.google.protobuf.GeneratedMessage implements SanitizationResultOrBuilder
 Sanitization result after applying all the filters on input content.
Protobuf type google.cloud.modelarmor.v1beta.SanitizationResult
See Also:

  • Field Details

    • FILTER_MATCH_STATE_FIELD_NUMBER

      public static final int FILTER_MATCH_STATE_FIELD_NUMBER
      See Also:

    • FILTER_RESULTS_FIELD_NUMBER

      public static final int FILTER_RESULTS_FIELD_NUMBER
      See Also:

    • INVOCATION_RESULT_FIELD_NUMBER

      public static final int INVOCATION_RESULT_FIELD_NUMBER
      See Also:

    • SANITIZATION_METADATA_FIELD_NUMBER

      public static final int SANITIZATION_METADATA_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

    • getFilterMatchStateValue

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

    • getFilterMatchState

      public 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];
      Specified by:
      getFilterMatchState in interface SanitizationResultOrBuilder
      Returns:
      The filterMatchState.

    • getFilterResultsCount

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

    • containsFilterResults

      public 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];
      Specified by:
      containsFilterResults in interface SanitizationResultOrBuilder

    • getFilterResults

      @Deprecated public Map<String,FilterResult> getFilterResults()
      Deprecated.
      Use getFilterResultsMap() instead.
      Specified by:
      getFilterResults in interface SanitizationResultOrBuilder

    • getFilterResultsMap

      public 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];
      Specified by:
      getFilterResultsMap in interface SanitizationResultOrBuilder

    • getFilterResultsOrDefault

      public 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];
      Specified by:
      getFilterResultsOrDefault in interface SanitizationResultOrBuilder

    • getFilterResultsOrThrow

      public 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];
      Specified by:
      getFilterResultsOrThrow in interface SanitizationResultOrBuilder

    • getInvocationResultValue

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

    • getInvocationResult

      public 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];
      Specified by:
      getInvocationResult in interface SanitizationResultOrBuilder
      Returns:
      The invocationResult.

    • hasSanitizationMetadata

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

    • getSanitizationMetadata

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

    • getSanitizationMetadataOrBuilder

      public SanitizationResult.SanitizationMetadataOrBuilder getSanitizationMetadataOrBuilder()
       Output only. Metadata related to Sanitization.
      .google.cloud.modelarmor.v1beta.SanitizationResult.SanitizationMetadata sanitization_metadata = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getSanitizationMetadataOrBuilder in interface SanitizationResultOrBuilder

    • 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 SanitizationResult parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static SanitizationResult.Builder newBuilder()

    • newBuilder

      public static SanitizationResult.Builder newBuilder(SanitizationResult prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static SanitizationResult getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<SanitizationResult> 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 SanitizationResult getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder