Package software.amazon.awssdk.services.rekognition.model

Interface GetFaceSearchRequest.Builder

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

  • Method Details

    • jobId

      GetFaceSearchRequest.Builder jobId(String jobId)

      The job identifer for the search request. You get the job identifier from an initial call to StartFaceSearch.

      Parameters:
      jobId - The job identifer for the search request. You get the job identifier from an initial call to StartFaceSearch.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxResults

      GetFaceSearchRequest.Builder maxResults(Integer maxResults)

      Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.

      Parameters:
      maxResults - Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • nextToken

      GetFaceSearchRequest.Builder nextToken(String nextToken)

      If the previous response was incomplete (because there is more search results to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of search results.

      Parameters:
      nextToken - If the previous response was incomplete (because there is more search results to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of search results.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sortBy

      GetFaceSearchRequest.Builder sortBy(String sortBy)

      Sort to use for grouping faces in the response. Use TIMESTAMP to group faces by the time that they are recognized. Use INDEX to sort by recognized faces.

      Parameters:
      sortBy - Sort to use for grouping faces in the response. Use TIMESTAMP to group faces by the time that they are recognized. Use INDEX to sort by recognized faces.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • sortBy

      GetFaceSearchRequest.Builder sortBy(FaceSearchSortBy sortBy)

      Sort to use for grouping faces in the response. Use TIMESTAMP to group faces by the time that they are recognized. Use INDEX to sort by recognized faces.

      Parameters:
      sortBy - Sort to use for grouping faces in the response. Use TIMESTAMP to group faces by the time that they are recognized. Use INDEX to sort by recognized faces.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

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

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