Package software.amazon.awssdk.services.kinesisvideoarchivedmedia.model

Class GetImagesRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.kinesisvideoarchivedmedia.model.KinesisVideoArchivedMediaRequest
software.amazon.awssdk.services.kinesisvideoarchivedmedia.model.GetImagesRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetImagesRequest.Builder,GetImagesRequest>
@Generated("software.amazon.awssdk:codegen") public final class GetImagesRequest extends KinesisVideoArchivedMediaRequest implements ToCopyableBuilder<GetImagesRequest.Builder,GetImagesRequest>

  • Method Details

    • streamName

      public final String streamName()

      The name of the stream from which to retrieve the images. You must specify either the StreamName or the StreamARN.

      Returns:
      The name of the stream from which to retrieve the images. You must specify either the StreamName or the StreamARN.

    • streamARN

      public final String streamARN()

      The Amazon Resource Name (ARN) of the stream from which to retrieve the images. You must specify either the StreamName or the StreamARN.

      Returns:
      The Amazon Resource Name (ARN) of the stream from which to retrieve the images. You must specify either the StreamName or the StreamARN.

    • imageSelectorType

      public final ImageSelectorType imageSelectorType()

      The origin of the Server or Producer timestamps to use to generate the images.

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

      Returns:
      The origin of the Server or Producer timestamps to use to generate the images.
      See Also:

    • imageSelectorTypeAsString

      public final String imageSelectorTypeAsString()

      The origin of the Server or Producer timestamps to use to generate the images.

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

      Returns:
      The origin of the Server or Producer timestamps to use to generate the images.
      See Also:

    • startTimestamp

      public final Instant startTimestamp()

      The starting point from which the images should be generated. This StartTimestamp must be within an inclusive range of timestamps for an image to be returned.

      Returns:
      The starting point from which the images should be generated. This StartTimestamp must be within an inclusive range of timestamps for an image to be returned.

    • endTimestamp

      public final Instant endTimestamp()

      The end timestamp for the range of images to be generated. If the time range between StartTimestamp and EndTimestamp is more than 300 seconds above StartTimestamp, you will receive an IllegalArgumentException.

      Returns:
      The end timestamp for the range of images to be generated. If the time range between StartTimestamp and EndTimestamp is more than 300 seconds above StartTimestamp, you will receive an IllegalArgumentException.

    • samplingInterval

      public final Integer samplingInterval()

      The time interval in milliseconds (ms) at which the images need to be generated from the stream. The minimum value that can be provided is 200 ms (5 images per second). If the timestamp range is less than the sampling interval, the image from the startTimestamp will be returned if available.

      Returns:
      The time interval in milliseconds (ms) at which the images need to be generated from the stream. The minimum value that can be provided is 200 ms (5 images per second). If the timestamp range is less than the sampling interval, the image from the startTimestamp will be returned if available.

    • format

      public final Format format()

      The format that will be used to encode the image.

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

      Returns:
      The format that will be used to encode the image.
      See Also:

    • formatAsString

      public final String formatAsString()

      The format that will be used to encode the image.

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

      Returns:
      The format that will be used to encode the image.
      See Also:

    • formatConfig

      public final Map<FormatConfigKey,String> formatConfig()

      The list of a key-value pair structure that contains extra parameters that can be applied when the image is generated. The FormatConfig key is the JPEGQuality, which indicates the JPEG quality key to be used to generate the image. The FormatConfig value accepts ints from 1 to 100. If the value is 1, the image will be generated with less quality and the best compression. If the value is 100, the image will be generated with the best quality and less compression. If no value is provided, the default value of the JPEGQuality key will be set to 80.

      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 hasFormatConfig() method.

      Returns:
      The list of a key-value pair structure that contains extra parameters that can be applied when the image is generated. The FormatConfig key is the JPEGQuality, which indicates the JPEG quality key to be used to generate the image. The FormatConfig value accepts ints from 1 to 100. If the value is 1, the image will be generated with less quality and the best compression. If the value is 100, the image will be generated with the best quality and less compression. If no value is provided, the default value of the JPEGQuality key will be set to 80.

    • hasFormatConfig

      public final boolean hasFormatConfig()
      For responses, this returns true if the service returned a value for the FormatConfig 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.

    • formatConfigAsStrings

      public final Map<String,String> formatConfigAsStrings()

      The list of a key-value pair structure that contains extra parameters that can be applied when the image is generated. The FormatConfig key is the JPEGQuality, which indicates the JPEG quality key to be used to generate the image. The FormatConfig value accepts ints from 1 to 100. If the value is 1, the image will be generated with less quality and the best compression. If the value is 100, the image will be generated with the best quality and less compression. If no value is provided, the default value of the JPEGQuality key will be set to 80.

      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 hasFormatConfig() method.

      Returns:
      The list of a key-value pair structure that contains extra parameters that can be applied when the image is generated. The FormatConfig key is the JPEGQuality, which indicates the JPEG quality key to be used to generate the image. The FormatConfig value accepts ints from 1 to 100. If the value is 1, the image will be generated with less quality and the best compression. If the value is 100, the image will be generated with the best quality and less compression. If no value is provided, the default value of the JPEGQuality key will be set to 80.

    • widthPixels

      public final Integer widthPixels()

      The width of the output image that is used in conjunction with the HeightPixels parameter. When both WidthPixels and HeightPixels parameters are provided, the image will be stretched to fit the specified aspect ratio. If only the WidthPixels parameter is provided or if only the HeightPixels is provided, a ValidationException will be thrown. If neither parameter is provided, the original image size from the stream will be returned.

      Returns:
      The width of the output image that is used in conjunction with the HeightPixels parameter. When both WidthPixels and HeightPixels parameters are provided, the image will be stretched to fit the specified aspect ratio. If only the WidthPixels parameter is provided or if only the HeightPixels is provided, a ValidationException will be thrown. If neither parameter is provided, the original image size from the stream will be returned.

    • heightPixels

      public final Integer heightPixels()

      The height of the output image that is used in conjunction with the WidthPixels parameter. When both HeightPixels and WidthPixels parameters are provided, the image will be stretched to fit the specified aspect ratio. If only the HeightPixels parameter is provided, its original aspect ratio will be used to calculate the WidthPixels ratio. If neither parameter is provided, the original image size will be returned.

      Returns:
      The height of the output image that is used in conjunction with the WidthPixels parameter. When both HeightPixels and WidthPixels parameters are provided, the image will be stretched to fit the specified aspect ratio. If only the HeightPixels parameter is provided, its original aspect ratio will be used to calculate the WidthPixels ratio. If neither parameter is provided, the original image size will be returned.

    • maxResults

      public final Long maxResults()

      The maximum number of images to be returned by the API.

      The default limit is 25 images per API response. Providing a MaxResults greater than this value will result in a page size of 25. Any additional results will be paginated.

      Returns:
      The maximum number of images to be returned by the API.

      The default limit is 25 images per API response. Providing a MaxResults greater than this value will result in a page size of 25. Any additional results will be paginated.

    • nextToken

      public final String nextToken()

      A token that specifies where to start paginating the next set of Images. This is the GetImages:NextToken from a previously truncated response.

      Returns:
      A token that specifies where to start paginating the next set of Images. This is the GetImages:NextToken from a previously truncated response.

    • toBuilder

      public GetImagesRequest.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<GetImagesRequest.Builder,GetImagesRequest>
      Specified by:
      toBuilder in class KinesisVideoArchivedMediaRequest
      Returns:
      a builder for type T

    • builder

      public static GetImagesRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetImagesRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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