Class StreamInfo

java.lang.Object
software.amazon.awssdk.services.kinesisvideo.model.StreamInfo
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<StreamInfo.Builder,StreamInfo>
@Generated("software.amazon.awssdk:codegen") public final class StreamInfo extends Object implements SdkPojo, Serializable, ToCopyableBuilder<StreamInfo.Builder,StreamInfo>

An object describing a Kinesis video stream.

See Also:

  • Method Details

    • deviceName

      public final String deviceName()

      The name of the device that is associated with the stream.

      Returns:
      The name of the device that is associated with the stream.

    • streamName

      public final String streamName()

      The name of the stream.

      Returns:
      The name of the stream.

    • streamARN

      public final String streamARN()

      The Amazon Resource Name (ARN) of the stream.

      Returns:
      The Amazon Resource Name (ARN) of the stream.

    • mediaType

      public final String mediaType()

      The MediaType of the stream.

      Returns:
      The MediaType of the stream.

    • kmsKeyId

      public final String kmsKeyId()

      The ID of the Key Management Service (KMS) key that Kinesis Video Streams uses to encrypt data on the stream.

      Returns:
      The ID of the Key Management Service (KMS) key that Kinesis Video Streams uses to encrypt data on the stream.

    • version

      public final String version()

      The version of the stream.

      Returns:
      The version of the stream.

    • status

      public final Status status()

      The status of the stream.

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

      Returns:
      The status of the stream.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the stream.

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

      Returns:
      The status of the stream.
      See Also:

    • creationTime

      public final Instant creationTime()

      A time stamp that indicates when the stream was created.

      Returns:
      A time stamp that indicates when the stream was created.

    • dataRetentionInHours

      public final Integer dataRetentionInHours()

      How long the stream retains data, in hours.

      Returns:
      How long the stream retains data, in hours.

    • toBuilder

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

    • builder

      public static StreamInfo.Builder builder()

    • serializableBuilderClass

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