com.amazonaws.services.kinesisvideo.model

Class GetImagesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.kinesisvideo.model.GetImagesRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GetImagesRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
GetImagesRequest()

Method Summary

Modifier and Type	Method and Description
GetImagesRequest	addFormatConfigEntry(String key, String value) Add a single FormatConfig entry
GetImagesRequest	clearFormatConfigEntries() Removes all the entries added into FormatConfig.
GetImagesRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
Date	getEndTimestamp() The end timestamp for the range of images to be generated.
String	getFormat() The format that will be used to encode the image.
Map<String,String>	getFormatConfig() The list of a key-value pair structure that contains extra parameters that can be applied when the image is generated.
Integer	getHeightPixels() The height of the output image that is used in conjunction with the WidthPixels parameter.
String	getImageSelectorType() The origin of the Server or Producer timestamps to use to generate the images.
Long	getMaxResults() The maximum number of images to be returned by the API.
String	getNextToken() A token that specifies where to start paginating the next set of Images.
Integer	getSamplingInterval() The time interval in milliseconds (ms) at which the images need to be generated from the stream.
Date	getStartTimestamp() The starting point from which the images should be generated.
String	getStreamARN() The Amazon Resource Name (ARN) of the stream from which to retrieve the images.
String	getStreamName() The name of the stream from which to retrieve the images.
Integer	getWidthPixels() The width of the output image that is used in conjunction with the HeightPixels parameter.
int	hashCode()
void	setEndTimestamp(Date endTimestamp) The end timestamp for the range of images to be generated.
void	setFormat(String format) The format that will be used to encode the image.
void	setFormatConfig(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.
void	setHeightPixels(Integer heightPixels) The height of the output image that is used in conjunction with the WidthPixels parameter.
void	setImageSelectorType(String imageSelectorType) The origin of the Server or Producer timestamps to use to generate the images.
void	setMaxResults(Long maxResults) The maximum number of images to be returned by the API.
void	setNextToken(String nextToken) A token that specifies where to start paginating the next set of Images.
void	setSamplingInterval(Integer samplingInterval) The time interval in milliseconds (ms) at which the images need to be generated from the stream.
void	setStartTimestamp(Date startTimestamp) The starting point from which the images should be generated.
void	setStreamARN(String streamARN) The Amazon Resource Name (ARN) of the stream from which to retrieve the images.
void	setStreamName(String streamName) The name of the stream from which to retrieve the images.
void	setWidthPixels(Integer widthPixels) The width of the output image that is used in conjunction with the HeightPixels parameter.
String	toString() Returns a string representation of this object.
GetImagesRequest	withEndTimestamp(Date endTimestamp) The end timestamp for the range of images to be generated.
GetImagesRequest	withFormat(Format format) The format that will be used to encode the image.
GetImagesRequest	withFormat(String format) The format that will be used to encode the image.
GetImagesRequest	withFormatConfig(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.
GetImagesRequest	withHeightPixels(Integer heightPixels) The height of the output image that is used in conjunction with the WidthPixels parameter.
GetImagesRequest	withImageSelectorType(ImageSelectorType imageSelectorType) The origin of the Server or Producer timestamps to use to generate the images.
GetImagesRequest	withImageSelectorType(String imageSelectorType) The origin of the Server or Producer timestamps to use to generate the images.
GetImagesRequest	withMaxResults(Long maxResults) The maximum number of images to be returned by the API.
GetImagesRequest	withNextToken(String nextToken) A token that specifies where to start paginating the next set of Images.
GetImagesRequest	withSamplingInterval(Integer samplingInterval) The time interval in milliseconds (ms) at which the images need to be generated from the stream.
GetImagesRequest	withStartTimestamp(Date startTimestamp) The starting point from which the images should be generated.
GetImagesRequest	withStreamARN(String streamARN) The Amazon Resource Name (ARN) of the stream from which to retrieve the images.
GetImagesRequest	withStreamName(String streamName) The name of the stream from which to retrieve the images.
GetImagesRequest	withWidthPixels(Integer widthPixels) The width of the output image that is used in conjunction with the HeightPixels parameter.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GetImagesRequest

public GetImagesRequest()

Method Detail

setStreamName

public void setStreamName(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.

getStreamName

public String getStreamName()

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.

withStreamName

public GetImagesRequest withStreamName(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.

setStreamARN

public void setStreamARN(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.

getStreamARN

public String getStreamARN()

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.

withStreamARN

public GetImagesRequest withStreamARN(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.

setImageSelectorType

public void setImageSelectorType(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.

See Also:

ImageSelectorType

getImageSelectorType

public String getImageSelectorType()

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

Returns:

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

See Also:

ImageSelectorType

withImageSelectorType

public GetImagesRequest withImageSelectorType(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

withImageSelectorType

public GetImagesRequest withImageSelectorType(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:

ImageSelectorType

setStartTimestamp

public void setStartTimestamp(Date 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.

getStartTimestamp

public Date getStartTimestamp()

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.

withStartTimestamp

public GetImagesRequest withStartTimestamp(Date 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.

setEndTimestamp

public void setEndTimestamp(Date 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.

getEndTimestamp

public Date getEndTimestamp()

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.

withEndTimestamp

public GetImagesRequest withEndTimestamp(Date 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.

setSamplingInterval

public void setSamplingInterval(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.

Parameters:

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.

getSamplingInterval

public Integer getSamplingInterval()

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.

withSamplingInterval

public GetImagesRequest withSamplingInterval(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.

Parameters:

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:

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

setFormat

public void setFormat(String format)

The format that will be used to encode the image.

Parameters:

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

See Also:

Format

getFormat

public String getFormat()

The format that will be used to encode the image.

Returns:

The format that will be used to encode the image.

See Also:

Format

withFormat

public GetImagesRequest withFormat(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

withFormat

public GetImagesRequest withFormat(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:

Format

getFormatConfig

public Map<String,String> getFormatConfig()

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:

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.

setFormatConfig

public void setFormatConfig(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.

withFormatConfig

public GetImagesRequest withFormatConfig(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.

addFormatConfigEntry

public GetImagesRequest addFormatConfigEntry(String key,
                                             String value)

Add a single FormatConfig entry

See Also:

withFormatConfig(java.util.Map<java.lang.String, java.lang.String>)

clearFormatConfigEntries

public GetImagesRequest clearFormatConfigEntries()

Removes all the entries added into FormatConfig.

Returns:

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

setWidthPixels

public void setWidthPixels(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.

getWidthPixels

public Integer getWidthPixels()

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.

withWidthPixels

public GetImagesRequest withWidthPixels(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.

setHeightPixels

public void setHeightPixels(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.

getHeightPixels

public Integer getHeightPixels()

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.

withHeightPixels

public GetImagesRequest withHeightPixels(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.

setMaxResults

public void setMaxResults(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.

getMaxResults

public Long getMaxResults()

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.

withMaxResults

public GetImagesRequest withMaxResults(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.

setNextToken

public void setNextToken(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.

getNextToken

public String getNextToken()

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.

withNextToken

public GetImagesRequest withNextToken(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.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public GetImagesRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()