Class ApplyGuardrailResponse

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

  • Method Details

    • usage

      public final GuardrailUsage usage()

      The usage details in the response from the guardrail.

      Returns:
      The usage details in the response from the guardrail.

    • action

      public final GuardrailAction action()

      The action taken in the response from the guardrail.

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

      Returns:
      The action taken in the response from the guardrail.
      See Also:

    • actionAsString

      public final String actionAsString()

      The action taken in the response from the guardrail.

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

      Returns:
      The action taken in the response from the guardrail.
      See Also:

    • actionReason

      public final String actionReason()

      The reason for the action taken when harmful content is detected.

      Returns:
      The reason for the action taken when harmful content is detected.

    • hasOutputs

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

    • outputs

      public final List<GuardrailOutputContent> outputs()

      The output details in the response from 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 hasOutputs() method.

      Returns:
      The output details in the response from the guardrail.

    • hasAssessments

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

    • assessments

      public final List<GuardrailAssessment> assessments()

      The assessment details in the response from 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 hasAssessments() method.

      Returns:
      The assessment details in the response from the guardrail.

    • guardrailCoverage

      public final GuardrailCoverage guardrailCoverage()

      The guardrail coverage details in the apply guardrail response.

      Returns:
      The guardrail coverage details in the apply guardrail response.

    • toBuilder

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

    • builder

      public static ApplyGuardrailResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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 SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      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.