software.amazon.awssdk.services.appstream.model

Interface Session.Builder

All Superinterfaces:

Buildable, CopyableBuilder<Session.Builder,Session>, SdkBuilder<Session.Builder,Session>, SdkPojo

Enclosing class:

Session

public static interface Session.Builder
extends SdkPojo, CopyableBuilder<Session.Builder,Session>

Method Summary

Modifier and Type	Method and Description
Session.Builder	authenticationType(AuthenticationType authenticationType) The authentication method.
Session.Builder	authenticationType(String authenticationType) The authentication method.
Session.Builder	connectionState(SessionConnectionState connectionState) Specifies whether a user is connected to the streaming session.
Session.Builder	connectionState(String connectionState) Specifies whether a user is connected to the streaming session.
Session.Builder	fleetName(String fleetName) The name of the fleet for the streaming session.
Session.Builder	id(String id) The identifier of the streaming session.
Session.Builder	maxExpirationTime(Instant maxExpirationTime) The time when the streaming session is set to expire.
default Session.Builder	networkAccessConfiguration(Consumer<NetworkAccessConfiguration.Builder> networkAccessConfiguration) The network details for the streaming session.
Session.Builder	networkAccessConfiguration(NetworkAccessConfiguration networkAccessConfiguration) The network details for the streaming session.
Session.Builder	stackName(String stackName) The name of the stack for the streaming session.
Session.Builder	startTime(Instant startTime) The time when a streaming instance is dedicated for the user.
Session.Builder	state(SessionState state) The current state of the streaming session.
Session.Builder	state(String state) The current state of the streaming session.
Session.Builder	userId(String userId) The identifier of the user for whom the session was created.

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

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

id

Session.Builder id(String id)

The identifier of the streaming session.

Parameters:

id - The identifier of the streaming session.

Returns:

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

userId

Session.Builder userId(String userId)

The identifier of the user for whom the session was created.

Parameters:

userId - The identifier of the user for whom the session was created.

Returns:

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

stackName

Session.Builder stackName(String stackName)

The name of the stack for the streaming session.

Parameters:

stackName - The name of the stack for the streaming session.

Returns:

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

fleetName

Session.Builder fleetName(String fleetName)

The name of the fleet for the streaming session.

Parameters:

fleetName - The name of the fleet for the streaming session.

Returns:

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

state

Session.Builder state(String state)

The current state of the streaming session.

Parameters:

state - The current state of the streaming session.

Returns:

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

See Also:

SessionState, SessionState

state

Session.Builder state(SessionState state)

The current state of the streaming session.

Parameters:

state - The current state of the streaming session.

Returns:

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

See Also:

SessionState, SessionState

connectionState

Session.Builder connectionState(String connectionState)

Specifies whether a user is connected to the streaming session.

Parameters:

connectionState - Specifies whether a user is connected to the streaming session.

Returns:

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

See Also:

SessionConnectionState, SessionConnectionState

connectionState

Session.Builder connectionState(SessionConnectionState connectionState)

Specifies whether a user is connected to the streaming session.

Parameters:

connectionState - Specifies whether a user is connected to the streaming session.

Returns:

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

See Also:

SessionConnectionState, SessionConnectionState

startTime

Session.Builder startTime(Instant startTime)

The time when a streaming instance is dedicated for the user.

Parameters:

startTime - The time when a streaming instance is dedicated for the user.

Returns:

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

maxExpirationTime

Session.Builder maxExpirationTime(Instant maxExpirationTime)

The time when the streaming session is set to expire. This time is based on the MaxUserDurationinSeconds value, which determines the maximum length of time that a streaming session can run. A streaming session might end earlier than the time specified in SessionMaxExpirationTime, when the DisconnectTimeOutInSeconds elapses or the user chooses to end his or her session. If the DisconnectTimeOutInSeconds elapses, or the user chooses to end his or her session, the streaming instance is terminated and the streaming session ends.

Parameters:

maxExpirationTime - The time when the streaming session is set to expire. This time is based on the MaxUserDurationinSeconds value, which determines the maximum length of time that a streaming session can run. A streaming session might end earlier than the time specified in SessionMaxExpirationTime, when the DisconnectTimeOutInSeconds elapses or the user chooses to end his or her session. If the DisconnectTimeOutInSeconds elapses, or the user chooses to end his or her session, the streaming instance is terminated and the streaming session ends.

Returns:

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

authenticationType

Session.Builder authenticationType(String authenticationType)

The authentication method. The user is authenticated using a streaming URL (API) or SAML 2.0 federation (SAML).

Parameters:

authenticationType - The authentication method. The user is authenticated using a streaming URL (API) or SAML 2.0 federation (SAML).

Returns:

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

See Also:

AuthenticationType, AuthenticationType

authenticationType

Session.Builder authenticationType(AuthenticationType authenticationType)

The authentication method. The user is authenticated using a streaming URL (API) or SAML 2.0 federation (SAML).

Parameters:

authenticationType - The authentication method. The user is authenticated using a streaming URL (API) or SAML 2.0 federation (SAML).

Returns:

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

See Also:

AuthenticationType, AuthenticationType

networkAccessConfiguration

Session.Builder networkAccessConfiguration(NetworkAccessConfiguration networkAccessConfiguration)

The network details for the streaming session.

Parameters:

networkAccessConfiguration - The network details for the streaming session.

Returns:

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

networkAccessConfiguration

default Session.Builder networkAccessConfiguration(Consumer<NetworkAccessConfiguration.Builder> networkAccessConfiguration)

The network details for the streaming session.

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

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

Parameters:

networkAccessConfiguration - a consumer that will call methods on NetworkAccessConfiguration.Builder

Returns:

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

See Also:

networkAccessConfiguration(NetworkAccessConfiguration)