java.lang.Object
- software.amazon.awssdk.services.qconnect.model.AssistantSummary

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<AssistantSummary.Builder,AssistantSummary>

@Generated("software.amazon.awssdk:codegen")
public final class AssistantSummary
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AssistantSummary.Builder,AssistantSummary>

Summary information about the assistant.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface AssistantSummary.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`assistantArn()`	The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
`String`	`assistantId()`	The identifier of the Amazon Q in Connect assistant.
`static AssistantSummary.Builder`	`builder()`
`AssistantCapabilityConfiguration`	`capabilityConfiguration()`	The configuration information for the Amazon Q in Connect assistant capability.
`String`	`description()`	The description of the assistant.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasTags()`	For responses, this returns true if the service returned a value for the Tags property.
`AssistantIntegrationConfiguration`	`integrationConfiguration()`	The configuration information for the Amazon Q in Connect assistant integration.
`String`	`name()`	The name of the assistant.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends AssistantSummary.Builder>`	`serializableBuilderClass()`
`ServerSideEncryptionConfiguration`	`serverSideEncryptionConfiguration()`	The configuration information for the customer managed key used for encryption.
`AssistantStatus`	`status()`	The status of the assistant.
`String`	`statusAsString()`	The status of the assistant.
`Map<String,String>`	`tags()`	The tags used to organize, track, or control access for this resource.
`AssistantSummary.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`AssistantType`	`type()`	The type of the assistant.
`String`	`typeAsString()`	The type of the 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 of the assistant.
    
    Returns:
    
    The description of the assistant.
  - 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 of the assistant.
    
    Returns:
    
    The name of the assistant.
  - 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.
  - 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:
    
    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, 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:
    
    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 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.
  - type
```
public final AssistantType type()
```
    The type of the 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 the assistant.
    
    See Also:
    
    AssistantType
  - typeAsString
```
public final String typeAsString()
```
    The type of the 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 the assistant.
    
    See Also:
    
    AssistantType
  - toBuilder
```
public AssistantSummary.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<AssistantSummary.Builder,AssistantSummary>
  - builder
```
public static AssistantSummary.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends AssistantSummary.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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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

Class AssistantSummary

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

assistantArn

assistantId

capabilityConfiguration

description

integrationConfiguration

name

serverSideEncryptionConfiguration

status

statusAsString

hasTags

tags

type

typeAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields