Class UpdateGuardrailRequest

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

  • Method Details

    • guardrailIdentifier

      public final String guardrailIdentifier()

      The unique identifier of the guardrail. This can be an ID or the ARN.

      Returns:
      The unique identifier of the guardrail. This can be an ID or the ARN.

    • name

      public final String name()

      A name for the guardrail.

      Returns:
      A name for the guardrail.

    • description

      public final String description()

      A description of the guardrail.

      Returns:
      A description of the guardrail.

    • topicPolicyConfig

      public final GuardrailTopicPolicyConfig topicPolicyConfig()

      The topic policy to configure for the guardrail.

      Returns:
      The topic policy to configure for the guardrail.

    • contentPolicyConfig

      public final GuardrailContentPolicyConfig contentPolicyConfig()

      The content policy to configure for the guardrail.

      Returns:
      The content policy to configure for the guardrail.

    • wordPolicyConfig

      public final GuardrailWordPolicyConfig wordPolicyConfig()

      The word policy to configure for the guardrail.

      Returns:
      The word policy to configure for the guardrail.

    • sensitiveInformationPolicyConfig

      public final GuardrailSensitiveInformationPolicyConfig sensitiveInformationPolicyConfig()

      The sensitive information policy to configure for the guardrail.

      Returns:
      The sensitive information policy to configure for the guardrail.

    • contextualGroundingPolicyConfig

      public final GuardrailContextualGroundingPolicyConfig contextualGroundingPolicyConfig()

      The contextual grounding policy configuration used to update a guardrail.

      Returns:
      The contextual grounding policy configuration used to update a guardrail.

    • crossRegionConfig

      public final GuardrailCrossRegionConfig crossRegionConfig()

      The system-defined guardrail profile that you're using with your guardrail. Guardrail profiles define the destination Amazon Web Services Regions where guardrail inference requests can be automatically routed.

      For more information, see the Amazon Bedrock User Guide.

      Returns:
      The system-defined guardrail profile that you're using with your guardrail. Guardrail profiles define the destination Amazon Web Services Regions where guardrail inference requests can be automatically routed.

      For more information, see the Amazon Bedrock User Guide.

    • blockedInputMessaging

      public final String blockedInputMessaging()

      The message to return when the guardrail blocks a prompt.

      Returns:
      The message to return when the guardrail blocks a prompt.

    • blockedOutputsMessaging

      public final String blockedOutputsMessaging()

      The message to return when the guardrail blocks a model response.

      Returns:
      The message to return when the guardrail blocks a model response.

    • kmsKeyId

      public final String kmsKeyId()

      The ARN of the KMS key with which to encrypt the guardrail.

      Returns:
      The ARN of the KMS key with which to encrypt the guardrail.

    • toBuilder

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

    • builder

      public static UpdateGuardrailRequest.Builder builder()

    • serializableBuilderClass

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