Class Image

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

A structure that contains the Timestamp, Error, and ImageContent.

See Also:

  • Method Details

    • timeStamp

      public final Instant timeStamp()

      An attribute of the Image object that is used to extract an image from the video stream. This field is used to manage gaps on images or to better understand the pagination window.

      Returns:
      An attribute of the Image object that is used to extract an image from the video stream. This field is used to manage gaps on images or to better understand the pagination window.

    • error

      public final ImageError error()

      The error message shown when the image for the provided timestamp was not extracted due to a non-tryable error. An error will be returned if:

      • There is no media that exists for the specified Timestamp.

      • The media for the specified time does not allow an image to be extracted. In this case the media is audio only, or the incorrect media has been ingested.

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

      Returns:
      The error message shown when the image for the provided timestamp was not extracted due to a non-tryable error. An error will be returned if:

      • There is no media that exists for the specified Timestamp.

      • The media for the specified time does not allow an image to be extracted. In this case the media is audio only, or the incorrect media has been ingested.

      See Also:

    • errorAsString

      public final String errorAsString()

      The error message shown when the image for the provided timestamp was not extracted due to a non-tryable error. An error will be returned if:

      • There is no media that exists for the specified Timestamp.

      • The media for the specified time does not allow an image to be extracted. In this case the media is audio only, or the incorrect media has been ingested.

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

      Returns:
      The error message shown when the image for the provided timestamp was not extracted due to a non-tryable error. An error will be returned if:

      • There is no media that exists for the specified Timestamp.

      • The media for the specified time does not allow an image to be extracted. In this case the media is audio only, or the incorrect media has been ingested.

      See Also:

    • imageContent

      public final String imageContent()

      An attribute of the Image object that is Base64 encoded.

      Returns:
      An attribute of the Image object that is Base64 encoded.

    • toBuilder

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

    • builder

      public static Image.Builder builder()

    • serializableBuilderClass

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