/* * Copyright 2018-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.cognitoidp.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.AmazonWebServiceRequest; /** *

* Represents the request to get user attribute verification. *

* * @see AWS API Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class GetUserAttributeVerificationCodeRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *

* A non-expired access token for the user whose attribute verification code you want to generate. *

*/ private String accessToken; /** *

* The attribute name returned by the server response to get the user attribute verification code. *

*/ private String attributeName; /** *

* A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers. *

*

* You create custom workflows by assigning Lambda functions to user pool triggers. When you use the * GetUserAttributeVerificationCode API action, Amazon Cognito invokes the function that is assigned to the * custom message trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the * function receives as input. This payload contains a clientMetadata attribute, which provides the * data that you assigned to the ClientMetadata parameter in your GetUserAttributeVerificationCode request. In your * function code in Lambda, you can process the clientMetadata value to enhance your workflow for your * specific needs. *

*

* For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide. *

* *

* When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following: *

* * */ private java.util.Map clientMetadata; /** *

* A non-expired access token for the user whose attribute verification code you want to generate. *

* * @param accessToken * A non-expired access token for the user whose attribute verification code you want to generate. */ public void setAccessToken(String accessToken) { this.accessToken = accessToken; } /** *

* A non-expired access token for the user whose attribute verification code you want to generate. *

* * @return A non-expired access token for the user whose attribute verification code you want to generate. */ public String getAccessToken() { return this.accessToken; } /** *

* A non-expired access token for the user whose attribute verification code you want to generate. *

* * @param accessToken * A non-expired access token for the user whose attribute verification code you want to generate. * @return Returns a reference to this object so that method calls can be chained together. */ public GetUserAttributeVerificationCodeRequest withAccessToken(String accessToken) { setAccessToken(accessToken); return this; } /** *

* The attribute name returned by the server response to get the user attribute verification code. *

* * @param attributeName * The attribute name returned by the server response to get the user attribute verification code. */ public void setAttributeName(String attributeName) { this.attributeName = attributeName; } /** *

* The attribute name returned by the server response to get the user attribute verification code. *

* * @return The attribute name returned by the server response to get the user attribute verification code. */ public String getAttributeName() { return this.attributeName; } /** *

* The attribute name returned by the server response to get the user attribute verification code. *

* * @param attributeName * The attribute name returned by the server response to get the user attribute verification code. * @return Returns a reference to this object so that method calls can be chained together. */ public GetUserAttributeVerificationCodeRequest withAttributeName(String attributeName) { setAttributeName(attributeName); return this; } /** *

* A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers. *

*

* You create custom workflows by assigning Lambda functions to user pool triggers. When you use the * GetUserAttributeVerificationCode API action, Amazon Cognito invokes the function that is assigned to the * custom message trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the * function receives as input. This payload contains a clientMetadata attribute, which provides the * data that you assigned to the ClientMetadata parameter in your GetUserAttributeVerificationCode request. In your * function code in Lambda, you can process the clientMetadata value to enhance your workflow for your * specific needs. *

*

* For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide. *

* *

* When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following: *

* * * * @return A map of custom key-value pairs that you can provide as input for any custom workflows that this action * triggers.

*

* You create custom workflows by assigning Lambda functions to user pool triggers. When you use the * GetUserAttributeVerificationCode API action, Amazon Cognito invokes the function that is assigned to the * custom message trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which * the function receives as input. This payload contains a clientMetadata attribute, which * provides the data that you assigned to the ClientMetadata parameter in your * GetUserAttributeVerificationCode request. In your function code in Lambda, you can process the * clientMetadata value to enhance your workflow for your specific needs. *

*

* For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide. *

* *

* When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following: *

* */ public java.util.Map getClientMetadata() { return clientMetadata; } /** *

* A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers. *

*

* You create custom workflows by assigning Lambda functions to user pool triggers. When you use the * GetUserAttributeVerificationCode API action, Amazon Cognito invokes the function that is assigned to the * custom message trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the * function receives as input. This payload contains a clientMetadata attribute, which provides the * data that you assigned to the ClientMetadata parameter in your GetUserAttributeVerificationCode request. In your * function code in Lambda, you can process the clientMetadata value to enhance your workflow for your * specific needs. *

*

* For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide. *

* *

* When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following: *

*
    *
  • *

    * Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool * to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata * parameter serves no purpose. *

    *
    • *
  • *

    * Validate the ClientMetadata value. *

    *
    • *
  • *

    * Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information. *

    *
    • *
* * * @param clientMetadata * A map of custom key-value pairs that you can provide as input for any custom workflows that this action * triggers.

*

* You create custom workflows by assigning Lambda functions to user pool triggers. When you use the * GetUserAttributeVerificationCode API action, Amazon Cognito invokes the function that is assigned to the * custom message trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which * the function receives as input. This payload contains a clientMetadata attribute, which * provides the data that you assigned to the ClientMetadata parameter in your * GetUserAttributeVerificationCode request. In your function code in Lambda, you can process the * clientMetadata value to enhance your workflow for your specific needs. *

*

* For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide. *

* *

* When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following: *

*
    *
  • *

    * Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user * pool to support custom workflows. If your user pool configuration doesn't include triggers, the * ClientMetadata parameter serves no purpose. *

    *
    • *
  • *

    * Validate the ClientMetadata value. *

    *
    • *
  • *

    * Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information. *

    *
    • *
*/ public void setClientMetadata(java.util.Map clientMetadata) { this.clientMetadata = clientMetadata; } /** *

* A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers. *

*

* You create custom workflows by assigning Lambda functions to user pool triggers. When you use the * GetUserAttributeVerificationCode API action, Amazon Cognito invokes the function that is assigned to the * custom message trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the * function receives as input. This payload contains a clientMetadata attribute, which provides the * data that you assigned to the ClientMetadata parameter in your GetUserAttributeVerificationCode request. In your * function code in Lambda, you can process the clientMetadata value to enhance your workflow for your * specific needs. *

*

* For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide. *

* *

* When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following: *

*
    *
  • *

    * Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool * to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata * parameter serves no purpose. *

    *
    • *
  • *

    * Validate the ClientMetadata value. *

    *
    • *
  • *

    * Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information. *

    *
    • *
* * * @param clientMetadata * A map of custom key-value pairs that you can provide as input for any custom workflows that this action * triggers.

*

* You create custom workflows by assigning Lambda functions to user pool triggers. When you use the * GetUserAttributeVerificationCode API action, Amazon Cognito invokes the function that is assigned to the * custom message trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which * the function receives as input. This payload contains a clientMetadata attribute, which * provides the data that you assigned to the ClientMetadata parameter in your * GetUserAttributeVerificationCode request. In your function code in Lambda, you can process the * clientMetadata value to enhance your workflow for your specific needs. *

*

* For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide. *

* *

* When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following: *

*
    *
  • *

    * Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user * pool to support custom workflows. If your user pool configuration doesn't include triggers, the * ClientMetadata parameter serves no purpose. *

    *
    • *
  • *

    * Validate the ClientMetadata value. *

    *
    • *
  • *

    * Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information. *

    *
    • *
* @return Returns a reference to this object so that method calls can be chained together. */ public GetUserAttributeVerificationCodeRequest withClientMetadata(java.util.Map clientMetadata) { setClientMetadata(clientMetadata); return this; } /** * Add a single ClientMetadata entry * * @see GetUserAttributeVerificationCodeRequest#withClientMetadata * @returns a reference to this object so that method calls can be chained together. */ public GetUserAttributeVerificationCodeRequest addClientMetadataEntry(String key, String value) { if (null == this.clientMetadata) { this.clientMetadata = new java.util.HashMap(); } if (this.clientMetadata.containsKey(key)) throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided."); this.clientMetadata.put(key, value); return this; } /** * Removes all the entries added into ClientMetadata. * * @return Returns a reference to this object so that method calls can be chained together. */ public GetUserAttributeVerificationCodeRequest clearClientMetadataEntries() { this.clientMetadata = null; return this; } /** * Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be * redacted from this string using a placeholder value. * * @return A string representation of this object. * * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getAccessToken() != null) sb.append("AccessToken: ").append("***Sensitive Data Redacted***").append(","); if (getAttributeName() != null) sb.append("AttributeName: ").append(getAttributeName()).append(","); if (getClientMetadata() != null) sb.append("ClientMetadata: ").append(getClientMetadata()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof GetUserAttributeVerificationCodeRequest == false) return false; GetUserAttributeVerificationCodeRequest other = (GetUserAttributeVerificationCodeRequest) obj; if (other.getAccessToken() == null ^ this.getAccessToken() == null) return false; if (other.getAccessToken() != null && other.getAccessToken().equals(this.getAccessToken()) == false) return false; if (other.getAttributeName() == null ^ this.getAttributeName() == null) return false; if (other.getAttributeName() != null && other.getAttributeName().equals(this.getAttributeName()) == false) return false; if (other.getClientMetadata() == null ^ this.getClientMetadata() == null) return false; if (other.getClientMetadata() != null && other.getClientMetadata().equals(this.getClientMetadata()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getAccessToken() == null) ? 0 : getAccessToken().hashCode()); hashCode = prime * hashCode + ((getAttributeName() == null) ? 0 : getAttributeName().hashCode()); hashCode = prime * hashCode + ((getClientMetadata() == null) ? 0 : getClientMetadata().hashCode()); return hashCode; } @Override public GetUserAttributeVerificationCodeRequest clone() { return (GetUserAttributeVerificationCodeRequest) super.clone(); } }