Interface ListFacesRequest.Builder
-
- All Superinterfaces:
AwsRequest.Builder,Buildable,CopyableBuilder<ListFacesRequest.Builder,ListFacesRequest>,RekognitionRequest.Builder,SdkBuilder<ListFacesRequest.Builder,ListFacesRequest>,SdkPojo,SdkRequest.Builder
- Enclosing class:
- ListFacesRequest
public static interface ListFacesRequest.Builder extends RekognitionRequest.Builder, SdkPojo, CopyableBuilder<ListFacesRequest.Builder,ListFacesRequest>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ListFacesRequest.BuildercollectionId(String collectionId)ID of the collection from which to list the faces.ListFacesRequest.BuilderfaceIds(String... faceIds)An array of face IDs to filter results with when listing faces in a collection.ListFacesRequest.BuilderfaceIds(Collection<String> faceIds)An array of face IDs to filter results with when listing faces in a collection.ListFacesRequest.BuildermaxResults(Integer maxResults)Maximum number of faces to return.ListFacesRequest.BuildernextToken(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.BuilderoverrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)ListFacesRequest.BuilderoverrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)ListFacesRequest.BuilderuserId(String userId)An array of user IDs to filter results with when listing faces in a collection.-
Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.services.rekognition.model.RekognitionRequest.Builder
build
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
-
-
-
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.
-
userId
ListFacesRequest.Builder userId(String userId)
An array of user IDs to filter results with when listing faces in a collection.
- Parameters:
userId- An array of user IDs to filter results with when listing faces in a collection.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
faceIds
ListFacesRequest.Builder faceIds(Collection<String> faceIds)
An array of face IDs to filter results with when listing faces in a collection.
- Parameters:
faceIds- An array of face IDs to filter results with when listing faces in a collection.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
faceIds
ListFacesRequest.Builder faceIds(String... faceIds)
An array of face IDs to filter results with when listing faces in a collection.
- Parameters:
faceIds- An array of face IDs to filter results with when listing faces in a collection.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
ListFacesRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
overrideConfiguration
ListFacesRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
-