Interface ListStreamSessionsRequest.Builder

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

  • Method Details

    • exportFilesStatus

      ListStreamSessionsRequest.Builder exportFilesStatus(String exportFilesStatus)

      Filter by the exported files status. You can specify one status in each request to retrieve only sessions that currently have that exported files status.

      Exported files can be in one of the following states:

      • SUCCEEDED: The exported files are successfully stored in S3 bucket.

      • FAILED: The session ended but Amazon GameLift Streams couldn't collect and upload the to S3.

      • PENDING: Either the stream session is still in progress, or uploading the exported files to the S3 bucket is in progress.

      Parameters:
      exportFilesStatus - Filter by the exported files status. You can specify one status in each request to retrieve only sessions that currently have that exported files status.

      Exported files can be in one of the following states:

      • SUCCEEDED: The exported files are successfully stored in S3 bucket.

      • FAILED: The session ended but Amazon GameLift Streams couldn't collect and upload the to S3.

      • PENDING: Either the stream session is still in progress, or uploading the exported files to the S3 bucket is in progress.

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

    • exportFilesStatus

      ListStreamSessionsRequest.Builder exportFilesStatus(ExportFilesStatus exportFilesStatus)

      Filter by the exported files status. You can specify one status in each request to retrieve only sessions that currently have that exported files status.

      Exported files can be in one of the following states:

      • SUCCEEDED: The exported files are successfully stored in S3 bucket.

      • FAILED: The session ended but Amazon GameLift Streams couldn't collect and upload the to S3.

      • PENDING: Either the stream session is still in progress, or uploading the exported files to the S3 bucket is in progress.

      Parameters:
      exportFilesStatus - Filter by the exported files status. You can specify one status in each request to retrieve only sessions that currently have that exported files status.

      Exported files can be in one of the following states:

      • SUCCEEDED: The exported files are successfully stored in S3 bucket.

      • FAILED: The session ended but Amazon GameLift Streams couldn't collect and upload the to S3.

      • PENDING: Either the stream session is still in progress, or uploading the exported files to the S3 bucket is in progress.

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

    • identifier

      ListStreamSessionsRequest.Builder identifier(String identifier)

      The unique identifier of a Amazon GameLift Streams stream group to retrieve the stream session for. You can use either the stream group ID or the Amazon Resource Name (ARN).

      Parameters:
      identifier - The unique identifier of a Amazon GameLift Streams stream group to retrieve the stream session for. You can use either the stream group ID or the Amazon Resource Name (ARN).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxResults

      ListStreamSessionsRequest.Builder maxResults(Integer maxResults)

      The number of results to return. Use this parameter with NextToken to return results in sequential pages. Default value is 25.

      Parameters:
      maxResults - The number of results to return. Use this parameter with NextToken to return results in sequential pages. Default value is 25.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • nextToken

      ListStreamSessionsRequest.Builder nextToken(String nextToken)

      The token that marks the start of the next set of results. Use this token when you retrieve results as sequential pages. To get the first page of results, omit a token value. To get the remaining pages, provide the token returned with the previous result set.

      Parameters:
      nextToken - The token that marks the start of the next set of results. Use this token when you retrieve results as sequential pages. To get the first page of results, omit a token value. To get the remaining pages, provide the token returned with the previous result set.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • status

      ListStreamSessionsRequest.Builder status(String status)

      Filter by the stream session status. You can specify one status in each request to retrieve only sessions that are currently in that status.

      Parameters:
      status - Filter by the stream session status. You can specify one status in each request to retrieve only sessions that are currently in that status.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      ListStreamSessionsRequest.Builder status(StreamSessionStatus status)

      Filter by the stream session status. You can specify one status in each request to retrieve only sessions that are currently in that status.

      Parameters:
      status - Filter by the stream session status. You can specify one status in each request to retrieve only sessions that are currently in that status.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

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

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