Class StreamSession

java.lang.Object
software.amazon.awssdk.services.ivs.model.StreamSession
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<StreamSession.Builder,StreamSession>
@Generated("software.amazon.awssdk:codegen") public final class StreamSession extends Object implements SdkPojo, Serializable, 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:

  • Method Details

    • channel

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

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

      public final IngestConfiguration ingestConfiguration()

      The properties of the incoming RTMP stream.

      Note: ingestConfiguration is deprecated in favor of ingestConfigurations but retained to ensure backward compatibility. If multitrack is not enabled, ingestConfiguration and ingestConfigurations contain the same data, namely information about track0 (the sole track). If multitrack is enabled, ingestConfiguration contains data for only the first track (track0) and ingestConfigurations contains data for all tracks.

      Returns:
      The properties of the incoming RTMP stream.

      Note: ingestConfiguration is deprecated in favor of ingestConfigurations but retained to ensure backward compatibility. If multitrack is not enabled, ingestConfiguration and ingestConfigurations contain the same data, namely information about track0 (the sole track). If multitrack is enabled, ingestConfiguration contains data for only the first track (track0) and ingestConfigurations contains data for all tracks.

    • ingestConfigurations

      public final IngestConfigurations ingestConfigurations()

      The properties of the incoming RTMP stream. If multitrack is enabled, ingestConfigurations contains data for all tracks; otherwise, it contains data only for track0 (the sole track).

      Returns:
      The properties of the incoming RTMP stream. If multitrack is enabled, ingestConfigurations contains data for all tracks; otherwise, it contains data only for track0 (the sole track).

    • recordingConfiguration

      public final RecordingConfiguration recordingConfiguration()

      The properties of recording the live stream.

      Returns:
      The properties of recording the live stream.

    • startTime

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

      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.

    • 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 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.

    • truncatedEvents

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

      public StreamSession.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<StreamSession.Builder,StreamSession>
      Returns:
      a builder for type T

    • builder

      public static StreamSession.Builder builder()

    • serializableBuilderClass

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