/*
 * 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 StartFaceDetectionRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {

    /**
     * <p>
     * The video in which you want to detect faces. The video must be stored in an Amazon S3 bucket.
     * </p>
     */
    private Video video;
    /**
     * <p>
     * Idempotent token used to identify the start request. If you use the same token with multiple
     * <code>StartFaceDetection</code> requests, the same <code>JobId</code> is returned. Use
     * <code>ClientRequestToken</code> to prevent the same job from being accidently started more than once.
     * </p>
     */
    private String clientRequestToken;
    /**
     * <p>
     * The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of
     * the face detection operation. The Amazon SNS topic must have a topic name that begins with
     * <i>AmazonRekognition</i> if you are using the AmazonRekognitionServiceRole permissions policy.
     * </p>
     */
    private NotificationChannel notificationChannel;
    /**
     * <p>
     * The face attributes you want returned.
     * </p>
     * <p>
     * <code>DEFAULT</code> - The following subset of facial attributes are returned: BoundingBox, Confidence, Pose,
     * Quality and Landmarks.
     * </p>
     * <p>
     * <code>ALL</code> - All facial attributes are returned.
     * </p>
     */
    private String faceAttributes;
    /**
     * <p>
     * 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 <code>JobTag</code> to group related jobs and identify them
     * in the completion notification.
     * </p>
     */
    private String jobTag;

    /**
     * <p>
     * The video in which you want to detect faces. The video must be stored in an Amazon S3 bucket.
     * </p>
     * 
     * @param video
     *        The video in which you want to detect faces. The video must be stored in an Amazon S3 bucket.
     */

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

    /**
     * <p>
     * The video in which you want to detect faces. The video must be stored in an Amazon S3 bucket.
     * </p>
     * 
     * @return The video in which you want to detect faces. The video must be stored in an Amazon S3 bucket.
     */

    public Video getVideo() {
        return this.video;
    }

    /**
     * <p>
     * The video in which you want to detect faces. The video must be stored in an Amazon S3 bucket.
     * </p>
     * 
     * @param video
     *        The video in which you want to detect faces. 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 StartFaceDetectionRequest withVideo(Video video) {
        setVideo(video);
        return this;
    }

    /**
     * <p>
     * Idempotent token used to identify the start request. If you use the same token with multiple
     * <code>StartFaceDetection</code> requests, the same <code>JobId</code> is returned. Use
     * <code>ClientRequestToken</code> to prevent the same job from being accidently started more than once.
     * </p>
     * 
     * @param clientRequestToken
     *        Idempotent token used to identify the start request. If you use the same token with multiple
     *        <code>StartFaceDetection</code> requests, the same <code>JobId</code> is returned. Use
     *        <code>ClientRequestToken</code> to prevent the same job from being accidently started more than once.
     */

    public void setClientRequestToken(String clientRequestToken) {
        this.clientRequestToken = clientRequestToken;
    }

    /**
     * <p>
     * Idempotent token used to identify the start request. If you use the same token with multiple
     * <code>StartFaceDetection</code> requests, the same <code>JobId</code> is returned. Use
     * <code>ClientRequestToken</code> to prevent the same job from being accidently started more than once.
     * </p>
     * 
     * @return Idempotent token used to identify the start request. If you use the same token with multiple
     *         <code>StartFaceDetection</code> requests, the same <code>JobId</code> is returned. Use
     *         <code>ClientRequestToken</code> to prevent the same job from being accidently started more than once.
     */

    public String getClientRequestToken() {
        return this.clientRequestToken;
    }

    /**
     * <p>
     * Idempotent token used to identify the start request. If you use the same token with multiple
     * <code>StartFaceDetection</code> requests, the same <code>JobId</code> is returned. Use
     * <code>ClientRequestToken</code> to prevent the same job from being accidently started more than once.
     * </p>
     * 
     * @param clientRequestToken
     *        Idempotent token used to identify the start request. If you use the same token with multiple
     *        <code>StartFaceDetection</code> requests, the same <code>JobId</code> is returned. Use
     *        <code>ClientRequestToken</code> 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 StartFaceDetectionRequest withClientRequestToken(String clientRequestToken) {
        setClientRequestToken(clientRequestToken);
        return this;
    }

    /**
     * <p>
     * The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of
     * the face detection operation. The Amazon SNS topic must have a topic name that begins with
     * <i>AmazonRekognition</i> if you are using the AmazonRekognitionServiceRole permissions policy.
     * </p>
     * 
     * @param notificationChannel
     *        The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion
     *        status of the face detection operation. The Amazon SNS topic must have a topic name that begins with
     *        <i>AmazonRekognition</i> if you are using the AmazonRekognitionServiceRole permissions policy.
     */

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

    /**
     * <p>
     * The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of
     * the face detection operation. The Amazon SNS topic must have a topic name that begins with
     * <i>AmazonRekognition</i> if you are using the AmazonRekognitionServiceRole permissions policy.
     * </p>
     * 
     * @return The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion
     *         status of the face detection operation. The Amazon SNS topic must have a topic name that begins with
     *         <i>AmazonRekognition</i> if you are using the AmazonRekognitionServiceRole permissions policy.
     */

    public NotificationChannel getNotificationChannel() {
        return this.notificationChannel;
    }

    /**
     * <p>
     * The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of
     * the face detection operation. The Amazon SNS topic must have a topic name that begins with
     * <i>AmazonRekognition</i> if you are using the AmazonRekognitionServiceRole permissions policy.
     * </p>
     * 
     * @param notificationChannel
     *        The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion
     *        status of the face detection operation. The Amazon SNS topic must have a topic name that begins with
     *        <i>AmazonRekognition</i> if you are using the AmazonRekognitionServiceRole permissions policy.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public StartFaceDetectionRequest withNotificationChannel(NotificationChannel notificationChannel) {
        setNotificationChannel(notificationChannel);
        return this;
    }

    /**
     * <p>
     * The face attributes you want returned.
     * </p>
     * <p>
     * <code>DEFAULT</code> - The following subset of facial attributes are returned: BoundingBox, Confidence, Pose,
     * Quality and Landmarks.
     * </p>
     * <p>
     * <code>ALL</code> - All facial attributes are returned.
     * </p>
     * 
     * @param faceAttributes
     *        The face attributes you want returned.</p>
     *        <p>
     *        <code>DEFAULT</code> - The following subset of facial attributes are returned: BoundingBox, Confidence,
     *        Pose, Quality and Landmarks.
     *        </p>
     *        <p>
     *        <code>ALL</code> - All facial attributes are returned.
     * @see FaceAttributes
     */

    public void setFaceAttributes(String faceAttributes) {
        this.faceAttributes = faceAttributes;
    }

    /**
     * <p>
     * The face attributes you want returned.
     * </p>
     * <p>
     * <code>DEFAULT</code> - The following subset of facial attributes are returned: BoundingBox, Confidence, Pose,
     * Quality and Landmarks.
     * </p>
     * <p>
     * <code>ALL</code> - All facial attributes are returned.
     * </p>
     * 
     * @return The face attributes you want returned.</p>
     *         <p>
     *         <code>DEFAULT</code> - The following subset of facial attributes are returned: BoundingBox, Confidence,
     *         Pose, Quality and Landmarks.
     *         </p>
     *         <p>
     *         <code>ALL</code> - All facial attributes are returned.
     * @see FaceAttributes
     */

    public String getFaceAttributes() {
        return this.faceAttributes;
    }

    /**
     * <p>
     * The face attributes you want returned.
     * </p>
     * <p>
     * <code>DEFAULT</code> - The following subset of facial attributes are returned: BoundingBox, Confidence, Pose,
     * Quality and Landmarks.
     * </p>
     * <p>
     * <code>ALL</code> - All facial attributes are returned.
     * </p>
     * 
     * @param faceAttributes
     *        The face attributes you want returned.</p>
     *        <p>
     *        <code>DEFAULT</code> - The following subset of facial attributes are returned: BoundingBox, Confidence,
     *        Pose, Quality and Landmarks.
     *        </p>
     *        <p>
     *        <code>ALL</code> - All facial attributes are returned.
     * @return Returns a reference to this object so that method calls can be chained together.
     * @see FaceAttributes
     */

    public StartFaceDetectionRequest withFaceAttributes(String faceAttributes) {
        setFaceAttributes(faceAttributes);
        return this;
    }

    /**
     * <p>
     * The face attributes you want returned.
     * </p>
     * <p>
     * <code>DEFAULT</code> - The following subset of facial attributes are returned: BoundingBox, Confidence, Pose,
     * Quality and Landmarks.
     * </p>
     * <p>
     * <code>ALL</code> - All facial attributes are returned.
     * </p>
     * 
     * @param faceAttributes
     *        The face attributes you want returned.</p>
     *        <p>
     *        <code>DEFAULT</code> - The following subset of facial attributes are returned: BoundingBox, Confidence,
     *        Pose, Quality and Landmarks.
     *        </p>
     *        <p>
     *        <code>ALL</code> - All facial attributes are returned.
     * @return Returns a reference to this object so that method calls can be chained together.
     * @see FaceAttributes
     */

    public StartFaceDetectionRequest withFaceAttributes(FaceAttributes faceAttributes) {
        this.faceAttributes = faceAttributes.toString();
        return this;
    }

    /**
     * <p>
     * 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 <code>JobTag</code> to group related jobs and identify them
     * in the completion notification.
     * </p>
     * 
     * @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 <code>JobTag</code> to group related jobs and
     *        identify them in the completion notification.
     */

    public void setJobTag(String jobTag) {
        this.jobTag = jobTag;
    }

    /**
     * <p>
     * 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 <code>JobTag</code> to group related jobs and identify them
     * in the completion notification.
     * </p>
     * 
     * @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 <code>JobTag</code> to group related jobs and
     *         identify them in the completion notification.
     */

    public String getJobTag() {
        return this.jobTag;
    }

    /**
     * <p>
     * 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 <code>JobTag</code> to group related jobs and identify them
     * in the completion notification.
     * </p>
     * 
     * @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 <code>JobTag</code> 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 StartFaceDetectionRequest withJobTag(String jobTag) {
        setJobTag(jobTag);
        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 (getNotificationChannel() != null)
            sb.append("NotificationChannel: ").append(getNotificationChannel()).append(",");
        if (getFaceAttributes() != null)
            sb.append("FaceAttributes: ").append(getFaceAttributes()).append(",");
        if (getJobTag() != null)
            sb.append("JobTag: ").append(getJobTag());
        sb.append("}");
        return sb.toString();
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj)
            return true;
        if (obj == null)
            return false;

        if (obj instanceof StartFaceDetectionRequest == false)
            return false;
        StartFaceDetectionRequest other = (StartFaceDetectionRequest) 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.getFaceAttributes() == null ^ this.getFaceAttributes() == null)
            return false;
        if (other.getFaceAttributes() != null && other.getFaceAttributes().equals(this.getFaceAttributes()) == 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;
    }

    @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 + ((getFaceAttributes() == null) ? 0 : getFaceAttributes().hashCode());
        hashCode = prime * hashCode + ((getJobTag() == null) ? 0 : getJobTag().hashCode());
        return hashCode;
    }

    @Override
    public StartFaceDetectionRequest clone() {
        return (StartFaceDetectionRequest) super.clone();
    }

}