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

Class StartCelebrityRecognitionRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.rekognition.model.RekognitionRequest

software.amazon.awssdk.services.rekognition.model.StartCelebrityRecognitionRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<StartCelebrityRecognitionRequest.Builder,StartCelebrityRecognitionRequest>

@Generated("software.amazon.awssdk:codegen")
public final class StartCelebrityRecognitionRequest
extends RekognitionRequest
implements ToCopyableBuilder<StartCelebrityRecognitionRequest.Builder,StartCelebrityRecognitionRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	StartCelebrityRecognitionRequest.Builder

Method Summary

Modifier and Type	Method	Description
static StartCelebrityRecognitionRequest.Builder	builder()
String	clientRequestToken()	Idempotent token used to identify the start request.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	jobTag()	An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic.
NotificationChannel	notificationChannel()	The Amazon SNS topic ARN that you want Amazon Rekognition Video to publish the completion status of the celebrity recognition analysis to.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends StartCelebrityRecognitionRequest.Builder>	serializableBuilderClass()
StartCelebrityRecognitionRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
Video	video()	The video in which you want to recognize celebrities.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

video

public final Video video()

The video in which you want to recognize celebrities. The video must be stored in an Amazon S3 bucket.

Returns:

The video in which you want to recognize celebrities. The video must be stored in an Amazon S3 bucket.

clientRequestToken

public final String clientRequestToken()

Idempotent token used to identify the start request. If you use the same token with multiple StartCelebrityRecognition requests, the same JobId is returned. Use ClientRequestToken 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 StartCelebrityRecognition requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidently started more than once.

notificationChannel

public final NotificationChannel notificationChannel()

The Amazon SNS topic ARN that you want Amazon Rekognition Video to publish the completion status of the celebrity recognition analysis 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 that you want Amazon Rekognition Video to publish the completion status of the celebrity recognition analysis to. The Amazon SNS topic must have a topic name that begins with AmazonRekognition if you are using the AmazonRekognitionServiceRole permissions policy.

jobTag

public final 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:

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

public StartCelebrityRecognitionRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StartCelebrityRecognitionRequest.Builder,StartCelebrityRecognitionRequest>

Specified by:

toBuilder in class RekognitionRequest

builder

public static StartCelebrityRecognitionRequest.Builder builder()

serializableBuilderClass

public static Class<? extends StartCelebrityRecognitionRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String 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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo