Interface SearchUsersRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<SearchUsersRequest.Builder,SearchUsersRequest>, RekognitionRequest.Builder, SdkBuilder<SearchUsersRequest.Builder,SearchUsersRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
SearchUsersRequest
@Mutable @NotThreadSafe public static interface SearchUsersRequest.Builder extends RekognitionRequest.Builder, SdkPojo, CopyableBuilder<SearchUsersRequest.Builder,SearchUsersRequest>

  • Method Details

    • collectionId

      SearchUsersRequest.Builder collectionId(String collectionId)

      The ID of an existing collection containing the UserID, used with a UserId or FaceId. If a FaceId is provided, UserId isn’t required to be present in the Collection.

      Parameters:
      collectionId - The ID of an existing collection containing the UserID, used with a UserId or FaceId. If a FaceId is provided, UserId isn’t required to be present in the Collection.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • userId

      SearchUsersRequest.Builder userId(String userId)

      ID for the existing User.

      Parameters:
      userId - ID for the existing User.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • faceId

      SearchUsersRequest.Builder faceId(String faceId)

      ID for the existing face.

      Parameters:
      faceId - ID for the existing face.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • userMatchThreshold

      SearchUsersRequest.Builder userMatchThreshold(Float userMatchThreshold)

      Optional value that specifies the minimum confidence in the matched UserID to return. Default value of 80.

      Parameters:
      userMatchThreshold - Optional value that specifies the minimum confidence in the matched UserID to return. Default value of 80.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxUsers

      SearchUsersRequest.Builder maxUsers(Integer maxUsers)

      Maximum number of identities to return.

      Parameters:
      maxUsers - Maximum number of identities to return.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

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