com.amazonaws.services.paymentcryptography.model.ListKeysRequest Maven / Gradle / Ivy
/*
* 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.paymentcryptography.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class ListKeysRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The key state of the keys you want to list.
*
*/
private String keyState;
/**
*
* Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the
* value of NextToken from the truncated response you just received.
*
*/
private String nextToken;
/**
*
* Use this parameter to specify the maximum number of items to return. When this value is present, Amazon Web
* Services Payment Cryptography does not return more than the specified number of items, but it might return fewer.
*
*
* This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a
* value, it defaults to 50.
*
*/
private Integer maxResults;
/**
*
* The key state of the keys you want to list.
*
*
* @param keyState
* The key state of the keys you want to list.
* @see KeyState
*/
public void setKeyState(String keyState) {
this.keyState = keyState;
}
/**
*
* The key state of the keys you want to list.
*
*
* @return The key state of the keys you want to list.
* @see KeyState
*/
public String getKeyState() {
return this.keyState;
}
/**
*
* The key state of the keys you want to list.
*
*
* @param keyState
* The key state of the keys you want to list.
* @return Returns a reference to this object so that method calls can be chained together.
* @see KeyState
*/
public ListKeysRequest withKeyState(String keyState) {
setKeyState(keyState);
return this;
}
/**
*
* The key state of the keys you want to list.
*
*
* @param keyState
* The key state of the keys you want to list.
* @return Returns a reference to this object so that method calls can be chained together.
* @see KeyState
*/
public ListKeysRequest withKeyState(KeyState keyState) {
this.keyState = keyState.toString();
return this;
}
/**
*
* Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the
* value of NextToken from the truncated response you just received.
*
*
* @param nextToken
* Use this parameter in a subsequent request after you receive a response with truncated results. Set it to
* the value of NextToken from the truncated response you just received.
*/
public void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
/**
*
* Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the
* value of NextToken from the truncated response you just received.
*
*
* @return Use this parameter in a subsequent request after you receive a response with truncated results. Set it to
* the value of NextToken from the truncated response you just received.
*/
public String getNextToken() {
return this.nextToken;
}
/**
*
* Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the
* value of NextToken from the truncated response you just received.
*
*
* @param nextToken
* Use this parameter in a subsequent request after you receive a response with truncated results. Set it to
* the value of NextToken from the truncated response you just received.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListKeysRequest withNextToken(String nextToken) {
setNextToken(nextToken);
return this;
}
/**
*
* Use this parameter to specify the maximum number of items to return. When this value is present, Amazon Web
* Services Payment Cryptography does not return more than the specified number of items, but it might return fewer.
*
*
* This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a
* value, it defaults to 50.
*
*
* @param maxResults
* Use this parameter to specify the maximum number of items to return. When this value is present, Amazon
* Web Services Payment Cryptography does not return more than the specified number of items, but it might
* return fewer.
*
* This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not
* include a value, it defaults to 50.
*/
public void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
/**
*
* Use this parameter to specify the maximum number of items to return. When this value is present, Amazon Web
* Services Payment Cryptography does not return more than the specified number of items, but it might return fewer.
*
*
* This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a
* value, it defaults to 50.
*
*
* @return Use this parameter to specify the maximum number of items to return. When this value is present, Amazon
* Web Services Payment Cryptography does not return more than the specified number of items, but it might
* return fewer.
*
* This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not
* include a value, it defaults to 50.
*/
public Integer getMaxResults() {
return this.maxResults;
}
/**
*
* Use this parameter to specify the maximum number of items to return. When this value is present, Amazon Web
* Services Payment Cryptography does not return more than the specified number of items, but it might return fewer.
*
*
* This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a
* value, it defaults to 50.
*
*
* @param maxResults
* Use this parameter to specify the maximum number of items to return. When this value is present, Amazon
* Web Services Payment Cryptography does not return more than the specified number of items, but it might
* return fewer.
*
* This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not
* include a value, it defaults to 50.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListKeysRequest withMaxResults(Integer maxResults) {
setMaxResults(maxResults);
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 (getKeyState() != null)
sb.append("KeyState: ").append(getKeyState()).append(",");
if (getNextToken() != null)
sb.append("NextToken: ").append(getNextToken()).append(",");
if (getMaxResults() != null)
sb.append("MaxResults: ").append(getMaxResults());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof ListKeysRequest == false)
return false;
ListKeysRequest other = (ListKeysRequest) obj;
if (other.getKeyState() == null ^ this.getKeyState() == null)
return false;
if (other.getKeyState() != null && other.getKeyState().equals(this.getKeyState()) == false)
return false;
if (other.getNextToken() == null ^ this.getNextToken() == null)
return false;
if (other.getNextToken() != null && other.getNextToken().equals(this.getNextToken()) == false)
return false;
if (other.getMaxResults() == null ^ this.getMaxResults() == null)
return false;
if (other.getMaxResults() != null && other.getMaxResults().equals(this.getMaxResults()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getKeyState() == null) ? 0 : getKeyState().hashCode());
hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode());
hashCode = prime * hashCode + ((getMaxResults() == null) ? 0 : getMaxResults().hashCode());
return hashCode;
}
@Override
public ListKeysRequest clone() {
return (ListKeysRequest) super.clone();
}
}