Class BedrockGuardrailDetails

java.lang.Object
software.amazon.awssdk.services.guardduty.model.BedrockGuardrailDetails
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<BedrockGuardrailDetails.Builder,BedrockGuardrailDetails>
@Generated("software.amazon.awssdk:codegen") public final class BedrockGuardrailDetails extends Object implements SdkPojo, Serializable, ToCopyableBuilder<BedrockGuardrailDetails.Builder,BedrockGuardrailDetails>

Contains information about the Bedrock guardrail that was involved in a finding.

See Also:

  • Method Details

    • guardrailArn

      @Deprecated public final String guardrailArn()
      Deprecated.
      Use guardrails list instead

      The ARN of the Bedrock guardrail. This field is deprecated. Use the guardrails list instead.

      Returns:
      The ARN of the Bedrock guardrail. This field is deprecated. Use the guardrails list instead.

    • guardrailVersion

      @Deprecated public final String guardrailVersion()
      Deprecated.
      Use guardrails list instead

      The version of the Bedrock guardrail. This field is deprecated. Use the guardrails list instead.

      Returns:
      The version of the Bedrock guardrail. This field is deprecated. Use the guardrails list instead.

    • hasGuardrails

      public final boolean hasGuardrails()
      For responses, this returns true if the service returned a value for the Guardrails property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • guardrails

      public final List<BedrockGuardrail> guardrails()

      The list of Bedrock guardrails associated with the finding.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasGuardrails() method.

      Returns:
      The list of Bedrock guardrails associated with the finding.

    • guardrailAction

      public final GuardrailAction guardrailAction()

      Indicates whether the guardrail intervened or not.

      If the service returns an enum value that is not available in the current SDK version, guardrailAction will return GuardrailAction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from guardrailActionAsString().

      Returns:
      Indicates whether the guardrail intervened or not.
      See Also:

    • guardrailActionAsString

      public final String guardrailActionAsString()

      Indicates whether the guardrail intervened or not.

      If the service returns an enum value that is not available in the current SDK version, guardrailAction will return GuardrailAction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from guardrailActionAsString().

      Returns:
      Indicates whether the guardrail intervened or not.
      See Also:

    • guardrailSource

      public final GuardrailSource guardrailSource()

      Indicates whether the guardrail was applied on the input or output of the model invocation.

      If the service returns an enum value that is not available in the current SDK version, guardrailSource will return GuardrailSource.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from guardrailSourceAsString().

      Returns:
      Indicates whether the guardrail was applied on the input or output of the model invocation.
      See Also:

    • guardrailSourceAsString

      public final String guardrailSourceAsString()

      Indicates whether the guardrail was applied on the input or output of the model invocation.

      If the service returns an enum value that is not available in the current SDK version, guardrailSource will return GuardrailSource.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from guardrailSourceAsString().

      Returns:
      Indicates whether the guardrail was applied on the input or output of the model invocation.
      See Also:

    • hasContentPolicyFilters

      public final boolean hasContentPolicyFilters()
      For responses, this returns true if the service returned a value for the ContentPolicyFilters property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • contentPolicyFilters

      public final List<ContentPolicyFilter> contentPolicyFilters()

      The list of content policy filters that matched during the guardrail evaluation.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasContentPolicyFilters() method.

      Returns:
      The list of content policy filters that matched during the guardrail evaluation.

    • toBuilder

      public BedrockGuardrailDetails.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<BedrockGuardrailDetails.Builder,BedrockGuardrailDetails>
      Returns:
      a builder for type T

    • builder

      public static BedrockGuardrailDetails.Builder builder()

    • serializableBuilderClass

      public static Class<? extends BedrockGuardrailDetails.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.