java.lang.Object
- software.amazon.awssdk.services.appstream.model.Session

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<Session.Builder,Session>

@Generated("software.amazon.awssdk:codegen")
public final class Session
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Session.Builder,Session>

Describes a streaming session.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface Session.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`AuthenticationType`	`authenticationType()`	The authentication method.
`String`	`authenticationTypeAsString()`	The authentication method.
`static Session.Builder`	`builder()`
`SessionConnectionState`	`connectionState()`	Specifies whether a user is connected to the streaming session.
`String`	`connectionStateAsString()`	Specifies whether a user is connected to the streaming session.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`fleetName()`	The name of the fleet for the streaming session.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`id()`	The identifier of the streaming session.
`String`	`instanceId()`	The identifier for the instance hosting the session.
`Instant`	`maxExpirationTime()`	The time when the streaming session is set to expire.
`NetworkAccessConfiguration`	`networkAccessConfiguration()`	The network details for the streaming session.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends Session.Builder>`	`serializableBuilderClass()`
`String`	`stackName()`	The name of the stack for the streaming session.
`Instant`	`startTime()`	The time when a streaming instance is dedicated for the user.
`SessionState`	`state()`	The current state of the streaming session.
`String`	`stateAsString()`	The current state of the streaming session.
`Session.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`String`	`userId()`	The identifier of the user for whom the session was created.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - id
```
public final String id()
```
    The identifier of the streaming session.
    
    Returns:
    
    The identifier of the streaming session.
  - userId
```
public final String 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
```
public final String stackName()
```
    The name of the stack for the streaming session.
    
    Returns:
    
    The name of the stack for the streaming session.
  - fleetName
```
public final String fleetName()
```
    The name of the fleet for the streaming session.
    
    Returns:
    
    The name of the fleet for the streaming session.
  - state
```
public final SessionState 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 return SessionState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().
    
    Returns:
    
    The current state of the streaming session.
    
    See Also:
    
    SessionState
  - stateAsString
```
public final String 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 return SessionState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().
    
    Returns:
    
    The current state of the streaming session.
    
    See Also:
    
    SessionState
  - connectionState
```
public final SessionConnectionState 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 return SessionConnectionState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from connectionStateAsString().
    
    Returns:
    
    Specifies whether a user is connected to the streaming session.
    
    See Also:
    
    SessionConnectionState
  - connectionStateAsString
```
public final String 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 return SessionConnectionState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from connectionStateAsString().
    
    Returns:
    
    Specifies whether a user is connected to the streaming session.
    
    See Also:
    
    SessionConnectionState
  - startTime
```
public final Instant 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
```
public final 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.
    
    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 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.
  - authenticationType
```
public final AuthenticationType 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 return AuthenticationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from authenticationTypeAsString().
    
    Returns:
    
    The authentication method. The user is authenticated using a streaming URL (API) or SAML 2.0 federation (SAML).
    
    See Also:
    
    AuthenticationType
  - authenticationTypeAsString
```
public final String 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 return AuthenticationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from authenticationTypeAsString().
    
    Returns:
    
    The authentication method. The user is authenticated using a streaming URL (API) or SAML 2.0 federation (SAML).
    
    See Also:
    
    AuthenticationType
  - networkAccessConfiguration
```
public final NetworkAccessConfiguration networkAccessConfiguration()
```
    The network details for the streaming session.
    
    Returns:
    
    The network details for the streaming session.
  - instanceId
```
public final String instanceId()
```
    The identifier for the instance hosting the session.
    
    Returns:
    
    The identifier for the instance hosting the session.
  - toBuilder
```
public Session.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Session.Builder,Session>
  - builder
```
public static Session.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Session.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String 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.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class Session

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

id

userId

stackName

fleetName

state

stateAsString

connectionState

connectionStateAsString

startTime

maxExpirationTime

authenticationType

authenticationTypeAsString

networkAccessConfiguration

instanceId

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField