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
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description Session.BuilderauthenticationType(String authenticationType)The authentication method.Session.BuilderauthenticationType(AuthenticationType authenticationType)The authentication method.Session.BuilderconnectionState(String connectionState)Specifies whether a user is connected to the streaming session.Session.BuilderconnectionState(SessionConnectionState connectionState)Specifies whether a user is connected to the streaming session.Session.BuilderfleetName(String fleetName)The name of the fleet for the streaming session.Session.Builderid(String id)The identifier of the streaming session.Session.BuilderinstanceId(String instanceId)The identifier for the instance hosting the session.Session.BuildermaxExpirationTime(Instant maxExpirationTime)The time when the streaming session is set to expire.default Session.BuildernetworkAccessConfiguration(Consumer<NetworkAccessConfiguration.Builder> networkAccessConfiguration)The network details for the streaming session.Session.BuildernetworkAccessConfiguration(NetworkAccessConfiguration networkAccessConfiguration)The network details for the streaming session.Session.BuilderstackName(String stackName)The name of the stack for the streaming session.Session.BuilderstartTime(Instant startTime)The time when a streaming instance is dedicated for the user.Session.Builderstate(String state)The current state of the streaming session.Session.Builderstate(SessionState state)The current state of the streaming session.Session.BuilderuserId(String userId)The identifier of the user for whom the session was created.-
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, sdkFieldNameToField, sdkFields
-
-
-
-
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
MaxUserDurationinSecondsvalue, which determines the maximum length of time that a streaming session can run. A streaming session might end earlier than the time specified inSessionMaxExpirationTime, when theDisconnectTimeOutInSecondselapses or the user chooses to end his or her session. If theDisconnectTimeOutInSecondselapses, 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 theMaxUserDurationinSecondsvalue, which determines the maximum length of time that a streaming session can run. A streaming session might end earlier than the time specified inSessionMaxExpirationTime, when theDisconnectTimeOutInSecondselapses or the user chooses to end his or her session. If theDisconnectTimeOutInSecondselapses, 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 theNetworkAccessConfiguration.Builderavoiding the need to create one manually viaNetworkAccessConfiguration.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tonetworkAccessConfiguration(NetworkAccessConfiguration).- Parameters:
networkAccessConfiguration- a consumer that will call methods onNetworkAccessConfiguration.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
networkAccessConfiguration(NetworkAccessConfiguration)
-
instanceId
Session.Builder instanceId(String instanceId)
The identifier for the instance hosting the session.
- Parameters:
instanceId- The identifier for the instance hosting the session.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-