/* * Copyright 2010-2022 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). * You may not use this file except in compliance with the License. * A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either * express or implied. See the License for the specific language governing * permissions and limitations under the License. */ package com.amazonaws.services.kinesisvideoarchivedmedia.model; import java.io.Serializable; import com.amazonaws.AmazonWebServiceRequest; /** *

* Retrieves a list of Images corresponding to each timestamp for a given time * range, sampling interval, and image format configuration. *

*/ public class GetImagesRequest extends AmazonWebServiceRequest implements Serializable { /** *

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

*

* Constraints:
* Length: 1 - 256
* Pattern: [a-zA-Z0-9_.-]+
*/ private String streamName; /** *

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

*

* Constraints:
* Length: 1 - 1024
* Pattern: * arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA- * Z0-9_.-]+/[0-9]+
*/ private String streamARN; /** *

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

*

* Constraints:
* Allowed Values: PRODUCER_TIMESTAMP, SERVER_TIMESTAMP */ private String imageSelectorType; /** *

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

*/ private java.util.Date startTimestamp; /** *

* The end timestamp for the range of images to be generated. *

*/ private java.util.Date endTimestamp; /** *

* 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 3000 * 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 3000 ms is a soft limit. If needed, a lower sampling * frequency can be requested. *

* *

* Constraints:
* Range: 3000 - 20000
*/ private Integer samplingInterval; /** *

* The format that will be used to encode the image. *

*

* Constraints:
* Allowed Values: JPEG, PNG */ private String format; /** *

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

*/ private java.util.Map formatConfig = new java.util.HashMap(); /** *

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

*

* Constraints:
* Range: 1 - 3840
*/ private Integer widthPixels; /** *

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

*

* Constraints:
* Range: 1 - 2160
*/ private Integer heightPixels; /** *

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

* *

* The default limit is 100 images per API response. The additional results * will be paginated. *

* *

* Constraints:
* Range: 1 - 100
*/ private Long maxResults; /** *

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

*

* Constraints:
* Length: 1 - 4096
* Pattern: [a-zA-Z0-9+/]+={0,2}
*/ private String nextToken; /** *

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

*

* Constraints:
* Length: 1 - 256
* Pattern: [a-zA-Z0-9_.-]+
* * @return

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

*/ public String getStreamName() { return streamName; } /** *

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

*

* Constraints:
* Length: 1 - 256
* Pattern: [a-zA-Z0-9_.-]+
* * @param streamName

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

*/ public void setStreamName(String streamName) { this.streamName = streamName; } /** *

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

*

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

* Constraints:
* Length: 1 - 256
* Pattern: [a-zA-Z0-9_.-]+
* * @param streamName

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

* @return A reference to this updated object so that method calls can be * chained together. */ public GetImagesRequest withStreamName(String streamName) { this.streamName = streamName; return this; } /** *

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

*

* Constraints:
* Length: 1 - 1024
* Pattern: * arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA- * Z0-9_.-]+/[0-9]+
* * @return

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

*/ public String getStreamARN() { return streamARN; } /** *

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

*

* Constraints:
* Length: 1 - 1024
* Pattern: * arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA- * Z0-9_.-]+/[0-9]+
* * @param streamARN

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

*/ public void setStreamARN(String streamARN) { this.streamARN = 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 a reference to this object so that method calls can be chained * together. *

* Constraints:
* Length: 1 - 1024
* Pattern: * arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA- * Z0-9_.-]+/[0-9]+
* * @param streamARN

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

* @return A reference to this updated object so that method calls can be * chained together. */ public GetImagesRequest withStreamARN(String streamARN) { this.streamARN = streamARN; return this; } /** *

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

*

* Constraints:
* Allowed Values: PRODUCER_TIMESTAMP, SERVER_TIMESTAMP * * @return

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

* @see ImageSelectorType */ public String getImageSelectorType() { return imageSelectorType; } /** *

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

*

* Constraints:
* Allowed Values: PRODUCER_TIMESTAMP, SERVER_TIMESTAMP * * @param imageSelectorType

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

* @see ImageSelectorType */ public void setImageSelectorType(String imageSelectorType) { this.imageSelectorType = imageSelectorType; } /** *

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

*

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

* Constraints:
* Allowed Values: PRODUCER_TIMESTAMP, SERVER_TIMESTAMP * * @param imageSelectorType

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

* @return A reference to this updated object so that method calls can be * chained together. * @see ImageSelectorType */ public GetImagesRequest withImageSelectorType(String imageSelectorType) { this.imageSelectorType = imageSelectorType; return this; } /** *

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

*

* Constraints:
* Allowed Values: PRODUCER_TIMESTAMP, SERVER_TIMESTAMP * * @param imageSelectorType

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

* @see ImageSelectorType */ public void setImageSelectorType(ImageSelectorType imageSelectorType) { this.imageSelectorType = imageSelectorType.toString(); } /** *

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

*

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

* Constraints:
* Allowed Values: PRODUCER_TIMESTAMP, SERVER_TIMESTAMP * * @param imageSelectorType

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

* @return A reference to this updated object so that method calls can be * chained together. * @see ImageSelectorType */ public GetImagesRequest withImageSelectorType(ImageSelectorType imageSelectorType) { this.imageSelectorType = imageSelectorType.toString(); return this; } /** *

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

* * @return

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

*/ public java.util.Date getStartTimestamp() { return 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. *

* * @param 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. *

*/ public void setStartTimestamp(java.util.Date startTimestamp) { this.startTimestamp = 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 a reference to this object so that method calls can be chained * together. * * @param 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. *

* @return A reference to this updated object so that method calls can be * chained together. */ public GetImagesRequest withStartTimestamp(java.util.Date startTimestamp) { this.startTimestamp = startTimestamp; return this; } /** *

* The end timestamp for the range of images to be generated. *

* * @return

* The end timestamp for the range of images to be generated. *

*/ public java.util.Date getEndTimestamp() { return endTimestamp; } /** *

* The end timestamp for the range of images to be generated. *

* * @param endTimestamp

* The end timestamp for the range of images to be generated. *

*/ public void setEndTimestamp(java.util.Date endTimestamp) { this.endTimestamp = endTimestamp; } /** *

* The end timestamp for the range of images to be generated. *

*

* Returns a reference to this object so that method calls can be chained * together. * * @param endTimestamp

* The end timestamp for the range of images to be generated. *

* @return A reference to this updated object so that method calls can be * chained together. */ public GetImagesRequest withEndTimestamp(java.util.Date endTimestamp) { this.endTimestamp = endTimestamp; return this; } /** *

* 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 3000 * 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 3000 ms is a soft limit. If needed, a lower sampling * frequency can be requested. *

* *

* Constraints:
* Range: 3000 - 20000
* * @return

* 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 3000 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 3000 ms is a soft limit. If needed, a lower * sampling frequency can be requested. *

* */ public Integer getSamplingInterval() { return 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 3000 * 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 3000 ms is a soft limit. If needed, a lower sampling * frequency can be requested. *

* *

* Constraints:
* Range: 3000 - 20000
* * @param 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 3000 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 3000 ms is a soft limit. If needed, a * lower sampling frequency can be requested. *

* */ public void setSamplingInterval(Integer samplingInterval) { this.samplingInterval = 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 3000 * 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 3000 ms is a soft limit. If needed, a lower sampling * frequency can be requested. *

* *

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

* Constraints:
* Range: 3000 - 20000
* * @param 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 3000 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 3000 ms is a soft limit. If needed, a * lower sampling frequency can be requested. *

* * @return A reference to this updated object so that method calls can be * chained together. */ public GetImagesRequest withSamplingInterval(Integer samplingInterval) { this.samplingInterval = samplingInterval; return this; } /** *

* The format that will be used to encode the image. *

*

* Constraints:
* Allowed Values: JPEG, PNG * * @return

* The format that will be used to encode the image. *

* @see Format */ public String getFormat() { return format; } /** *

* The format that will be used to encode the image. *

*

* Constraints:
* Allowed Values: JPEG, PNG * * @param format

* The format that will be used to encode the image. *

* @see Format */ public void setFormat(String format) { this.format = format; } /** *

* The format that will be used to encode the image. *

*

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

* Constraints:
* Allowed Values: JPEG, PNG * * @param format

* The format that will be used to encode the image. *

* @return A reference to this updated object so that method calls can be * chained together. * @see Format */ public GetImagesRequest withFormat(String format) { this.format = format; return this; } /** *

* The format that will be used to encode the image. *

*

* Constraints:
* Allowed Values: JPEG, PNG * * @param format

* The format that will be used to encode the image. *

* @see Format */ public void setFormat(Format format) { this.format = format.toString(); } /** *

* The format that will be used to encode the image. *

*

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

* Constraints:
* Allowed Values: JPEG, PNG * * @param format

* The format that will be used to encode the image. *

* @return A reference to this updated object so that method calls can be * chained together. * @see Format */ public GetImagesRequest withFormat(Format format) { this.format = format.toString(); return this; } /** *

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

* * @return

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

*/ public java.util.Map getFormatConfig() { return 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. *

* * @param 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. *

*/ public void setFormatConfig(java.util.Map formatConfig) { this.formatConfig = 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 a reference to this object so that method calls can be chained * together. * * @param 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. *

* @return A reference to this updated object so that method calls can be * chained together. */ public GetImagesRequest withFormatConfig(java.util.Map formatConfig) { this.formatConfig = formatConfig; return this; } /** *

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

*

* The method adds a new key-value pair into FormatConfig parameter, and * returns a reference to this object so that method calls can be chained * together. * * @param key The key of the entry to be added into FormatConfig. * @param value The corresponding value of the entry to be added into * FormatConfig. * @return A reference to this updated object so that method calls can be * chained together. */ public GetImagesRequest addFormatConfigEntry(String key, String value) { if (null == this.formatConfig) { this.formatConfig = new java.util.HashMap(); } if (this.formatConfig.containsKey(key)) throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided."); this.formatConfig.put(key, value); return this; } /** * Removes all the entries added into FormatConfig. *

* Returns a reference to this object so that method calls can be chained * together. */ public GetImagesRequest clearFormatConfigEntries() { this.formatConfig = null; return this; } /** *

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

*

* Constraints:
* Range: 1 - 3840
* * @return

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

*/ public Integer getWidthPixels() { return 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. *

*

* Constraints:
* Range: 1 - 3840
* * @param 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. *

*/ public void setWidthPixels(Integer widthPixels) { this.widthPixels = 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 a reference to this object so that method calls can be chained * together. *

* Constraints:
* Range: 1 - 3840
* * @param 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. *

* @return A reference to this updated object so that method calls can be * chained together. */ public GetImagesRequest withWidthPixels(Integer widthPixels) { this.widthPixels = widthPixels; return this; } /** *

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

*

* Constraints:
* Range: 1 - 2160
* * @return

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

*/ public Integer getHeightPixels() { return 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. *

*

* Constraints:
* Range: 1 - 2160
* * @param 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. *

*/ public void setHeightPixels(Integer heightPixels) { this.heightPixels = 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 a reference to this object so that method calls can be chained * together. *

* Constraints:
* Range: 1 - 2160
* * @param 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. *

* @return A reference to this updated object so that method calls can be * chained together. */ public GetImagesRequest withHeightPixels(Integer heightPixels) { this.heightPixels = heightPixels; return this; } /** *

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

* *

* The default limit is 100 images per API response. The additional results * will be paginated. *

* *

* Constraints:
* Range: 1 - 100
* * @return

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

* *

* The default limit is 100 images per API response. The additional * results will be paginated. *

* */ public Long getMaxResults() { return maxResults; } /** *

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

* *

* The default limit is 100 images per API response. The additional results * will be paginated. *

* *

* Constraints:
* Range: 1 - 100
* * @param maxResults

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

* *

* The default limit is 100 images per API response. The * additional results will be paginated. *

* */ public void setMaxResults(Long maxResults) { this.maxResults = maxResults; } /** *

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

* *

* The default limit is 100 images per API response. The additional results * will be paginated. *

* *

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

* Constraints:
* Range: 1 - 100
* * @param maxResults

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

* *

* The default limit is 100 images per API response. The * additional results will be paginated. *

* * @return A reference to this updated object so that method calls can be * chained together. */ public GetImagesRequest withMaxResults(Long maxResults) { this.maxResults = maxResults; return this; } /** *

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

*

* Constraints:
* Length: 1 - 4096
* Pattern: [a-zA-Z0-9+/]+={0,2}
* * @return

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

*/ public String getNextToken() { return nextToken; } /** *

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

*

* Constraints:
* Length: 1 - 4096
* Pattern: [a-zA-Z0-9+/]+={0,2}
* * @param nextToken

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

*/ public void setNextToken(String nextToken) { this.nextToken = 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 reference to this object so that method calls can be chained * together. *

* Constraints:
* Length: 1 - 4096
* Pattern: [a-zA-Z0-9+/]+={0,2}
* * @param nextToken

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

* @return A reference to this updated object so that method calls can be * chained together. */ public GetImagesRequest withNextToken(String nextToken) { this.nextToken = nextToken; return this; } /** * Returns a string representation of this object; useful for testing and * debugging. * * @return A string representation of this object. * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getStreamName() != null) sb.append("StreamName: " + getStreamName() + ","); if (getStreamARN() != null) sb.append("StreamARN: " + getStreamARN() + ","); if (getImageSelectorType() != null) sb.append("ImageSelectorType: " + getImageSelectorType() + ","); if (getStartTimestamp() != null) sb.append("StartTimestamp: " + getStartTimestamp() + ","); if (getEndTimestamp() != null) sb.append("EndTimestamp: " + getEndTimestamp() + ","); if (getSamplingInterval() != null) sb.append("SamplingInterval: " + getSamplingInterval() + ","); if (getFormat() != null) sb.append("Format: " + getFormat() + ","); if (getFormatConfig() != null) sb.append("FormatConfig: " + getFormatConfig() + ","); if (getWidthPixels() != null) sb.append("WidthPixels: " + getWidthPixels() + ","); if (getHeightPixels() != null) sb.append("HeightPixels: " + getHeightPixels() + ","); if (getMaxResults() != null) sb.append("MaxResults: " + getMaxResults() + ","); if (getNextToken() != null) sb.append("NextToken: " + getNextToken()); sb.append("}"); return sb.toString(); } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getStreamName() == null) ? 0 : getStreamName().hashCode()); hashCode = prime * hashCode + ((getStreamARN() == null) ? 0 : getStreamARN().hashCode()); hashCode = prime * hashCode + ((getImageSelectorType() == null) ? 0 : getImageSelectorType().hashCode()); hashCode = prime * hashCode + ((getStartTimestamp() == null) ? 0 : getStartTimestamp().hashCode()); hashCode = prime * hashCode + ((getEndTimestamp() == null) ? 0 : getEndTimestamp().hashCode()); hashCode = prime * hashCode + ((getSamplingInterval() == null) ? 0 : getSamplingInterval().hashCode()); hashCode = prime * hashCode + ((getFormat() == null) ? 0 : getFormat().hashCode()); hashCode = prime * hashCode + ((getFormatConfig() == null) ? 0 : getFormatConfig().hashCode()); hashCode = prime * hashCode + ((getWidthPixels() == null) ? 0 : getWidthPixels().hashCode()); hashCode = prime * hashCode + ((getHeightPixels() == null) ? 0 : getHeightPixels().hashCode()); hashCode = prime * hashCode + ((getMaxResults() == null) ? 0 : getMaxResults().hashCode()); hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode()); return hashCode; } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof GetImagesRequest == false) return false; GetImagesRequest other = (GetImagesRequest) obj; if (other.getStreamName() == null ^ this.getStreamName() == null) return false; if (other.getStreamName() != null && other.getStreamName().equals(this.getStreamName()) == false) return false; if (other.getStreamARN() == null ^ this.getStreamARN() == null) return false; if (other.getStreamARN() != null && other.getStreamARN().equals(this.getStreamARN()) == false) return false; if (other.getImageSelectorType() == null ^ this.getImageSelectorType() == null) return false; if (other.getImageSelectorType() != null && other.getImageSelectorType().equals(this.getImageSelectorType()) == false) return false; if (other.getStartTimestamp() == null ^ this.getStartTimestamp() == null) return false; if (other.getStartTimestamp() != null && other.getStartTimestamp().equals(this.getStartTimestamp()) == false) return false; if (other.getEndTimestamp() == null ^ this.getEndTimestamp() == null) return false; if (other.getEndTimestamp() != null && other.getEndTimestamp().equals(this.getEndTimestamp()) == false) return false; if (other.getSamplingInterval() == null ^ this.getSamplingInterval() == null) return false; if (other.getSamplingInterval() != null && other.getSamplingInterval().equals(this.getSamplingInterval()) == false) return false; if (other.getFormat() == null ^ this.getFormat() == null) return false; if (other.getFormat() != null && other.getFormat().equals(this.getFormat()) == false) return false; if (other.getFormatConfig() == null ^ this.getFormatConfig() == null) return false; if (other.getFormatConfig() != null && other.getFormatConfig().equals(this.getFormatConfig()) == false) return false; if (other.getWidthPixels() == null ^ this.getWidthPixels() == null) return false; if (other.getWidthPixels() != null && other.getWidthPixels().equals(this.getWidthPixels()) == false) return false; if (other.getHeightPixels() == null ^ this.getHeightPixels() == null) return false; if (other.getHeightPixels() != null && other.getHeightPixels().equals(this.getHeightPixels()) == false) return false; if (other.getMaxResults() == null ^ this.getMaxResults() == null) return false; if (other.getMaxResults() != null && other.getMaxResults().equals(this.getMaxResults()) == false) return false; if (other.getNextToken() == null ^ this.getNextToken() == null) return false; if (other.getNextToken() != null && other.getNextToken().equals(this.getNextToken()) == false) return false; return true; } }