Class StreamSummary
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<StreamSummary.Builder,
StreamSummary>
Summary information about a stream.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic StreamSummary.Builder
builder()
final String
Channel ARN for the stream.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final StreamHealth
health()
The stream’s health.final String
The stream’s health.static Class
<? extends StreamSummary.Builder> final Instant
Time of the stream’s start.final StreamState
state()
The stream’s state.final String
The stream’s state.final String
streamId()
Unique identifier for a live or previously live stream in the specified channel.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 Long
A count of concurrent views of the stream.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
channelArn
Channel ARN for the stream.
- Returns:
- Channel ARN for the stream.
-
health
The stream’s health.
If the service returns an enum value that is not available in the current SDK version,
health
will returnStreamHealth.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromhealthAsString()
.- Returns:
- The stream’s health.
- See Also:
-
healthAsString
The stream’s health.
If the service returns an enum value that is not available in the current SDK version,
health
will returnStreamHealth.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromhealthAsString()
.- Returns:
- The stream’s health.
- See Also:
-
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
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 returnStreamState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- 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:
-
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 returnStreamState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- 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:
-
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
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 fromviewerCount
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 fromviewerCount
within 1 minute of when video playback ends. A value of -1 indicates that the request timed out; in this case, retry.
-
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 interfaceToCopyableBuilder<StreamSummary.Builder,
StreamSummary> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-