StartSegmentDetectionRequest (AWS SDK for Android

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public class StartSegmentDetectionRequest
extends AmazonWebServiceRequest
implements java.io.Serializable
```
Starts asynchronous detection of segment detection in a stored video.

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

You can use the Filters (StartSegmentDetectionFilters) input parameter to specify the minimum detection confidence returned in the response. Within Filters, use ShotFilter (StartShotDetectionFilter) to filter detected shots. Use TechnicalCueFilter (StartTechnicalCueDetectionFilter) to filter technical cues.

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

For more information, see Detecting Video Segments in Stored Video in the Amazon Rekognition Developer Guide.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

StartSegmentDetectionRequest()

Constructors
Constructor and Description
`StartSegmentDetectionRequest()`

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.
`StartSegmentDetectionFilters`	`getFilters()` Filters for technical cue or shot detection.
`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 ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the segment detection operation.
`java.util.List<java.lang.String>`	`getSegmentTypes()` An array of segment types to detect in the video.
`Video`	`getVideo()` Video file stored in an Amazon S3 bucket.
`int`	`hashCode()`
`void`	`setClientRequestToken(java.lang.String clientRequestToken)` Idempotent token used to identify the start request.
`void`	`setFilters(StartSegmentDetectionFilters filters)` Filters for technical cue or shot detection.
`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 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(java.util.Collection<java.lang.String> segmentTypes)` An array of segment types to detect in the video.
`void`	`setVideo(Video video)` Video file stored in an Amazon S3 bucket.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`StartSegmentDetectionRequest`	`withClientRequestToken(java.lang.String clientRequestToken)` Idempotent token used to identify the start request.
`StartSegmentDetectionRequest`	`withFilters(StartSegmentDetectionFilters filters)` Filters for technical cue or shot detection.
`StartSegmentDetectionRequest`	`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.
`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(java.util.Collection<java.lang.String> segmentTypes)` An array of segment types to detect in the video.
`StartSegmentDetectionRequest`	`withSegmentTypes(java.lang.String... segmentTypes)` An array of segment types to detect in the video.
`StartSegmentDetectionRequest`	`withVideo(Video video)` Video file stored in an Amazon S3 bucket.

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
  - StartSegmentDetectionRequest
```
public StartSegmentDetectionRequest()
```
- Method Detail
  - getVideo
```
public Video getVideo()
```
    Video file stored in an Amazon S3 bucket. Amazon Rekognition video start operations such as StartLabelDetection use Video to specify a video for analysis. The supported file formats are .mp4, .mov and .avi.
    
    Returns:
    
    Video file stored in an Amazon S3 bucket. Amazon Rekognition video start operations such as StartLabelDetection use Video to specify a video for analysis. The supported file formats are .mp4, .mov and .avi.
  - setVideo
```
public void setVideo(Video video)
```
    Video file stored in an Amazon S3 bucket. Amazon Rekognition video start operations such as StartLabelDetection use Video to specify a video for analysis. The supported file formats are .mp4, .mov and .avi.
    
    Parameters:
    
    video -
    Video file stored in an Amazon S3 bucket. Amazon Rekognition video start operations such as StartLabelDetection use Video to specify a video for analysis. The supported file formats are .mp4, .mov and .avi.
  - withVideo
```
public StartSegmentDetectionRequest withVideo(Video video)
```
    Video file stored in an Amazon S3 bucket. Amazon Rekognition video start operations such as StartLabelDetection use Video to specify a video for analysis. The supported file formats are .mp4, .mov and .avi.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    video -
    Video file stored in an Amazon S3 bucket. Amazon Rekognition video start operations such as StartLabelDetection use Video to specify a video for analysis. The supported file formats are .mp4, .mov and .avi.
    
    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 StartSegmentDetection 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 StartSegmentDetection 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 StartSegmentDetection 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 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(java.lang.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.
    
    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 StartSegmentDetection 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 ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the segment detection operation.
    
    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.
  - 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.
    
    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.
  - 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.
    
    Returns a reference to this object so that method calls can be chained together.
    
    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.
    
    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 StartSegmentDetectionRequest 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.
  - getFilters
```
public StartSegmentDetectionFilters getFilters()
```
    Filters for technical cue or shot detection.
    
    Returns:
    
    Filters for technical cue or shot detection.
  - setFilters
```
public void setFilters(StartSegmentDetectionFilters filters)
```
    Filters for technical cue or shot detection.
    
    Parameters:
    
    filters -
    Filters for technical cue or shot detection.
  - withFilters
```
public StartSegmentDetectionRequest withFilters(StartSegmentDetectionFilters filters)
```
    Filters for technical cue or shot detection.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    filters -
    Filters for technical cue or shot detection.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getSegmentTypes
```
public java.util.List<java.lang.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.
  - setSegmentTypes
```
public void setSegmentTypes(java.util.Collection<java.lang.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.
  - withSegmentTypes
```
public StartSegmentDetectionRequest withSegmentTypes(java.lang.String... segmentTypes)
```
    An array of segment types to detect in the video. Valid values are TECHNICAL_CUE and SHOT.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    segmentTypes -
    An array of segment types to detect in the video. Valid values are TECHNICAL_CUE and SHOT.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - withSegmentTypes
```
public StartSegmentDetectionRequest withSegmentTypes(java.util.Collection<java.lang.String> segmentTypes)
```
    An array of segment types to detect in the video. Valid values are TECHNICAL_CUE and SHOT.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    segmentTypes -
    An array of segment types to detect in the video. Valid values are TECHNICAL_CUE and SHOT.
    
    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 StartSegmentDetectionRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

StartSegmentDetectionRequest

Method Detail

getVideo

setVideo

withVideo

getClientRequestToken

setClientRequestToken

withClientRequestToken

getNotificationChannel

setNotificationChannel

withNotificationChannel

getJobTag

setJobTag

withJobTag

getFilters

setFilters

withFilters

getSegmentTypes

setSegmentTypes

withSegmentTypes

withSegmentTypes

toString

hashCode

equals