Interface SearchUsersResponse.Builder

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

  • Method Details

    • userMatches

      SearchUsersResponse.Builder userMatches(Collection<UserMatch> userMatches)

      An array of UserMatch objects that matched the input face along with the confidence in the match. Array will be empty if there are no matches.

      Parameters:
      userMatches - An array of UserMatch objects that matched the input face along with the confidence in the match. Array will be empty if there are no matches.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • userMatches

      SearchUsersResponse.Builder userMatches(UserMatch... userMatches)

      An array of UserMatch objects that matched the input face along with the confidence in the match. Array will be empty if there are no matches.

      Parameters:
      userMatches - An array of UserMatch objects that matched the input face along with the confidence in the match. Array will be empty if there are no matches.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • userMatches

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

      An array of UserMatch objects that matched the input face along with the confidence in the match. Array will be empty if there are no matches.

      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

      SearchUsersResponse.Builder faceModelVersion(String faceModelVersion)

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

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

    • searchedFace

      SearchUsersResponse.Builder searchedFace(SearchedFace searchedFace)

      Contains the ID of a face that was used to search for matches in a collection.

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

    • searchedFace

      default SearchUsersResponse.Builder searchedFace(Consumer<SearchedFace.Builder> searchedFace)

      Contains the ID of a face that was used to search for matches in a collection.

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

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

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

    • searchedUser

      SearchUsersResponse.Builder searchedUser(SearchedUser searchedUser)

      Contains the ID of the UserID that was used to search for matches in a collection.

      Parameters:
      searchedUser - Contains the ID of the UserID that was used to search for matches in a collection.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • searchedUser

      default SearchUsersResponse.Builder searchedUser(Consumer<SearchedUser.Builder> searchedUser)

      Contains the ID of the UserID that was used to search for matches in a collection.

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

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

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