Class StreamSession
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<StreamSession.Builder,
StreamSession>
Object that captures the Amazon IVS configuration that the customer provisioned, the ingest configurations that the broadcaster used, and the most recent Amazon IVS stream events it encountered.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic StreamSession.Builder
builder()
final Channel
channel()
The properties of the channel at the time of going live.final Instant
endTime()
Time when the channel went offline.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 boolean
For responses, this returns true if the service returned a value for the TruncatedEvents property.final IngestConfiguration
The properties of the incoming RTMP stream for the stream.final RecordingConfiguration
The properties of recording the live stream.static Class
<? extends StreamSession.Builder> final Instant
Time when the channel went live.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 List
<StreamEvent> List of Amazon IVS events that the stream encountered.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
channel
The properties of the channel at the time of going live.
- Returns:
- The properties of the channel at the time of going live.
-
endTime
Time when the channel went offline. This is an ISO 8601 timestamp; note that this is returned as a string. For live streams, this is
NULL
.- Returns:
- Time when the channel went offline. This is an ISO 8601 timestamp; note that this is returned as a
string. For live streams, this is
NULL
.
-
ingestConfiguration
The properties of the incoming RTMP stream for the stream.
- Returns:
- The properties of the incoming RTMP stream for the stream.
-
recordingConfiguration
The properties of recording the live stream.
- Returns:
- The properties of recording the live stream.
-
startTime
Time when the channel went live. This is an ISO 8601 timestamp; note that this is returned as a string.
- Returns:
- Time when the channel went live. This is an ISO 8601 timestamp; note that this is returned as a 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.
-
hasTruncatedEvents
public final boolean hasTruncatedEvents()For responses, this returns true if the service returned a value for the TruncatedEvents property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
truncatedEvents
List of Amazon IVS events that the stream encountered. The list is sorted by most recent events and contains up to 500 events. For Amazon IVS events, see Using Amazon EventBridge with Amazon IVS.
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
hasTruncatedEvents()
method.- Returns:
- List of Amazon IVS events that the stream encountered. The list is sorted by most recent events and contains up to 500 events. For Amazon IVS events, see Using Amazon EventBridge with Amazon IVS.
-
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<StreamSession.Builder,
StreamSession> - 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
-