/* * 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 the asynchronous search for faces in a collection that match the faces * of persons detected in a stored video. *

*

* The video must be stored in an Amazon S3 bucket. Use Video to specify * the bucket name and the filename of the video. StartFaceSearch * returns a job identifier (JobId) which you use to get the search * results once the search has completed. When searching is finished, Amazon * Rekognition Video publishes a completion status to the Amazon Simple * Notification Service topic that you specify in * NotificationChannel. To get the search results, first check that * the status value published to the Amazon SNS topic is SUCCEEDED. * If so, call GetFaceSearch and pass the job identifier ( * JobId) from the initial call to StartFaceSearch. * For more information, see Searching stored videos for faces. *

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

* The video you want to search. 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 StartFaceSearch 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 minimum confidence in the person match to return. For example, don't * return any matches where confidence in matches is less than 70%. The * default value is 80%. *

*

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

* ID of the collection that contains the faces you want to search for. *

*

* Constraints:
* Length: 1 - 255
* Pattern: [a-zA-Z0-9_.\-]+
*/ private String collectionId; /** *

* The ARN of the Amazon SNS topic to which you want Amazon Rekognition * Video to publish the completion status of the search. 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 you want to search. The video must be stored in an Amazon S3 * bucket. *

* * @return

* The video you want to search. The video must be stored in an * Amazon S3 bucket. *

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

* The video you want to search. The video must be stored in an Amazon S3 * bucket. *

* * @param video

* The video you want to search. The video must be stored in an * Amazon S3 bucket. *

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

* The video you want to search. 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 you want to search. 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 StartFaceSearchRequest withVideo(Video video) { this.video = video; return this; } /** *

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

* The minimum confidence in the person match to return. For example, don't * return any matches where confidence in matches is less than 70%. The * default value is 80%. *

*

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

* The minimum confidence in the person match to return. For * example, don't return any matches where confidence in matches is * less than 70%. The default value is 80%. *

*/ public Float getFaceMatchThreshold() { return faceMatchThreshold; } /** *

* The minimum confidence in the person match to return. For example, don't * return any matches where confidence in matches is less than 70%. The * default value is 80%. *

*

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

* The minimum confidence in the person match to return. For * example, don't return any matches where confidence in matches * is less than 70%. The default value is 80%. *

*/ public void setFaceMatchThreshold(Float faceMatchThreshold) { this.faceMatchThreshold = faceMatchThreshold; } /** *

* The minimum confidence in the person match to return. For example, don't * return any matches where confidence in matches is less than 70%. The * default value is 80%. *

*

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

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

* The minimum confidence in the person match to return. For * example, don't return any matches where confidence in matches * is less than 70%. The default value is 80%. *

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

* ID of the collection that contains the faces you want to search for. *

*

* Constraints:
* Length: 1 - 255
* Pattern: [a-zA-Z0-9_.\-]+
* * @return

* ID of the collection that contains the faces you want to search * for. *

*/ public String getCollectionId() { return collectionId; } /** *

* ID of the collection that contains the faces you want to search for. *

*

* Constraints:
* Length: 1 - 255
* Pattern: [a-zA-Z0-9_.\-]+
* * @param collectionId

* ID of the collection that contains the faces you want to * search for. *

*/ public void setCollectionId(String collectionId) { this.collectionId = collectionId; } /** *

* ID of the collection that contains the faces you want to search for. *

*

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

* Constraints:
* Length: 1 - 255
* Pattern: [a-zA-Z0-9_.\-]+
* * @param collectionId

* ID of the collection that contains the faces you want to * search for. *

* @return A reference to this updated object so that method calls can be * chained together. */ public StartFaceSearchRequest withCollectionId(String collectionId) { this.collectionId = collectionId; return this; } /** *

* The ARN of the Amazon SNS topic to which you want Amazon Rekognition * Video to publish the completion status of the search. 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 ARN of the Amazon SNS topic to which you want Amazon * Rekognition Video to publish the completion status of the search. * 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 ARN of the Amazon SNS topic to which you want Amazon Rekognition * Video to publish the completion status of the search. 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 ARN of the Amazon SNS topic to which you want Amazon * Rekognition Video to publish the completion status of the * search. 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 ARN of the Amazon SNS topic to which you want Amazon Rekognition * Video to publish the completion status of the search. 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 ARN of the Amazon SNS topic to which you want Amazon * Rekognition Video to publish the completion status of the * search. 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 StartFaceSearchRequest 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 StartFaceSearchRequest 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 (getClientRequestToken() != null) sb.append("ClientRequestToken: " + getClientRequestToken() + ","); if (getFaceMatchThreshold() != null) sb.append("FaceMatchThreshold: " + getFaceMatchThreshold() + ","); if (getCollectionId() != null) sb.append("CollectionId: " + getCollectionId() + ","); 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 + ((getClientRequestToken() == null) ? 0 : getClientRequestToken().hashCode()); hashCode = prime * hashCode + ((getFaceMatchThreshold() == null) ? 0 : getFaceMatchThreshold().hashCode()); hashCode = prime * hashCode + ((getCollectionId() == null) ? 0 : getCollectionId().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 StartFaceSearchRequest == false) return false; StartFaceSearchRequest other = (StartFaceSearchRequest) 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.getFaceMatchThreshold() == null ^ this.getFaceMatchThreshold() == null) return false; if (other.getFaceMatchThreshold() != null && other.getFaceMatchThreshold().equals(this.getFaceMatchThreshold()) == false) return false; if (other.getCollectionId() == null ^ this.getCollectionId() == null) return false; if (other.getCollectionId() != null && other.getCollectionId().equals(this.getCollectionId()) == 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; } }