/* * Copyright 2018-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 javax.annotation.Generated; import com.amazonaws.AmazonWebServiceRequest; @Generated("com.amazonaws:aws-java-sdk-code-generator") public class StartLabelDetectionRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *
* 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.
*
* 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.
*
* 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.
*
* The features to return after video analysis. You can specify that GENERAL_LABELS are returned. *
*/ private java.util.List* 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. *
* * @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. *
* * @return The video in which you want to detect labels. The video must be stored in an Amazon S3 bucket. */ public Video getVideo() { return this.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. * @return Returns a reference to this object so that method calls can be chained together. */ public StartLabelDetectionRequest withVideo(Video video) { setVideo(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.
*
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.
*
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 this.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.
*
StartLabelDetection
requests, the same JobId
is returned. Use
* ClientRequestToken
to prevent the same job from being accidently started more than once.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartLabelDetectionRequest withClientRequestToken(String clientRequestToken) {
setClientRequestToken(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.
*
* 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.
*
* 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 this.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.
*
* 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 Returns a reference to this object so that method calls can be chained together.
*/
public StartLabelDetectionRequest withMinConfidence(Float minConfidence) {
setMinConfidence(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. *
* * @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. *
* * @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 this.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. * @return Returns a reference to this object so that method calls can be chained together. */ public StartLabelDetectionRequest withNotificationChannel(NotificationChannel notificationChannel) { setNotificationChannel(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.
*
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.
*
JobTag
to group related jobs and
* identify them in the completion notification.
*/
public String getJobTag() {
return this.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.
*
JobTag
to group related jobs and
* identify them in the completion notification.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartLabelDetectionRequest withJobTag(String jobTag) {
setJobTag(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. * @see LabelDetectionFeatureName */ public java.util.List* 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. * @see LabelDetectionFeatureName */ public void setFeatures(java.util.Collection* The features to return after video analysis. You can specify that GENERAL_LABELS are returned. *
** NOTE: This method appends the values to the existing list (if any). Use * {@link #setFeatures(java.util.Collection)} or {@link #withFeatures(java.util.Collection)} if you want to override * the existing values. *
* * @param features * The features to return after video analysis. You can specify that GENERAL_LABELS are returned. * @return Returns a reference to this object so that method calls can be chained together. * @see LabelDetectionFeatureName */ public StartLabelDetectionRequest withFeatures(String... features) { if (this.features == null) { setFeatures(new java.util.ArrayList* 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. * @return Returns a reference to this object so that method calls can be chained together. * @see LabelDetectionFeatureName */ public StartLabelDetectionRequest withFeatures(java.util.Collection* 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. * @return Returns a reference to this object so that method calls can be chained together. * @see LabelDetectionFeatureName */ public StartLabelDetectionRequest withFeatures(LabelDetectionFeatureName... features) { java.util.ArrayList* 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. *
* * @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 this.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. * @return Returns a reference to this object so that method calls can be chained together. */ public StartLabelDetectionRequest withSettings(LabelDetectionSettings settings) { setSettings(settings); return this; } /** * 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. * * @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: ").append(getVideo()).append(","); if (getClientRequestToken() != null) sb.append("ClientRequestToken: ").append(getClientRequestToken()).append(","); if (getMinConfidence() != null) sb.append("MinConfidence: ").append(getMinConfidence()).append(","); if (getNotificationChannel() != null) sb.append("NotificationChannel: ").append(getNotificationChannel()).append(","); if (getJobTag() != null) sb.append("JobTag: ").append(getJobTag()).append(","); if (getFeatures() != null) sb.append("Features: ").append(getFeatures()).append(","); if (getSettings() != null) sb.append("Settings: ").append(getSettings()); sb.append("}"); return sb.toString(); } @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; } @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 StartLabelDetectionRequest clone() { return (StartLabelDetectionRequest) super.clone(); } }