Interface StartQAppSessionRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<StartQAppSessionRequest.Builder,StartQAppSessionRequest>, QAppsRequest.Builder, SdkBuilder<StartQAppSessionRequest.Builder,StartQAppSessionRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

StartQAppSessionRequest

@Mutable
@NotThreadSafe
public static interface StartQAppSessionRequest.Builder
extends QAppsRequest.Builder, SdkPojo, CopyableBuilder<StartQAppSessionRequest.Builder,StartQAppSessionRequest>

Method Summary

Modifier and Type	Method	Description
StartQAppSessionRequest.Builder	appId(String appId)	The unique identifier of the Q App to start a session for.
StartQAppSessionRequest.Builder	appVersion(Integer appVersion)	The version of the Q App to use for the session.
StartQAppSessionRequest.Builder	initialValues(Collection<CardValue> initialValues)	Optional initial input values to provide for the Q App session.
StartQAppSessionRequest.Builder	initialValues(Consumer<CardValue.Builder>... initialValues)	Optional initial input values to provide for the Q App session.
StartQAppSessionRequest.Builder	initialValues(CardValue... initialValues)	Optional initial input values to provide for the Q App session.
StartQAppSessionRequest.Builder	instanceId(String instanceId)	The unique identifier of the Amazon Q Business application environment instance.
StartQAppSessionRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
StartQAppSessionRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
StartQAppSessionRequest.Builder	sessionId(String sessionId)	The unique identifier of the a Q App session.
StartQAppSessionRequest.Builder	tags(Map<String,String> tags)	Optional tags to associate with the new Q App session.

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.qapps.model.QAppsRequest.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

instanceId

StartQAppSessionRequest.Builder instanceId(String instanceId)

The unique identifier of the Amazon Q Business application environment instance.

Parameters:

instanceId - The unique identifier of the Amazon Q Business application environment instance.

Returns:

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

appId

StartQAppSessionRequest.Builder appId(String appId)

The unique identifier of the Q App to start a session for.

Parameters:

appId - The unique identifier of the Q App to start a session for.

Returns:

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

appVersion

StartQAppSessionRequest.Builder appVersion(Integer appVersion)

The version of the Q App to use for the session.

Parameters:

appVersion - The version of the Q App to use for the session.

Returns:

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

initialValues

StartQAppSessionRequest.Builder initialValues(Collection<CardValue> initialValues)

Optional initial input values to provide for the Q App session.

Parameters:

initialValues - Optional initial input values to provide for the Q App session.

Returns:

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

initialValues

StartQAppSessionRequest.Builder initialValues(CardValue... initialValues)

Optional initial input values to provide for the Q App session.

Parameters:

initialValues - Optional initial input values to provide for the Q App session.

Returns:

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

initialValues

StartQAppSessionRequest.Builder initialValues(Consumer<CardValue.Builder>... initialValues)

Optional initial input values to provide for the Q App session.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to initialValues(List<CardValue>).

Parameters:

initialValues - a consumer that will call methods on CardValue.Builder

Returns:

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

See Also:

• initialValues(java.util.Collection<CardValue>)

sessionId

StartQAppSessionRequest.Builder sessionId(String sessionId)

The unique identifier of the a Q App session.

Parameters:

sessionId - The unique identifier of the a Q App session.

Returns:

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

tags

StartQAppSessionRequest.Builder tags(Map<String,String> tags)

Optional tags to associate with the new Q App session.

Parameters:

tags - Optional tags to associate with the new Q App session.

Returns:

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

overrideConfiguration

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

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