Interface StreamSessionSummary.Builder

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

  • Method Details

    • arn

      StreamSessionSummary.Builder arn(String 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.

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

    • userId

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

      StreamSessionSummary.Builder status(String status)

      The current status of the stream session resource. Possible statuses include the following:

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

      • ACTIVE: The stream session is ready to accept client connections.

      • CONNECTED: The stream session has a connected client.

      • PENDING_CLIENT_RECONNECTION: A client has recently disconnected, and the stream session is waiting for the client to reconnect. After a short time, if the client doesn't reconnect, the stream session status transitions to TERMINATED.

      • TERMINATING: The stream session is ending.

      • TERMINATED: The stream session has ended.

      • ERROR: The stream session failed to activate.

      Parameters:
      status - The current status of the stream session resource. Possible statuses include the following:

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

      • ACTIVE: The stream session is ready to accept client connections.

      • CONNECTED: The stream session has a connected client.

      • PENDING_CLIENT_RECONNECTION: A client has recently disconnected, and the stream session is waiting for the client to reconnect. After a short time, if the client doesn't reconnect, the stream session status transitions to TERMINATED.

      • TERMINATING: The stream session is ending.

      • TERMINATED: The stream session has ended.

      • ERROR: The stream session failed to activate.

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

    • status

      StreamSessionSummary.Builder status(StreamSessionStatus status)

      The current status of the stream session resource. Possible statuses include the following:

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

      • ACTIVE: The stream session is ready to accept client connections.

      • CONNECTED: The stream session has a connected client.

      • PENDING_CLIENT_RECONNECTION: A client has recently disconnected, and the stream session is waiting for the client to reconnect. After a short time, if the client doesn't reconnect, the stream session status transitions to TERMINATED.

      • TERMINATING: The stream session is ending.

      • TERMINATED: The stream session has ended.

      • ERROR: The stream session failed to activate.

      Parameters:
      status - The current status of the stream session resource. Possible statuses include the following:

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

      • ACTIVE: The stream session is ready to accept client connections.

      • CONNECTED: The stream session has a connected client.

      • PENDING_CLIENT_RECONNECTION: A client has recently disconnected, and the stream session is waiting for the client to reconnect. After a short time, if the client doesn't reconnect, the stream session status transitions to TERMINATED.

      • TERMINATING: The stream session is ending.

      • TERMINATED: The stream session has ended.

      • ERROR: The stream session failed to activate.

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

    • protocol

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

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

    • lastUpdatedAt

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

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

      StreamSessionSummary.Builder applicationArn(String applicationArn)

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

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

    • location

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