Interface GetImagesResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<GetImagesResponse.Builder,GetImagesResponse>, KinesisVideoArchivedMediaResponse.Builder, SdkBuilder<GetImagesResponse.Builder,GetImagesResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

GetImagesResponse

@Mutable
@NotThreadSafe
public static interface GetImagesResponse.Builder
extends KinesisVideoArchivedMediaResponse.Builder, SdkPojo, CopyableBuilder<GetImagesResponse.Builder,GetImagesResponse>

Method Summary

Modifier and Type	Method	Description
GetImagesResponse.Builder	images(Collection<Image> images)	The list of images generated from the video stream.
GetImagesResponse.Builder	images(Consumer<Image.Builder>... images)	The list of images generated from the video stream.
GetImagesResponse.Builder	images(Image... images)	The list of images generated from the video stream.
GetImagesResponse.Builder	nextToken(String nextToken)	The encrypted token that was used in the request to get more images.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.services.kinesisvideoarchivedmedia.model.KinesisVideoArchivedMediaResponse.Builder

build, responseMetadata, responseMetadata

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Method Details

images

GetImagesResponse.Builder images(Collection<Image> images)

The list of images generated from the video stream. If there is no media available for the given timestamp, the NO_MEDIA error will be listed in the output. If an error occurs while the image is being generated, the MEDIA_ERROR will be listed in the output as the cause of the missing image.

Parameters:

images - The list of images generated from the video stream. If there is no media available for the given timestamp, the NO_MEDIA error will be listed in the output. If an error occurs while the image is being generated, the MEDIA_ERROR will be listed in the output as the cause of the missing image.

Returns:

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

images

GetImagesResponse.Builder images(Image... images)

The list of images generated from the video stream. If there is no media available for the given timestamp, the NO_MEDIA error will be listed in the output. If an error occurs while the image is being generated, the MEDIA_ERROR will be listed in the output as the cause of the missing image.

Parameters:

images - The list of images generated from the video stream. If there is no media available for the given timestamp, the NO_MEDIA error will be listed in the output. If an error occurs while the image is being generated, the MEDIA_ERROR will be listed in the output as the cause of the missing image.

Returns:

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

images

GetImagesResponse.Builder images(Consumer<Image.Builder>... images)

The list of images generated from the video stream. If there is no media available for the given timestamp, the NO_MEDIA error will be listed in the output. If an error occurs while the image is being generated, the MEDIA_ERROR will be listed in the output as the cause of the missing image.

This is a convenience method that creates an instance of the Image.Builder avoiding the need to create one manually via Image.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to images(List<Image>).

Parameters:

images - a consumer that will call methods on Image.Builder

Returns:

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

See Also:

• images(java.util.Collection<Image>)

nextToken

GetImagesResponse.Builder nextToken(String nextToken)

The encrypted token that was used in the request to get more images.

Parameters:

nextToken - The encrypted token that was used in the request to get more images.

Returns:

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