Package software.amazon.awssdk.services.rekognition.model

Interface GetCelebrityRecognitionResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<GetCelebrityRecognitionResponse.Builder,GetCelebrityRecognitionResponse>, RekognitionResponse.Builder, SdkBuilder<GetCelebrityRecognitionResponse.Builder,GetCelebrityRecognitionResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

GetCelebrityRecognitionResponse

public static interface GetCelebrityRecognitionResponse.Builder
extends RekognitionResponse.Builder, SdkPojo, CopyableBuilder<GetCelebrityRecognitionResponse.Builder,GetCelebrityRecognitionResponse>

Method Summary

Modifier and Type	Method	Description
GetCelebrityRecognitionResponse.Builder	celebrities(Collection<CelebrityRecognition> celebrities)	Array of celebrities recognized in the video.
GetCelebrityRecognitionResponse.Builder	celebrities(Consumer<CelebrityRecognition.Builder>... celebrities)	Array of celebrities recognized in the video.
GetCelebrityRecognitionResponse.Builder	celebrities(CelebrityRecognition... celebrities)	Array of celebrities recognized in the video.
GetCelebrityRecognitionResponse.Builder	jobId(String jobId)	Job identifier for the celebrity recognition operation for which you want to obtain results.
GetCelebrityRecognitionResponse.Builder	jobStatus(String jobStatus)	The current status of the celebrity recognition job.
GetCelebrityRecognitionResponse.Builder	jobStatus(VideoJobStatus jobStatus)	The current status of the celebrity recognition job.
GetCelebrityRecognitionResponse.Builder	jobTag(String jobTag)	A job identifier specified in the call to StartCelebrityRecognition and returned in the job completion notification sent to your Amazon Simple Notification Service topic.
GetCelebrityRecognitionResponse.Builder	nextToken(String nextToken)	If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of celebrities.
GetCelebrityRecognitionResponse.Builder	statusMessage(String statusMessage)	If the job fails, StatusMessage provides a descriptive error message.
default GetCelebrityRecognitionResponse.Builder	video(Consumer<Video.Builder> video)	Sets the value of the Video property for this object.
GetCelebrityRecognitionResponse.Builder	video(Video video)	Sets the value of the Video property for this object.
default GetCelebrityRecognitionResponse.Builder	videoMetadata(Consumer<VideoMetadata.Builder> videoMetadata)	Information about a video that Amazon Rekognition Video analyzed.
GetCelebrityRecognitionResponse.Builder	videoMetadata(VideoMetadata videoMetadata)	Information about a video that Amazon Rekognition Video analyzed.

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

copy

Methods inherited from interface software.amazon.awssdk.services.rekognition.model.RekognitionResponse.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 Detail

jobStatus

GetCelebrityRecognitionResponse.Builder jobStatus(String jobStatus)

The current status of the celebrity recognition job.

Parameters:

jobStatus - The current status of the celebrity recognition job.

Returns:

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

See Also:

VideoJobStatus, VideoJobStatus

jobStatus

GetCelebrityRecognitionResponse.Builder jobStatus(VideoJobStatus jobStatus)

The current status of the celebrity recognition job.

Parameters:

jobStatus - The current status of the celebrity recognition job.

Returns:

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

See Also:

VideoJobStatus, VideoJobStatus

statusMessage

GetCelebrityRecognitionResponse.Builder statusMessage(String statusMessage)

If the job fails, StatusMessage provides a descriptive error message.

Parameters:

statusMessage - If the job fails, StatusMessage provides a descriptive error message.

Returns:

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

videoMetadata

GetCelebrityRecognitionResponse.Builder videoMetadata(VideoMetadata videoMetadata)

Information about a video that Amazon Rekognition Video analyzed. Videometadata is returned in every page of paginated responses from a Amazon Rekognition Video operation.

Parameters:

videoMetadata - Information about a video that Amazon Rekognition Video analyzed. Videometadata is returned in every page of paginated responses from a Amazon Rekognition Video operation.

Returns:

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

videoMetadata

default GetCelebrityRecognitionResponse.Builder videoMetadata(Consumer<VideoMetadata.Builder> videoMetadata)

Information about a video that Amazon Rekognition Video analyzed. Videometadata is returned in every page of paginated responses from a Amazon Rekognition Video operation.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to videoMetadata(VideoMetadata).

Parameters:

videoMetadata - a consumer that will call methods on VideoMetadata.Builder

Returns:

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

See Also:

videoMetadata(VideoMetadata)

nextToken

GetCelebrityRecognitionResponse.Builder nextToken(String nextToken)

If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of celebrities.

Parameters:

nextToken - If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of celebrities.

Returns:

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

celebrities

GetCelebrityRecognitionResponse.Builder celebrities(Collection<CelebrityRecognition> celebrities)

Array of celebrities recognized in the video.

Parameters:

celebrities - Array of celebrities recognized in the video.

Returns:

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

celebrities

GetCelebrityRecognitionResponse.Builder celebrities(CelebrityRecognition... celebrities)

Array of celebrities recognized in the video.

Parameters:

celebrities - Array of celebrities recognized in the video.

Returns:

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

celebrities

GetCelebrityRecognitionResponse.Builder celebrities(Consumer<CelebrityRecognition.Builder>... celebrities)

Array of celebrities recognized in the video.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #celebrities(List).

Parameters:

celebrities - a consumer that will call methods on CelebrityRecognition.Builder

Returns:

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

See Also:

#celebrities(java.util.Collection)

jobId

GetCelebrityRecognitionResponse.Builder jobId(String jobId)

Job identifier for the celebrity recognition operation for which you want to obtain results. The job identifer is returned by an initial call to StartCelebrityRecognition.

Parameters:

jobId - Job identifier for the celebrity recognition operation for which you want to obtain results. The job identifer is returned by an initial call to StartCelebrityRecognition.

Returns:

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

video

GetCelebrityRecognitionResponse.Builder video(Video video)

Sets the value of the Video property for this object.

Parameters:

video - The new value for the Video property for this object.

Returns:

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

video

default GetCelebrityRecognitionResponse.Builder video(Consumer<Video.Builder> video)

Sets the value of the Video property for this object. This is a convenience method that creates an instance of the Video.Builder avoiding the need to create one manually via Video.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to video(Video).

Parameters:

video - a consumer that will call methods on Video.Builder

Returns:

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

See Also:

video(Video)

jobTag

GetCelebrityRecognitionResponse.Builder jobTag(String jobTag)

A job identifier specified in the call to StartCelebrityRecognition and returned in the job completion notification sent to your Amazon Simple Notification Service topic.

Parameters:

jobTag - A job identifier specified in the call to StartCelebrityRecognition and returned in the job completion notification sent to your Amazon Simple Notification Service topic.

Returns:

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