Interface StartStreamSessionRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<StartStreamSessionRequest.Builder,StartStreamSessionRequest>, GameLiftStreamsRequest.Builder, SdkBuilder<StartStreamSessionRequest.Builder,StartStreamSessionRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
StartStreamSessionRequest
@Mutable @NotThreadSafe public static interface StartStreamSessionRequest.Builder extends GameLiftStreamsRequest.Builder, SdkPojo, CopyableBuilder<StartStreamSessionRequest.Builder,StartStreamSessionRequest>

  • Method Details

    • additionalEnvironmentVariables

      StartStreamSessionRequest.Builder additionalEnvironmentVariables(Map<String,String> 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 and AdditionalLaunchArgs have similar purposes. AdditionalEnvironmentVariables passes data using environment variables; while AdditionalLaunchArgs passes data using command-line arguments.

      Parameters:
      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 and AdditionalLaunchArgs have similar purposes. AdditionalEnvironmentVariables passes data using environment variables; while AdditionalLaunchArgs passes data using command-line arguments.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • additionalLaunchArgs

      StartStreamSessionRequest.Builder additionalLaunchArgs(Collection<String> 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 and AdditionalLaunchArgs have similar purposes. AdditionalEnvironmentVariables passes data using environment variables; while AdditionalLaunchArgs passes data using command-line arguments.

      Parameters:
      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 and AdditionalLaunchArgs have similar purposes. AdditionalEnvironmentVariables passes data using environment variables; while AdditionalLaunchArgs passes data using command-line arguments.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • additionalLaunchArgs

      StartStreamSessionRequest.Builder additionalLaunchArgs(String... 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 and AdditionalLaunchArgs have similar purposes. AdditionalEnvironmentVariables passes data using environment variables; while AdditionalLaunchArgs passes data using command-line arguments.

      Parameters:
      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 and AdditionalLaunchArgs have similar purposes. AdditionalEnvironmentVariables passes data using environment variables; while AdditionalLaunchArgs passes data using command-line arguments.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • applicationIdentifier

      StartStreamSessionRequest.Builder applicationIdentifier(String 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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • clientToken

      StartStreamSessionRequest.Builder clientToken(String 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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • connectionTimeoutSeconds

      StartStreamSessionRequest.Builder connectionTimeoutSeconds(Integer connectionTimeoutSeconds)

      Length of time (in seconds) that Amazon GameLift Streams should wait for a client to connect to the stream session. This time span starts when the stream session reaches ACTIVE status. If no client connects before the timeout, Amazon GameLift Streams stops the stream session with status of TERMINATED. Default value is 120.

      Parameters:
      connectionTimeoutSeconds - Length of time (in seconds) that Amazon GameLift Streams should wait for a client to connect to the stream session. This time span starts when the stream session reaches ACTIVE status. If no client connects before the timeout, Amazon GameLift Streams stops the stream session with status of TERMINATED. Default value is 120.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      StartStreamSessionRequest.Builder description(String description)

      A human-readable label for the stream session. You can update this value later.

      Parameters:
      description - A human-readable label for the stream session. You can update this value later.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • identifier

      StartStreamSessionRequest.Builder identifier(String 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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • locations

      StartStreamSessionRequest.Builder locations(Collection<String> locations)

      A list of locations, in order of priority, where you want Amazon GameLift Streams to start a stream from. 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.

      This value is A set of location names. 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.

      Parameters:
      locations - A list of locations, in order of priority, where you want Amazon GameLift Streams to start a stream from. 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.

      This value is A set of location names. 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:
      Returns a reference to this object so that method calls can be chained together.

    • locations

      StartStreamSessionRequest.Builder locations(String... locations)

      A list of locations, in order of priority, where you want Amazon GameLift Streams to start a stream from. 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.

      This value is A set of location names. 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.

      Parameters:
      locations - A list of locations, in order of priority, where you want Amazon GameLift Streams to start a stream from. 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.

      This value is A set of location names. 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:
      Returns a reference to this object so that method calls can be chained together.

    • protocol

      StartStreamSessionRequest.Builder protocol(String protocol)

      The data transport protocol to use for the stream session.

      Parameters:
      protocol - The data transport protocol to use for the stream session.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • protocol

      StartStreamSessionRequest.Builder protocol(Protocol protocol)

      The data transport protocol to use for the stream session.

      Parameters:
      protocol - The data transport protocol to use for the stream session.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • sessionLengthSeconds

      StartStreamSessionRequest.Builder sessionLengthSeconds(Integer sessionLengthSeconds)

      The maximum length of time (in seconds) that Amazon GameLift Streams keeps the stream session open. At this point, Amazon GameLift Streams ends the stream session regardless of any existing client connections. Default value is 43200.

      Parameters:
      sessionLengthSeconds - The maximum length of time (in seconds) that Amazon GameLift Streams keeps the stream session open. At this point, Amazon GameLift Streams ends the stream session regardless of any existing client connections. Default value is 43200.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • signalRequest

      StartStreamSessionRequest.Builder signalRequest(String 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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • userId

      StartStreamSessionRequest.Builder userId(String userId)

      An opaque, unique identifier for an end-user, defined by the developer.

      Parameters:
      userId - An opaque, unique identifier for an end-user, defined by the developer.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      StartStreamSessionRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      StartStreamSessionRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.