Class StartPersonTrackingRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<StartPersonTrackingRequest.Builder,
StartPersonTrackingRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
Idempotent token used to identify the start request.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final String
jobTag()
An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic.final NotificationChannel
The Amazon SNS topic ARN you want Amazon Rekognition Video to publish the completion status of the people detection operation to.static Class
<? extends StartPersonTrackingRequest.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final Video
video()
The video in which you want to detect people.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
video
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.
-
clientRequestToken
Idempotent token used to identify the start request. If you use the same token with multiple
StartPersonTracking
requests, the sameJobId
is returned. UseClientRequestToken
to prevent the same job from being accidently started more than once.- Returns:
- Idempotent token used to identify the start request. If you use the same token with multiple
StartPersonTracking
requests, the sameJobId
is returned. UseClientRequestToken
to prevent the same job from being accidently started more than once.
-
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:
- 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.
-
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:
- 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.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<StartPersonTrackingRequest.Builder,
StartPersonTrackingRequest> - Specified by:
toBuilder
in classRekognitionRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-