Interface GetStreamUrlResponse.Builder

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

  • Method Details

    • arn

      GetStreamUrlResponse.Builder arn(String arn)

      The Amazon Resource Name (ARN) that uniquely identifies the stream URL across all Amazon Web Services Regions. Format is arn:aws:gameliftstreams:[AWS Region]:[AWS account]:streamurl/[stream group resource ID]/[stream URL resource ID] .

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

    • streamUrlId

      GetStreamUrlResponse.Builder streamUrlId(String streamUrlId)

      The unique identifier for the stream URL resource, for example su-1AB2C3De4.

      Parameters:
      streamUrlId - The unique identifier for the stream URL resource, for example su-1AB2C3De4.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • streamUrl

      GetStreamUrlResponse.Builder streamUrl(String streamUrl)

      The shareable stream URL. Distribute this URL to end users so that they can start and play a stream session in a hosted web player. Treat the stream URL as a secret. Anyone who has it can start a stream session until the stream URL expires, is revoked, or reaches its usage limit.

      Parameters:
      streamUrl - The shareable stream URL. Distribute this URL to end users so that they can start and play a stream session in a hosted web player. Treat the stream URL as a secret. Anyone who has it can start a stream session until the stream URL expires, is revoked, or reaches its usage limit.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • status

      GetStreamUrlResponse.Builder status(String status)

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

      • ACTIVE: The stream URL is valid and can start stream sessions.

      • EXPIRED: The stream URL has passed its expiration time and can no longer start stream sessions.

      • REVOKED: The stream URL was revoked and can no longer start stream sessions.

      • LIMIT_REACHED: The stream URL has been used the maximum number of times and can no longer start stream sessions.

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

      • ACTIVE: The stream URL is valid and can start stream sessions.

      • EXPIRED: The stream URL has passed its expiration time and can no longer start stream sessions.

      • REVOKED: The stream URL was revoked and can no longer start stream sessions.

      • LIMIT_REACHED: The stream URL has been used the maximum number of times and can no longer start stream sessions.

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

    • status

      GetStreamUrlResponse.Builder status(StreamUrlStatus status)

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

      • ACTIVE: The stream URL is valid and can start stream sessions.

      • EXPIRED: The stream URL has passed its expiration time and can no longer start stream sessions.

      • REVOKED: The stream URL was revoked and can no longer start stream sessions.

      • LIMIT_REACHED: The stream URL has been used the maximum number of times and can no longer start stream sessions.

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

      • ACTIVE: The stream URL is valid and can start stream sessions.

      • EXPIRED: The stream URL has passed its expiration time and can no longer start stream sessions.

      • REVOKED: The stream URL was revoked and can no longer start stream sessions.

      • LIMIT_REACHED: The stream URL has been used the maximum number of times and can no longer start stream sessions.

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

    • statusReason

      GetStreamUrlResponse.Builder statusReason(String statusReason)

      Additional information about why the stream URL is in its current status. Amazon GameLift Streams populates this value when the status is REVOKED. Possible values include the following:

      • userRevoked: You revoked the stream URL.

      • revokedAndTerminatingSessions: You revoked the stream URL and Amazon GameLift Streams is ending its running stream sessions.

      • revokedAndSessionsTerminated: You revoked the stream URL and its running stream sessions have ended.

      • streamGroupDeleted: The stream group was deleted, which revoked the stream URL.

      • applicationDeleted: The application was deleted, which revoked the stream URL.

      Parameters:
      statusReason - Additional information about why the stream URL is in its current status. Amazon GameLift Streams populates this value when the status is REVOKED. Possible values include the following:

      • userRevoked: You revoked the stream URL.

      • revokedAndTerminatingSessions: You revoked the stream URL and Amazon GameLift Streams is ending its running stream sessions.

      • revokedAndSessionsTerminated: You revoked the stream URL and its running stream sessions have ended.

      • streamGroupDeleted: The stream group was deleted, which revoked the stream URL.

      • applicationDeleted: The application was deleted, which revoked the stream URL.

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

    • statusReason

      GetStreamUrlResponse.Builder statusReason(StreamUrlStatusReason statusReason)

      Additional information about why the stream URL is in its current status. Amazon GameLift Streams populates this value when the status is REVOKED. Possible values include the following:

      • userRevoked: You revoked the stream URL.

      • revokedAndTerminatingSessions: You revoked the stream URL and Amazon GameLift Streams is ending its running stream sessions.

      • revokedAndSessionsTerminated: You revoked the stream URL and its running stream sessions have ended.

      • streamGroupDeleted: The stream group was deleted, which revoked the stream URL.

      • applicationDeleted: The application was deleted, which revoked the stream URL.

      Parameters:
      statusReason - Additional information about why the stream URL is in its current status. Amazon GameLift Streams populates this value when the status is REVOKED. Possible values include the following:

      • userRevoked: You revoked the stream URL.

      • revokedAndTerminatingSessions: You revoked the stream URL and Amazon GameLift Streams is ending its running stream sessions.

      • revokedAndSessionsTerminated: You revoked the stream URL and its running stream sessions have ended.

      • streamGroupDeleted: The stream group was deleted, which revoked the stream URL.

      • applicationDeleted: The application was deleted, which revoked the stream URL.

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

    • expiresAt

      GetStreamUrlResponse.Builder expiresAt(Instant expiresAt)

      The date and time when the stream URL expires and stops accepting new stream sessions. Timestamps are expressed using in ISO8601 format, such as: 2022-12-27T22:29:40+00:00 (UTC).

      Parameters:
      expiresAt - The date and time when the stream URL expires and stops accepting new stream sessions. 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

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

    • usageLimit

      GetStreamUrlResponse.Builder usageLimit(Integer usageLimit)

      The maximum number of times the stream URL can start a stream session.

      Parameters:
      usageLimit - The maximum number of times the stream URL can start a stream session.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • remainingUses

      GetStreamUrlResponse.Builder remainingUses(Integer remainingUses)

      The number of times the stream URL can still be used to start a stream session.

      Parameters:
      remainingUses - The number of times the stream URL can still be used to start a stream session.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • streamGroupArn

      GetStreamUrlResponse.Builder streamGroupArn(String streamGroupArn)

      The stream group that runs the stream sessions.

      This value is an Amazon Resource Name (ARN) that uniquely identifies the stream group resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4.

      Parameters:
      streamGroupArn - The stream group that runs the stream sessions.

      This value is an Amazon Resource Name (ARN) that uniquely identifies the stream group resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4.

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

    • applicationArn

      GetStreamUrlResponse.Builder applicationArn(String applicationArn)

      The application that runs in the stream sessions.

      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 that runs in the stream sessions.

      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.

    • protocol

      GetStreamUrlResponse.Builder protocol(String protocol)

      The data transport protocol used for stream sessions started from this stream URL.

      Parameters:
      protocol - The data transport protocol used for stream sessions started from this stream URL.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • protocol

      GetStreamUrlResponse.Builder protocol(Protocol protocol)

      The data transport protocol used for stream sessions started from this stream URL.

      Parameters:
      protocol - The data transport protocol used for stream sessions started from this stream URL.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • locations

      GetStreamUrlResponse.Builder locations(Collection<String> locations)

      The list of locations, in order of preference, where Amazon GameLift Streams places the stream session. 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:
      locations - The list of locations, in order of preference, where Amazon GameLift Streams places the stream session. 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.

    • locations

      GetStreamUrlResponse.Builder locations(String... locations)

      The list of locations, in order of preference, where Amazon GameLift Streams places the stream session. 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:
      locations - The list of locations, in order of preference, where Amazon GameLift Streams places the stream session. 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.

    • sessionLengthSeconds

      GetStreamUrlResponse.Builder sessionLengthSeconds(Integer sessionLengthSeconds)

      The maximum length of time, in seconds, that a stream session started from this stream URL can run.

      Parameters:
      sessionLengthSeconds - The maximum length of time, in seconds, that a stream session started from this stream URL can run.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      GetStreamUrlResponse.Builder description(String description)

      The descriptive label for the stream URL.

      Parameters:
      description - The descriptive label for the stream URL.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • additionalLaunchArgs

      GetStreamUrlResponse.Builder additionalLaunchArgs(Collection<String> additionalLaunchArgs)

      The command-line arguments passed to the application when a stream session starts.

      Parameters:
      additionalLaunchArgs - The command-line arguments passed to the application when a stream session starts.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • additionalLaunchArgs

      GetStreamUrlResponse.Builder additionalLaunchArgs(String... additionalLaunchArgs)

      The command-line arguments passed to the application when a stream session starts.

      Parameters:
      additionalLaunchArgs - The command-line arguments passed to the application when a stream session starts.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • additionalEnvironmentVariables

      GetStreamUrlResponse.Builder additionalEnvironmentVariables(Map<String,String> additionalEnvironmentVariables)

      The environment variables made available to the application when a stream session starts.

      Parameters:
      additionalEnvironmentVariables - The environment variables made available to the application when a stream session starts.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • roleArn

      GetStreamUrlResponse.Builder roleArn(String roleArn)

      The Amazon Resource Name (ARN) of the IAM role that Amazon GameLift Streams assumes during stream sessions started from this stream URL. For more information, see Provide AWS credentials to your streaming application in the Amazon GameLift Streams Developer Guide.

      Parameters:
      roleArn - The Amazon Resource Name (ARN) of the IAM role that Amazon GameLift Streams assumes during stream sessions started from this stream URL. For more information, see Provide AWS credentials to your streaming application in the Amazon GameLift Streams Developer Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • displayConfiguration

      GetStreamUrlResponse.Builder displayConfiguration(DisplayConfiguration displayConfiguration)

      The display settings, such as resolution, for stream sessions started from this stream URL.

      Parameters:
      displayConfiguration - The display settings, such as resolution, for stream sessions started from this stream URL.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • displayConfiguration

      default GetStreamUrlResponse.Builder displayConfiguration(Consumer<DisplayConfiguration.Builder> displayConfiguration)

      The display settings, such as resolution, for stream sessions started from this stream URL.

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

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

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

    • streamSessions

      GetStreamUrlResponse.Builder streamSessions(Collection<StreamSessionSummary> streamSessions)

      A list of the stream sessions that have been started through this stream URL.

      Parameters:
      streamSessions - A list of the stream sessions that have been started through this stream URL.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • streamSessions

      GetStreamUrlResponse.Builder streamSessions(StreamSessionSummary... streamSessions)

      A list of the stream sessions that have been started through this stream URL.

      Parameters:
      streamSessions - A list of the stream sessions that have been started through this stream URL.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • streamSessions

      GetStreamUrlResponse.Builder streamSessions(Consumer<StreamSessionSummary.Builder>... streamSessions)

      A list of the stream sessions that have been started through this stream URL.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to streamSessions(List<StreamSessionSummary>).

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