Class AIGuardrailData

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

The data for the AI Guardrail

See Also:

  • Method Details

    • assistantId

      public final String assistantId()

      The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

      Returns:
      The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

    • assistantArn

      public final String assistantArn()

      The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.

      Returns:
      The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.

    • aiGuardrailArn

      public final String aiGuardrailArn()

      The Amazon Resource Name (ARN) of the AI Guardrail.

      Returns:
      The Amazon Resource Name (ARN) of the AI Guardrail.

    • aiGuardrailId

      public final String aiGuardrailId()

      The identifier of the Amazon Q in Connect AI Guardrail.

      Returns:
      The identifier of the Amazon Q in Connect AI Guardrail.

    • name

      public final String name()

      The name of the AI Guardrail.

      Returns:
      The name of the AI Guardrail.

    • visibilityStatus

      public final VisibilityStatus visibilityStatus()

      The visibility status of the AI Guardrail.

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

      Returns:
      The visibility status of the AI Guardrail.
      See Also:

    • visibilityStatusAsString

      public final String visibilityStatusAsString()

      The visibility status of the AI Guardrail.

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

      Returns:
      The visibility status of the AI Guardrail.
      See Also:

    • blockedInputMessaging

      public final String blockedInputMessaging()

      The message to return when the AI Guardrail blocks a prompt.

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

    • blockedOutputsMessaging

      public final String blockedOutputsMessaging()

      The message to return when the AI Guardrail blocks a model response.

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

    • description

      public final String description()

      A description of the AI Guardrail.

      Returns:
      A description of the AI Guardrail.

    • topicPolicyConfig

      public final AIGuardrailTopicPolicyConfig topicPolicyConfig()

      Contains details about topics that the AI Guardrail should identify and deny.

      Returns:
      Contains details about topics that the AI Guardrail should identify and deny.

    • contentPolicyConfig

      public final AIGuardrailContentPolicyConfig contentPolicyConfig()

      Contains details about how to handle harmful content.

      Returns:
      Contains details about how to handle harmful content.

    • wordPolicyConfig

      public final AIGuardrailWordPolicyConfig wordPolicyConfig()

      Contains details about the word policy to configured for the AI Guardrail.

      Returns:
      Contains details about the word policy to configured for the AI Guardrail.

    • sensitiveInformationPolicyConfig

      public final AIGuardrailSensitiveInformationPolicyConfig sensitiveInformationPolicyConfig()

      Contains details about PII entities and regular expressions to configure for the AI Guardrail.

      Returns:
      Contains details about PII entities and regular expressions to configure for the AI Guardrail.

    • contextualGroundingPolicyConfig

      public final AIGuardrailContextualGroundingPolicyConfig contextualGroundingPolicyConfig()

      The policy configuration details for the AI Guardrail's contextual grounding policy.

      Returns:
      The policy configuration details for the AI Guardrail's contextual grounding policy.

    • hasTags

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

    • tags

      public final Map<String,String> tags()

      The tags used to organize, track, or control access for this resource.

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

      Returns:
      The tags used to organize, track, or control access for this resource.

    • status

      public final Status status()

      The status of the AI Guardrail.

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

      Returns:
      The status of the AI Guardrail.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the AI Guardrail.

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

      Returns:
      The status of the AI Guardrail.
      See Also:

    • modifiedTime

      public final Instant modifiedTime()

      The time the AI Guardrail was last modified.

      Returns:
      The time the AI Guardrail was last modified.

    • toBuilder

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

    • builder

      public static AIGuardrailData.Builder builder()

    • serializableBuilderClass

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