software.amazon.awssdk.services.rekognition.model

Interface GetPersonTrackingResponse.Builder

All Superinterfaces:

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

Enclosing class:

GetPersonTrackingResponse

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

Method Summary

Modifier and Type	Method and Description
GetPersonTrackingResponse.Builder	jobId(String jobId) Job identifier for the person tracking operation for which you want to obtain results.
GetPersonTrackingResponse.Builder	jobStatus(String jobStatus) The current status of the person tracking job.
GetPersonTrackingResponse.Builder	jobStatus(VideoJobStatus jobStatus) The current status of the person tracking job.
GetPersonTrackingResponse.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.
GetPersonTrackingResponse.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 persons.
GetPersonTrackingResponse.Builder	persons(Collection<PersonDetection> persons) An array of the persons detected in the video and the time(s) their path was tracked throughout the video.
GetPersonTrackingResponse.Builder	persons(Consumer<PersonDetection.Builder>... persons) An array of the persons detected in the video and the time(s) their path was tracked throughout the video.
GetPersonTrackingResponse.Builder	persons(PersonDetection... persons) An array of the persons detected in the video and the time(s) their path was tracked throughout the video.
GetPersonTrackingResponse.Builder	statusMessage(String statusMessage) If the job fails, StatusMessage provides a descriptive error message.
default GetPersonTrackingResponse.Builder	video(Consumer<Video.Builder> video) Sets the value of the Video property for this object.
GetPersonTrackingResponse.Builder	video(Video video) Sets the value of the Video property for this object.
default GetPersonTrackingResponse.Builder	videoMetadata(Consumer<VideoMetadata.Builder> videoMetadata) Information about a video that Amazon Rekognition Video analyzed.
GetPersonTrackingResponse.Builder	videoMetadata(VideoMetadata videoMetadata) Information about a video that Amazon Rekognition Video analyzed.

Methods inherited from interface software.amazon.awssdk.services.rekognition.model.RekognitionResponse.Builder

build, responseMetadata, responseMetadata

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

sdkHttpResponse, sdkHttpResponse

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

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

jobStatus

GetPersonTrackingResponse.Builder jobStatus(String jobStatus)

The current status of the person tracking job.

Parameters:

jobStatus - The current status of the person tracking job.

Returns:

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

See Also:

VideoJobStatus, VideoJobStatus

jobStatus

GetPersonTrackingResponse.Builder jobStatus(VideoJobStatus jobStatus)

The current status of the person tracking job.

Parameters:

jobStatus - The current status of the person tracking job.

Returns:

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

See Also:

VideoJobStatus, VideoJobStatus

statusMessage

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

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

GetPersonTrackingResponse.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 persons.

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

Returns:

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

persons

GetPersonTrackingResponse.Builder persons(Collection<PersonDetection> persons)

An array of the persons detected in the video and the time(s) their path was tracked throughout the video. An array element will exist for each time a person's path is tracked.

Parameters:

persons - An array of the persons detected in the video and the time(s) their path was tracked throughout the video. An array element will exist for each time a person's path is tracked.

Returns:

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

persons

GetPersonTrackingResponse.Builder persons(PersonDetection... persons)

An array of the persons detected in the video and the time(s) their path was tracked throughout the video. An array element will exist for each time a person's path is tracked.

Parameters:

persons - An array of the persons detected in the video and the time(s) their path was tracked throughout the video. An array element will exist for each time a person's path is tracked.

Returns:

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

persons

GetPersonTrackingResponse.Builder persons(Consumer<PersonDetection.Builder>... persons)

An array of the persons detected in the video and the time(s) their path was tracked throughout the video. An array element will exist for each time a person's path is tracked.

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

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

Parameters:

persons - a consumer that will call methods on PersonDetection.Builder

Returns:

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

See Also:

#persons(java.util.Collection)

jobId

GetPersonTrackingResponse.Builder jobId(String jobId)

Job identifier for the person tracking operation for which you want to obtain results. The job identifer is returned by an initial call to StartPersonTracking.

Parameters:

jobId - Job identifier for the person tracking operation for which you want to obtain results. The job identifer is returned by an initial call to StartPersonTracking.

Returns:

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

video

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

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