Interface StartStreamSessionResponse.Builder

All Superinterfaces:
AwsResponse.Builder, Buildable, CopyableBuilder<StartStreamSessionResponse.Builder,StartStreamSessionResponse>, GameLiftStreamsResponse.Builder, SdkBuilder<StartStreamSessionResponse.Builder,StartStreamSessionResponse>, SdkPojo, SdkResponse.Builder
Enclosing class:
StartStreamSessionResponse
@Mutable @NotThreadSafe public static interface StartStreamSessionResponse.Builder extends GameLiftStreamsResponse.Builder, SdkPojo, CopyableBuilder<StartStreamSessionResponse.Builder,StartStreamSessionResponse>

  • Method Details

    • arn

      StartStreamSessionResponse.Builder arn(String arn)

      The Amazon Resource Name (ARN) that's assigned to a stream session resource. When combined with the stream group resource ID, this value uniquely identifies the stream session across all Amazon Web Services Regions. Format is arn:aws:gameliftstreams:[AWS Region]:[AWS account]:streamsession/[stream group resource ID]/[stream session resource ID] .

      Parameters:
      arn - The Amazon Resource Name (ARN) that's assigned to a stream session resource. When combined with the stream group resource ID, this value uniquely identifies the stream session across all Amazon Web Services Regions. Format is arn:aws:gameliftstreams:[AWS Region]:[AWS account]:streamsession/[stream group resource ID]/[stream session resource ID] .
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      StartStreamSessionResponse.Builder description(String description)

      A human-readable label for the stream session. You can update this value at any time.

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

    • streamGroupId

      StartStreamSessionResponse.Builder streamGroupId(String streamGroupId)

      The unique identifier for the Amazon GameLift Streams stream group that is hosting the stream session. Format example: sg-1AB2C3De4.

      Parameters:
      streamGroupId - The unique identifier for the Amazon GameLift Streams stream group that is hosting the stream session. Format example: sg-1AB2C3De4.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • userId

      StartStreamSessionResponse.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.

    • status

      StartStreamSessionResponse.Builder status(String status)

      The current status of the stream session. A stream session is ready for a client to connect when in ACTIVE status.

      • ACTIVATING: The stream session is starting and preparing to stream.

      • ACTIVE: The stream session is ready and waiting for a client connection. A client has ConnectionTimeoutSeconds (specified in StartStreamSession) from when the session reaches ACTIVE 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 by SessionLengthSeconds in StartStreamSession is exceeded.

      • ERROR: The stream session failed to activate. See StatusReason (returned by GetStreamSession and StartStreamSession) for more information.

      • PENDING_CLIENT_RECONNECTION: A client has recently disconnected and the stream session is waiting for the client to reconnect. A client has ConnectionTimeoutSeconds (specified in StartStreamSession) from when the session reaches PENDING_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 in PENDING_CLIENT_RECONNECTION state.

      • TERMINATING: The stream session is ending.

      • TERMINATED: The stream session has ended.

      Parameters:
      status - The current status of the stream session. A stream session is ready for a client to connect when in ACTIVE status.

      • ACTIVATING: The stream session is starting and preparing to stream.

      • ACTIVE: The stream session is ready and waiting for a client connection. A client has ConnectionTimeoutSeconds (specified in StartStreamSession) from when the session reaches ACTIVE 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 by SessionLengthSeconds in StartStreamSession is exceeded.

      • ERROR: The stream session failed to activate. See StatusReason (returned by GetStreamSession and StartStreamSession) for more information.

      • PENDING_CLIENT_RECONNECTION: A client has recently disconnected and the stream session is waiting for the client to reconnect. A client has ConnectionTimeoutSeconds (specified in StartStreamSession) from when the session reaches PENDING_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 in PENDING_CLIENT_RECONNECTION state.

      • TERMINATING: The stream session is ending.

      • TERMINATED: The stream session has ended.

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

    • status

      StartStreamSessionResponse.Builder status(StreamSessionStatus status)

      The current status of the stream session. A stream session is ready for a client to connect when in ACTIVE status.

      • ACTIVATING: The stream session is starting and preparing to stream.

      • ACTIVE: The stream session is ready and waiting for a client connection. A client has ConnectionTimeoutSeconds (specified in StartStreamSession) from when the session reaches ACTIVE 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 by SessionLengthSeconds in StartStreamSession is exceeded.

      • ERROR: The stream session failed to activate. See StatusReason (returned by GetStreamSession and StartStreamSession) for more information.

      • PENDING_CLIENT_RECONNECTION: A client has recently disconnected and the stream session is waiting for the client to reconnect. A client has ConnectionTimeoutSeconds (specified in StartStreamSession) from when the session reaches PENDING_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 in PENDING_CLIENT_RECONNECTION state.

      • TERMINATING: The stream session is ending.

      • TERMINATED: The stream session has ended.

      Parameters:
      status - The current status of the stream session. A stream session is ready for a client to connect when in ACTIVE status.

      • ACTIVATING: The stream session is starting and preparing to stream.

      • ACTIVE: The stream session is ready and waiting for a client connection. A client has ConnectionTimeoutSeconds (specified in StartStreamSession) from when the session reaches ACTIVE 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 by SessionLengthSeconds in StartStreamSession is exceeded.

      • ERROR: The stream session failed to activate. See StatusReason (returned by GetStreamSession and StartStreamSession) for more information.

      • PENDING_CLIENT_RECONNECTION: A client has recently disconnected and the stream session is waiting for the client to reconnect. A client has ConnectionTimeoutSeconds (specified in StartStreamSession) from when the session reaches PENDING_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 in PENDING_CLIENT_RECONNECTION state.

      • TERMINATING: The stream session is ending.

      • TERMINATED: The stream session has ended.

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

    • statusReason

      StartStreamSessionResponse.Builder statusReason(String statusReason)

      A short description of the reason the stream session is in ERROR status or TERMINATED status.

      ERROR status reasons:

      • applicationLogS3DestinationError: Could not write the application log to the Amazon S3 bucket that is configured for the streaming application. Make sure the bucket still exists.

      • internalError: An internal service error occurred. Start a new stream session to continue streaming.

      • invalidSignalRequest: The WebRTC signal request that was sent is not valid. When starting or reconnecting to a stream session, use generateSignalRequest in the Amazon GameLift Streams Web SDK to generate a new signal request.

      • placementTimeout: Amazon GameLift Streams could not find available stream capacity to start a stream session. Increase the stream capacity in the stream group or wait until capacity becomes available.

      TERMINATED status reasons:

      • apiTerminated: The stream session was terminated by an API call to TerminateStreamSession.

      • applicationExit: The streaming application exited or crashed. The stream session was terminated because the application is no longer running.

      • connectionTimeout: The stream session was terminated because the client failed to connect within the connection timeout period specified by ConnectionTimeoutSeconds.

      • idleTimeout: The stream session was terminated because it exceeded the idle timeout period of 60 minutes with no user input activity.

      • maxSessionLengthTimeout: The stream session was terminated because it exceeded the maximum session length timeout period specified by SessionLengthSeconds.

      • reconnectionTimeout: The stream session was terminated because the client failed to reconnect within the reconnection timeout period specified by ConnectionTimeoutSeconds after losing connection.

      Parameters:
      statusReason - A short description of the reason the stream session is in ERROR status or TERMINATED status.

      ERROR status reasons:

      • applicationLogS3DestinationError: Could not write the application log to the Amazon S3 bucket that is configured for the streaming application. Make sure the bucket still exists.

      • internalError: An internal service error occurred. Start a new stream session to continue streaming.

      • invalidSignalRequest: The WebRTC signal request that was sent is not valid. When starting or reconnecting to a stream session, use generateSignalRequest in the Amazon GameLift Streams Web SDK to generate a new signal request.

      • placementTimeout: Amazon GameLift Streams could not find available stream capacity to start a stream session. Increase the stream capacity in the stream group or wait until capacity becomes available.

      TERMINATED status reasons:

      • apiTerminated: The stream session was terminated by an API call to TerminateStreamSession.

      • applicationExit: The streaming application exited or crashed. The stream session was terminated because the application is no longer running.

      • connectionTimeout: The stream session was terminated because the client failed to connect within the connection timeout period specified by ConnectionTimeoutSeconds.

      • idleTimeout: The stream session was terminated because it exceeded the idle timeout period of 60 minutes with no user input activity.

      • maxSessionLengthTimeout: The stream session was terminated because it exceeded the maximum session length timeout period specified by SessionLengthSeconds.

      • reconnectionTimeout: The stream session was terminated because the client failed to reconnect within the reconnection timeout period specified by ConnectionTimeoutSeconds after losing connection.

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

    • statusReason

      StartStreamSessionResponse.Builder statusReason(StreamSessionStatusReason statusReason)

      A short description of the reason the stream session is in ERROR status or TERMINATED status.

      ERROR status reasons:

      • applicationLogS3DestinationError: Could not write the application log to the Amazon S3 bucket that is configured for the streaming application. Make sure the bucket still exists.

      • internalError: An internal service error occurred. Start a new stream session to continue streaming.

      • invalidSignalRequest: The WebRTC signal request that was sent is not valid. When starting or reconnecting to a stream session, use generateSignalRequest in the Amazon GameLift Streams Web SDK to generate a new signal request.

      • placementTimeout: Amazon GameLift Streams could not find available stream capacity to start a stream session. Increase the stream capacity in the stream group or wait until capacity becomes available.

      TERMINATED status reasons:

      • apiTerminated: The stream session was terminated by an API call to TerminateStreamSession.

      • applicationExit: The streaming application exited or crashed. The stream session was terminated because the application is no longer running.

      • connectionTimeout: The stream session was terminated because the client failed to connect within the connection timeout period specified by ConnectionTimeoutSeconds.

      • idleTimeout: The stream session was terminated because it exceeded the idle timeout period of 60 minutes with no user input activity.

      • maxSessionLengthTimeout: The stream session was terminated because it exceeded the maximum session length timeout period specified by SessionLengthSeconds.

      • reconnectionTimeout: The stream session was terminated because the client failed to reconnect within the reconnection timeout period specified by ConnectionTimeoutSeconds after losing connection.

      Parameters:
      statusReason - A short description of the reason the stream session is in ERROR status or TERMINATED status.

      ERROR status reasons:

      • applicationLogS3DestinationError: Could not write the application log to the Amazon S3 bucket that is configured for the streaming application. Make sure the bucket still exists.

      • internalError: An internal service error occurred. Start a new stream session to continue streaming.

      • invalidSignalRequest: The WebRTC signal request that was sent is not valid. When starting or reconnecting to a stream session, use generateSignalRequest in the Amazon GameLift Streams Web SDK to generate a new signal request.

      • placementTimeout: Amazon GameLift Streams could not find available stream capacity to start a stream session. Increase the stream capacity in the stream group or wait until capacity becomes available.

      TERMINATED status reasons:

      • apiTerminated: The stream session was terminated by an API call to TerminateStreamSession.

      • applicationExit: The streaming application exited or crashed. The stream session was terminated because the application is no longer running.

      • connectionTimeout: The stream session was terminated because the client failed to connect within the connection timeout period specified by ConnectionTimeoutSeconds.

      • idleTimeout: The stream session was terminated because it exceeded the idle timeout period of 60 minutes with no user input activity.

      • maxSessionLengthTimeout: The stream session was terminated because it exceeded the maximum session length timeout period specified by SessionLengthSeconds.

      • reconnectionTimeout: The stream session was terminated because the client failed to reconnect within the reconnection timeout period specified by ConnectionTimeoutSeconds after losing connection.

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

    • protocol

      StartStreamSessionResponse.Builder protocol(String protocol)

      The data transfer protocol in use with the stream session.

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

    • protocol

      StartStreamSessionResponse.Builder protocol(Protocol protocol)

      The data transfer protocol in use with the stream session.

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

    • location

      StartStreamSessionResponse.Builder location(String 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.

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

    • signalRequest

      StartStreamSessionResponse.Builder signalRequest(String signalRequest)

      The WebRTC ICE offer string that a client generates to initiate a connection to the stream session.

      Parameters:
      signalRequest - The WebRTC ICE offer string that a client generates to initiate a connection to the stream session.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • signalResponse

      StartStreamSessionResponse.Builder signalResponse(String signalResponse)

      The WebRTC answer string that the stream server generates in response to the SignalRequest.

      Parameters:
      signalResponse - The WebRTC answer string that the stream server generates in response to the SignalRequest.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • connectionTimeoutSeconds

      StartStreamSessionResponse.Builder connectionTimeoutSeconds(Integer connectionTimeoutSeconds)

      The length of time that Amazon GameLift Streams should wait for a client to connect or reconnect to the stream session. This time span starts when the stream session reaches ACTIVE or PENDING_CLIENT_RECONNECTION state. If no client connects (or reconnects) before the timeout, Amazon GameLift Streams terminates the stream session.

      Parameters:
      connectionTimeoutSeconds - The length of time that Amazon GameLift Streams should wait for a client to connect or reconnect to the stream session. This time span starts when the stream session reaches ACTIVE or PENDING_CLIENT_RECONNECTION state. If no client connects (or reconnects) before the timeout, Amazon GameLift Streams terminates the stream session.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sessionLengthSeconds

      StartStreamSessionResponse.Builder sessionLengthSeconds(Integer 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.

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

    • additionalLaunchArgs

      StartStreamSessionResponse.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

      StartStreamSessionResponse.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.

    • additionalEnvironmentVariables

      StartStreamSessionResponse.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.

    • logFileLocationUri

      StartStreamSessionResponse.Builder logFileLocationUri(String logFileLocationUri)

      Access location for log files that your content generates during a stream session. These log files are uploaded to cloud storage location at the end of a stream session. The Amazon GameLift Streams application resource defines which log files to upload.

      Parameters:
      logFileLocationUri - Access location for log files that your content generates during a stream session. These log files are uploaded to cloud storage location at the end of a stream session. The Amazon GameLift Streams application resource defines which log files to upload.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • webSdkProtocolUrl

      StartStreamSessionResponse.Builder webSdkProtocolUrl(String webSdkProtocolUrl)

      The URL of an S3 bucket that stores Amazon GameLift Streams WebSDK files. The URL is used to establish connection with the client.

      Parameters:
      webSdkProtocolUrl - The URL of an S3 bucket that stores Amazon GameLift Streams WebSDK files. The URL is used to establish connection with the client.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lastUpdatedAt

      StartStreamSessionResponse.Builder lastUpdatedAt(Instant 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).

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

    • createdAt

      StartStreamSessionResponse.Builder createdAt(Instant 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).

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

    • applicationArn

      StartStreamSessionResponse.Builder applicationArn(String applicationArn)

      The application streaming in this session.

      This value is an Amazon Resource Name (ARN) that uniquely identifies the application resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6.

      Parameters:
      applicationArn - The application streaming in this session.

      This value is an Amazon Resource Name (ARN) that uniquely identifies the application resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6.

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

    • exportFilesMetadata

      StartStreamSessionResponse.Builder exportFilesMetadata(ExportFilesMetadata exportFilesMetadata)

      Provides details about the stream session's exported files.

      Parameters:
      exportFilesMetadata - Provides details about the stream session's exported files.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • exportFilesMetadata

      default StartStreamSessionResponse.Builder exportFilesMetadata(Consumer<ExportFilesMetadata.Builder> exportFilesMetadata)

      Provides details about the stream session's exported files.

      This is a convenience method that creates an instance of the ExportFilesMetadata.Builder avoiding the need to create one manually via ExportFilesMetadata.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to exportFilesMetadata(ExportFilesMetadata).

      Parameters:
      exportFilesMetadata - a consumer that will call methods on ExportFilesMetadata.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: