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

* Associates one or more faces with an existing UserID. Takes an array of * FaceIds. Each FaceId that are present in the * FaceIds list is associated with the provided UserID. The maximum * number of total FaceIds per UserID is 100. *

*

* The UserMatchThreshold parameter specifies the minimum user * match confidence required for the face to be associated with a UserID that * has at least one FaceID already associated. This ensures that * the FaceIds are associated with the right UserID. The value * ranges from 0-100 and default value is 75. *

*

* If successful, an array of AssociatedFace objects containing the * associated FaceIds is returned. If a given face is already * associated with the given UserID, it will be ignored and will * not be returned in the response. If a given face is already associated to a * different UserID, isn't found in the collection, doesn’t meet * the UserMatchThreshold, or there are already 100 faces * associated with the UserID, it will be returned as part of an * array of UnsuccessfulFaceAssociations. *

*

* The UserStatus reflects the status of an operation which updates * a UserID representation with a list of given faces. The * UserStatus can be: *

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

* The ID of an existing collection containing the UserID. *

*

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

* The ID for the existing UserID. *

*

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

* An array of FaceIDs to associate with the UserID. *

*/ private java.util.List faceIds; /** *

* An optional value specifying the minimum confidence in the UserID match * to return. The default value is 75. *

*

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

* Idempotent token used to identify the request to * AssociateFaces. If you use the same token with multiple * AssociateFaces requests, the same response is returned. Use * ClientRequestToken to prevent the same request from being processed more * than once. *

*

* Constraints:
* Length: 1 - 64
* Pattern: ^[a-zA-Z0-9-_]+$
*/ private String clientRequestToken; /** *

* The ID of an existing collection containing the UserID. *

*

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

* The ID of an existing collection containing the UserID. *

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

* The ID of an existing collection containing the UserID. *

*

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

* The ID of an existing collection containing the UserID. *

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

* The ID of an existing collection containing the UserID. *

*

* 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

* The ID of an existing collection containing the UserID. *

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

* The ID for the existing UserID. *

*

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

* The ID for the existing UserID. *

*/ public String getUserId() { return userId; } /** *

* The ID for the existing UserID. *

*

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

* The ID for the existing UserID. *

*/ public void setUserId(String userId) { this.userId = userId; } /** *

* The ID for the existing UserID. *

*

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

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

* The ID for the existing UserID. *

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

* An array of FaceIDs to associate with the UserID. *

* * @return

* An array of FaceIDs to associate with the UserID. *

*/ public java.util.List getFaceIds() { return faceIds; } /** *

* An array of FaceIDs to associate with the UserID. *

* * @param faceIds

* An array of FaceIDs to associate with the UserID. *

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

* An array of FaceIDs to associate with the UserID. *

*

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

* An array of FaceIDs to associate with the UserID. *

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

* An array of FaceIDs to associate with the UserID. *

*

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

* An array of FaceIDs to associate with the UserID. *

* @return A reference to this updated object so that method calls can be * chained together. */ public AssociateFacesRequest withFaceIds(java.util.Collection faceIds) { setFaceIds(faceIds); return this; } /** *

* An optional value specifying the minimum confidence in the UserID match * to return. The default value is 75. *

*

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

* An optional value specifying the minimum confidence in the UserID * match to return. The default value is 75. *

*/ public Float getUserMatchThreshold() { return userMatchThreshold; } /** *

* An optional value specifying the minimum confidence in the UserID match * to return. The default value is 75. *

*

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

* An optional value specifying the minimum confidence in the * UserID match to return. The default value is 75. *

*/ public void setUserMatchThreshold(Float userMatchThreshold) { this.userMatchThreshold = userMatchThreshold; } /** *

* An optional value specifying the minimum confidence in the UserID match * to return. The default value is 75. *

*

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

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

* An optional value specifying the minimum confidence in the * UserID match to return. The default value is 75. *

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

* Idempotent token used to identify the request to * AssociateFaces. If you use the same token with multiple * AssociateFaces requests, the same response is returned. Use * ClientRequestToken to prevent the same request from being processed more * than once. *

*

* Constraints:
* Length: 1 - 64
* Pattern: ^[a-zA-Z0-9-_]+$
* * @return

* Idempotent token used to identify the request to * AssociateFaces. If you use the same token with * multiple AssociateFaces requests, the same response * is returned. Use ClientRequestToken to prevent the same request * from being processed more than once. *

*/ public String getClientRequestToken() { return clientRequestToken; } /** *

* Idempotent token used to identify the request to * AssociateFaces. If you use the same token with multiple * AssociateFaces requests, the same response is returned. Use * ClientRequestToken to prevent the same request from being processed more * than once. *

*

* Constraints:
* Length: 1 - 64
* Pattern: ^[a-zA-Z0-9-_]+$
* * @param clientRequestToken

* Idempotent token used to identify the request to * AssociateFaces. If you use the same token with * multiple AssociateFaces requests, the same * response is returned. Use ClientRequestToken to prevent the * same request from being processed more than once. *

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

* Idempotent token used to identify the request to * AssociateFaces. If you use the same token with multiple * AssociateFaces requests, the same response is returned. Use * ClientRequestToken to prevent the same request from being processed 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 request to * AssociateFaces. If you use the same token with * multiple AssociateFaces requests, the same * response is returned. Use ClientRequestToken to prevent the * same request from being processed more than once. *

* @return A reference to this updated object so that method calls can be * chained together. */ public AssociateFacesRequest withClientRequestToken(String clientRequestToken) { this.clientRequestToken = clientRequestToken; 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 (getCollectionId() != null) sb.append("CollectionId: " + getCollectionId() + ","); if (getUserId() != null) sb.append("UserId: " + getUserId() + ","); if (getFaceIds() != null) sb.append("FaceIds: " + getFaceIds() + ","); if (getUserMatchThreshold() != null) sb.append("UserMatchThreshold: " + getUserMatchThreshold() + ","); if (getClientRequestToken() != null) sb.append("ClientRequestToken: " + getClientRequestToken()); sb.append("}"); return sb.toString(); } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getCollectionId() == null) ? 0 : getCollectionId().hashCode()); hashCode = prime * hashCode + ((getUserId() == null) ? 0 : getUserId().hashCode()); hashCode = prime * hashCode + ((getFaceIds() == null) ? 0 : getFaceIds().hashCode()); hashCode = prime * hashCode + ((getUserMatchThreshold() == null) ? 0 : getUserMatchThreshold().hashCode()); hashCode = prime * hashCode + ((getClientRequestToken() == null) ? 0 : getClientRequestToken().hashCode()); return hashCode; } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof AssociateFacesRequest == false) return false; AssociateFacesRequest other = (AssociateFacesRequest) obj; if (other.getCollectionId() == null ^ this.getCollectionId() == null) return false; if (other.getCollectionId() != null && other.getCollectionId().equals(this.getCollectionId()) == false) return false; if (other.getUserId() == null ^ this.getUserId() == null) return false; if (other.getUserId() != null && other.getUserId().equals(this.getUserId()) == false) return false; if (other.getFaceIds() == null ^ this.getFaceIds() == null) return false; if (other.getFaceIds() != null && other.getFaceIds().equals(this.getFaceIds()) == false) return false; if (other.getUserMatchThreshold() == null ^ this.getUserMatchThreshold() == null) return false; if (other.getUserMatchThreshold() != null && other.getUserMatchThreshold().equals(this.getUserMatchThreshold()) == false) return false; if (other.getClientRequestToken() == null ^ this.getClientRequestToken() == null) return false; if (other.getClientRequestToken() != null && other.getClientRequestToken().equals(this.getClientRequestToken()) == false) return false; return true; } }