Class CreateStreamUrlResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.gameliftstreams.model.GameLiftStreamsResponse
software.amazon.awssdk.services.gameliftstreams.model.CreateStreamUrlResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateStreamUrlResponse.Builder,CreateStreamUrlResponse>
@Generated("software.amazon.awssdk:codegen") public final class CreateStreamUrlResponse extends GameLiftStreamsResponse implements ToCopyableBuilder<CreateStreamUrlResponse.Builder,CreateStreamUrlResponse>

  • Method Details

    • arn

      public final 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] .

      Returns:
      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] .

    • streamUrlId

      public final String streamUrlId()

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

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

    • streamUrl

      public final 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.

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

    • status

      public final 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.

      If the service returns an enum value that is not available in the current SDK version, status will return StreamUrlStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

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

      See Also:

    • statusAsString

      public final String statusAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, status will return StreamUrlStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

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

      See Also:

    • statusReason

      public final 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.

      If the service returns an enum value that is not available in the current SDK version, statusReason will return StreamUrlStatusReason.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusReasonAsString().

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

      See Also:

    • statusReasonAsString

      public final String statusReasonAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, statusReason will return StreamUrlStatusReason.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusReasonAsString().

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

      See Also:

    • expiresAt

      public final 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).

      Returns:
      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).

    • createdAt

      public final 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).

      Returns:
      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).

    • usageLimit

      public final Integer usageLimit()

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

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

    • remainingUses

      public final Integer remainingUses()

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

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

    • streamGroupArn

      public final 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.

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

    • applicationArn

      public final 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.

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

    • protocol

      public final Protocol protocol()

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

      If the service returns an enum value that is not available in the current SDK version, protocol will return Protocol.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from protocolAsString().

      Returns:
      The data transport protocol used for stream sessions started from this stream URL.
      See Also:

    • protocolAsString

      public final String protocolAsString()

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

      If the service returns an enum value that is not available in the current SDK version, protocol will return Protocol.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from protocolAsString().

      Returns:
      The data transport protocol used for stream sessions started from this stream URL.
      See Also:

    • hasLocations

      public final boolean hasLocations()
      For responses, this returns true if the service returned a value for the Locations property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • locations

      public final List<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.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasLocations() method.

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

    • sessionLengthSeconds

      public final Integer sessionLengthSeconds()

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

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

    • description

      public final String description()

      The descriptive label for the stream URL.

      Returns:
      The descriptive label for the stream URL.

    • hasAdditionalLaunchArgs

      public final boolean hasAdditionalLaunchArgs()
      For responses, this returns true if the service returned a value for the AdditionalLaunchArgs property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • additionalLaunchArgs

      public final List<String> additionalLaunchArgs()

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

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAdditionalLaunchArgs() method.

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

    • hasAdditionalEnvironmentVariables

      public final boolean hasAdditionalEnvironmentVariables()
      For responses, this returns true if the service returned a value for the AdditionalEnvironmentVariables property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • additionalEnvironmentVariables

      public final Map<String,String> additionalEnvironmentVariables()

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

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAdditionalEnvironmentVariables() method.

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

    • roleArn

      public final 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.

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

    • displayConfiguration

      public final DisplayConfiguration displayConfiguration()

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

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

    • toBuilder

      public CreateStreamUrlResponse.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<CreateStreamUrlResponse.Builder,CreateStreamUrlResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static CreateStreamUrlResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateStreamUrlResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.