Package software.amazon.awssdk.services.ivs.model

Class StreamSummary

java.lang.Object

software.amazon.awssdk.services.ivs.model.StreamSummary

All Implemented Interfaces:

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

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

Summary information about a stream.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	StreamSummary.Builder

Method Summary

Modifier and Type	Method	Description
static StreamSummary.Builder	builder()
String	channelArn()	Channel ARN for the stream.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
StreamHealth	health()	The stream’s health.
String	healthAsString()	The stream’s health.
List<SdkField<?>>	sdkFields()
static Class<? extends StreamSummary.Builder>	serializableBuilderClass()
Instant	startTime()	Time of the stream’s start.
StreamState	state()	The stream’s state.
String	stateAsString()	The stream’s state.
String	streamId()	Unique identifier for a live or previously live stream in the specified channel.
StreamSummary.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
Long	viewerCount()	A count of concurrent views of the stream.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

channelArn

public final String channelArn()

Channel ARN for the stream.

Returns:

Channel ARN for the stream.

health

public final StreamHealth health()

The stream’s health.

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

Returns:

The stream’s health.

See Also:

StreamHealth

healthAsString

public final String healthAsString()

The stream’s health.

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

Returns:

The stream’s health.

See Also:

StreamHealth

startTime

public final Instant startTime()

Time of the stream’s start. This is an ISO 8601 timestamp; note that this is returned as a string.

Returns:

Time of the stream’s start. This is an ISO 8601 timestamp; note that this is returned as a string.

state

public final StreamState state()

The stream’s state. Do not rely on the OFFLINE state, as the API may not return it; instead, a "NotBroadcasting" error will indicate that the stream is not live.

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

Returns:

The stream’s state. Do not rely on the OFFLINE state, as the API may not return it; instead, a "NotBroadcasting" error will indicate that the stream is not live.

See Also:

StreamState

stateAsString

public final String stateAsString()

The stream’s state. Do not rely on the OFFLINE state, as the API may not return it; instead, a "NotBroadcasting" error will indicate that the stream is not live.

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

Returns:

The stream’s state. Do not rely on the OFFLINE state, as the API may not return it; instead, a "NotBroadcasting" error will indicate that the stream is not live.

See Also:

StreamState

streamId

public final String streamId()

Unique identifier for a live or previously live stream in the specified channel.

Returns:

Unique identifier for a live or previously live stream in the specified channel.

viewerCount

public final Long viewerCount()

A count of concurrent views of the stream. Typically, a new view appears in viewerCount within 15 seconds of when video playback starts and a view is removed from viewerCount within 1 minute of when video playback ends. A value of -1 indicates that the request timed out; in this case, retry.

Returns:

A count of concurrent views of the stream. Typically, a new view appears in viewerCount within 15 seconds of when video playback starts and a view is removed from viewerCount within 1 minute of when video playback ends. A value of -1 indicates that the request timed out; in this case, retry.

toBuilder

public StreamSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StreamSummary.Builder,StreamSummary>

builder

public static StreamSummary.Builder builder()

serializableBuilderClass

public static Class<? extends StreamSummary.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)

Specified by:

equalsBySdkFields in interface SdkPojo

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