Interface GetStreamSessionResponse.Builder

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

  • Method Details

    • additionalEnvironmentVariables

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

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

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

    • applicationArn

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

    • arn

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

    • connectionTimeoutSeconds

      GetStreamSessionResponse.Builder connectionTimeoutSeconds(Integer connectionTimeoutSeconds)

      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.

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

    • createdAt

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

    • description

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

    • exportFilesMetadata

      GetStreamSessionResponse.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 GetStreamSessionResponse.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:

    • lastUpdatedAt

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

    • location

      GetStreamSessionResponse.Builder location(String location)

      The location where Amazon GameLift Streams is hosting the stream session.

      A location's name. 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 is hosting the stream session.

      A location's name. 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.

    • logFileLocationUri

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

    • protocol

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

      GetStreamSessionResponse.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:

    • sessionLengthSeconds

      GetStreamSessionResponse.Builder sessionLengthSeconds(Integer sessionLengthSeconds)

      The length of time that Amazon GameLift Streams keeps the game session open.

      Parameters:
      sessionLengthSeconds - The length of time that Amazon GameLift Streams keeps the game session open.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • signalRequest

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

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

    • status

      GetStreamSessionResponse.Builder status(String status)

      The current status of the stream session. A stream session can host clients when in ACTIVE status.

      Parameters:
      status - The current status of the stream session. A stream session can host clients when in ACTIVE status.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      GetStreamSessionResponse.Builder status(StreamSessionStatus status)

      The current status of the stream session. A stream session can host clients when in ACTIVE status.

      Parameters:
      status - The current status of the stream session. A stream session can host clients when in ACTIVE status.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • statusReason

      GetStreamSessionResponse.Builder statusReason(String statusReason)

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

      Parameters:
      statusReason - A short description of the reason the stream session is in ERROR status.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • statusReason

      GetStreamSessionResponse.Builder statusReason(StreamSessionStatusReason statusReason)

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

      Parameters:
      statusReason - A short description of the reason the stream session is in ERROR status.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • streamGroupId

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

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

    • webSdkProtocolUrl

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