Interface SearchFacesResponse.Builder

All Superinterfaces:
AwsResponse.Builder, Buildable, CopyableBuilder<SearchFacesResponse.Builder,SearchFacesResponse>, RekognitionResponse.Builder, SdkBuilder<SearchFacesResponse.Builder,SearchFacesResponse>, SdkPojo, SdkResponse.Builder
Enclosing class:
SearchFacesResponse
public static interface SearchFacesResponse.Builder extends RekognitionResponse.Builder, SdkPojo, CopyableBuilder<SearchFacesResponse.Builder,SearchFacesResponse>

  • Method Details

    • searchedFaceId

      SearchFacesResponse.Builder searchedFaceId(String searchedFaceId)

      ID of the face that was searched for matches in a collection.

      Parameters:
      searchedFaceId - ID of the face that was searched for matches in a collection.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • faceMatches

      SearchFacesResponse.Builder faceMatches(Collection<FaceMatch> faceMatches)

      An array of faces that matched the input face, along with the confidence in the match.

      Parameters:
      faceMatches - An array of faces that matched the input face, along with the confidence in the match.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • faceMatches

      SearchFacesResponse.Builder faceMatches(FaceMatch... faceMatches)

      An array of faces that matched the input face, along with the confidence in the match.

      Parameters:
      faceMatches - An array of faces that matched the input face, along with the confidence in the match.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • faceMatches

      SearchFacesResponse.Builder faceMatches(Consumer<FaceMatch.Builder>... faceMatches)

      An array of faces that matched the input face, along with the confidence in the match.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to faceMatches(List<FaceMatch>).

      Parameters:
      faceMatches - a consumer that will call methods on FaceMatch.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • faceModelVersion

      SearchFacesResponse.Builder faceModelVersion(String faceModelVersion)

      Version number of the face detection model associated with the input collection (CollectionId).

      Parameters:
      faceModelVersion - Version number of the face detection model associated with the input collection ( CollectionId).
      Returns:
      Returns a reference to this object so that method calls can be chained together.