/* * 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 inappropriate, unwanted, or offensive * content in a stored video. For a list of moderation labels in Amazon * Rekognition, see Using the image and video moderation APIs. *

*

* Amazon Rekognition Video can moderate content in a video stored in an Amazon * S3 bucket. Use Video to specify the bucket name and the filename of * the video. StartContentModeration returns a job identifier ( * JobId) which you use to get the results of the analysis. When * content analysis 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 content analysis, first check that the status value * published to the Amazon SNS topic is SUCCEEDED. If so, call * GetContentModeration and pass the job identifier (JobId) * from the initial call to StartContentModeration. *

*

* For more information, see Moderating content in the Amazon Rekognition * Developer Guide. *

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

* The video in which you want to detect inappropriate, unwanted, or * offensive content. The video must be stored in an Amazon S3 bucket. *

*/ private Video video; /** *

* Specifies the minimum confidence that Amazon Rekognition must have in * order to return a moderated content label. Confidence represents how * certain Amazon Rekognition is that the moderated content is correctly * identified. 0 is the lowest confidence. 100 is the highest confidence. * Amazon Rekognition doesn't return any moderated content labels with a * confidence level lower than this specified value. If you don't specify * MinConfidence, GetContentModeration returns * labels with confidence values greater than or equal to 50 percent. *

*

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

* Idempotent token used to identify the start request. If you use the same * token with multiple StartContentModeration 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 Amazon SNS topic ARN that you want Amazon Rekognition Video to * publish the completion status of the content analysis to. 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; /** *

* The video in which you want to detect inappropriate, unwanted, or * offensive content. The video must be stored in an Amazon S3 bucket. *

* * @return

* The video in which you want to detect inappropriate, unwanted, or * offensive content. The video must be stored in an Amazon S3 * bucket. *

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

* The video in which you want to detect inappropriate, unwanted, or * offensive content. The video must be stored in an Amazon S3 bucket. *

* * @param video

* The video in which you want to detect inappropriate, unwanted, * or offensive content. 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 inappropriate, unwanted, or * offensive content. 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 inappropriate, unwanted, * or offensive content. 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 StartContentModerationRequest withVideo(Video video) { this.video = video; return this; } /** *

* Specifies the minimum confidence that Amazon Rekognition must have in * order to return a moderated content label. Confidence represents how * certain Amazon Rekognition is that the moderated content is correctly * identified. 0 is the lowest confidence. 100 is the highest confidence. * Amazon Rekognition doesn't return any moderated content labels with a * confidence level lower than this specified value. If you don't specify * MinConfidence, GetContentModeration returns * labels with confidence values greater than or equal to 50 percent. *

*

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

* Specifies the minimum confidence that Amazon Rekognition must * have in order to return a moderated content label. Confidence * represents how certain Amazon Rekognition is that the moderated * content is correctly identified. 0 is the lowest confidence. 100 * is the highest confidence. Amazon Rekognition doesn't return any * moderated content labels with a confidence level lower than this * specified value. If you don't specify MinConfidence, * GetContentModeration returns labels with confidence * values greater than or equal to 50 percent. *

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

* Specifies the minimum confidence that Amazon Rekognition must have in * order to return a moderated content label. Confidence represents how * certain Amazon Rekognition is that the moderated content is correctly * identified. 0 is the lowest confidence. 100 is the highest confidence. * Amazon Rekognition doesn't return any moderated content labels with a * confidence level lower than this specified value. If you don't specify * MinConfidence, GetContentModeration returns * labels 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 must * have in order to return a moderated content label. Confidence * represents how certain Amazon Rekognition is that the * moderated content is correctly identified. 0 is the lowest * confidence. 100 is the highest confidence. Amazon Rekognition * doesn't return any moderated content labels with a confidence * level lower than this specified value. If you don't specify * MinConfidence, GetContentModeration * returns labels 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 must have in * order to return a moderated content label. Confidence represents how * certain Amazon Rekognition is that the moderated content is correctly * identified. 0 is the lowest confidence. 100 is the highest confidence. * Amazon Rekognition doesn't return any moderated content labels with a * confidence level lower than this specified value. If you don't specify * MinConfidence, GetContentModeration returns * labels 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 must * have in order to return a moderated content label. Confidence * represents how certain Amazon Rekognition is that the * moderated content is correctly identified. 0 is the lowest * confidence. 100 is the highest confidence. Amazon Rekognition * doesn't return any moderated content labels with a confidence * level lower than this specified value. If you don't specify * MinConfidence, GetContentModeration * returns labels 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 StartContentModerationRequest withMinConfidence(Float minConfidence) { this.minConfidence = minConfidence; return this; } /** *

* Idempotent token used to identify the start request. If you use the same * token with multiple StartContentModeration 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 StartContentModeration * 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 StartContentModeration 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 * StartContentModeration 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 StartContentModeration 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 * StartContentModeration 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 StartContentModerationRequest withClientRequestToken(String clientRequestToken) { this.clientRequestToken = clientRequestToken; return this; } /** *

* The Amazon SNS topic ARN that you want Amazon Rekognition Video to * publish the completion status of the content analysis to. 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 Amazon SNS topic ARN that you want Amazon Rekognition Video * to publish the completion status of the content analysis to. 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 Amazon SNS topic ARN that you want Amazon Rekognition Video to * publish the completion status of the content analysis to. 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 Amazon SNS topic ARN that you want Amazon Rekognition * Video to publish the completion status of the content analysis * to. 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 Amazon SNS topic ARN that you want Amazon Rekognition Video to * publish the completion status of the content analysis to. 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 Amazon SNS topic ARN that you want Amazon Rekognition * Video to publish the completion status of the content analysis * to. 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 StartContentModerationRequest 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 StartContentModerationRequest withJobTag(String jobTag) { this.jobTag = jobTag; 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 (getMinConfidence() != null) sb.append("MinConfidence: " + getMinConfidence() + ","); if (getClientRequestToken() != null) sb.append("ClientRequestToken: " + getClientRequestToken() + ","); if (getNotificationChannel() != null) sb.append("NotificationChannel: " + getNotificationChannel() + ","); if (getJobTag() != null) sb.append("JobTag: " + getJobTag()); 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 + ((getMinConfidence() == null) ? 0 : getMinConfidence().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()); return hashCode; } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof StartContentModerationRequest == false) return false; StartContentModerationRequest other = (StartContentModerationRequest) obj; if (other.getVideo() == null ^ this.getVideo() == null) return false; if (other.getVideo() != null && other.getVideo().equals(this.getVideo()) == 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.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; return true; } }