Class AssistantData

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

The assistant data.

See Also:

  • Method Details

    • assistantId

      public final String assistantId()

      The identifier of the Amazon Q in Connect assistant.

      Returns:
      The identifier of the Amazon Q in Connect assistant.

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

    • name

      public final String name()

      The name.

      Returns:
      The name.

    • type

      public final AssistantType type()

      The type of assistant.

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

      Returns:
      The type of assistant.
      See Also:

    • typeAsString

      public final String typeAsString()

      The type of assistant.

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

      Returns:
      The type of assistant.
      See Also:

    • status

      public final AssistantStatus status()

      The status of the assistant.

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

      Returns:
      The status of the assistant.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the assistant.

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

      Returns:
      The status of the assistant.
      See Also:

    • description

      public final String description()

      The description.

      Returns:
      The description.

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

    • serverSideEncryptionConfiguration

      public final ServerSideEncryptionConfiguration serverSideEncryptionConfiguration()

      The configuration information for the customer managed key used for encryption.

      This KMS key must have a policy that allows kms:CreateGrant, kms:DescribeKey, kms:Decrypt, and kms:GenerateDataKey* permissions to the IAM identity using the key to invoke Amazon Q in Connect. To use Amazon Q in Connect with chat, the key policy must also allow kms:Decrypt, kms:GenerateDataKey*, and kms:DescribeKey permissions to the connect.amazonaws.com service principal.

      For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance.

      Returns:
      The configuration information for the customer managed key used for encryption.

      This KMS key must have a policy that allows kms:CreateGrant, kms:DescribeKey, kms:Decrypt, and kms:GenerateDataKey* permissions to the IAM identity using the key to invoke Amazon Q in Connect. To use Amazon Q in Connect with chat, the key policy must also allow kms:Decrypt, kms:GenerateDataKey*, and kms:DescribeKey permissions to the connect.amazonaws.com service principal.

      For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance.

    • integrationConfiguration

      public final AssistantIntegrationConfiguration integrationConfiguration()

      The configuration information for the Amazon Q in Connect assistant integration.

      Returns:
      The configuration information for the Amazon Q in Connect assistant integration.

    • capabilityConfiguration

      public final AssistantCapabilityConfiguration capabilityConfiguration()

      The configuration information for the Amazon Q in Connect assistant capability.

      Returns:
      The configuration information for the Amazon Q in Connect assistant capability.

    • aiAgentConfiguration

      public final Map<AIAgentType,AIAgentConfigurationData> aiAgentConfiguration()

      The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that is set on the Amazon Q in Connect Assistant.

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

      Returns:
      The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that is set on the Amazon Q in Connect Assistant.

    • hasAiAgentConfiguration

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

    • aiAgentConfigurationAsStrings

      public final Map<String,AIAgentConfigurationData> aiAgentConfigurationAsStrings()

      The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that is set on the Amazon Q in Connect Assistant.

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

      Returns:
      The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that is set on the Amazon Q in Connect Assistant.

    • toBuilder

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

    • builder

      public static AssistantData.Builder builder()

    • serializableBuilderClass

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