Class BedrockGuardrailResource

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

Contains details about an Amazon Bedrock guardrail evaluated during a model invocation.

See Also:

  • Method Details

    • version

      public final String version()

      The version of the Amazon Bedrock guardrail. Valid values are a numeric version, DRAFT, or ENFORCED.

      Returns:
      The version of the Amazon Bedrock guardrail. Valid values are a numeric version, DRAFT, or ENFORCED.

    • guardrailAction

      public final GuardrailAction guardrailAction()

      Indicates whether the guardrail intervened during the model invocation.

      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 during the model invocation.
      See Also:

    • guardrailActionAsString

      public final String guardrailActionAsString()

      Indicates whether the guardrail intervened during the model invocation.

      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 during the model invocation.
      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:

    • toBuilder

      public BedrockGuardrailResource.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<BedrockGuardrailResource.Builder,BedrockGuardrailResource>
      Returns:
      a builder for type T

    • builder

      public static BedrockGuardrailResource.Builder builder()

    • serializableBuilderClass

      public static Class<? extends BedrockGuardrailResource.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.