software.amazon.awssdk.services.rekognition.model

Interface ListFacesRequest.Builder

All Superinterfaces:

AwsRequest.Builder, CopyableBuilder<ListFacesRequest.Builder,ListFacesRequest>, RekognitionRequest.Builder, SdkBuilder<ListFacesRequest.Builder,ListFacesRequest>, SdkRequest.Builder

Enclosing class:

ListFacesRequest

public static interface ListFacesRequest.Builder
extends RekognitionRequest.Builder, CopyableBuilder<ListFacesRequest.Builder,ListFacesRequest>

Method Summary

Modifier and Type	Method and Description
ListFacesRequest.Builder	collectionId(String collectionId) ID of the collection from which to list the faces.
ListFacesRequest.Builder	maxResults(Integer maxResults) Maximum number of faces to return.
ListFacesRequest.Builder	nextToken(String nextToken) If the previous response was incomplete (because there is more data to retrieve), Amazon Rekognition returns a pagination token in the response.
ListFacesRequest.Builder	requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig) Add an optional request override configuration.
ListFacesRequest.Builder	requestOverrideConfig(Consumer<AwsRequestOverrideConfig.Builder> builderConsumer) Add an optional request override configuration.

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

build

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

requestOverrideConfig

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

copy

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

apply, build

Method Detail

collectionId

ListFacesRequest.Builder collectionId(String collectionId)

ID of the collection from which to list the faces.

Parameters:

collectionId - ID of the collection from which to list the faces.

Returns:

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

nextToken

ListFacesRequest.Builder nextToken(String nextToken)

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

Parameters:

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

Returns:

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

maxResults

ListFacesRequest.Builder maxResults(Integer maxResults)

Maximum number of faces to return.

Parameters:

maxResults - Maximum number of faces to return.

Returns:

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

requestOverrideConfig

ListFacesRequest.Builder requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

requestOverrideConfig in interface AwsRequest.Builder

Parameters:

awsRequestOverrideConfig - The override configuration.

Returns:

This object for method chaining.

requestOverrideConfig

ListFacesRequest.Builder requestOverrideConfig(Consumer<AwsRequestOverrideConfig.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

requestOverrideConfig in interface AwsRequest.Builder

Parameters:

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

Returns:

This object for method chaining.