com.amazonaws.services.cognitoidp.model.AdminInitiateAuthRequest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws-java-sdk-cognitoidp Show documentation
Show all versions of aws-java-sdk-cognitoidp Show documentation
The AWS Java SDK for Amazon Cognito Identity Provider Service module holds the client classes that are used for communicating with Amazon Cognito Identity Provider Service.
/*
* Copyright 2011-2016 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 com.amazonaws.AmazonWebServiceRequest;
/**
*
* Initiates the authorization request, as an administrator.
*
*/
public class AdminInitiateAuthRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The ID of the Amazon Cognito user pool.
*
*/
private String userPoolId;
/**
*
* The client app ID.
*
*/
private String clientId;
/**
*
* The authentication flow.
*
*/
private String authFlow;
/**
*
* The authentication parameters.
*
*/
private java.util.Map authParameters;
/**
*
* The client app metadata.
*
*/
private java.util.Map clientMetadata;
/**
*
* The ID of the Amazon Cognito user pool.
*
*
* @param userPoolId
* The ID of the Amazon Cognito user pool.
*/
public void setUserPoolId(String userPoolId) {
this.userPoolId = userPoolId;
}
/**
*
* The ID of the Amazon Cognito user pool.
*
*
* @return The ID of the Amazon Cognito user pool.
*/
public String getUserPoolId() {
return this.userPoolId;
}
/**
*
* The ID of the Amazon Cognito user pool.
*
*
* @param userPoolId
* The ID of the Amazon Cognito user pool.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AdminInitiateAuthRequest withUserPoolId(String userPoolId) {
setUserPoolId(userPoolId);
return this;
}
/**
*
* The client app ID.
*
*
* @param clientId
* The client app ID.
*/
public void setClientId(String clientId) {
this.clientId = clientId;
}
/**
*
* The client app ID.
*
*
* @return The client app ID.
*/
public String getClientId() {
return this.clientId;
}
/**
*
* The client app ID.
*
*
* @param clientId
* The client app ID.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AdminInitiateAuthRequest withClientId(String clientId) {
setClientId(clientId);
return this;
}
/**
*
* The authentication flow.
*
*
* @param authFlow
* The authentication flow.
* @see AuthFlowType
*/
public void setAuthFlow(String authFlow) {
this.authFlow = authFlow;
}
/**
*
* The authentication flow.
*
*
* @return The authentication flow.
* @see AuthFlowType
*/
public String getAuthFlow() {
return this.authFlow;
}
/**
*
* The authentication flow.
*
*
* @param authFlow
* The authentication flow.
* @return Returns a reference to this object so that method calls can be chained together.
* @see AuthFlowType
*/
public AdminInitiateAuthRequest withAuthFlow(String authFlow) {
setAuthFlow(authFlow);
return this;
}
/**
*
* The authentication flow.
*
*
* @param authFlow
* The authentication flow.
* @see AuthFlowType
*/
public void setAuthFlow(AuthFlowType authFlow) {
this.authFlow = authFlow.toString();
}
/**
*
* The authentication flow.
*
*
* @param authFlow
* The authentication flow.
* @return Returns a reference to this object so that method calls can be chained together.
* @see AuthFlowType
*/
public AdminInitiateAuthRequest withAuthFlow(AuthFlowType authFlow) {
setAuthFlow(authFlow);
return this;
}
/**
*
* The authentication parameters.
*
*
* @return The authentication parameters.
*/
public java.util.Map getAuthParameters() {
return authParameters;
}
/**
*
* The authentication parameters.
*
*
* @param authParameters
* The authentication parameters.
*/
public void setAuthParameters(java.util.Map authParameters) {
this.authParameters = authParameters;
}
/**
*
* The authentication parameters.
*
*
* @param authParameters
* The authentication parameters.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AdminInitiateAuthRequest withAuthParameters(java.util.Map authParameters) {
setAuthParameters(authParameters);
return this;
}
public AdminInitiateAuthRequest addAuthParametersEntry(String key, String value) {
if (null == this.authParameters) {
this.authParameters = new java.util.HashMap();
}
if (this.authParameters.containsKey(key))
throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided.");
this.authParameters.put(key, value);
return this;
}
/**
* Removes all the entries added into AuthParameters. <p> Returns a reference to this object so that method calls
* can be chained together.
*/
public AdminInitiateAuthRequest clearAuthParametersEntries() {
this.authParameters = null;
return this;
}
/**
*
* The client app metadata.
*
*
* @return The client app metadata.
*/
public java.util.Map getClientMetadata() {
return clientMetadata;
}
/**
*
* The client app metadata.
*
*
* @param clientMetadata
* The client app metadata.
*/
public void setClientMetadata(java.util.Map clientMetadata) {
this.clientMetadata = clientMetadata;
}
/**
*
* The client app metadata.
*
*
* @param clientMetadata
* The client app metadata.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AdminInitiateAuthRequest withClientMetadata(java.util.Map clientMetadata) {
setClientMetadata(clientMetadata);
return this;
}
public AdminInitiateAuthRequest 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. <p> Returns a reference to this object so that method calls
* can be chained together.
*/
public AdminInitiateAuthRequest clearClientMetadataEntries() {
this.clientMetadata = null;
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 (getUserPoolId() != null)
sb.append("UserPoolId: " + getUserPoolId() + ",");
if (getClientId() != null)
sb.append("ClientId: " + getClientId() + ",");
if (getAuthFlow() != null)
sb.append("AuthFlow: " + getAuthFlow() + ",");
if (getAuthParameters() != null)
sb.append("AuthParameters: " + getAuthParameters() + ",");
if (getClientMetadata() != null)
sb.append("ClientMetadata: " + 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 AdminInitiateAuthRequest == false)
return false;
AdminInitiateAuthRequest other = (AdminInitiateAuthRequest) obj;
if (other.getUserPoolId() == null ^ this.getUserPoolId() == null)
return false;
if (other.getUserPoolId() != null && other.getUserPoolId().equals(this.getUserPoolId()) == false)
return false;
if (other.getClientId() == null ^ this.getClientId() == null)
return false;
if (other.getClientId() != null && other.getClientId().equals(this.getClientId()) == false)
return false;
if (other.getAuthFlow() == null ^ this.getAuthFlow() == null)
return false;
if (other.getAuthFlow() != null && other.getAuthFlow().equals(this.getAuthFlow()) == false)
return false;
if (other.getAuthParameters() == null ^ this.getAuthParameters() == null)
return false;
if (other.getAuthParameters() != null && other.getAuthParameters().equals(this.getAuthParameters()) == 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 + ((getUserPoolId() == null) ? 0 : getUserPoolId().hashCode());
hashCode = prime * hashCode + ((getClientId() == null) ? 0 : getClientId().hashCode());
hashCode = prime * hashCode + ((getAuthFlow() == null) ? 0 : getAuthFlow().hashCode());
hashCode = prime * hashCode + ((getAuthParameters() == null) ? 0 : getAuthParameters().hashCode());
hashCode = prime * hashCode + ((getClientMetadata() == null) ? 0 : getClientMetadata().hashCode());
return hashCode;
}
@Override
public AdminInitiateAuthRequest clone() {
return (AdminInitiateAuthRequest) super.clone();
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy