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

Interface GetImagesRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<GetImagesRequest.Builder,GetImagesRequest>, KinesisVideoArchivedMediaRequest.Builder, SdkBuilder<GetImagesRequest.Builder,GetImagesRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
GetImagesRequest
public static interface GetImagesRequest.Builder extends KinesisVideoArchivedMediaRequest.Builder, SdkPojo, CopyableBuilder<GetImagesRequest.Builder,GetImagesRequest>

  • Method Details

    • streamName

      GetImagesRequest.Builder streamName(String streamName)

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

      Parameters:
      streamName - The name of the stream from which to retrieve the images. You must specify either the StreamName or the StreamARN.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • streamARN

      GetImagesRequest.Builder streamARN(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • imageSelectorType

      GetImagesRequest.Builder imageSelectorType(String imageSelectorType)

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

      Parameters:
      imageSelectorType - The origin of the Server or Producer timestamps to use to generate the images.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • imageSelectorType

      GetImagesRequest.Builder imageSelectorType(ImageSelectorType imageSelectorType)

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

      Parameters:
      imageSelectorType - The origin of the Server or Producer timestamps to use to generate the images.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • startTimestamp

      GetImagesRequest.Builder startTimestamp(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • endTimestamp

      GetImagesRequest.Builder endTimestamp(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • samplingInterval

      GetImagesRequest.Builder samplingInterval(Integer samplingInterval)

      The time interval in milliseconds (ms) at which the images need to be generated from the stream, with a default of 3000 ms. The minimum value that can be provided is 200 ms. If the timestamp range is less than the sampling interval, the Image from the startTimestamp will be returned if available.

      The minimum value of 200 ms is a hard limit.

      Parameters:
      samplingInterval - The time interval in milliseconds (ms) at which the images need to be generated from the stream, with a default of 3000 ms. The minimum value that can be provided is 200 ms. If the timestamp range is less than the sampling interval, the Image from the startTimestamp will be returned if available.

      The minimum value of 200 ms is a hard limit.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • format

      GetImagesRequest.Builder format(String format)

      The format that will be used to encode the image.

      Parameters:
      format - The format that will be used to encode the image.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • format

      GetImagesRequest.Builder format(Format format)

      The format that will be used to encode the image.

      Parameters:
      format - The format that will be used to encode the image.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • formatConfigWithStrings

      GetImagesRequest.Builder formatConfigWithStrings(Map<String,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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • formatConfig

      GetImagesRequest.Builder formatConfig(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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • widthPixels

      GetImagesRequest.Builder widthPixels(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • heightPixels

      GetImagesRequest.Builder heightPixels(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • maxResults

      GetImagesRequest.Builder maxResults(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • nextToken

      GetImagesRequest.Builder nextToken(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      GetImagesRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      GetImagesRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.