Interface SearchUsersByImageRequest.Builder

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

  • Method Details

    • collectionId

      SearchUsersByImageRequest.Builder collectionId(String collectionId)

      The ID of an existing collection containing the UserID.

      Parameters:
      collectionId - The ID of an existing collection containing the UserID.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • image

      SearchUsersByImageRequest.Builder image(Image image)
      Sets the value of the Image property for this object.
      Parameters:
      image - The new value for the Image property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • image

      default SearchUsersByImageRequest.Builder image(Consumer<Image.Builder> image)
      Sets the value of the Image property for this object. This is a convenience method that creates an instance of the Image.Builder avoiding the need to create one manually via Image.builder().

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

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

    • userMatchThreshold

      SearchUsersByImageRequest.Builder userMatchThreshold(Float userMatchThreshold)

      Specifies the minimum confidence in the UserID match to return. Default value is 80.

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

    • maxUsers

      SearchUsersByImageRequest.Builder maxUsers(Integer maxUsers)

      Maximum number of UserIDs to return.

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

    • qualityFilter

      SearchUsersByImageRequest.Builder qualityFilter(String qualityFilter)

      A filter that specifies a quality bar for how much filtering is done to identify faces. Filtered faces aren't searched for in the collection. The default value is NONE.

      Parameters:
      qualityFilter - A filter that specifies a quality bar for how much filtering is done to identify faces. Filtered faces aren't searched for in the collection. The default value is NONE.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • qualityFilter

      SearchUsersByImageRequest.Builder qualityFilter(QualityFilter qualityFilter)

      A filter that specifies a quality bar for how much filtering is done to identify faces. Filtered faces aren't searched for in the collection. The default value is NONE.

      Parameters:
      qualityFilter - A filter that specifies a quality bar for how much filtering is done to identify faces. Filtered faces aren't searched for in the collection. The default value is NONE.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

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

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