Package software.amazon.awssdk.services.appstream.model

Interface DescribeSessionsRequest.Builder

All Superinterfaces:

CopyableBuilder<DescribeSessionsRequest.Builder,DescribeSessionsRequest>, SdkBuilder<DescribeSessionsRequest.Builder,DescribeSessionsRequest>

Enclosing class:

DescribeSessionsRequest

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

Method Summary

Modifier and Type	Method	Description
DescribeSessionsRequest.Builder	authenticationType(String authenticationType)	The authentication method of the user.
DescribeSessionsRequest.Builder	authenticationType(AuthenticationType authenticationType)	The authentication method of the user.
DescribeSessionsRequest.Builder	fleetName(String fleetName)	The name of the fleet for which to list sessions.
DescribeSessionsRequest.Builder	limit(Integer limit)	The size of each page of results.
DescribeSessionsRequest.Builder	nextToken(String nextToken)	The pagination token to use to retrieve the next page of results for this operation.
DescribeSessionsRequest.Builder	stackName(String stackName)	The name of the stack for which to list sessions.
DescribeSessionsRequest.Builder	userId(String userId)	The user for whom to list sessions.

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

copy

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

apply, build

Method Detail

stackName

DescribeSessionsRequest.Builder stackName(String stackName)

The name of the stack for which to list sessions.

Parameters:

stackName - The name of the stack for which to list sessions.

Returns:

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

fleetName

DescribeSessionsRequest.Builder fleetName(String fleetName)

The name of the fleet for which to list sessions.

Parameters:

fleetName - The name of the fleet for which to list sessions.

Returns:

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

userId

DescribeSessionsRequest.Builder userId(String userId)

The user for whom to list sessions. Use null to describe all the sessions for the stack and fleet.

Parameters:

userId - The user for whom to list sessions. Use null to describe all the sessions for the stack and fleet.

Returns:

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

nextToken

DescribeSessionsRequest.Builder nextToken(String nextToken)

The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

Parameters:

nextToken - The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

Returns:

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

limit

DescribeSessionsRequest.Builder limit(Integer limit)

The size of each page of results. The default value is 20 and the maximum supported value is 50.

Parameters:

limit - The size of each page of results. The default value is 20 and the maximum supported value is 50.

Returns:

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

authenticationType

DescribeSessionsRequest.Builder authenticationType(String authenticationType)

The authentication method of the user. It can be API for a user authenticated using a streaming URL, or SAML for a SAML federated user. If an authentication type is not provided, the operation defaults to users authenticated using a streaming URL.

Parameters:

authenticationType - The authentication method of the user. It can be API for a user authenticated using a streaming URL, or SAML for a SAML federated user. If an authentication type is not provided, the operation defaults to users authenticated using a streaming URL.

Returns:

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

See Also:

AuthenticationType

authenticationType

DescribeSessionsRequest.Builder authenticationType(AuthenticationType authenticationType)

The authentication method of the user. It can be API for a user authenticated using a streaming URL, or SAML for a SAML federated user. If an authentication type is not provided, the operation defaults to users authenticated using a streaming URL.

Parameters:

authenticationType - The authentication method of the user. It can be API for a user authenticated using a streaming URL, or SAML for a SAML federated user. If an authentication type is not provided, the operation defaults to users authenticated using a streaming URL.

Returns:

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

See Also:

AuthenticationType