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

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 Details

    • 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)
      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

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