StartPersonTrackingRequest (AWS SDK for Android

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.rekognition.model.StartPersonTrackingRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public class StartPersonTrackingRequest
extends AmazonWebServiceRequest
implements java.io.Serializable
```
Starts the asynchronous tracking of a person's path in a stored video.

Amazon Rekognition Video can track the path of people in a video stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartPersonTracking returns a job identifier (JobId) which you use to get the results of the operation. When label detection is finished, Amazon Rekognition publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel.

To get the results of the person detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetPersonTracking and pass the job identifier ( JobId) from the initial call to StartPersonTracking .

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

StartPersonTrackingRequest()

Constructors
Constructor and Description
`StartPersonTrackingRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`java.lang.String`	`getClientRequestToken()` Idempotent token used to identify the start request.
`java.lang.String`	`getJobTag()` An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic.
`NotificationChannel`	`getNotificationChannel()` The Amazon SNS topic ARN you want Amazon Rekognition Video to publish the completion status of the people detection operation to.
`Video`	`getVideo()` The video in which you want to detect people.
`int`	`hashCode()`
`void`	`setClientRequestToken(java.lang.String clientRequestToken)` Idempotent token used to identify the start request.
`void`	`setJobTag(java.lang.String jobTag)` An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic.
`void`	`setNotificationChannel(NotificationChannel notificationChannel)` The Amazon SNS topic ARN you want Amazon Rekognition Video to publish the completion status of the people detection operation to.
`void`	`setVideo(Video video)` The video in which you want to detect people.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`StartPersonTrackingRequest`	`withClientRequestToken(java.lang.String clientRequestToken)` Idempotent token used to identify the start request.
`StartPersonTrackingRequest`	`withJobTag(java.lang.String jobTag)` An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic.
`StartPersonTrackingRequest`	`withNotificationChannel(NotificationChannel notificationChannel)` The Amazon SNS topic ARN you want Amazon Rekognition Video to publish the completion status of the people detection operation to.
`StartPersonTrackingRequest`	`withVideo(Video video)` The video in which you want to detect people.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - StartPersonTrackingRequest
```
public StartPersonTrackingRequest()
```
- Method Detail
  - getVideo
```
public Video getVideo()
```
    The video in which you want to detect people. The video must be stored in an Amazon S3 bucket.
    
    Returns:
    
    The video in which you want to detect people. The video must be stored in an Amazon S3 bucket.
  - setVideo
```
public void setVideo(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.
  - withVideo
```
public StartPersonTrackingRequest withVideo(Video video)
```
    The video in which you want to detect people. The video must be stored in an Amazon S3 bucket.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    video -
    The video in which you want to detect people. The video must be stored in an Amazon S3 bucket.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getClientRequestToken
```
public java.lang.String getClientRequestToken()
```
    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.
    
    Constraints:
    Length: 1 - 64
    Pattern: ^[a-zA-Z0-9-_]+$
    
    Returns:
    
    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.
  - setClientRequestToken
```
public void setClientRequestToken(java.lang.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.
    
    Constraints:
    Length: 1 - 64
    Pattern: ^[a-zA-Z0-9-_]+$
    
    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.
  - withClientRequestToken
```
public StartPersonTrackingRequest withClientRequestToken(java.lang.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.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 64
    Pattern: ^[a-zA-Z0-9-_]+$
    
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - getNotificationChannel
```
public NotificationChannel getNotificationChannel()
```
    The Amazon SNS topic ARN you want Amazon Rekognition Video to publish the completion status of the people detection operation to.
    
    Returns:
    
    The Amazon SNS topic ARN you want Amazon Rekognition Video to publish the completion status of the people detection operation to.
  - setNotificationChannel
```
public void setNotificationChannel(NotificationChannel notificationChannel)
```
    The Amazon SNS topic ARN you want Amazon Rekognition Video to publish the completion status of the people detection operation to.
    
    Parameters:
    
    notificationChannel -
    The Amazon SNS topic ARN you want Amazon Rekognition Video to publish the completion status of the people detection operation to.
  - withNotificationChannel
```
public StartPersonTrackingRequest withNotificationChannel(NotificationChannel notificationChannel)
```
    The Amazon SNS topic ARN you want Amazon Rekognition Video to publish the completion status of the people detection operation to.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    notificationChannel -
    The Amazon SNS topic ARN you want Amazon Rekognition Video to publish the completion status of the people detection operation to.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getJobTag
```
public java.lang.String getJobTag()
```
    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.
    
    Constraints:
    Length: 1 - 256
    Pattern: [a-zA-Z0-9_.\-:]+
    
    Returns:
    
    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.
  - setJobTag
```
public void setJobTag(java.lang.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.
    
    Constraints:
    Length: 1 - 256
    Pattern: [a-zA-Z0-9_.\-:]+
    
    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.
  - withJobTag
```
public StartPersonTrackingRequest withJobTag(java.lang.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.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 256
    Pattern: [a-zA-Z0-9_.\-:]+
    
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object

Class StartPersonTrackingRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

StartPersonTrackingRequest

Method Detail

getVideo

setVideo

withVideo

getClientRequestToken

setClientRequestToken

withClientRequestToken

getNotificationChannel

setNotificationChannel

withNotificationChannel

getJobTag

setJobTag

withJobTag

toString

hashCode

equals