Class StreamUrlSummary

java.lang.Object

software.amazon.awssdk.services.gameliftstreams.model.StreamUrlSummary

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<StreamUrlSummary.Builder,StreamUrlSummary>

@Generated("software.amazon.awssdk:codegen")
public final class StreamUrlSummary
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<StreamUrlSummary.Builder,StreamUrlSummary>

Describes a stream URL. This is a summary view that omits the full configuration, such as launch arguments and display settings. To retrieve the complete configuration, call GetStreamUrl.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	StreamUrlSummary.Builder

Method Summary

Modifier and Type	Method	Description
final String	applicationArn()	The application that runs in the stream sessions.
final String	arn()	The Amazon Resource Name (ARN) that uniquely identifies the stream URL across all Amazon Web Services Regions.
static StreamUrlSummary.Builder	builder()
final Instant	createdAt()	A timestamp that indicates when this resource was created.
final String	description()	The descriptive label for the stream URL.
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)	Indicates whether some other object is "equal to" this one by SDK fields.
final Instant	expiresAt()	The date and time when the stream URL expires and stops accepting new stream sessions.
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final int	hashCode()
final Integer	remainingUses()	The number of times the stream URL can still be used to start a stream session.
final Map<String,SdkField<?>>	sdkFieldNameToField()
final List<SdkField<?>>	sdkFields()
static Class<? extends StreamUrlSummary.Builder>	serializableBuilderClass()
final Integer	sessionLengthSeconds()	The maximum length of time, in seconds, that a stream session started from this stream URL can run.
final StreamUrlStatus	status()	The current status of the stream URL.
final String	statusAsString()	The current status of the stream URL.
final StreamUrlStatusReason	statusReason()	Additional information about why the stream URL is in its current status.
final String	statusReasonAsString()	Additional information about why the stream URL is in its current status.
final String	streamGroupArn()	The stream group that runs the stream sessions.
final String	streamUrl()	The shareable stream URL.
final String	streamUrlId()	The unique identifier for the stream URL resource, for example su-1AB2C3De4.
StreamUrlSummary.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
final String	toString()	Returns a string representation of this object.
final Integer	usageLimit()	The maximum number of times the stream URL can start a stream session.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

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:

• StreamUrlStatus

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:

• StreamUrlStatus

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:

• StreamUrlStatusReason

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:

• StreamUrlStatusReason

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.

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.

toBuilder

public StreamUrlSummary.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<StreamUrlSummary.Builder,StreamUrlSummary>

Returns:

a builder for type T

builder

public static StreamUrlSummary.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

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.