com.amazonaws.services.appstream.model

Class Session

java.lang.Object

com.amazonaws.services.appstream.model.Session

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Session
extends Object
implements Serializable, Cloneable, StructuredPojo

Describes a streaming session.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
Session()

Method Summary

Modifier and Type	Method and Description
Session	clone()
boolean	equals(Object obj)
String	getAuthenticationType() The authentication method.
String	getConnectionState() Specifies whether a user is connected to the streaming session.
String	getFleetName() The name of the fleet for the streaming session.
String	getId() The identifier of the streaming session.
String	getInstanceId() The identifier for the instance hosting the session.
Date	getMaxExpirationTime() The time when the streaming session is set to expire.
NetworkAccessConfiguration	getNetworkAccessConfiguration() The network details for the streaming session.
String	getStackName() The name of the stack for the streaming session.
Date	getStartTime() The time when a streaming instance is dedicated for the user.
String	getState() The current state of the streaming session.
String	getUserId() The identifier of the user for whom the session was created.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setAuthenticationType(AuthenticationType authenticationType) The authentication method.
void	setAuthenticationType(String authenticationType) The authentication method.
void	setConnectionState(SessionConnectionState connectionState) Specifies whether a user is connected to the streaming session.
void	setConnectionState(String connectionState) Specifies whether a user is connected to the streaming session.
void	setFleetName(String fleetName) The name of the fleet for the streaming session.
void	setId(String id) The identifier of the streaming session.
void	setInstanceId(String instanceId) The identifier for the instance hosting the session.
void	setMaxExpirationTime(Date maxExpirationTime) The time when the streaming session is set to expire.
void	setNetworkAccessConfiguration(NetworkAccessConfiguration networkAccessConfiguration) The network details for the streaming session.
void	setStackName(String stackName) The name of the stack for the streaming session.
void	setStartTime(Date startTime) The time when a streaming instance is dedicated for the user.
void	setState(SessionState state) The current state of the streaming session.
void	setState(String state) The current state of the streaming session.
void	setUserId(String userId) The identifier of the user for whom the session was created.
String	toString() Returns a string representation of this object.
Session	withAuthenticationType(AuthenticationType authenticationType) The authentication method.
Session	withAuthenticationType(String authenticationType) The authentication method.
Session	withConnectionState(SessionConnectionState connectionState) Specifies whether a user is connected to the streaming session.
Session	withConnectionState(String connectionState) Specifies whether a user is connected to the streaming session.
Session	withFleetName(String fleetName) The name of the fleet for the streaming session.
Session	withId(String id) The identifier of the streaming session.
Session	withInstanceId(String instanceId) The identifier for the instance hosting the session.
Session	withMaxExpirationTime(Date maxExpirationTime) The time when the streaming session is set to expire.
Session	withNetworkAccessConfiguration(NetworkAccessConfiguration networkAccessConfiguration) The network details for the streaming session.
Session	withStackName(String stackName) The name of the stack for the streaming session.
Session	withStartTime(Date startTime) The time when a streaming instance is dedicated for the user.
Session	withState(SessionState state) The current state of the streaming session.
Session	withState(String state) The current state of the streaming session.
Session	withUserId(String userId) The identifier of the user for whom the session was created.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Session

public Session()

Method Detail

setId

public void setId(String id)

The identifier of the streaming session.

Parameters:

id - The identifier of the streaming session.

getId

public String getId()

The identifier of the streaming session.

Returns:

The identifier of the streaming session.

withId

public Session withId(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.

setUserId

public void setUserId(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.

getUserId

public String getUserId()

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

Returns:

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

withUserId

public Session withUserId(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.

setStackName

public void setStackName(String stackName)

The name of the stack for the streaming session.

Parameters:

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

getStackName

public String getStackName()

The name of the stack for the streaming session.

Returns:

The name of the stack for the streaming session.

withStackName

public Session withStackName(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.

setFleetName

public void setFleetName(String fleetName)

The name of the fleet for the streaming session.

Parameters:

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

getFleetName

public String getFleetName()

The name of the fleet for the streaming session.

Returns:

The name of the fleet for the streaming session.

withFleetName

public Session withFleetName(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.

setState

public void setState(String state)

The current state of the streaming session.

Parameters:

state - The current state of the streaming session.

See Also:

SessionState

getState

public String getState()

The current state of the streaming session.

Returns:

The current state of the streaming session.

See Also:

SessionState

withState

public Session withState(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

setState

public void setState(SessionState state)

The current state of the streaming session.

Parameters:

state - The current state of the streaming session.

See Also:

SessionState

withState

public Session withState(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

setConnectionState

public void setConnectionState(String connectionState)

Specifies whether a user is connected to the streaming session.

Parameters:

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

See Also:

SessionConnectionState

getConnectionState

public String getConnectionState()

Specifies whether a user is connected to the streaming session.

Returns:

Specifies whether a user is connected to the streaming session.

See Also:

SessionConnectionState

withConnectionState

public Session withConnectionState(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

setConnectionState

public void setConnectionState(SessionConnectionState connectionState)

Specifies whether a user is connected to the streaming session.

Parameters:

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

See Also:

SessionConnectionState

withConnectionState

public Session withConnectionState(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

setStartTime

public void setStartTime(Date 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.

getStartTime

public Date getStartTime()

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

Returns:

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

withStartTime

public Session withStartTime(Date 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.

setMaxExpirationTime

public void setMaxExpirationTime(Date 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.

getMaxExpirationTime

public Date getMaxExpirationTime()

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.

withMaxExpirationTime

public Session withMaxExpirationTime(Date 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.

setAuthenticationType

public void setAuthenticationType(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).

See Also:

AuthenticationType

getAuthenticationType

public String getAuthenticationType()

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

Returns:

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

See Also:

AuthenticationType

withAuthenticationType

public Session withAuthenticationType(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

setAuthenticationType

public void setAuthenticationType(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).

See Also:

AuthenticationType

withAuthenticationType

public Session withAuthenticationType(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

setNetworkAccessConfiguration

public void setNetworkAccessConfiguration(NetworkAccessConfiguration networkAccessConfiguration)

The network details for the streaming session.

Parameters:

networkAccessConfiguration - The network details for the streaming session.

getNetworkAccessConfiguration

public NetworkAccessConfiguration getNetworkAccessConfiguration()

The network details for the streaming session.

Returns:

The network details for the streaming session.

withNetworkAccessConfiguration

public Session withNetworkAccessConfiguration(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.

setInstanceId

public void setInstanceId(String instanceId)

The identifier for the instance hosting the session.

Parameters:

instanceId - The identifier for the instance hosting the session.

getInstanceId

public String getInstanceId()

The identifier for the instance hosting the session.

Returns:

The identifier for the instance hosting the session.

withInstanceId

public Session withInstanceId(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.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public Session clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.