com.amazonaws.services.cognitoidp.model.ListDevicesRequest 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;
/**
*
* Represents the request to list the devices.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class ListDevicesRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* A valid access token that Amazon Cognito issued to the user whose list of devices you want to view.
*
*/
private String accessToken;
/**
*
* The limit of the device request.
*
*/
private Integer limit;
/**
*
* This API operation returns a limited number of results. The pagination token is an identifier that you can
* present in an additional API request with the same parameters. When you include the pagination token, Amazon
* Cognito returns the next set of items after the current list. Subsequent requests return a new pagination token.
* By use of this token, you can paginate through the full list of items.
*
*/
private String paginationToken;
/**
*
* A valid access token that Amazon Cognito issued to the user whose list of devices you want to view.
*
*
* @param accessToken
* A valid access token that Amazon Cognito issued to the user whose list of devices you want to view.
*/
public void setAccessToken(String accessToken) {
this.accessToken = accessToken;
}
/**
*
* A valid access token that Amazon Cognito issued to the user whose list of devices you want to view.
*
*
* @return A valid access token that Amazon Cognito issued to the user whose list of devices you want to view.
*/
public String getAccessToken() {
return this.accessToken;
}
/**
*
* A valid access token that Amazon Cognito issued to the user whose list of devices you want to view.
*
*
* @param accessToken
* A valid access token that Amazon Cognito issued to the user whose list of devices you want to view.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListDevicesRequest withAccessToken(String accessToken) {
setAccessToken(accessToken);
return this;
}
/**
*
* The limit of the device request.
*
*
* @param limit
* The limit of the device request.
*/
public void setLimit(Integer limit) {
this.limit = limit;
}
/**
*
* The limit of the device request.
*
*
* @return The limit of the device request.
*/
public Integer getLimit() {
return this.limit;
}
/**
*
* The limit of the device request.
*
*
* @param limit
* The limit of the device request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListDevicesRequest withLimit(Integer limit) {
setLimit(limit);
return this;
}
/**
*
* This API operation returns a limited number of results. The pagination token is an identifier that you can
* present in an additional API request with the same parameters. When you include the pagination token, Amazon
* Cognito returns the next set of items after the current list. Subsequent requests return a new pagination token.
* By use of this token, you can paginate through the full list of items.
*
*
* @param paginationToken
* This API operation returns a limited number of results. The pagination token is an identifier that you can
* present in an additional API request with the same parameters. When you include the pagination token,
* Amazon Cognito returns the next set of items after the current list. Subsequent requests return a new
* pagination token. By use of this token, you can paginate through the full list of items.
*/
public void setPaginationToken(String paginationToken) {
this.paginationToken = paginationToken;
}
/**
*
* This API operation returns a limited number of results. The pagination token is an identifier that you can
* present in an additional API request with the same parameters. When you include the pagination token, Amazon
* Cognito returns the next set of items after the current list. Subsequent requests return a new pagination token.
* By use of this token, you can paginate through the full list of items.
*
*
* @return This API operation returns a limited number of results. The pagination token is an identifier that you
* can present in an additional API request with the same parameters. When you include the pagination token,
* Amazon Cognito returns the next set of items after the current list. Subsequent requests return a new
* pagination token. By use of this token, you can paginate through the full list of items.
*/
public String getPaginationToken() {
return this.paginationToken;
}
/**
*
* This API operation returns a limited number of results. The pagination token is an identifier that you can
* present in an additional API request with the same parameters. When you include the pagination token, Amazon
* Cognito returns the next set of items after the current list. Subsequent requests return a new pagination token.
* By use of this token, you can paginate through the full list of items.
*
*
* @param paginationToken
* This API operation returns a limited number of results. The pagination token is an identifier that you can
* present in an additional API request with the same parameters. When you include the pagination token,
* Amazon Cognito returns the next set of items after the current list. Subsequent requests return a new
* pagination token. By use of this token, you can paginate through the full list of items.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListDevicesRequest withPaginationToken(String paginationToken) {
setPaginationToken(paginationToken);
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 (getLimit() != null)
sb.append("Limit: ").append(getLimit()).append(",");
if (getPaginationToken() != null)
sb.append("PaginationToken: ").append(getPaginationToken());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof ListDevicesRequest == false)
return false;
ListDevicesRequest other = (ListDevicesRequest) obj;
if (other.getAccessToken() == null ^ this.getAccessToken() == null)
return false;
if (other.getAccessToken() != null && other.getAccessToken().equals(this.getAccessToken()) == false)
return false;
if (other.getLimit() == null ^ this.getLimit() == null)
return false;
if (other.getLimit() != null && other.getLimit().equals(this.getLimit()) == false)
return false;
if (other.getPaginationToken() == null ^ this.getPaginationToken() == null)
return false;
if (other.getPaginationToken() != null && other.getPaginationToken().equals(this.getPaginationToken()) == 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 + ((getLimit() == null) ? 0 : getLimit().hashCode());
hashCode = prime * hashCode + ((getPaginationToken() == null) ? 0 : getPaginationToken().hashCode());
return hashCode;
}
@Override
public ListDevicesRequest clone() {
return (ListDevicesRequest) super.clone();
}
}