/* * 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; /** *

* Detects faces within an image that is provided as input. *

*

* DetectFaces detects the 100 largest faces in the image. For each * face detected, the operation returns face details. These details include a * bounding box of the face, a confidence value (that the bounding box contains * a face), and a fixed set of attributes such as facial landmarks (for example, * coordinates of eye and mouth), pose, presence of facial occlusion, and so on. *

*

* The face-detection algorithm is most effective on frontal faces. For * non-frontal or obscured faces, the algorithm might not detect the faces or * might detect faces with lower confidence. *

*

* You pass the input image either as base64-encoded image bytes or as a * reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call * Amazon Rekognition operations, passing image bytes is not supported. The * image must be either a PNG or JPEG formatted file. *

* *

* This is a stateless API operation. That is, the operation does not persist * any data. *

* *

* This operation requires permissions to perform the * rekognition:DetectFaces action. *

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

* The input image as base64-encoded bytes or an S3 object. If you use the * AWS CLI to call Amazon Rekognition operations, passing base64-encoded * image bytes is not supported. *

*

* If you are using an AWS SDK to call Amazon Rekognition, you might not * need to base64-encode image bytes passed using the Bytes * field. For more information, see Images in the Amazon Rekognition * developer guide. *

*/ private Image image; /** *

* An array of facial attributes you want to be returned. A * DEFAULT subset of facial attributes - * BoundingBox, Confidence, Pose, * Quality, and Landmarks - will always be * returned. You can request for specific facial attributes (in addition to * the default list) - by using ["DEFAULT", "FACE_OCCLUDED"] or * just ["FACE_OCCLUDED"]. You can request for all facial * attributes by using ["ALL"]. Requesting more attributes may * increase response time. *

*

* If you provide both, ["ALL", "DEFAULT"], the service uses a * logical "AND" operator to determine which attributes to return (in this * case, all attributes). *

*/ private java.util.List attributes; /** * Default constructor for DetectFacesRequest object. Callers should use the * setter or fluent setter (with...) methods to initialize any additional * object members. */ public DetectFacesRequest() { } /** * Constructs a new DetectFacesRequest object. Callers should use the setter * or fluent setter (with...) methods to initialize any additional object * members. * * @param image

* The input image as base64-encoded bytes or an S3 object. If * you use the AWS CLI to call Amazon Rekognition operations, * passing base64-encoded image bytes is not supported. *

*

* If you are using an AWS SDK to call Amazon Rekognition, you * might not need to base64-encode image bytes passed using the * Bytes field. For more information, see Images in * the Amazon Rekognition developer guide. *

*/ public DetectFacesRequest(Image image) { setImage(image); } /** *

* The input image as base64-encoded bytes or an S3 object. If you use the * AWS CLI to call Amazon Rekognition operations, passing base64-encoded * image bytes is not supported. *

*

* If you are using an AWS SDK to call Amazon Rekognition, you might not * need to base64-encode image bytes passed using the Bytes * field. For more information, see Images in the Amazon Rekognition * developer guide. *

* * @return

* The input image as base64-encoded bytes or an S3 object. If you * use the AWS CLI to call Amazon Rekognition operations, passing * base64-encoded image bytes is not supported. *

*

* If you are using an AWS SDK to call Amazon Rekognition, you might * not need to base64-encode image bytes passed using the * Bytes field. For more information, see Images in the * Amazon Rekognition developer guide. *

*/ public Image getImage() { return image; } /** *

* The input image as base64-encoded bytes or an S3 object. If you use the * AWS CLI to call Amazon Rekognition operations, passing base64-encoded * image bytes is not supported. *

*

* If you are using an AWS SDK to call Amazon Rekognition, you might not * need to base64-encode image bytes passed using the Bytes * field. For more information, see Images in the Amazon Rekognition * developer guide. *

* * @param image

* The input image as base64-encoded bytes or an S3 object. If * you use the AWS CLI to call Amazon Rekognition operations, * passing base64-encoded image bytes is not supported. *

*

* If you are using an AWS SDK to call Amazon Rekognition, you * might not need to base64-encode image bytes passed using the * Bytes field. For more information, see Images in * the Amazon Rekognition developer guide. *

*/ public void setImage(Image image) { this.image = image; } /** *

* The input image as base64-encoded bytes or an S3 object. If you use the * AWS CLI to call Amazon Rekognition operations, passing base64-encoded * image bytes is not supported. *

*

* If you are using an AWS SDK to call Amazon Rekognition, you might not * need to base64-encode image bytes passed using the Bytes * field. For more information, see Images in the Amazon Rekognition * developer guide. *

*

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

* The input image as base64-encoded bytes or an S3 object. If * you use the AWS CLI to call Amazon Rekognition operations, * passing base64-encoded image bytes is not supported. *

*

* If you are using an AWS SDK to call Amazon Rekognition, you * might not need to base64-encode image bytes passed using the * Bytes field. For more information, see Images in * the Amazon Rekognition developer guide. *

* @return A reference to this updated object so that method calls can be * chained together. */ public DetectFacesRequest withImage(Image image) { this.image = image; return this; } /** *

* An array of facial attributes you want to be returned. A * DEFAULT subset of facial attributes - * BoundingBox, Confidence, Pose, * Quality, and Landmarks - will always be * returned. You can request for specific facial attributes (in addition to * the default list) - by using ["DEFAULT", "FACE_OCCLUDED"] or * just ["FACE_OCCLUDED"]. You can request for all facial * attributes by using ["ALL"]. Requesting more attributes may * increase response time. *

*

* If you provide both, ["ALL", "DEFAULT"], the service uses a * logical "AND" operator to determine which attributes to return (in this * case, all attributes). *

* * @return

* An array of facial attributes you want to be returned. A * DEFAULT subset of facial attributes - * BoundingBox, Confidence, * Pose, Quality, and * Landmarks - will always be returned. You can request * for specific facial attributes (in addition to the default list) * - by using ["DEFAULT", "FACE_OCCLUDED"] or just [ * "FACE_OCCLUDED"]. You can request for all facial * attributes by using ["ALL"]. Requesting more * attributes may increase response time. *

*

* If you provide both, ["ALL", "DEFAULT"], the service * uses a logical "AND" operator to determine which attributes to * return (in this case, all attributes). *

*/ public java.util.List getAttributes() { return attributes; } /** *

* An array of facial attributes you want to be returned. A * DEFAULT subset of facial attributes - * BoundingBox, Confidence, Pose, * Quality, and Landmarks - will always be * returned. You can request for specific facial attributes (in addition to * the default list) - by using ["DEFAULT", "FACE_OCCLUDED"] or * just ["FACE_OCCLUDED"]. You can request for all facial * attributes by using ["ALL"]. Requesting more attributes may * increase response time. *

*

* If you provide both, ["ALL", "DEFAULT"], the service uses a * logical "AND" operator to determine which attributes to return (in this * case, all attributes). *

* * @param attributes

* An array of facial attributes you want to be returned. A * DEFAULT subset of facial attributes - * BoundingBox, Confidence, * Pose, Quality, and * Landmarks - will always be returned. You can * request for specific facial attributes (in addition to the * default list) - by using [ * "DEFAULT", "FACE_OCCLUDED"] or just [ * "FACE_OCCLUDED"]. You can request for all facial * attributes by using ["ALL"]. Requesting more * attributes may increase response time. *

*

* If you provide both, ["ALL", "DEFAULT"], the * service uses a logical "AND" operator to determine which * attributes to return (in this case, all attributes). *

*/ public void setAttributes(java.util.Collection attributes) { if (attributes == null) { this.attributes = null; return; } this.attributes = new java.util.ArrayList(attributes); } /** *

* An array of facial attributes you want to be returned. A * DEFAULT subset of facial attributes - * BoundingBox, Confidence, Pose, * Quality, and Landmarks - will always be * returned. You can request for specific facial attributes (in addition to * the default list) - by using ["DEFAULT", "FACE_OCCLUDED"] or * just ["FACE_OCCLUDED"]. You can request for all facial * attributes by using ["ALL"]. Requesting more attributes may * increase response time. *

*

* If you provide both, ["ALL", "DEFAULT"], the service uses a * logical "AND" operator to determine which attributes to return (in this * case, all attributes). *

*

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

* An array of facial attributes you want to be returned. A * DEFAULT subset of facial attributes - * BoundingBox, Confidence, * Pose, Quality, and * Landmarks - will always be returned. You can * request for specific facial attributes (in addition to the * default list) - by using [ * "DEFAULT", "FACE_OCCLUDED"] or just [ * "FACE_OCCLUDED"]. You can request for all facial * attributes by using ["ALL"]. Requesting more * attributes may increase response time. *

*

* If you provide both, ["ALL", "DEFAULT"], the * service uses a logical "AND" operator to determine which * attributes to return (in this case, all attributes). *

* @return A reference to this updated object so that method calls can be * chained together. */ public DetectFacesRequest withAttributes(String... attributes) { if (getAttributes() == null) { this.attributes = new java.util.ArrayList(attributes.length); } for (String value : attributes) { this.attributes.add(value); } return this; } /** *

* An array of facial attributes you want to be returned. A * DEFAULT subset of facial attributes - * BoundingBox, Confidence, Pose, * Quality, and Landmarks - will always be * returned. You can request for specific facial attributes (in addition to * the default list) - by using ["DEFAULT", "FACE_OCCLUDED"] or * just ["FACE_OCCLUDED"]. You can request for all facial * attributes by using ["ALL"]. Requesting more attributes may * increase response time. *

*

* If you provide both, ["ALL", "DEFAULT"], the service uses a * logical "AND" operator to determine which attributes to return (in this * case, all attributes). *

*

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

* An array of facial attributes you want to be returned. A * DEFAULT subset of facial attributes - * BoundingBox, Confidence, * Pose, Quality, and * Landmarks - will always be returned. You can * request for specific facial attributes (in addition to the * default list) - by using [ * "DEFAULT", "FACE_OCCLUDED"] or just [ * "FACE_OCCLUDED"]. You can request for all facial * attributes by using ["ALL"]. Requesting more * attributes may increase response time. *

*

* If you provide both, ["ALL", "DEFAULT"], the * service uses a logical "AND" operator to determine which * attributes to return (in this case, all attributes). *

* @return A reference to this updated object so that method calls can be * chained together. */ public DetectFacesRequest withAttributes(java.util.Collection attributes) { setAttributes(attributes); 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 (getImage() != null) sb.append("Image: " + getImage() + ","); if (getAttributes() != null) sb.append("Attributes: " + getAttributes()); sb.append("}"); return sb.toString(); } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getImage() == null) ? 0 : getImage().hashCode()); hashCode = prime * hashCode + ((getAttributes() == null) ? 0 : getAttributes().hashCode()); return hashCode; } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof DetectFacesRequest == false) return false; DetectFacesRequest other = (DetectFacesRequest) obj; if (other.getImage() == null ^ this.getImage() == null) return false; if (other.getImage() != null && other.getImage().equals(this.getImage()) == false) return false; if (other.getAttributes() == null ^ this.getAttributes() == null) return false; if (other.getAttributes() != null && other.getAttributes().equals(this.getAttributes()) == false) return false; return true; } }