com.amazonaws.services.rekognition.model

Class StartLabelDetectionRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.rekognition.model.StartLabelDetectionRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class StartLabelDetectionRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
StartLabelDetectionRequest()

Method Summary

Modifier and Type	Method and Description
StartLabelDetectionRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getClientRequestToken() Idempotent token used to identify the start request.
String	getJobTag() Unique identifier you specify to identify the job in the completion status published to the Amazon Simple Notification Service topic.
Float	getMinConfidence() Specifies the minimum confidence that Rekognition Video must have in order to return a detected label.
NotificationChannel	getNotificationChannel() The Amazon SNS topic ARN you want Rekognition Video to publish the completion status of the label detection operation to.
Video	getVideo() The video in which you want to detect labels.
int	hashCode()
void	setClientRequestToken(String clientRequestToken) Idempotent token used to identify the start request.
void	setJobTag(String jobTag) Unique identifier you specify to identify the job in the completion status published to the Amazon Simple Notification Service topic.
void	setMinConfidence(Float minConfidence) Specifies the minimum confidence that Rekognition Video must have in order to return a detected label.
void	setNotificationChannel(NotificationChannel notificationChannel) The Amazon SNS topic ARN you want Rekognition Video to publish the completion status of the label detection operation to.
void	setVideo(Video video) The video in which you want to detect labels.
String	toString() Returns a string representation of this object; useful for testing and debugging.
StartLabelDetectionRequest	withClientRequestToken(String clientRequestToken) Idempotent token used to identify the start request.
StartLabelDetectionRequest	withJobTag(String jobTag) Unique identifier you specify to identify the job in the completion status published to the Amazon Simple Notification Service topic.
StartLabelDetectionRequest	withMinConfidence(Float minConfidence) Specifies the minimum confidence that Rekognition Video must have in order to return a detected label.
StartLabelDetectionRequest	withNotificationChannel(NotificationChannel notificationChannel) The Amazon SNS topic ARN you want Rekognition Video to publish the completion status of the label detection operation to.
StartLabelDetectionRequest	withVideo(Video video) The video in which you want to detect labels.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

StartLabelDetectionRequest

public StartLabelDetectionRequest()

Method Detail

setVideo

public void setVideo(Video video)

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

Parameters:

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

getVideo

public Video getVideo()

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

Returns:

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

withVideo

public StartLabelDetectionRequest withVideo(Video video)

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

Parameters:

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

setClientRequestToken

public void setClientRequestToken(String clientRequestToken)

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

getClientRequestToken

public String getClientRequestToken()

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

withClientRequestToken

public StartLabelDetectionRequest withClientRequestToken(String clientRequestToken)

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

setMinConfidence

public void setMinConfidence(Float minConfidence)

Specifies the minimum confidence that Rekognition Video must have in order to return a detected label. Confidence represents how certain Amazon Rekognition is that a label is correctly identified.0 is the lowest confidence. 100 is the highest confidence. Rekognition Video doesn't return any labels with a confidence level lower than this specified value.

If you don't specify MinConfidence, the operation returns labels with confidence values greater than or equal to 50 percent.

Parameters:

minConfidence - Specifies the minimum confidence that Rekognition Video must have in order to return a detected label. Confidence represents how certain Amazon Rekognition is that a label is correctly identified.0 is the lowest confidence. 100 is the highest confidence. Rekognition Video doesn't return any labels with a confidence level lower than this specified value.

If you don't specify MinConfidence, the operation returns labels with confidence values greater than or equal to 50 percent.

getMinConfidence

public Float getMinConfidence()

Specifies the minimum confidence that Rekognition Video must have in order to return a detected label. Confidence represents how certain Amazon Rekognition is that a label is correctly identified.0 is the lowest confidence. 100 is the highest confidence. Rekognition Video doesn't return any labels with a confidence level lower than this specified value.

If you don't specify MinConfidence, the operation returns labels with confidence values greater than or equal to 50 percent.

Returns:

Specifies the minimum confidence that Rekognition Video must have in order to return a detected label. Confidence represents how certain Amazon Rekognition is that a label is correctly identified.0 is the lowest confidence. 100 is the highest confidence. Rekognition Video doesn't return any labels with a confidence level lower than this specified value.

If you don't specify MinConfidence, the operation returns labels with confidence values greater than or equal to 50 percent.

withMinConfidence

public StartLabelDetectionRequest withMinConfidence(Float minConfidence)

Specifies the minimum confidence that Rekognition Video must have in order to return a detected label. Confidence represents how certain Amazon Rekognition is that a label is correctly identified.0 is the lowest confidence. 100 is the highest confidence. Rekognition Video doesn't return any labels with a confidence level lower than this specified value.

If you don't specify MinConfidence, the operation returns labels with confidence values greater than or equal to 50 percent.

Parameters:

minConfidence - Specifies the minimum confidence that Rekognition Video must have in order to return a detected label. Confidence represents how certain Amazon Rekognition is that a label is correctly identified.0 is the lowest confidence. 100 is the highest confidence. Rekognition Video doesn't return any labels with a confidence level lower than this specified value.

If you don't specify MinConfidence, the operation returns labels with confidence values greater than or equal to 50 percent.

Returns:

Returns a reference to this object so that method calls can be chained together.

setNotificationChannel

public void setNotificationChannel(NotificationChannel notificationChannel)

The Amazon SNS topic ARN you want Rekognition Video to publish the completion status of the label detection operation to.

Parameters:

notificationChannel - The Amazon SNS topic ARN you want Rekognition Video to publish the completion status of the label detection operation to.

getNotificationChannel

public NotificationChannel getNotificationChannel()

The Amazon SNS topic ARN you want Rekognition Video to publish the completion status of the label detection operation to.

Returns:

The Amazon SNS topic ARN you want Rekognition Video to publish the completion status of the label detection operation to.

withNotificationChannel

public StartLabelDetectionRequest withNotificationChannel(NotificationChannel notificationChannel)

The Amazon SNS topic ARN you want Rekognition Video to publish the completion status of the label detection operation to.

Parameters:

notificationChannel - The Amazon SNS topic ARN you want Rekognition Video to publish the completion status of the label detection operation to.

Returns:

Returns a reference to this object so that method calls can be chained together.

setJobTag

public void setJobTag(String jobTag)

Unique identifier you specify to identify the job in the completion status published to the Amazon Simple Notification Service topic.

Parameters:

jobTag - Unique identifier you specify to identify the job in the completion status published to the Amazon Simple Notification Service topic.

getJobTag

public String getJobTag()

Unique identifier you specify to identify the job in the completion status published to the Amazon Simple Notification Service topic.

Returns:

Unique identifier you specify to identify the job in the completion status published to the Amazon Simple Notification Service topic.

withJobTag

public StartLabelDetectionRequest withJobTag(String jobTag)

Unique identifier you specify to identify the job in the completion status published to the Amazon Simple Notification Service topic.

Parameters:

jobTag - Unique identifier you specify to identify the job in the completion status published to the Amazon Simple Notification Service topic.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public StartLabelDetectionRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()