com.amazonaws.services.kms.model.ListKeysResult Maven / Gradle / Ivy
Show all versions of aws-java-sdk-kms 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.kms.model;
import java.io.Serializable;
import javax.annotation.Generated;
/**
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class ListKeysResult extends com.amazonaws.AmazonWebServiceResult implements Serializable, Cloneable {
/**
*
* A list of KMS keys.
*
*/
private com.amazonaws.internal.SdkInternalList keys;
/**
*
* When Truncated is true, this element is present and contains the value to use for the
* Marker parameter in a subsequent request.
*
*/
private String nextMarker;
/**
*
* A flag that indicates whether there are more items in the list. When this value is true, the list in this
* response is truncated. To get more items, pass the value of the NextMarker element in this response
* to the Marker parameter in a subsequent request.
*
*/
private Boolean truncated;
/**
*
* A list of KMS keys.
*
*
* @return A list of KMS keys.
*/
public java.util.List getKeys() {
if (keys == null) {
keys = new com.amazonaws.internal.SdkInternalList();
}
return keys;
}
/**
*
* A list of KMS keys.
*
*
* @param keys
* A list of KMS keys.
*/
public void setKeys(java.util.Collection keys) {
if (keys == null) {
this.keys = null;
return;
}
this.keys = new com.amazonaws.internal.SdkInternalList(keys);
}
/**
*
* A list of KMS keys.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setKeys(java.util.Collection)} or {@link #withKeys(java.util.Collection)} if you want to override the
* existing values.
*
*
* @param keys
* A list of KMS keys.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListKeysResult withKeys(KeyListEntry... keys) {
if (this.keys == null) {
setKeys(new com.amazonaws.internal.SdkInternalList(keys.length));
}
for (KeyListEntry ele : keys) {
this.keys.add(ele);
}
return this;
}
/**
*
* A list of KMS keys.
*
*
* @param keys
* A list of KMS keys.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListKeysResult withKeys(java.util.Collection keys) {
setKeys(keys);
return this;
}
/**
*
* When Truncated is true, this element is present and contains the value to use for the
* Marker parameter in a subsequent request.
*
*
* @param nextMarker
* When Truncated is true, this element is present and contains the value to use for the
* Marker parameter in a subsequent request.
*/
public void setNextMarker(String nextMarker) {
this.nextMarker = nextMarker;
}
/**
*
* When Truncated is true, this element is present and contains the value to use for the
* Marker parameter in a subsequent request.
*
*
* @return When Truncated is true, this element is present and contains the value to use for the
* Marker parameter in a subsequent request.
*/
public String getNextMarker() {
return this.nextMarker;
}
/**
*
* When Truncated is true, this element is present and contains the value to use for the
* Marker parameter in a subsequent request.
*
*
* @param nextMarker
* When Truncated is true, this element is present and contains the value to use for the
* Marker parameter in a subsequent request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListKeysResult withNextMarker(String nextMarker) {
setNextMarker(nextMarker);
return this;
}
/**
*
* A flag that indicates whether there are more items in the list. When this value is true, the list in this
* response is truncated. To get more items, pass the value of the NextMarker element in this response
* to the Marker parameter in a subsequent request.
*
*
* @param truncated
* A flag that indicates whether there are more items in the list. When this value is true, the list in this
* response is truncated. To get more items, pass the value of the NextMarker element in this
* response to the Marker parameter in a subsequent request.
*/
public void setTruncated(Boolean truncated) {
this.truncated = truncated;
}
/**
*
* A flag that indicates whether there are more items in the list. When this value is true, the list in this
* response is truncated. To get more items, pass the value of the NextMarker element in this response
* to the Marker parameter in a subsequent request.
*
*
* @return A flag that indicates whether there are more items in the list. When this value is true, the list in this
* response is truncated. To get more items, pass the value of the NextMarker element in this
* response to the Marker parameter in a subsequent request.
*/
public Boolean getTruncated() {
return this.truncated;
}
/**
*
* A flag that indicates whether there are more items in the list. When this value is true, the list in this
* response is truncated. To get more items, pass the value of the NextMarker element in this response
* to the Marker parameter in a subsequent request.
*
*
* @param truncated
* A flag that indicates whether there are more items in the list. When this value is true, the list in this
* response is truncated. To get more items, pass the value of the NextMarker element in this
* response to the Marker parameter in a subsequent request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListKeysResult withTruncated(Boolean truncated) {
setTruncated(truncated);
return this;
}
/**
*
* A flag that indicates whether there are more items in the list. When this value is true, the list in this
* response is truncated. To get more items, pass the value of the NextMarker element in this response
* to the Marker parameter in a subsequent request.
*
*
* @return A flag that indicates whether there are more items in the list. When this value is true, the list in this
* response is truncated. To get more items, pass the value of the NextMarker element in this
* response to the Marker parameter in a subsequent request.
*/
public Boolean isTruncated() {
return this.truncated;
}
/**
* 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 (getKeys() != null)
sb.append("Keys: ").append(getKeys()).append(",");
if (getNextMarker() != null)
sb.append("NextMarker: ").append(getNextMarker()).append(",");
if (getTruncated() != null)
sb.append("Truncated: ").append(getTruncated());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof ListKeysResult == false)
return false;
ListKeysResult other = (ListKeysResult) obj;
if (other.getKeys() == null ^ this.getKeys() == null)
return false;
if (other.getKeys() != null && other.getKeys().equals(this.getKeys()) == false)
return false;
if (other.getNextMarker() == null ^ this.getNextMarker() == null)
return false;
if (other.getNextMarker() != null && other.getNextMarker().equals(this.getNextMarker()) == false)
return false;
if (other.getTruncated() == null ^ this.getTruncated() == null)
return false;
if (other.getTruncated() != null && other.getTruncated().equals(this.getTruncated()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getKeys() == null) ? 0 : getKeys().hashCode());
hashCode = prime * hashCode + ((getNextMarker() == null) ? 0 : getNextMarker().hashCode());
hashCode = prime * hashCode + ((getTruncated() == null) ? 0 : getTruncated().hashCode());
return hashCode;
}
@Override
public ListKeysResult clone() {
try {
return (ListKeysResult) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}