/* * 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 labels in a stored video. *

*

* Amazon Rekognition Video can detect labels in a video. Labels are instances * of real-world entities. This includes objects like flower, tree, and table; * events like wedding, graduation, and birthday party; concepts like landscape, * evening, and nature; and activities like a person getting out of a car or a * person skiing. *

*

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

*

* To get the results of the label detection operation, first check that the * status value published to the Amazon SNS topic is SUCCEEDED. If * so, call GetLabelDetection and pass the job identifier ( * JobId) from the initial call to StartLabelDetection * . *

*

* Optional Parameters *

*

* StartLabelDetection has the GENERAL_LABELS Feature * applied by default. This feature allows you to provide filtering criteria to * the Settings parameter. You can filter with sets of individual * labels or with label categories. You can specify inclusive filters, exclusive * filters, or a combination of inclusive and exclusive filters. For more * information on filtering, see Detecting labels in a video. *

*

* You can specify MinConfidence to control the confidence * threshold for the labels returned. The default is 50. *

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

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

*/ private Video video; /** *

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

*

* Constraints:
* Length: 1 - 64
* Pattern: ^[a-zA-Z0-9-_]+$
*/ private String clientRequestToken; /** *

* Specifies the minimum confidence that Amazon 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. Amazon 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 and bounding boxes (if detected) with confidence values greater * than or equal to 50 percent. *

*

* Constraints:
* Length: 0.0 - 100.0
*/ private Float minConfidence; /** *

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

*/ 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; /** *

* The features to return after video analysis. You can specify that * GENERAL_LABELS are returned. *

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

* The settings for a StartLabelDetection request.Contains the specified * parameters for the label detection request of an asynchronous label * analysis operation. Settings can include filters for GENERAL_LABELS. *

*/ private LabelDetectionSettings settings; /** *

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

* * @return

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

*/ public Video getVideo() { return video; } /** *

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

* * @param video

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

*/ public void setVideo(Video video) { this.video = video; } /** *

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

*

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

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

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

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

*

* 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 StartLabelDetection * 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 StartLabelDetection 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 * StartLabelDetection 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 StartLabelDetection 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 * StartLabelDetection 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 StartLabelDetectionRequest withClientRequestToken(String clientRequestToken) { this.clientRequestToken = clientRequestToken; return this; } /** *

* Specifies the minimum confidence that Amazon 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. Amazon 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 and bounding boxes (if detected) with confidence values greater * than or equal to 50 percent. *

*

* Constraints:
* Length: 0.0 - 100.0
* * @return

* Specifies the minimum confidence that Amazon 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. Amazon 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 and bounding boxes (if detected) with confidence * values greater than or equal to 50 percent. *

*/ public Float getMinConfidence() { return minConfidence; } /** *

* Specifies the minimum confidence that Amazon 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. Amazon 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 and bounding boxes (if detected) with confidence values greater * than or equal to 50 percent. *

*

* Constraints:
* Length: 0.0 - 100.0
* * @param minConfidence

* Specifies the minimum confidence that Amazon 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. Amazon 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 and bounding boxes (if detected) with * confidence values greater than or equal to 50 percent. *

*/ public void setMinConfidence(Float minConfidence) { this.minConfidence = minConfidence; } /** *

* Specifies the minimum confidence that Amazon 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. Amazon 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 and bounding boxes (if detected) with confidence values greater * than or equal to 50 percent. *

*

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

* Constraints:
* Length: 0.0 - 100.0
* * @param minConfidence

* Specifies the minimum confidence that Amazon 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. Amazon 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 and bounding boxes (if detected) with * confidence values greater than or equal to 50 percent. *

* @return A reference to this updated object so that method calls can be * chained together. */ public StartLabelDetectionRequest withMinConfidence(Float minConfidence) { this.minConfidence = minConfidence; return this; } /** *

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

* * @return

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

*/ public NotificationChannel getNotificationChannel() { return notificationChannel; } /** *

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

* * @param notificationChannel

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

*/ public void setNotificationChannel(NotificationChannel notificationChannel) { this.notificationChannel = notificationChannel; } /** *

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

*

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

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

* @return A reference to this updated object so that method calls can be * chained together. */ public StartLabelDetectionRequest 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 StartLabelDetectionRequest withJobTag(String jobTag) { this.jobTag = jobTag; return this; } /** *

* The features to return after video analysis. You can specify that * GENERAL_LABELS are returned. *

* * @return

* The features to return after video analysis. You can specify that * GENERAL_LABELS are returned. *

*/ public java.util.List getFeatures() { return features; } /** *

* The features to return after video analysis. You can specify that * GENERAL_LABELS are returned. *

* * @param features

* The features to return after video analysis. You can specify * that GENERAL_LABELS are returned. *

*/ public void setFeatures(java.util.Collection features) { if (features == null) { this.features = null; return; } this.features = new java.util.ArrayList(features); } /** *

* The features to return after video analysis. You can specify that * GENERAL_LABELS are returned. *

*

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

* The features to return after video analysis. You can specify * that GENERAL_LABELS are returned. *

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

* The features to return after video analysis. You can specify that * GENERAL_LABELS are returned. *

*

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

* The features to return after video analysis. You can specify * that GENERAL_LABELS are returned. *

* @return A reference to this updated object so that method calls can be * chained together. */ public StartLabelDetectionRequest withFeatures(java.util.Collection features) { setFeatures(features); return this; } /** *

* The settings for a StartLabelDetection request.Contains the specified * parameters for the label detection request of an asynchronous label * analysis operation. Settings can include filters for GENERAL_LABELS. *

* * @return

* The settings for a StartLabelDetection request.Contains the * specified parameters for the label detection request of an * asynchronous label analysis operation. Settings can include * filters for GENERAL_LABELS. *

*/ public LabelDetectionSettings getSettings() { return settings; } /** *

* The settings for a StartLabelDetection request.Contains the specified * parameters for the label detection request of an asynchronous label * analysis operation. Settings can include filters for GENERAL_LABELS. *

* * @param settings

* The settings for a StartLabelDetection request.Contains the * specified parameters for the label detection request of an * asynchronous label analysis operation. Settings can include * filters for GENERAL_LABELS. *

*/ public void setSettings(LabelDetectionSettings settings) { this.settings = settings; } /** *

* The settings for a StartLabelDetection request.Contains the specified * parameters for the label detection request of an asynchronous label * analysis operation. Settings can include filters for GENERAL_LABELS. *

*

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

* The settings for a StartLabelDetection request.Contains the * specified parameters for the label detection request of an * asynchronous label analysis operation. Settings can include * filters for GENERAL_LABELS. *

* @return A reference to this updated object so that method calls can be * chained together. */ public StartLabelDetectionRequest withSettings(LabelDetectionSettings settings) { this.settings = settings; 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 (getMinConfidence() != null) sb.append("MinConfidence: " + getMinConfidence() + ","); if (getNotificationChannel() != null) sb.append("NotificationChannel: " + getNotificationChannel() + ","); if (getJobTag() != null) sb.append("JobTag: " + getJobTag() + ","); if (getFeatures() != null) sb.append("Features: " + getFeatures() + ","); if (getSettings() != null) sb.append("Settings: " + getSettings()); 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 + ((getMinConfidence() == null) ? 0 : getMinConfidence().hashCode()); hashCode = prime * hashCode + ((getNotificationChannel() == null) ? 0 : getNotificationChannel().hashCode()); hashCode = prime * hashCode + ((getJobTag() == null) ? 0 : getJobTag().hashCode()); hashCode = prime * hashCode + ((getFeatures() == null) ? 0 : getFeatures().hashCode()); hashCode = prime * hashCode + ((getSettings() == null) ? 0 : getSettings().hashCode()); return hashCode; } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof StartLabelDetectionRequest == false) return false; StartLabelDetectionRequest other = (StartLabelDetectionRequest) 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.getMinConfidence() == null ^ this.getMinConfidence() == null) return false; if (other.getMinConfidence() != null && other.getMinConfidence().equals(this.getMinConfidence()) == 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.getFeatures() == null ^ this.getFeatures() == null) return false; if (other.getFeatures() != null && other.getFeatures().equals(this.getFeatures()) == false) return false; if (other.getSettings() == null ^ this.getSettings() == null) return false; if (other.getSettings() != null && other.getSettings().equals(this.getSettings()) == false) return false; return true; } }