Class StreamSessionSummary
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<StreamSessionSummary.Builder,
StreamSessionSummary>
Describes an Amazon GameLift Streams stream session. To retrieve additional details for the stream session, call GetStreamSession.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionfinal String
An Amazon Resource Name (ARN) that uniquely identifies the application resource.final String
arn()
An Amazon Resource Name (ARN) that uniquely identifies the stream session resource.static StreamSessionSummary.Builder
builder()
final Instant
A timestamp that indicates when this resource was created.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final ExportFilesMetadata
Provides details about the stream session's exported files.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final Instant
A timestamp that indicates when this resource was last updated.final String
location()
The location where Amazon GameLift Streams hosts and streams your application.final Protocol
protocol()
The data transfer protocol in use with the stream session.final String
The data transfer protocol in use with the stream session.static Class
<? extends StreamSessionSummary.Builder> final StreamSessionStatus
status()
The current status of the stream session resource.final String
The current status of the stream session resource.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()
An opaque, unique identifier for an end-user, defined by the developer.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
arn
An Amazon Resource Name (ARN) that uniquely identifies the stream session resource. Example ARN:
arn:aws:gameliftstreams:us-west-2:111122223333:streamsession/sg-1AB2C3De4/ABC123def4567
.- Returns:
- An Amazon Resource Name
(ARN) that uniquely identifies the stream session resource. Example ARN:
arn:aws:gameliftstreams:us-west-2:111122223333:streamsession/sg-1AB2C3De4/ABC123def4567
.
-
userId
An opaque, unique identifier for an end-user, defined by the developer.
- Returns:
- An opaque, unique identifier for an end-user, defined by the developer.
-
status
The current status of the stream session resource.
-
ACTIVATING
: The stream session is starting and preparing to stream. -
ACTIVE
: The stream session is ready and waiting for a client connection. A client hasConnectionTimeoutSeconds
(specified inStartStreamSession
) from when the session reachesACTIVE
state to establish a connection. If no client connects within this timeframe, the session automatically terminates. -
CONNECTED
: The stream session has a connected client. A session will automatically terminate if there is no user input for 60 minutes, or if the maximum length of a session specified bySessionLengthSeconds
inStartStreamSession
is exceeded. -
ERROR
: The stream session failed to activate. -
PENDING_CLIENT_RECONNECTION
: A client has recently disconnected and the stream session is waiting for the client to reconnect. A client hasConnectionTimeoutSeconds
(specified inStartStreamSession
) from when the session reachesPENDING_CLIENT_RECONNECTION
state to re-establish a connection. If no client connects within this timeframe, the session automatically terminates. -
RECONNECTING
: A client has initiated a reconnect to a session that was inPENDING_CLIENT_RECONNECTION
state. -
TERMINATING
: The stream session is ending. -
TERMINATED
: The stream session has ended.
If the service returns an enum value that is not available in the current SDK version,
status
will returnStreamSessionStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The current status of the stream session resource.
-
ACTIVATING
: The stream session is starting and preparing to stream. -
ACTIVE
: The stream session is ready and waiting for a client connection. A client hasConnectionTimeoutSeconds
(specified inStartStreamSession
) from when the session reachesACTIVE
state to establish a connection. If no client connects within this timeframe, the session automatically terminates. -
CONNECTED
: The stream session has a connected client. A session will automatically terminate if there is no user input for 60 minutes, or if the maximum length of a session specified bySessionLengthSeconds
inStartStreamSession
is exceeded. -
ERROR
: The stream session failed to activate. -
PENDING_CLIENT_RECONNECTION
: A client has recently disconnected and the stream session is waiting for the client to reconnect. A client hasConnectionTimeoutSeconds
(specified inStartStreamSession
) from when the session reachesPENDING_CLIENT_RECONNECTION
state to re-establish a connection. If no client connects within this timeframe, the session automatically terminates. -
RECONNECTING
: A client has initiated a reconnect to a session that was inPENDING_CLIENT_RECONNECTION
state. -
TERMINATING
: The stream session is ending. -
TERMINATED
: The stream session has ended.
-
- See Also:
-
-
statusAsString
The current status of the stream session resource.
-
ACTIVATING
: The stream session is starting and preparing to stream. -
ACTIVE
: The stream session is ready and waiting for a client connection. A client hasConnectionTimeoutSeconds
(specified inStartStreamSession
) from when the session reachesACTIVE
state to establish a connection. If no client connects within this timeframe, the session automatically terminates. -
CONNECTED
: The stream session has a connected client. A session will automatically terminate if there is no user input for 60 minutes, or if the maximum length of a session specified bySessionLengthSeconds
inStartStreamSession
is exceeded. -
ERROR
: The stream session failed to activate. -
PENDING_CLIENT_RECONNECTION
: A client has recently disconnected and the stream session is waiting for the client to reconnect. A client hasConnectionTimeoutSeconds
(specified inStartStreamSession
) from when the session reachesPENDING_CLIENT_RECONNECTION
state to re-establish a connection. If no client connects within this timeframe, the session automatically terminates. -
RECONNECTING
: A client has initiated a reconnect to a session that was inPENDING_CLIENT_RECONNECTION
state. -
TERMINATING
: The stream session is ending. -
TERMINATED
: The stream session has ended.
If the service returns an enum value that is not available in the current SDK version,
status
will returnStreamSessionStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The current status of the stream session resource.
-
ACTIVATING
: The stream session is starting and preparing to stream. -
ACTIVE
: The stream session is ready and waiting for a client connection. A client hasConnectionTimeoutSeconds
(specified inStartStreamSession
) from when the session reachesACTIVE
state to establish a connection. If no client connects within this timeframe, the session automatically terminates. -
CONNECTED
: The stream session has a connected client. A session will automatically terminate if there is no user input for 60 minutes, or if the maximum length of a session specified bySessionLengthSeconds
inStartStreamSession
is exceeded. -
ERROR
: The stream session failed to activate. -
PENDING_CLIENT_RECONNECTION
: A client has recently disconnected and the stream session is waiting for the client to reconnect. A client hasConnectionTimeoutSeconds
(specified inStartStreamSession
) from when the session reachesPENDING_CLIENT_RECONNECTION
state to re-establish a connection. If no client connects within this timeframe, the session automatically terminates. -
RECONNECTING
: A client has initiated a reconnect to a session that was inPENDING_CLIENT_RECONNECTION
state. -
TERMINATING
: The stream session is ending. -
TERMINATED
: The stream session has ended.
-
- See Also:
-
-
protocol
The data transfer protocol in use with the stream session.
If the service returns an enum value that is not available in the current SDK version,
protocol
will returnProtocol.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromprotocolAsString()
.- Returns:
- The data transfer protocol in use with the stream session.
- See Also:
-
protocolAsString
The data transfer protocol in use with the stream session.
If the service returns an enum value that is not available in the current SDK version,
protocol
will returnProtocol.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromprotocolAsString()
.- Returns:
- The data transfer protocol in use with the stream session.
- See Also:
-
lastUpdatedAt
A timestamp that indicates when this resource was last updated. Timestamps are expressed using in ISO8601 format, such as:
2022-12-27T22:29:40+00:00
(UTC).- Returns:
- A timestamp that indicates when this resource was last updated. Timestamps are expressed using in ISO8601
format, such as:
2022-12-27T22:29:40+00:00
(UTC).
-
createdAt
A timestamp that indicates when this resource was created. Timestamps are expressed using in ISO8601 format, such as:
2022-12-27T22:29:40+00:00
(UTC).- Returns:
- A timestamp that indicates when this resource was created. Timestamps are expressed using in ISO8601
format, such as:
2022-12-27T22:29:40+00:00
(UTC).
-
applicationArn
An Amazon Resource Name (ARN) that uniquely identifies the application resource. Example ARN:
arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6
.- Returns:
- An Amazon Resource Name
(ARN) that uniquely identifies the application resource. Example ARN:
arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6
.
-
exportFilesMetadata
Provides details about the stream session's exported files.
- Returns:
- Provides details about the stream session's exported files.
-
location
The location where Amazon GameLift Streams hosts and streams your application. For example,
us-east-1
. For a complete list of locations that Amazon GameLift Streams supports, refer to Regions, quotas, and limitations in the Amazon GameLift Streams Developer Guide.- Returns:
- The location where Amazon GameLift Streams hosts and streams your application. For example,
us-east-1
. For a complete list of locations that Amazon GameLift Streams supports, refer to Regions, quotas, and limitations in the Amazon GameLift Streams Developer Guide.
-
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<StreamSessionSummary.Builder,
StreamSessionSummary> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
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
-
getValueForField
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
- Returns:
- The mapping between the field name and its corresponding field.
-