Class ApplyGuardrailRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.bedrockruntime.model.BedrockRuntimeRequest
software.amazon.awssdk.services.bedrockruntime.model.ApplyGuardrailRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ApplyGuardrailRequest.Builder,ApplyGuardrailRequest>
@Generated("software.amazon.awssdk:codegen") public final class ApplyGuardrailRequest extends BedrockRuntimeRequest implements ToCopyableBuilder<ApplyGuardrailRequest.Builder,ApplyGuardrailRequest>

  • Method Details

    • guardrailIdentifier

      public final String guardrailIdentifier()

      The guardrail identifier used in the request to apply the guardrail.

      Returns:
      The guardrail identifier used in the request to apply the guardrail.

    • guardrailVersion

      public final String guardrailVersion()

      The guardrail version used in the request to apply the guardrail.

      Returns:
      The guardrail version used in the request to apply the guardrail.

    • source

      public final GuardrailContentSource source()

      The source of data used in the request to apply the guardrail.

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

      Returns:
      The source of data used in the request to apply the guardrail.
      See Also:

    • sourceAsString

      public final String sourceAsString()

      The source of data used in the request to apply the guardrail.

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

      Returns:
      The source of data used in the request to apply the guardrail.
      See Also:

    • hasContent

      public final boolean hasContent()
      For responses, this returns true if the service returned a value for the Content 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.

    • content

      public final List<GuardrailContentBlock> content()

      The content details used in the request to apply the guardrail.

      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 hasContent() method.

      Returns:
      The content details used in the request to apply the guardrail.

    • outputScope

      public final GuardrailOutputScope outputScope()

      Specifies the scope of the output that you get in the response. Set to FULL to return the entire output, including any detected and non-detected entries in the response for enhanced debugging.

      Note that the full output scope doesn't apply to word filters or regex in sensitive information filters. It does apply to all other filtering policies, including sensitive information with filters that can detect personally identifiable information (PII).

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

      Returns:
      Specifies the scope of the output that you get in the response. Set to FULL to return the entire output, including any detected and non-detected entries in the response for enhanced debugging.

      Note that the full output scope doesn't apply to word filters or regex in sensitive information filters. It does apply to all other filtering policies, including sensitive information with filters that can detect personally identifiable information (PII).

      See Also:

    • outputScopeAsString

      public final String outputScopeAsString()

      Specifies the scope of the output that you get in the response. Set to FULL to return the entire output, including any detected and non-detected entries in the response for enhanced debugging.

      Note that the full output scope doesn't apply to word filters or regex in sensitive information filters. It does apply to all other filtering policies, including sensitive information with filters that can detect personally identifiable information (PII).

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

      Returns:
      Specifies the scope of the output that you get in the response. Set to FULL to return the entire output, including any detected and non-detected entries in the response for enhanced debugging.

      Note that the full output scope doesn't apply to word filters or regex in sensitive information filters. It does apply to all other filtering policies, including sensitive information with filters that can detect personally identifiable information (PII).

      See Also:

    • toBuilder

      public ApplyGuardrailRequest.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<ApplyGuardrailRequest.Builder,ApplyGuardrailRequest>
      Specified by:
      toBuilder in class BedrockRuntimeRequest
      Returns:
      a builder for type T

    • builder

      public static ApplyGuardrailRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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