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

Interface StartPersonTrackingRequest.Builder

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

  • Method Details

    • video

      StartPersonTrackingRequest.Builder video(Video video)

      The video in which you want to detect people. The video must be stored in an Amazon S3 bucket.

      Parameters:
      video - The video in which you want to detect people. 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 StartPersonTrackingRequest.Builder video(Consumer<Video.Builder> video)

      The video in which you want to detect people. 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

      StartPersonTrackingRequest.Builder clientRequestToken(String clientRequestToken)

      Idempotent token used to identify the start request. If you use the same token with multiple StartPersonTracking 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 StartPersonTracking 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.

    • notificationChannel

      StartPersonTrackingRequest.Builder notificationChannel(NotificationChannel notificationChannel)

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

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

    • notificationChannel

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

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

      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

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

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

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