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

* Removes the association between a Face supplied in an array of * FaceIds and the User. If the User is not present already, then a * ResourceNotFound exception is thrown. If successful, an array of * faces that are disassociated from the User is returned. If a given face is * already disassociated from the given UserID, it will be ignored and not be * returned in the response. If a given face is already associated with a * different User or not found in the collection it will be returned as part of * UnsuccessfulDisassociations. You can remove 1 - 100 face IDs * from a user at one time. *

*/ public class DisassociateFacesRequest 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; /** *

* ID for the existing UserID. *

*

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

* Idempotent token used to identify the request to * DisassociateFaces. If you use the same token with multiple * DisassociateFaces 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; /** *

* An array of face IDs to disassociate from the UserID. *

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

* 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 DisassociateFacesRequest withCollectionId(String collectionId) { this.collectionId = collectionId; return this; } /** *

* ID for the existing UserID. *

*

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

* ID for the existing UserID. *

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

* ID for the existing UserID. *

*

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

* ID for the existing UserID. *

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

* 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

* ID for the existing UserID. *

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

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

* An array of face IDs to disassociate from the UserID. *

* * @return

* An array of face IDs to disassociate from the UserID. *

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

* An array of face IDs to disassociate from the UserID. *

* * @param faceIds

* An array of face IDs to disassociate from 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 face IDs to disassociate from the UserID. *

*

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

* An array of face IDs to disassociate from the UserID. *

* @return A reference to this updated object so that method calls can be * chained together. */ public DisassociateFacesRequest 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 face IDs to disassociate from the UserID. *

*

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

* An array of face IDs to disassociate from the UserID. *

* @return A reference to this updated object so that method calls can be * chained together. */ public DisassociateFacesRequest withFaceIds(java.util.Collection faceIds) { setFaceIds(faceIds); 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 (getClientRequestToken() != null) sb.append("ClientRequestToken: " + getClientRequestToken() + ","); if (getFaceIds() != null) sb.append("FaceIds: " + getFaceIds()); 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 + ((getClientRequestToken() == null) ? 0 : getClientRequestToken().hashCode()); hashCode = prime * hashCode + ((getFaceIds() == null) ? 0 : getFaceIds().hashCode()); return hashCode; } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof DisassociateFacesRequest == false) return false; DisassociateFacesRequest other = (DisassociateFacesRequest) 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.getClientRequestToken() == null ^ this.getClientRequestToken() == null) return false; if (other.getClientRequestToken() != null && other.getClientRequestToken().equals(this.getClientRequestToken()) == false) return false; if (other.getFaceIds() == null ^ this.getFaceIds() == null) return false; if (other.getFaceIds() != null && other.getFaceIds().equals(this.getFaceIds()) == false) return false; return true; } }