/* * Copyright 2010-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). * You may not use this file except in compliance with the License. * A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either * express or implied. See the License for the specific language governing * permissions and limitations under the License. */ package com.amazonaws.services.rekognition.model; import java.io.Serializable; import com.amazonaws.AmazonWebServiceRequest; /** *

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

*/ public class StartSegmentDetectionRequest extends AmazonWebServiceRequest implements Serializable { /** *

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

*/ private Video video; /** *

* 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-_]+$
*/ private String clientRequestToken; /** *

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

*/ private NotificationChannel notificationChannel; /** *

* 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 - 1024
* Pattern: [a-zA-Z0-9_.\-:+=\/]+
*/ private String jobTag; /** *

* Filters for technical cue or shot detection. *

*/ private StartSegmentDetectionFilters filters; /** *

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

*/ private java.util.List segmentTypes; /** *

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

* * @return

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

*/ public Video getVideo() { return 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. *

* * @param 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. *

*/ public void setVideo(Video video) { this.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. * * @param 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. *

* @return A reference to this updated object so that method calls can be * chained together. */ public StartSegmentDetectionRequest withVideo(Video video) { this.video = video; return this; } /** *

* 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-_]+$
* * @return

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

*/ public String getClientRequestToken() { return 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-_]+$
* * @param 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. *

*/ public void setClientRequestToken(String clientRequestToken) { this.clientRequestToken = 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-_]+$
* * @param 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. *

* @return A reference to this updated object so that method calls can be * chained together. */ public StartSegmentDetectionRequest withClientRequestToken(String clientRequestToken) { this.clientRequestToken = clientRequestToken; return this; } /** *

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

* * @return

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

*/ public NotificationChannel getNotificationChannel() { return 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. *

* * @param 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. *

*/ public void setNotificationChannel(NotificationChannel notificationChannel) { this.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. *

*

* Returns a reference to this object so that method calls can be chained * together. * * @param 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. *

* @return A reference to this updated object so that method calls can be * chained together. */ public StartSegmentDetectionRequest withNotificationChannel( NotificationChannel notificationChannel) { this.notificationChannel = notificationChannel; return this; } /** *

* 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 - 1024
* Pattern: [a-zA-Z0-9_.\-:+=\/]+
* * @return

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

*/ public String getJobTag() { return 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 - 1024
* Pattern: [a-zA-Z0-9_.\-:+=\/]+
* * @param 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. *

*/ public void setJobTag(String jobTag) { this.jobTag = 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 - 1024
* Pattern: [a-zA-Z0-9_.\-:+=\/]+
* * @param 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. *

* @return A reference to this updated object so that method calls can be * chained together. */ public StartSegmentDetectionRequest withJobTag(String jobTag) { this.jobTag = jobTag; return this; } /** *

* Filters for technical cue or shot detection. *

* * @return

* Filters for technical cue or shot detection. *

*/ public StartSegmentDetectionFilters getFilters() { return filters; } /** *

* Filters for technical cue or shot detection. *

* * @param filters

* Filters for technical cue or shot detection. *

*/ public void setFilters(StartSegmentDetectionFilters filters) { this.filters = filters; } /** *

* Filters for technical cue or shot detection. *

*

* Returns a reference to this object so that method calls can be chained * together. * * @param filters

* Filters for technical cue or shot detection. *

* @return A reference to this updated object so that method calls can be * chained together. */ public StartSegmentDetectionRequest withFilters(StartSegmentDetectionFilters filters) { this.filters = filters; return this; } /** *

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

* * @return

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

*/ public java.util.List getSegmentTypes() { return segmentTypes; } /** *

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

* * @param segmentTypes

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

*/ public void setSegmentTypes(java.util.Collection segmentTypes) { if (segmentTypes == null) { this.segmentTypes = null; return; } this.segmentTypes = new java.util.ArrayList(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. * * @param segmentTypes

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

* @return A reference to this updated object so that method calls can be * chained together. */ public StartSegmentDetectionRequest withSegmentTypes(String... segmentTypes) { if (getSegmentTypes() == null) { this.segmentTypes = new java.util.ArrayList(segmentTypes.length); } for (String value : segmentTypes) { this.segmentTypes.add(value); } return this; } /** *

* 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. * * @param segmentTypes

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

* @return A reference to this updated object so that method calls can be * chained together. */ public StartSegmentDetectionRequest withSegmentTypes(java.util.Collection segmentTypes) { setSegmentTypes(segmentTypes); return this; } /** * Returns a string representation of this object; useful for testing and * debugging. * * @return A string representation of this object. * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getVideo() != null) sb.append("Video: " + getVideo() + ","); if (getClientRequestToken() != null) sb.append("ClientRequestToken: " + getClientRequestToken() + ","); if (getNotificationChannel() != null) sb.append("NotificationChannel: " + getNotificationChannel() + ","); if (getJobTag() != null) sb.append("JobTag: " + getJobTag() + ","); if (getFilters() != null) sb.append("Filters: " + getFilters() + ","); if (getSegmentTypes() != null) sb.append("SegmentTypes: " + getSegmentTypes()); sb.append("}"); return sb.toString(); } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getVideo() == null) ? 0 : getVideo().hashCode()); hashCode = prime * hashCode + ((getClientRequestToken() == null) ? 0 : getClientRequestToken().hashCode()); hashCode = prime * hashCode + ((getNotificationChannel() == null) ? 0 : getNotificationChannel().hashCode()); hashCode = prime * hashCode + ((getJobTag() == null) ? 0 : getJobTag().hashCode()); hashCode = prime * hashCode + ((getFilters() == null) ? 0 : getFilters().hashCode()); hashCode = prime * hashCode + ((getSegmentTypes() == null) ? 0 : getSegmentTypes().hashCode()); return hashCode; } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof StartSegmentDetectionRequest == false) return false; StartSegmentDetectionRequest other = (StartSegmentDetectionRequest) obj; if (other.getVideo() == null ^ this.getVideo() == null) return false; if (other.getVideo() != null && other.getVideo().equals(this.getVideo()) == false) return false; if (other.getClientRequestToken() == null ^ this.getClientRequestToken() == null) return false; if (other.getClientRequestToken() != null && other.getClientRequestToken().equals(this.getClientRequestToken()) == false) return false; if (other.getNotificationChannel() == null ^ this.getNotificationChannel() == null) return false; if (other.getNotificationChannel() != null && other.getNotificationChannel().equals(this.getNotificationChannel()) == false) return false; if (other.getJobTag() == null ^ this.getJobTag() == null) return false; if (other.getJobTag() != null && other.getJobTag().equals(this.getJobTag()) == false) return false; if (other.getFilters() == null ^ this.getFilters() == null) return false; if (other.getFilters() != null && other.getFilters().equals(this.getFilters()) == false) return false; if (other.getSegmentTypes() == null ^ this.getSegmentTypes() == null) return false; if (other.getSegmentTypes() != null && other.getSegmentTypes().equals(this.getSegmentTypes()) == false) return false; return true; } }