Interface StartFaceSearchRequest.Builder

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

  • Method Details

    • video

      StartFaceSearchRequest.Builder video(Video video)

      The video you want to search. The video must be stored in an Amazon S3 bucket.

      Parameters:
      video - The video you want to search. The video must be stored in an Amazon S3 bucket.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • video

      default StartFaceSearchRequest.Builder video(Consumer<Video.Builder> video)

      The video you want to search. The video must be stored in an Amazon S3 bucket.

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

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

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

    • clientRequestToken

      StartFaceSearchRequest.Builder clientRequestToken(String clientRequestToken)

      Idempotent token used to identify the start request. If you use the same token with multiple StartFaceSearch requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidently started more than once.

      Parameters:
      clientRequestToken - Idempotent token used to identify the start request. If you use the same token with multiple StartFaceSearch requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidently started more than once.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • faceMatchThreshold

      StartFaceSearchRequest.Builder faceMatchThreshold(Float faceMatchThreshold)

      The minimum confidence in the person 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 - The minimum confidence in the person 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.

    • collectionId

      StartFaceSearchRequest.Builder collectionId(String collectionId)

      ID of the collection that contains the faces you want to search for.

      Parameters:
      collectionId - ID of the collection that contains the faces you want to search for.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • notificationChannel

      StartFaceSearchRequest.Builder notificationChannel(NotificationChannel notificationChannel)

      The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the search. The Amazon SNS topic must have a topic name that begins with AmazonRekognition if you are using the AmazonRekognitionServiceRole permissions policy to access the topic.

      Parameters:
      notificationChannel - The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the search. The Amazon SNS topic must have a topic name that begins with AmazonRekognition if you are using the AmazonRekognitionServiceRole permissions policy to access the topic.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • notificationChannel

      default StartFaceSearchRequest.Builder notificationChannel(Consumer<NotificationChannel.Builder> notificationChannel)

      The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the search. The Amazon SNS topic must have a topic name that begins with AmazonRekognition if you are using the AmazonRekognitionServiceRole permissions policy to access the topic.

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

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

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

    • jobTag

      StartFaceSearchRequest.Builder jobTag(String jobTag)

      An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic. For example, you can use JobTag to group related jobs and identify them in the completion notification.

      Parameters:
      jobTag - An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic. For example, you can use JobTag to group related jobs and identify them in the completion notification.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

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