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

* Creates a new User within a collection specified by CollectionId * . Takes UserId as a parameter, which is a user provided ID which * should be unique within the collection. The provided UserId will * alias the system generated UUID to make the UserId more user * friendly. *

*

* Uses a ClientToken, an idempotency token that ensures a call to * CreateUser completes only once. If the value is not supplied, * the AWS SDK generates an idempotency token for the requests. This prevents * retries after a network error results from making multiple * CreateUser calls. *

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

* The ID of an existing collection to which the new UserID needs to be * created. *

*

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

* ID for the UserID to be created. This ID needs to be unique within the * collection. *

*

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

* Idempotent token used to identify the request to CreateUser. * If you use the same token with multiple CreateUser 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 to which the new UserID needs to be * created. *

*

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

* The ID of an existing collection to which the new UserID needs to * be created. *

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

* The ID of an existing collection to which the new UserID needs to be * created. *

*

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

* The ID of an existing collection to which the new UserID needs * to be created. *

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

* The ID of an existing collection to which the new UserID needs to be * created. *

*

* 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 to which the new UserID needs * to be created. *

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

* ID for the UserID to be created. This ID needs to be unique within the * collection. *

*

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

* ID for the UserID to be created. This ID needs to be unique * within the collection. *

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

* ID for the UserID to be created. This ID needs to be unique within the * collection. *

*

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

* ID for the UserID to be created. This ID needs to be unique * within the collection. *

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

* ID for the UserID to be created. This ID needs to be unique within the * collection. *

*

* 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 UserID to be created. This ID needs to be unique * within the collection. *

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

* Idempotent token used to identify the request to CreateUser. * If you use the same token with multiple CreateUser 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 * CreateUser. If you use the same token with multiple * CreateUser 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 CreateUser. * If you use the same token with multiple CreateUser 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 * CreateUser. If you use the same token with * multiple CreateUser 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 CreateUser. * If you use the same token with multiple CreateUser 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 * CreateUser. If you use the same token with * multiple CreateUser 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 CreateUserRequest 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 (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 + ((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 CreateUserRequest == false) return false; CreateUserRequest other = (CreateUserRequest) 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; return true; } }