/* * 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 StartCelebrityRecognitionRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *
* The video in which you want to recognize celebrities. 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
* StartCelebrityRecognition
requests, the same JobId
is returned. Use
* ClientRequestToken
to prevent the same job from being accidently started more than once.
*
* The Amazon SNS topic ARN that you want Amazon Rekognition Video to publish the completion status of the celebrity * recognition analysis 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 video in which you want to recognize celebrities. The video must be stored in an Amazon S3 bucket. *
* * @param video * The video in which you want to recognize celebrities. 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 recognize celebrities. The video must be stored in an Amazon S3 bucket. *
* * @return The video in which you want to recognize celebrities. The video must be stored in an Amazon S3 bucket. */ public Video getVideo() { return this.video; } /** ** The video in which you want to recognize celebrities. The video must be stored in an Amazon S3 bucket. *
* * @param video * The video in which you want to recognize celebrities. 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 StartCelebrityRecognitionRequest withVideo(Video video) { setVideo(video); return this; } /** *
* Idempotent token used to identify the start request. If you use the same token with multiple
* StartCelebrityRecognition
requests, the same JobId
is returned. Use
* ClientRequestToken
to prevent the same job from being accidently started more than once.
*
StartCelebrityRecognition
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
* StartCelebrityRecognition
requests, the same JobId
is returned. Use
* ClientRequestToken
to prevent the same job from being accidently started more than once.
*
StartCelebrityRecognition
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
* StartCelebrityRecognition
requests, the same JobId
is returned. Use
* ClientRequestToken
to prevent the same job from being accidently started more than once.
*
StartCelebrityRecognition
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 StartCelebrityRecognitionRequest withClientRequestToken(String clientRequestToken) {
setClientRequestToken(clientRequestToken);
return this;
}
/**
* * The Amazon SNS topic ARN that you want Amazon Rekognition Video to publish the completion status of the celebrity * recognition analysis 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 that you want Amazon Rekognition Video to publish the completion status of the * celebrity recognition analysis 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 that you want Amazon Rekognition Video to publish the completion status of the celebrity * recognition analysis 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 that you want Amazon Rekognition Video to publish the completion status of the * celebrity recognition analysis 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 that you want Amazon Rekognition Video to publish the completion status of the celebrity * recognition analysis 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 that you want Amazon Rekognition Video to publish the completion status of the * celebrity recognition analysis 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 StartCelebrityRecognitionRequest 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 StartCelebrityRecognitionRequest 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 (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 StartCelebrityRecognitionRequest == false)
return false;
StartCelebrityRecognitionRequest other = (StartCelebrityRecognitionRequest) 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;
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 + ((getJobTag() == null) ? 0 : getJobTag().hashCode());
return hashCode;
}
@Override
public StartCelebrityRecognitionRequest clone() {
return (StartCelebrityRecognitionRequest) super.clone();
}
}