Class StartStreamSessionRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<StartStreamSessionRequest.Builder,
StartStreamSessionRequest>
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionA set of options that you can use to control the stream session runtime environment, expressed as a set of key-value pairs.A list of CLI arguments that are sent to the streaming server when a stream session launches.final String
An Amazon Resource Name (ARN) or ID that uniquely identifies the application resource.builder()
final String
A unique identifier that represents a client request.final Integer
Length of time (in seconds) that Amazon GameLift Streams should wait for a client to connect or reconnect to the stream session.final String
A human-readable label for the stream session.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final boolean
For responses, this returns true if the service returned a value for the AdditionalEnvironmentVariables property.final boolean
For responses, this returns true if the service returned a value for the AdditionalLaunchArgs property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Locations property.final String
The stream group to run this stream session with.A list of locations, in order of priority, where you want Amazon GameLift Streams to start a stream from.final Protocol
protocol()
The data transport protocol to use for the stream session.final String
The data transport protocol to use for the stream session.static Class
<? extends StartStreamSessionRequest.Builder> final Integer
The maximum duration of a session.final String
A WebRTC ICE offer string to use when initializing a WebRTC connection.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 class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
clientToken
A unique identifier that represents a client request. The request is idempotent, which ensures that an API request completes only once. When users send a request, Amazon GameLift Streams automatically populates this field.
- Returns:
- A unique identifier that represents a client request. The request is idempotent, which ensures that an API request completes only once. When users send a request, Amazon GameLift Streams automatically populates this field.
-
description
A human-readable label for the stream session. You can update this value later.
- Returns:
- A human-readable label for the stream session. You can update this value later.
-
identifier
The stream group to run this stream session with.
This value is an Amazon Resource Name (ARN) or ID that uniquely identifies the stream group resource. Example ARN:
arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4
. Example ID:sg-1AB2C3De4
.- Returns:
- The stream group to run this stream session with.
This value is an Amazon Resource Name (ARN) or ID that uniquely identifies the stream group resource. Example ARN:
arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4
. Example ID:sg-1AB2C3De4
.
-
protocol
The data transport protocol to use for 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 transport protocol to use for the stream session.
- See Also:
-
protocolAsString
The data transport protocol to use for 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 transport protocol to use for the stream session.
- See Also:
-
signalRequest
A WebRTC ICE offer string to use when initializing a WebRTC connection. Typically, the offer is a very long JSON string. Provide the string as a text value in quotes.
Amazon GameLift Streams also supports setting the field to "NO_CLIENT_CONNECTION". This will create a session without needing any browser request or Web SDK integration. The session starts up as usual and waits for a reconnection from a browser, which is accomplished using CreateStreamSessionConnection.
- Returns:
- A WebRTC ICE offer string to use when initializing a WebRTC connection. Typically, the offer is a very
long JSON string. Provide the string as a text value in quotes.
Amazon GameLift Streams also supports setting the field to "NO_CLIENT_CONNECTION". This will create a session without needing any browser request or Web SDK integration. The session starts up as usual and waits for a reconnection from a browser, which is accomplished using CreateStreamSessionConnection.
-
applicationIdentifier
An Amazon Resource Name (ARN) or ID that uniquely identifies the application resource. Example ARN:
arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6
. Example ID:a-9ZY8X7Wv6
.- Returns:
- An Amazon Resource Name
(ARN) or ID that uniquely identifies the application resource. Example ARN:
arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6
. Example ID:a-9ZY8X7Wv6
.
-
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.
-
hasLocations
public final boolean hasLocations()For responses, this returns true if the service returned a value for the Locations property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
locations
A list of locations, in order of priority, where you want Amazon GameLift Streams to start a stream from. For example,
us-east-1
. Amazon GameLift Streams selects the location with the next available capacity to start a single stream session in. If this value is empty, Amazon GameLift Streams attempts to start a stream session in the primary location.For a complete list of locations that Amazon GameLift Streams supports, refer to Regions, quotas, and limitations in the Amazon GameLift Streams Developer Guide.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasLocations()
method.- Returns:
- A list of locations, in order of priority, where you want Amazon GameLift Streams to start a stream from.
For example,
us-east-1
. Amazon GameLift Streams selects the location with the next available capacity to start a single stream session in. If this value is empty, Amazon GameLift Streams attempts to start a stream session in the primary location.For a complete list of locations that Amazon GameLift Streams supports, refer to Regions, quotas, and limitations in the Amazon GameLift Streams Developer Guide.
-
connectionTimeoutSeconds
Length of time (in seconds) that Amazon GameLift Streams should wait for a client to connect or reconnect to the stream session. Applies to both connection and reconnection scenarios. This time span starts when the stream session reaches
ACTIVE
state. If no client connects before the timeout, Amazon GameLift Streams terminates the stream session. Default value is 120.- Returns:
- Length of time (in seconds) that Amazon GameLift Streams should wait for a client to connect or reconnect
to the stream session. Applies to both connection and reconnection scenarios. This time span starts when
the stream session reaches
ACTIVE
state. If no client connects before the timeout, Amazon GameLift Streams terminates the stream session. Default value is 120.
-
sessionLengthSeconds
The maximum duration of a session. Amazon GameLift Streams will automatically terminate a session after this amount of time has elapsed, regardless of any existing client connections. Default value is 43200 (12 hours).
- Returns:
- The maximum duration of a session. Amazon GameLift Streams will automatically terminate a session after this amount of time has elapsed, regardless of any existing client connections. Default value is 43200 (12 hours).
-
hasAdditionalLaunchArgs
public final boolean hasAdditionalLaunchArgs()For responses, this returns true if the service returned a value for the AdditionalLaunchArgs property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
additionalLaunchArgs
A list of CLI arguments that are sent to the streaming server when a stream session launches. You can use this to configure the application or stream session details. You can also provide custom arguments that Amazon GameLift Streams passes to your game client.
AdditionalEnvironmentVariables
andAdditionalLaunchArgs
have similar purposes.AdditionalEnvironmentVariables
passes data using environment variables; whileAdditionalLaunchArgs
passes data using command-line arguments.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasAdditionalLaunchArgs()
method.- Returns:
- A list of CLI arguments that are sent to the streaming server when a stream session launches. You can use
this to configure the application or stream session details. You can also provide custom arguments that
Amazon GameLift Streams passes to your game client.
AdditionalEnvironmentVariables
andAdditionalLaunchArgs
have similar purposes.AdditionalEnvironmentVariables
passes data using environment variables; whileAdditionalLaunchArgs
passes data using command-line arguments.
-
hasAdditionalEnvironmentVariables
public final boolean hasAdditionalEnvironmentVariables()For responses, this returns true if the service returned a value for the AdditionalEnvironmentVariables property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
additionalEnvironmentVariables
A set of options that you can use to control the stream session runtime environment, expressed as a set of key-value pairs. You can use this to configure the application or stream session details. You can also provide custom environment variables that Amazon GameLift Streams passes to your game client.
If you want to debug your application with environment variables, we recommend that you do so in a local environment outside of Amazon GameLift Streams. For more information, refer to the Compatibility Guidance in the troubleshooting section of the Developer Guide.
AdditionalEnvironmentVariables
andAdditionalLaunchArgs
have similar purposes.AdditionalEnvironmentVariables
passes data using environment variables; whileAdditionalLaunchArgs
passes data using command-line arguments.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasAdditionalEnvironmentVariables()
method.- Returns:
- A set of options that you can use to control the stream session runtime environment, expressed as a set
of key-value pairs. You can use this to configure the application or stream session details. You can also
provide custom environment variables that Amazon GameLift Streams passes to your game client.
If you want to debug your application with environment variables, we recommend that you do so in a local environment outside of Amazon GameLift Streams. For more information, refer to the Compatibility Guidance in the troubleshooting section of the Developer Guide.
AdditionalEnvironmentVariables
andAdditionalLaunchArgs
have similar purposes.AdditionalEnvironmentVariables
passes data using environment variables; whileAdditionalLaunchArgs
passes data using command-line arguments.
-
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<StartStreamSessionRequest.Builder,
StartStreamSessionRequest> - Specified by:
toBuilder
in classGameLiftStreamsRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
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
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
- Returns:
- The mapping between the field name and its corresponding field.
-