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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceAssistantData.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description StringassistantArn()The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.StringassistantId()The identifier of the Amazon Q in Connect assistant.static AssistantData.Builderbuilder()AssistantCapabilityConfigurationcapabilityConfiguration()The configuration information for the Amazon Q in Connect assistant capability.Stringdescription()The description.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.AssistantIntegrationConfigurationintegrationConfiguration()The configuration information for the Amazon Q in Connect assistant integration.Stringname()The name.List<SdkField<?>>sdkFields()static Class<? extends AssistantData.Builder>serializableBuilderClass()ServerSideEncryptionConfigurationserverSideEncryptionConfiguration()The configuration information for the customer managed key used for encryption.AssistantStatusstatus()The status of the assistant.StringstatusAsString()The status of the assistant.Map<String,String>tags()The tags used to organize, track, or control access for this resource.AssistantData.BuildertoBuilder()StringtoString()Returns a string representation of this object.AssistantTypetype()The type of assistant.StringtypeAsString()The type of assistant.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
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.
-
assistantId
public final String assistantId()
The identifier of the Amazon Q in Connect assistant.
- Returns:
- The identifier of the Amazon Q in Connect assistant.
-
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.
-
description
public final String description()
The description.
- Returns:
- The description.
-
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.
-
name
public final String name()
The name.
- Returns:
- The name.
-
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, andkms: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 allowkms:Decrypt,kms:GenerateDataKey*, andkms:DescribeKeypermissions to theconnect.amazonaws.comservice 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, andkms: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 allowkms:Decrypt,kms:GenerateDataKey*, andkms:DescribeKeypermissions to theconnect.amazonaws.comservice 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.
-
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,
statuswill returnAssistantStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The status of the assistant.
- See Also:
AssistantStatus
-
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,
statuswill returnAssistantStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The status of the assistant.
- See Also:
AssistantStatus
-
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 theisEmpty()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.
-
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,
typewill returnAssistantType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromtypeAsString().- Returns:
- The type of assistant.
- See Also:
AssistantType
-
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,
typewill returnAssistantType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromtypeAsString().- Returns:
- The type of assistant.
- See Also:
AssistantType
-
toBuilder
public AssistantData.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<AssistantData.Builder,AssistantData>
-
builder
public static AssistantData.Builder builder()
-
serializableBuilderClass
public static Class<? extends AssistantData.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
-