Interface CreateSubscriptionRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateSubscriptionRequest.Builder,CreateSubscriptionRequest>, QBusinessRequest.Builder, SdkBuilder<CreateSubscriptionRequest.Builder,CreateSubscriptionRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateSubscriptionRequest

@Mutable
@NotThreadSafe
public static interface CreateSubscriptionRequest.Builder
extends QBusinessRequest.Builder, SdkPojo, CopyableBuilder<CreateSubscriptionRequest.Builder,CreateSubscriptionRequest>

Method Summary

Modifier and Type	Method	Description
CreateSubscriptionRequest.Builder	applicationId(String applicationId)	The identifier of the Amazon Q Business application the subscription should be added to.
CreateSubscriptionRequest.Builder	clientToken(String clientToken)	A token that you provide to identify the request to create a subscription for your Amazon Q Business application.
CreateSubscriptionRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
CreateSubscriptionRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
default CreateSubscriptionRequest.Builder	principal(Consumer<SubscriptionPrincipal.Builder> principal)	The IAM Identity Center UserId or GroupId of a user or group in the IAM Identity Center instance connected to the Amazon Q Business application.
CreateSubscriptionRequest.Builder	principal(SubscriptionPrincipal principal)	The IAM Identity Center UserId or GroupId of a user or group in the IAM Identity Center instance connected to the Amazon Q Business application.
CreateSubscriptionRequest.Builder	type(String type)	The type of Amazon Q Business subscription you want to create.
CreateSubscriptionRequest.Builder	type(SubscriptionType type)	The type of Amazon Q Business subscription you want to create.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

copy

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

build

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

applyMutation, build

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

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

applicationId

CreateSubscriptionRequest.Builder applicationId(String applicationId)

The identifier of the Amazon Q Business application the subscription should be added to.

Parameters:

applicationId - The identifier of the Amazon Q Business application the subscription should be added to.

Returns:

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

principal

CreateSubscriptionRequest.Builder principal(SubscriptionPrincipal principal)

The IAM Identity Center UserId or GroupId of a user or group in the IAM Identity Center instance connected to the Amazon Q Business application.

Parameters:

principal - The IAM Identity Center UserId or GroupId of a user or group in the IAM Identity Center instance connected to the Amazon Q Business application.

Returns:

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

principal

default CreateSubscriptionRequest.Builder principal(Consumer<SubscriptionPrincipal.Builder> principal)

The IAM Identity Center UserId or GroupId of a user or group in the IAM Identity Center instance connected to the Amazon Q Business application.

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

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

Parameters:

principal - a consumer that will call methods on SubscriptionPrincipal.Builder

Returns:

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

See Also:

• principal(SubscriptionPrincipal)

type

CreateSubscriptionRequest.Builder type(String type)

The type of Amazon Q Business subscription you want to create.

Parameters:

type - The type of Amazon Q Business subscription you want to create.

Returns:

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

See Also:

• SubscriptionType
• SubscriptionType

type

CreateSubscriptionRequest.Builder type(SubscriptionType type)

The type of Amazon Q Business subscription you want to create.

Parameters:

type - The type of Amazon Q Business subscription you want to create.

Returns:

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

See Also:

• SubscriptionType
• SubscriptionType

clientToken

CreateSubscriptionRequest.Builder clientToken(String clientToken)

A token that you provide to identify the request to create a subscription for your Amazon Q Business application.

Parameters:

clientToken - A token that you provide to identify the request to create a subscription for your Amazon Q Business application.

Returns:

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

overrideConfiguration

CreateSubscriptionRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

CreateSubscriptionRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.