Class GetGuardrailResponse

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

  • Method Details

    • name

      public final String name()

      The name of the guardrail.

      Returns:
      The name of the guardrail.

    • description

      public final String description()

      The description of the guardrail.

      Returns:
      The description of the guardrail.

    • guardrailId

      public final String guardrailId()

      The unique identifier of the guardrail.

      Returns:
      The unique identifier of the guardrail.

    • guardrailArn

      public final String guardrailArn()

      The ARN of the guardrail.

      Returns:
      The ARN of the guardrail.

    • version

      public final String version()

      The version of the guardrail.

      Returns:
      The version of the guardrail.

    • status

      public final GuardrailStatus status()

      The status of the guardrail.

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

      Returns:
      The status of the guardrail.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the guardrail.

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

      Returns:
      The status of the guardrail.
      See Also:

    • topicPolicy

      public final GuardrailTopicPolicy topicPolicy()

      The topic policy that was configured for the guardrail.

      Returns:
      The topic policy that was configured for the guardrail.

    • contentPolicy

      public final GuardrailContentPolicy contentPolicy()

      The content policy that was configured for the guardrail.

      Returns:
      The content policy that was configured for the guardrail.

    • wordPolicy

      public final GuardrailWordPolicy wordPolicy()

      The word policy that was configured for the guardrail.

      Returns:
      The word policy that was configured for the guardrail.

    • sensitiveInformationPolicy

      public final GuardrailSensitiveInformationPolicy sensitiveInformationPolicy()

      The sensitive information policy that was configured for the guardrail.

      Returns:
      The sensitive information policy that was configured for the guardrail.

    • contextualGroundingPolicy

      public final GuardrailContextualGroundingPolicy contextualGroundingPolicy()

      The contextual grounding policy used in the guardrail.

      Returns:
      The contextual grounding policy used in the guardrail.

    • crossRegionDetails

      public final GuardrailCrossRegionDetails crossRegionDetails()

      Details about the system-defined guardrail profile that you're using with your guardrail, including the guardrail profile ID and Amazon Resource Name (ARN).

      Returns:
      Details about the system-defined guardrail profile that you're using with your guardrail, including the guardrail profile ID and Amazon Resource Name (ARN).

    • createdAt

      public final Instant createdAt()

      The date and time at which the guardrail was created.

      Returns:
      The date and time at which the guardrail was created.

    • updatedAt

      public final Instant updatedAt()

      The date and time at which the guardrail was updated.

      Returns:
      The date and time at which the guardrail was updated.

    • hasStatusReasons

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

    • statusReasons

      public final List<String> statusReasons()

      Appears if the status is FAILED. A list of reasons for why the guardrail failed to be created, updated, versioned, or deleted.

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

      Returns:
      Appears if the status is FAILED. A list of reasons for why the guardrail failed to be created, updated, versioned, or deleted.

    • hasFailureRecommendations

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

    • failureRecommendations

      public final List<String> failureRecommendations()

      Appears if the status of the guardrail is FAILED. A list of recommendations to carry out before retrying the request.

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

      Returns:
      Appears if the status of the guardrail is FAILED. A list of recommendations to carry out before retrying the request.

    • blockedInputMessaging

      public final String blockedInputMessaging()

      The message that the guardrail returns when it blocks a prompt.

      Returns:
      The message that the guardrail returns when it blocks a prompt.

    • blockedOutputsMessaging

      public final String blockedOutputsMessaging()

      The message that the guardrail returns when it blocks a model response.

      Returns:
      The message that the guardrail returns when it blocks a model response.

    • kmsKeyArn

      public final String kmsKeyArn()

      The ARN of the KMS key that encrypts the guardrail.

      Returns:
      The ARN of the KMS key that encrypts the guardrail.

    • toBuilder

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

    • builder

      public static GetGuardrailResponse.Builder builder()

    • serializableBuilderClass

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