Interface GetApplicationResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<GetApplicationResponse.Builder,GetApplicationResponse>, QBusinessResponse.Builder, SdkBuilder<GetApplicationResponse.Builder,GetApplicationResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

GetApplicationResponse

@Mutable
@NotThreadSafe
public static interface GetApplicationResponse.Builder
extends QBusinessResponse.Builder, SdkPojo, CopyableBuilder<GetApplicationResponse.Builder,GetApplicationResponse>

Method Summary

Modifier and Type	Method	Description
GetApplicationResponse.Builder	applicationArn(String applicationArn)	The Amazon Resource Name (ARN) of the Amazon Q Business application.
GetApplicationResponse.Builder	applicationId(String applicationId)	The identifier of the Amazon Q Business application.
default GetApplicationResponse.Builder	attachmentsConfiguration(Consumer<AppliedAttachmentsConfiguration.Builder> attachmentsConfiguration)	Settings for whether end users can upload files directly during chat.
GetApplicationResponse.Builder	attachmentsConfiguration(AppliedAttachmentsConfiguration attachmentsConfiguration)	Settings for whether end users can upload files directly during chat.
default GetApplicationResponse.Builder	autoSubscriptionConfiguration(Consumer<AutoSubscriptionConfiguration.Builder> autoSubscriptionConfiguration)	Settings for auto-subscription behavior for this application.
GetApplicationResponse.Builder	autoSubscriptionConfiguration(AutoSubscriptionConfiguration autoSubscriptionConfiguration)	Settings for auto-subscription behavior for this application.
GetApplicationResponse.Builder	clientIdsForOIDC(String... clientIdsForOIDC)	The OIDC client ID for a Amazon Q Business application.
GetApplicationResponse.Builder	clientIdsForOIDC(Collection<String> clientIdsForOIDC)	The OIDC client ID for a Amazon Q Business application.
GetApplicationResponse.Builder	createdAt(Instant createdAt)	The Unix timestamp when the Amazon Q Business application was last updated.
GetApplicationResponse.Builder	description(String description)	A description for the Amazon Q Business application.
GetApplicationResponse.Builder	displayName(String displayName)	The name of the Amazon Q Business application.
default GetApplicationResponse.Builder	encryptionConfiguration(Consumer<EncryptionConfiguration.Builder> encryptionConfiguration)	The identifier of the Amazon Web Services KMS key that is used to encrypt your data.
GetApplicationResponse.Builder	encryptionConfiguration(EncryptionConfiguration encryptionConfiguration)	The identifier of the Amazon Web Services KMS key that is used to encrypt your data.
default GetApplicationResponse.Builder	error(Consumer<ErrorDetail.Builder> error)	If the Status field is set to ERROR, the ErrorMessage field contains a description of the error that caused the synchronization to fail.
GetApplicationResponse.Builder	error(ErrorDetail error)	If the Status field is set to ERROR, the ErrorMessage field contains a description of the error that caused the synchronization to fail.
GetApplicationResponse.Builder	iamIdentityProviderArn(String iamIdentityProviderArn)	The Amazon Resource Name (ARN) of an identity provider being used by an Amazon Q Business application.
GetApplicationResponse.Builder	identityCenterApplicationArn(String identityCenterApplicationArn)	The Amazon Resource Name (ARN) of the AWS IAM Identity Center instance attached to your Amazon Q Business application.
GetApplicationResponse.Builder	identityType(String identityType)	The authentication type being used by a Amazon Q Business application.
GetApplicationResponse.Builder	identityType(IdentityType identityType)	The authentication type being used by a Amazon Q Business application.
default GetApplicationResponse.Builder	personalizationConfiguration(Consumer<PersonalizationConfiguration.Builder> personalizationConfiguration)	Configuration information about chat response personalization.
GetApplicationResponse.Builder	personalizationConfiguration(PersonalizationConfiguration personalizationConfiguration)	Configuration information about chat response personalization.
default GetApplicationResponse.Builder	qAppsConfiguration(Consumer<QAppsConfiguration.Builder> qAppsConfiguration)	Settings for whether end users can create and use Amazon Q Apps in the web experience.
GetApplicationResponse.Builder	qAppsConfiguration(QAppsConfiguration qAppsConfiguration)	Settings for whether end users can create and use Amazon Q Apps in the web experience.
default GetApplicationResponse.Builder	quickSightConfiguration(Consumer<QuickSightConfiguration.Builder> quickSightConfiguration)	The Amazon QuickSight authentication configuration for the Amazon Q Business application.
GetApplicationResponse.Builder	quickSightConfiguration(QuickSightConfiguration quickSightConfiguration)	The Amazon QuickSight authentication configuration for the Amazon Q Business application.
GetApplicationResponse.Builder	roleArn(String roleArn)	The Amazon Resource Name (ARN) of the IAM with permissions to access your CloudWatch logs and metrics.
GetApplicationResponse.Builder	status(String status)	The status of the Amazon Q Business application.
GetApplicationResponse.Builder	status(ApplicationStatus status)	The status of the Amazon Q Business application.
GetApplicationResponse.Builder	updatedAt(Instant updatedAt)	The Unix timestamp when the Amazon Q Business application was last updated.

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

copy

Methods inherited from interface software.amazon.awssdk.services.qbusiness.model.QBusinessResponse.Builder

build, responseMetadata, responseMetadata

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Method Details

displayName

GetApplicationResponse.Builder displayName(String displayName)

The name of the Amazon Q Business application.

Parameters:

displayName - The name of the Amazon Q Business application.

Returns:

Returns a reference to this object so that method calls can be chained together.

applicationId

GetApplicationResponse.Builder applicationId(String applicationId)

The identifier of the Amazon Q Business application.

Parameters:

applicationId - The identifier of the Amazon Q Business application.

Returns:

Returns a reference to this object so that method calls can be chained together.

applicationArn

GetApplicationResponse.Builder applicationArn(String applicationArn)

The Amazon Resource Name (ARN) of the Amazon Q Business application.

Parameters:

applicationArn - The Amazon Resource Name (ARN) of the Amazon Q Business application.

Returns:

Returns a reference to this object so that method calls can be chained together.

identityType

GetApplicationResponse.Builder identityType(String identityType)

The authentication type being used by a Amazon Q Business application.

Parameters:

identityType - The authentication type being used by a Amazon Q Business application.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• IdentityType
• IdentityType

identityType

GetApplicationResponse.Builder identityType(IdentityType identityType)

The authentication type being used by a Amazon Q Business application.

Parameters:

identityType - The authentication type being used by a Amazon Q Business application.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• IdentityType
• IdentityType

iamIdentityProviderArn

GetApplicationResponse.Builder iamIdentityProviderArn(String iamIdentityProviderArn)

The Amazon Resource Name (ARN) of an identity provider being used by an Amazon Q Business application.

Parameters:

iamIdentityProviderArn - The Amazon Resource Name (ARN) of an identity provider being used by an Amazon Q Business application.

Returns:

Returns a reference to this object so that method calls can be chained together.

identityCenterApplicationArn

GetApplicationResponse.Builder identityCenterApplicationArn(String identityCenterApplicationArn)

The Amazon Resource Name (ARN) of the AWS IAM Identity Center instance attached to your Amazon Q Business application.

Parameters:

identityCenterApplicationArn - The Amazon Resource Name (ARN) of the AWS IAM Identity Center instance attached to your Amazon Q Business application.

Returns:

Returns a reference to this object so that method calls can be chained together.

roleArn

GetApplicationResponse.Builder roleArn(String roleArn)

The Amazon Resource Name (ARN) of the IAM with permissions to access your CloudWatch logs and metrics.

Parameters:

roleArn - The Amazon Resource Name (ARN) of the IAM with permissions to access your CloudWatch logs and metrics.

Returns:

Returns a reference to this object so that method calls can be chained together.

status

GetApplicationResponse.Builder status(String status)

The status of the Amazon Q Business application.

Parameters:

status - The status of the Amazon Q Business application.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• ApplicationStatus
• ApplicationStatus

status

GetApplicationResponse.Builder status(ApplicationStatus status)

The status of the Amazon Q Business application.

Parameters:

status - The status of the Amazon Q Business application.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• ApplicationStatus
• ApplicationStatus

description

GetApplicationResponse.Builder description(String description)

A description for the Amazon Q Business application.

Parameters:

description - A description for the Amazon Q Business application.

Returns:

Returns a reference to this object so that method calls can be chained together.

encryptionConfiguration

GetApplicationResponse.Builder encryptionConfiguration(EncryptionConfiguration encryptionConfiguration)

The identifier of the Amazon Web Services KMS key that is used to encrypt your data. Amazon Q Business doesn't support asymmetric keys.

Parameters:

encryptionConfiguration - The identifier of the Amazon Web Services KMS key that is used to encrypt your data. Amazon Q Business doesn't support asymmetric keys.

Returns:

Returns a reference to this object so that method calls can be chained together.

encryptionConfiguration

default GetApplicationResponse.Builder encryptionConfiguration(Consumer<EncryptionConfiguration.Builder> encryptionConfiguration)

The identifier of the Amazon Web Services KMS key that is used to encrypt your data. Amazon Q Business doesn't support asymmetric keys.

This is a convenience method that creates an instance of the EncryptionConfiguration.Builder avoiding the need to create one manually via EncryptionConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to encryptionConfiguration(EncryptionConfiguration).

Parameters:

encryptionConfiguration - a consumer that will call methods on EncryptionConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• encryptionConfiguration(EncryptionConfiguration)

createdAt

GetApplicationResponse.Builder createdAt(Instant createdAt)

The Unix timestamp when the Amazon Q Business application was last updated.

Parameters:

createdAt - The Unix timestamp when the Amazon Q Business application was last updated.

Returns:

Returns a reference to this object so that method calls can be chained together.

updatedAt

GetApplicationResponse.Builder updatedAt(Instant updatedAt)

The Unix timestamp when the Amazon Q Business application was last updated.

Parameters:

updatedAt - The Unix timestamp when the Amazon Q Business application was last updated.

Returns:

Returns a reference to this object so that method calls can be chained together.

error

GetApplicationResponse.Builder error(ErrorDetail error)

If the Status field is set to ERROR, the ErrorMessage field contains a description of the error that caused the synchronization to fail.

Parameters:

error - If the Status field is set to ERROR, the ErrorMessage field contains a description of the error that caused the synchronization to fail.

Returns:

Returns a reference to this object so that method calls can be chained together.

error

default GetApplicationResponse.Builder error(Consumer<ErrorDetail.Builder> error)

If the Status field is set to ERROR, the ErrorMessage field contains a description of the error that caused the synchronization to fail.

This is a convenience method that creates an instance of the ErrorDetail.Builder avoiding the need to create one manually via ErrorDetail.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to error(ErrorDetail).

Parameters:

error - a consumer that will call methods on ErrorDetail.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• error(ErrorDetail)

attachmentsConfiguration

GetApplicationResponse.Builder attachmentsConfiguration(AppliedAttachmentsConfiguration attachmentsConfiguration)

Settings for whether end users can upload files directly during chat.

Parameters:

attachmentsConfiguration - Settings for whether end users can upload files directly during chat.

Returns:

Returns a reference to this object so that method calls can be chained together.

attachmentsConfiguration

default GetApplicationResponse.Builder attachmentsConfiguration(Consumer<AppliedAttachmentsConfiguration.Builder> attachmentsConfiguration)

Settings for whether end users can upload files directly during chat.

This is a convenience method that creates an instance of the AppliedAttachmentsConfiguration.Builder avoiding the need to create one manually via AppliedAttachmentsConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to attachmentsConfiguration(AppliedAttachmentsConfiguration).

Parameters:

attachmentsConfiguration - a consumer that will call methods on AppliedAttachmentsConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• attachmentsConfiguration(AppliedAttachmentsConfiguration)

qAppsConfiguration

GetApplicationResponse.Builder qAppsConfiguration(QAppsConfiguration qAppsConfiguration)

Settings for whether end users can create and use Amazon Q Apps in the web experience.

Parameters:

qAppsConfiguration - Settings for whether end users can create and use Amazon Q Apps in the web experience.

Returns:

Returns a reference to this object so that method calls can be chained together.

qAppsConfiguration

default GetApplicationResponse.Builder qAppsConfiguration(Consumer<QAppsConfiguration.Builder> qAppsConfiguration)

Settings for whether end users can create and use Amazon Q Apps in the web experience.

This is a convenience method that creates an instance of the QAppsConfiguration.Builder avoiding the need to create one manually via QAppsConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to qAppsConfiguration(QAppsConfiguration).

Parameters:

qAppsConfiguration - a consumer that will call methods on QAppsConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• qAppsConfiguration(QAppsConfiguration)

personalizationConfiguration

GetApplicationResponse.Builder personalizationConfiguration(PersonalizationConfiguration personalizationConfiguration)

Configuration information about chat response personalization. For more information, see Personalizing chat responses.

Parameters:

personalizationConfiguration - Configuration information about chat response personalization. For more information, see Personalizing chat responses.

Returns:

Returns a reference to this object so that method calls can be chained together.

personalizationConfiguration

default GetApplicationResponse.Builder personalizationConfiguration(Consumer<PersonalizationConfiguration.Builder> personalizationConfiguration)

Configuration information about chat response personalization. For more information, see Personalizing chat responses.

This is a convenience method that creates an instance of the PersonalizationConfiguration.Builder avoiding the need to create one manually via PersonalizationConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to personalizationConfiguration(PersonalizationConfiguration).

Parameters:

personalizationConfiguration - a consumer that will call methods on PersonalizationConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• personalizationConfiguration(PersonalizationConfiguration)

autoSubscriptionConfiguration

GetApplicationResponse.Builder autoSubscriptionConfiguration(AutoSubscriptionConfiguration autoSubscriptionConfiguration)

Settings for auto-subscription behavior for this application. This is only applicable to SAML and OIDC applications.

Parameters:

autoSubscriptionConfiguration - Settings for auto-subscription behavior for this application. This is only applicable to SAML and OIDC applications.

Returns:

Returns a reference to this object so that method calls can be chained together.

autoSubscriptionConfiguration

default GetApplicationResponse.Builder autoSubscriptionConfiguration(Consumer<AutoSubscriptionConfiguration.Builder> autoSubscriptionConfiguration)

Settings for auto-subscription behavior for this application. This is only applicable to SAML and OIDC applications.

This is a convenience method that creates an instance of the AutoSubscriptionConfiguration.Builder avoiding the need to create one manually via AutoSubscriptionConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to autoSubscriptionConfiguration(AutoSubscriptionConfiguration).

Parameters:

autoSubscriptionConfiguration - a consumer that will call methods on AutoSubscriptionConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• autoSubscriptionConfiguration(AutoSubscriptionConfiguration)

clientIdsForOIDC

GetApplicationResponse.Builder clientIdsForOIDC(Collection<String> clientIdsForOIDC)

The OIDC client ID for a Amazon Q Business application.

Parameters:

clientIdsForOIDC - The OIDC client ID for a Amazon Q Business application.

Returns:

Returns a reference to this object so that method calls can be chained together.

clientIdsForOIDC

GetApplicationResponse.Builder clientIdsForOIDC(String... clientIdsForOIDC)

The OIDC client ID for a Amazon Q Business application.

Parameters:

clientIdsForOIDC - The OIDC client ID for a Amazon Q Business application.

Returns:

Returns a reference to this object so that method calls can be chained together.

quickSightConfiguration

GetApplicationResponse.Builder quickSightConfiguration(QuickSightConfiguration quickSightConfiguration)

The Amazon QuickSight authentication configuration for the Amazon Q Business application.

Parameters:

quickSightConfiguration - The Amazon QuickSight authentication configuration for the Amazon Q Business application.

Returns:

Returns a reference to this object so that method calls can be chained together.

quickSightConfiguration

default GetApplicationResponse.Builder quickSightConfiguration(Consumer<QuickSightConfiguration.Builder> quickSightConfiguration)

The Amazon QuickSight authentication configuration for the Amazon Q Business application.

This is a convenience method that creates an instance of the QuickSightConfiguration.Builder avoiding the need to create one manually via QuickSightConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to quickSightConfiguration(QuickSightConfiguration).

Parameters:

quickSightConfiguration - a consumer that will call methods on QuickSightConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• quickSightConfiguration(QuickSightConfiguration)