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:

  • Method Details

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

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

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

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

    • 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()
      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<StreamSummary.Builder,StreamSummary>
      Returns:
      a builder for type T

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