Class Session
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Session.Builder,
Session>
Describes a streaming session.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal AuthenticationType
The authentication method.final String
The authentication method.static Session.Builder
builder()
final SessionConnectionState
Specifies whether a user is connected to the streaming session.final String
Specifies whether a user is connected to the streaming session.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
The name of the fleet for the streaming session.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final String
id()
The identifier of the streaming session.final String
The identifier for the instance hosting the session.final Instant
The time when the streaming session is set to expire.The network details for the streaming session.static Class
<? extends Session.Builder> final String
The name of the stack for the streaming session.final Instant
The time when a streaming instance is dedicated for the user.final SessionState
state()
The current state of the streaming session.final String
The current state of the streaming session.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
userId()
The identifier of the user for whom the session was created.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
id
The identifier of the streaming session.
- Returns:
- The identifier of the streaming session.
-
userId
The identifier of the user for whom the session was created.
- Returns:
- The identifier of the user for whom the session was created.
-
stackName
The name of the stack for the streaming session.
- Returns:
- The name of the stack for the streaming session.
-
fleetName
The name of the fleet for the streaming session.
- Returns:
- The name of the fleet for the streaming session.
-
state
The current state of the streaming session.
If the service returns an enum value that is not available in the current SDK version,
state
will returnSessionState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- The current state of the streaming session.
- See Also:
-
stateAsString
The current state of the streaming session.
If the service returns an enum value that is not available in the current SDK version,
state
will returnSessionState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- The current state of the streaming session.
- See Also:
-
connectionState
Specifies whether a user is connected to the streaming session.
If the service returns an enum value that is not available in the current SDK version,
connectionState
will returnSessionConnectionState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromconnectionStateAsString()
.- Returns:
- Specifies whether a user is connected to the streaming session.
- See Also:
-
connectionStateAsString
Specifies whether a user is connected to the streaming session.
If the service returns an enum value that is not available in the current SDK version,
connectionState
will returnSessionConnectionState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromconnectionStateAsString()
.- Returns:
- Specifies whether a user is connected to the streaming session.
- See Also:
-
startTime
The time when a streaming instance is dedicated for the user.
- Returns:
- The time when a streaming instance is dedicated for the user.
-
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 inSessionMaxExpirationTime
, when theDisconnectTimeOutInSeconds
elapses or the user chooses to end his or her session. If theDisconnectTimeOutInSeconds
elapses, or the user chooses to end his or her session, the streaming instance is terminated and the streaming session ends.- Returns:
- 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 inSessionMaxExpirationTime
, when theDisconnectTimeOutInSeconds
elapses or the user chooses to end his or her session. If theDisconnectTimeOutInSeconds
elapses, or the user chooses to end his or her session, the streaming instance is terminated and the streaming session ends.
-
authenticationType
The authentication method. The user is authenticated using a streaming URL (
API
) or SAML 2.0 federation (SAML
).If the service returns an enum value that is not available in the current SDK version,
authenticationType
will returnAuthenticationType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromauthenticationTypeAsString()
.- Returns:
- The authentication method. The user is authenticated using a streaming URL (
API
) or SAML 2.0 federation (SAML
). - See Also:
-
authenticationTypeAsString
The authentication method. The user is authenticated using a streaming URL (
API
) or SAML 2.0 federation (SAML
).If the service returns an enum value that is not available in the current SDK version,
authenticationType
will returnAuthenticationType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromauthenticationTypeAsString()
.- Returns:
- The authentication method. The user is authenticated using a streaming URL (
API
) or SAML 2.0 federation (SAML
). - See Also:
-
networkAccessConfiguration
The network details for the streaming session.
- Returns:
- The network details for the streaming session.
-
instanceId
The identifier for the instance hosting the session.
- Returns:
- The identifier for the instance hosting the session.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<Session.Builder,
Session> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-