com.amazonaws.services.rekognition.model

Class StartSegmentDetectionRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.rekognition.model.StartSegmentDetectionRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class StartSegmentDetectionRequest
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
StartSegmentDetectionRequest()

Method Summary

Modifier and Type	Method and Description
StartSegmentDetectionRequest	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.
StartSegmentDetectionFilters	getFilters() Filters for technical cue or shot detection.
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 ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the segment detection operation.
List<String>	getSegmentTypes() An array of segment types to detect in the video.
Video	getVideo()
int	hashCode()
void	setClientRequestToken(String clientRequestToken) Idempotent token used to identify the start request.
void	setFilters(StartSegmentDetectionFilters filters) Filters for technical cue or shot detection.
void	setJobTag(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 ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the segment detection operation.
void	setSegmentTypes(Collection<String> segmentTypes) An array of segment types to detect in the video.
void	setVideo(Video video)
String	toString() Returns a string representation of this object.
StartSegmentDetectionRequest	withClientRequestToken(String clientRequestToken) Idempotent token used to identify the start request.
StartSegmentDetectionRequest	withFilters(StartSegmentDetectionFilters filters) Filters for technical cue or shot detection.
StartSegmentDetectionRequest	withJobTag(String jobTag) An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic.
StartSegmentDetectionRequest	withNotificationChannel(NotificationChannel notificationChannel) The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the segment detection operation.
StartSegmentDetectionRequest	withSegmentTypes(Collection<String> segmentTypes) An array of segment types to detect in the video.
StartSegmentDetectionRequest	withSegmentTypes(SegmentType... segmentTypes) An array of segment types to detect in the video.
StartSegmentDetectionRequest	withSegmentTypes(String... segmentTypes) An array of segment types to detect in the video.
StartSegmentDetectionRequest	withVideo(Video video)

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

StartSegmentDetectionRequest

public StartSegmentDetectionRequest()

Method Detail

setVideo

public void setVideo(Video video)

Parameters:

video -

getVideo

public Video getVideo()

Returns:

withVideo

public StartSegmentDetectionRequest withVideo(Video video)

Parameters:

video -

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 StartSegmentDetection 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 StartSegmentDetection 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 StartSegmentDetection 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 StartSegmentDetection requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidently started more than once.

withClientRequestToken

public StartSegmentDetectionRequest withClientRequestToken(String clientRequestToken)

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

setNotificationChannel

public void setNotificationChannel(NotificationChannel notificationChannel)

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

Parameters:

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

getNotificationChannel

public NotificationChannel getNotificationChannel()

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

Returns:

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

withNotificationChannel

public StartSegmentDetectionRequest withNotificationChannel(NotificationChannel notificationChannel)

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

Parameters:

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

Returns:

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

setJobTag

public void setJobTag(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.

getJobTag

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

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.

withJobTag

public StartSegmentDetectionRequest withJobTag(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.

setFilters

public void setFilters(StartSegmentDetectionFilters filters)

Filters for technical cue or shot detection.

Parameters:

filters - Filters for technical cue or shot detection.

getFilters

public StartSegmentDetectionFilters getFilters()

Filters for technical cue or shot detection.

Returns:

Filters for technical cue or shot detection.

withFilters

public StartSegmentDetectionRequest withFilters(StartSegmentDetectionFilters filters)

Filters for technical cue or shot detection.

Parameters:

filters - Filters for technical cue or shot detection.

Returns:

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

getSegmentTypes

public List<String> getSegmentTypes()

An array of segment types to detect in the video. Valid values are TECHNICAL_CUE and SHOT.

Returns:

An array of segment types to detect in the video. Valid values are TECHNICAL_CUE and SHOT.

See Also:

SegmentType

setSegmentTypes

public void setSegmentTypes(Collection<String> segmentTypes)

An array of segment types to detect in the video. Valid values are TECHNICAL_CUE and SHOT.

Parameters:

segmentTypes - An array of segment types to detect in the video. Valid values are TECHNICAL_CUE and SHOT.

See Also:

SegmentType

withSegmentTypes

public StartSegmentDetectionRequest withSegmentTypes(String... segmentTypes)

An array of segment types to detect in the video. Valid values are TECHNICAL_CUE and SHOT.

NOTE: This method appends the values to the existing list (if any). Use setSegmentTypes(java.util.Collection) or withSegmentTypes(java.util.Collection) if you want to override the existing values.

Parameters:

segmentTypes - An array of segment types to detect in the video. Valid values are TECHNICAL_CUE and SHOT.

Returns:

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

See Also:

SegmentType

withSegmentTypes

public StartSegmentDetectionRequest withSegmentTypes(Collection<String> segmentTypes)

An array of segment types to detect in the video. Valid values are TECHNICAL_CUE and SHOT.

Parameters:

segmentTypes - An array of segment types to detect in the video. Valid values are TECHNICAL_CUE and SHOT.

Returns:

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

See Also:

SegmentType

withSegmentTypes

public StartSegmentDetectionRequest withSegmentTypes(SegmentType... segmentTypes)

An array of segment types to detect in the video. Valid values are TECHNICAL_CUE and SHOT.

Parameters:

segmentTypes - An array of segment types to detect in the video. Valid values are TECHNICAL_CUE and SHOT.

Returns:

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

See Also:

SegmentType

toString

public 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

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 StartSegmentDetectionRequest 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()