Package software.amazon.awssdk.services.ssm.model

Interface DescribeSessionsRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<DescribeSessionsRequest.Builder,DescribeSessionsRequest>, SdkBuilder<DescribeSessionsRequest.Builder,DescribeSessionsRequest>, SdkPojo, SdkRequest.Builder, SsmRequest.Builder

Enclosing class:

DescribeSessionsRequest

public static interface DescribeSessionsRequest.Builder
extends SsmRequest.Builder, SdkPojo, CopyableBuilder<DescribeSessionsRequest.Builder,DescribeSessionsRequest>

Method Summary

Modifier and Type	Method	Description
DescribeSessionsRequest.Builder	filters(Collection<SessionFilter> filters)	One or more filters to limit the type of sessions returned by the request.
DescribeSessionsRequest.Builder	filters(Consumer<SessionFilter.Builder>... filters)	One or more filters to limit the type of sessions returned by the request.
DescribeSessionsRequest.Builder	filters(SessionFilter... filters)	One or more filters to limit the type of sessions returned by the request.
DescribeSessionsRequest.Builder	maxResults(Integer maxResults)	The maximum number of items to return for this call.
DescribeSessionsRequest.Builder	nextToken(String nextToken)	The token for the next set of items to return.
DescribeSessionsRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
DescribeSessionsRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
DescribeSessionsRequest.Builder	state(String state)	The session status to retrieve a list of sessions for.
DescribeSessionsRequest.Builder	state(SessionState state)	The session status to retrieve a list of sessions for.

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.utils.builder.SdkBuilder

applyMutation, build

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

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.services.ssm.model.SsmRequest.Builder

build

Method Details

state

DescribeSessionsRequest.Builder state(String state)

The session status to retrieve a list of sessions for. For example, "Active".

Parameters:

state - The session status to retrieve a list of sessions for. For example, "Active".

Returns:

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

See Also:

• SessionState
• SessionState

state

DescribeSessionsRequest.Builder state(SessionState state)

The session status to retrieve a list of sessions for. For example, "Active".

Parameters:

state - The session status to retrieve a list of sessions for. For example, "Active".

Returns:

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

See Also:

• SessionState
• SessionState

maxResults

DescribeSessionsRequest.Builder maxResults(Integer maxResults)

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

Parameters:

maxResults - The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

Returns:

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

nextToken

DescribeSessionsRequest.Builder nextToken(String nextToken)

The token for the next set of items to return. (You received this token from a previous call.)

Parameters:

nextToken - The token for the next set of items to return. (You received this token from a previous call.)

Returns:

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

filters

DescribeSessionsRequest.Builder filters(Collection<SessionFilter> filters)

One or more filters to limit the type of sessions returned by the request.

Parameters:

filters - One or more filters to limit the type of sessions returned by the request.

Returns:

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

filters

DescribeSessionsRequest.Builder filters(SessionFilter... filters)

One or more filters to limit the type of sessions returned by the request.

Parameters:

filters - One or more filters to limit the type of sessions returned by the request.

Returns:

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

filters

DescribeSessionsRequest.Builder filters(Consumer<SessionFilter.Builder>... filters)

One or more filters to limit the type of sessions returned by the request.

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

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

Parameters:

filters - a consumer that will call methods on SessionFilter.Builder

Returns:

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

See Also:

• filters(java.util.Collection<SessionFilter>)

overrideConfiguration

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

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