Interface SearchUsersByImageResponse.Builder

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

  • Method Details

    • userMatches

      SearchUsersByImageResponse.Builder userMatches(Collection<UserMatch> userMatches)

      An array of UserID objects that matched the input face, along with the confidence in the match. The returned structure will be empty if there are no matches. Returned if the SearchUsersByImageResponse action is successful.

      Parameters:
      userMatches - An array of UserID objects that matched the input face, along with the confidence in the match. The returned structure will be empty if there are no matches. Returned if the SearchUsersByImageResponse action is successful.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • userMatches

      SearchUsersByImageResponse.Builder userMatches(UserMatch... userMatches)

      An array of UserID objects that matched the input face, along with the confidence in the match. The returned structure will be empty if there are no matches. Returned if the SearchUsersByImageResponse action is successful.

      Parameters:
      userMatches - An array of UserID objects that matched the input face, along with the confidence in the match. The returned structure will be empty if there are no matches. Returned if the SearchUsersByImageResponse action is successful.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • userMatches

      SearchUsersByImageResponse.Builder userMatches(Consumer<UserMatch.Builder>... userMatches)

      An array of UserID objects that matched the input face, along with the confidence in the match. The returned structure will be empty if there are no matches. Returned if the SearchUsersByImageResponse action is successful.

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

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

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

    • faceModelVersion

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

    • searchedFace

      SearchUsersByImageResponse.Builder searchedFace(SearchedFaceDetails searchedFace)

      A list of FaceDetail objects containing the BoundingBox for the largest face in image, as well as the confidence in the bounding box, that was searched for matches. If no valid face is detected in the image the response will contain no SearchedFace object.

      Parameters:
      searchedFace - A list of FaceDetail objects containing the BoundingBox for the largest face in image, as well as the confidence in the bounding box, that was searched for matches. If no valid face is detected in the image the response will contain no SearchedFace object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • searchedFace

      default SearchUsersByImageResponse.Builder searchedFace(Consumer<SearchedFaceDetails.Builder> searchedFace)

      A list of FaceDetail objects containing the BoundingBox for the largest face in image, as well as the confidence in the bounding box, that was searched for matches. If no valid face is detected in the image the response will contain no SearchedFace object.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to searchedFace(SearchedFaceDetails).

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

    • unsearchedFaces

      SearchUsersByImageResponse.Builder unsearchedFaces(Collection<UnsearchedFace> unsearchedFaces)

      List of UnsearchedFace objects. Contains the face details infered from the specified image but not used for search. Contains reasons that describe why a face wasn't used for Search.

      Parameters:
      unsearchedFaces - List of UnsearchedFace objects. Contains the face details infered from the specified image but not used for search. Contains reasons that describe why a face wasn't used for Search.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • unsearchedFaces

      SearchUsersByImageResponse.Builder unsearchedFaces(UnsearchedFace... unsearchedFaces)

      List of UnsearchedFace objects. Contains the face details infered from the specified image but not used for search. Contains reasons that describe why a face wasn't used for Search.

      Parameters:
      unsearchedFaces - List of UnsearchedFace objects. Contains the face details infered from the specified image but not used for search. Contains reasons that describe why a face wasn't used for Search.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • unsearchedFaces

      SearchUsersByImageResponse.Builder unsearchedFaces(Consumer<UnsearchedFace.Builder>... unsearchedFaces)

      List of UnsearchedFace objects. Contains the face details infered from the specified image but not used for search. Contains reasons that describe why a face wasn't used for Search.

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

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

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