software.amazon.awssdk.services.rekognition.model

Interface GetPersonTrackingRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<GetPersonTrackingRequest.Builder,GetPersonTrackingRequest>, RekognitionRequest.Builder, SdkBuilder<GetPersonTrackingRequest.Builder,GetPersonTrackingRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

GetPersonTrackingRequest

public static interface GetPersonTrackingRequest.Builder
extends RekognitionRequest.Builder, SdkPojo, CopyableBuilder<GetPersonTrackingRequest.Builder,GetPersonTrackingRequest>

Method Summary

Modifier and Type	Method and Description
GetPersonTrackingRequest.Builder	jobId(String jobId) The identifier for a job that tracks persons in a video.
GetPersonTrackingRequest.Builder	maxResults(Integer maxResults) Maximum number of results to return per paginated call.
GetPersonTrackingRequest.Builder	nextToken(String nextToken) If the previous response was incomplete (because there are more persons to retrieve), Amazon Rekognition Video returns a pagination token in the response.
GetPersonTrackingRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
GetPersonTrackingRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
GetPersonTrackingRequest.Builder	sortBy(PersonTrackingSortBy sortBy) Sort to use for elements in the Persons array.
GetPersonTrackingRequest.Builder	sortBy(String sortBy) Sort to use for elements in the Persons array.

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

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

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

jobId

GetPersonTrackingRequest.Builder jobId(String jobId)

The identifier for a job that tracks persons in a video. You get the JobId from a call to StartPersonTracking.

Parameters:

jobId - The identifier for a job that tracks persons in a video. You get the JobId from a call to StartPersonTracking.

Returns:

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

maxResults

GetPersonTrackingRequest.Builder maxResults(Integer maxResults)

Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.

Parameters:

maxResults - Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.

Returns:

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

nextToken

GetPersonTrackingRequest.Builder nextToken(String nextToken)

If the previous response was incomplete (because there are more persons to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of persons.

Parameters:

nextToken - If the previous response was incomplete (because there are more persons to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of persons.

Returns:

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

sortBy

GetPersonTrackingRequest.Builder sortBy(String sortBy)

Sort to use for elements in the Persons array. Use TIMESTAMP to sort array elements by the time persons are detected. Use INDEX to sort by the tracked persons. If you sort by INDEX, the array elements for each person are sorted by detection confidence. The default sort is by TIMESTAMP.

Parameters:

sortBy - Sort to use for elements in the Persons array. Use TIMESTAMP to sort array elements by the time persons are detected. Use INDEX to sort by the tracked persons. If you sort by INDEX, the array elements for each person are sorted by detection confidence. The default sort is by TIMESTAMP.

Returns:

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

See Also:

PersonTrackingSortBy, PersonTrackingSortBy

sortBy

GetPersonTrackingRequest.Builder sortBy(PersonTrackingSortBy sortBy)

Sort to use for elements in the Persons array. Use TIMESTAMP to sort array elements by the time persons are detected. Use INDEX to sort by the tracked persons. If you sort by INDEX, the array elements for each person are sorted by detection confidence. The default sort is by TIMESTAMP.

Parameters:

sortBy - Sort to use for elements in the Persons array. Use TIMESTAMP to sort array elements by the time persons are detected. Use INDEX to sort by the tracked persons. If you sort by INDEX, the array elements for each person are sorted by detection confidence. The default sort is by TIMESTAMP.

Returns:

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

See Also:

PersonTrackingSortBy, PersonTrackingSortBy

overrideConfiguration

GetPersonTrackingRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

GetPersonTrackingRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.