Interface CreateStreamSessionConnectionRequest.Builder

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

  • Method Details

    • clientToken

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

    • identifier

      CreateStreamSessionConnectionRequest.Builder identifier(String identifier)

      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.

      The stream group that you want to run this stream session with. The stream group must be in ACTIVE status and have idle stream capacity.

      Parameters:
      identifier - 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.

      The stream group that you want to run this stream session with. The stream group must be in ACTIVE status and have idle stream capacity.

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

    • signalRequest

      CreateStreamSessionConnectionRequest.Builder signalRequest(String signalRequest)

      A WebRTC ICE offer string to use when initializing a WebRTC connection. The offer is a very long JSON string. Provide the string as a text value in quotes. The offer must be newly generated, not the same offer provided to StartStreamSession.

      Parameters:
      signalRequest - A WebRTC ICE offer string to use when initializing a WebRTC connection. The offer is a very long JSON string. Provide the string as a text value in quotes. The offer must be newly generated, not the same offer provided to StartStreamSession.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • streamSessionIdentifier

      CreateStreamSessionConnectionRequest.Builder streamSessionIdentifier(String streamSessionIdentifier)

      Amazon Resource Name (ARN) or ID that uniquely identifies the stream session resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:streamsession/sg-1AB2C3De4/ABC123def4567. Example ID: ABC123def4567.

      The stream session must be in PENDING_CLIENT_RECONNECTION or ACTIVE status.

      Parameters:
      streamSessionIdentifier - Amazon Resource Name (ARN) or ID that uniquely identifies the stream session resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:streamsession/sg-1AB2C3De4/ABC123def4567. Example ID: ABC123def4567.

      The stream session must be in PENDING_CLIENT_RECONNECTION or ACTIVE status.

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

    • overrideConfiguration

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

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