Interface SearchFacesRequest.Builder

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

  • Method Details

    • collectionId

      SearchFacesRequest.Builder collectionId(String collectionId)

      ID of the collection the face belongs to.

      Parameters:
      collectionId - ID of the collection the face belongs to.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • faceId

      SearchFacesRequest.Builder faceId(String faceId)

      ID of a face to find matches for in the collection.

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

    • maxFaces

      SearchFacesRequest.Builder maxFaces(Integer maxFaces)

      Maximum number of faces to return. The operation returns the maximum number of faces with the highest confidence in the match.

      Parameters:
      maxFaces - Maximum number of faces to return. The operation returns the maximum number of faces with the highest confidence in the match.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • faceMatchThreshold

      SearchFacesRequest.Builder faceMatchThreshold(Float faceMatchThreshold)

      Optional value specifying the minimum confidence in the face match to return. For example, don't return any matches where confidence in matches is less than 70%. The default value is 80%.

      Parameters:
      faceMatchThreshold - Optional value specifying the minimum confidence in the face match to return. For example, don't return any matches where confidence in matches is less than 70%. The default value is 80%.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

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