com.amazonaws.services.cognitoidp.model.AdminUpdateDeviceStatusRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-cognitoidp Show documentation
/*
* Copyright 2019-2024 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;
/**
*
* The request to update the device status, as an administrator.
*
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class AdminUpdateDeviceStatusRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The user pool ID.
*
*/
private String userPoolId;
/**
*
* The username of the user that you want to query or modify. The value of this parameter is typically your user's
* username, but it can be any of their alias attributes. If username isn't an alias attribute in your
* user pool, this value must be the sub of a local user or the username of a user from a third-party
* IdP.
*
*/
private String username;
/**
*
* The device key.
*
*/
private String deviceKey;
/**
*
* The status indicating whether a device has been remembered or not.
*
*/
private String deviceRememberedStatus;
/**
*
* The user pool ID.
*
*
* @param userPoolId
* The user pool ID.
*/
public void setUserPoolId(String userPoolId) {
this.userPoolId = userPoolId;
}
/**
*
* The user pool ID.
*
*
* @return The user pool ID.
*/
public String getUserPoolId() {
return this.userPoolId;
}
/**
*
* The user pool ID.
*
*
* @param userPoolId
* The user pool ID.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AdminUpdateDeviceStatusRequest withUserPoolId(String userPoolId) {
setUserPoolId(userPoolId);
return this;
}
/**
*
* The username of the user that you want to query or modify. The value of this parameter is typically your user's
* username, but it can be any of their alias attributes. If username isn't an alias attribute in your
* user pool, this value must be the sub of a local user or the username of a user from a third-party
* IdP.
*
*
* @param username
* The username of the user that you want to query or modify. The value of this parameter is typically your
* user's username, but it can be any of their alias attributes. If username isn't an alias
* attribute in your user pool, this value must be the sub of a local user or the username of a
* user from a third-party IdP.
*/
public void setUsername(String username) {
this.username = username;
}
/**
*
* The username of the user that you want to query or modify. The value of this parameter is typically your user's
* username, but it can be any of their alias attributes. If username isn't an alias attribute in your
* user pool, this value must be the sub of a local user or the username of a user from a third-party
* IdP.
*
*
* @return The username of the user that you want to query or modify. The value of this parameter is typically your
* user's username, but it can be any of their alias attributes. If username isn't an alias
* attribute in your user pool, this value must be the sub of a local user or the username of a
* user from a third-party IdP.
*/
public String getUsername() {
return this.username;
}
/**
*
* The username of the user that you want to query or modify. The value of this parameter is typically your user's
* username, but it can be any of their alias attributes. If username isn't an alias attribute in your
* user pool, this value must be the sub of a local user or the username of a user from a third-party
* IdP.
*
*
* @param username
* The username of the user that you want to query or modify. The value of this parameter is typically your
* user's username, but it can be any of their alias attributes. If username isn't an alias
* attribute in your user pool, this value must be the sub of a local user or the username of a
* user from a third-party IdP.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AdminUpdateDeviceStatusRequest withUsername(String username) {
setUsername(username);
return this;
}
/**
*
* The device key.
*
*
* @param deviceKey
* The device key.
*/
public void setDeviceKey(String deviceKey) {
this.deviceKey = deviceKey;
}
/**
*
* The device key.
*
*
* @return The device key.
*/
public String getDeviceKey() {
return this.deviceKey;
}
/**
*
* The device key.
*
*
* @param deviceKey
* The device key.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AdminUpdateDeviceStatusRequest withDeviceKey(String deviceKey) {
setDeviceKey(deviceKey);
return this;
}
/**
*
* The status indicating whether a device has been remembered or not.
*
*
* @param deviceRememberedStatus
* The status indicating whether a device has been remembered or not.
* @see DeviceRememberedStatusType
*/
public void setDeviceRememberedStatus(String deviceRememberedStatus) {
this.deviceRememberedStatus = deviceRememberedStatus;
}
/**
*
* The status indicating whether a device has been remembered or not.
*
*
* @return The status indicating whether a device has been remembered or not.
* @see DeviceRememberedStatusType
*/
public String getDeviceRememberedStatus() {
return this.deviceRememberedStatus;
}
/**
*
* The status indicating whether a device has been remembered or not.
*
*
* @param deviceRememberedStatus
* The status indicating whether a device has been remembered or not.
* @return Returns a reference to this object so that method calls can be chained together.
* @see DeviceRememberedStatusType
*/
public AdminUpdateDeviceStatusRequest withDeviceRememberedStatus(String deviceRememberedStatus) {
setDeviceRememberedStatus(deviceRememberedStatus);
return this;
}
/**
*
* The status indicating whether a device has been remembered or not.
*
*
* @param deviceRememberedStatus
* The status indicating whether a device has been remembered or not.
* @see DeviceRememberedStatusType
*/
public void setDeviceRememberedStatus(DeviceRememberedStatusType deviceRememberedStatus) {
withDeviceRememberedStatus(deviceRememberedStatus);
}
/**
*
* The status indicating whether a device has been remembered or not.
*
*
* @param deviceRememberedStatus
* The status indicating whether a device has been remembered or not.
* @return Returns a reference to this object so that method calls can be chained together.
* @see DeviceRememberedStatusType
*/
public AdminUpdateDeviceStatusRequest withDeviceRememberedStatus(DeviceRememberedStatusType deviceRememberedStatus) {
this.deviceRememberedStatus = deviceRememberedStatus.toString();
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 (getUserPoolId() != null)
sb.append("UserPoolId: ").append(getUserPoolId()).append(",");
if (getUsername() != null)
sb.append("Username: ").append("***Sensitive Data Redacted***").append(",");
if (getDeviceKey() != null)
sb.append("DeviceKey: ").append(getDeviceKey()).append(",");
if (getDeviceRememberedStatus() != null)
sb.append("DeviceRememberedStatus: ").append(getDeviceRememberedStatus());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof AdminUpdateDeviceStatusRequest == false)
return false;
AdminUpdateDeviceStatusRequest other = (AdminUpdateDeviceStatusRequest) obj;
if (other.getUserPoolId() == null ^ this.getUserPoolId() == null)
return false;
if (other.getUserPoolId() != null && other.getUserPoolId().equals(this.getUserPoolId()) == false)
return false;
if (other.getUsername() == null ^ this.getUsername() == null)
return false;
if (other.getUsername() != null && other.getUsername().equals(this.getUsername()) == false)
return false;
if (other.getDeviceKey() == null ^ this.getDeviceKey() == null)
return false;
if (other.getDeviceKey() != null && other.getDeviceKey().equals(this.getDeviceKey()) == false)
return false;
if (other.getDeviceRememberedStatus() == null ^ this.getDeviceRememberedStatus() == null)
return false;
if (other.getDeviceRememberedStatus() != null && other.getDeviceRememberedStatus().equals(this.getDeviceRememberedStatus()) == 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 + ((getUsername() == null) ? 0 : getUsername().hashCode());
hashCode = prime * hashCode + ((getDeviceKey() == null) ? 0 : getDeviceKey().hashCode());
hashCode = prime * hashCode + ((getDeviceRememberedStatus() == null) ? 0 : getDeviceRememberedStatus().hashCode());
return hashCode;
}
@Override
public AdminUpdateDeviceStatusRequest clone() {
return (AdminUpdateDeviceStatusRequest) super.clone();
}
}