com.amazonaws.services.ec2.model.DescribeKeyPairsRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ec2 Show documentation
/*
* Copyright 2010-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.ec2.model;
import java.io.Serializable;
import com.amazonaws.AmazonWebServiceRequest;
import com.amazonaws.Request;
import com.amazonaws.services.ec2.model.transform.DescribeKeyPairsRequestMarshaller;
/**
*
* Contains the parameters for DescribeKeyPairs.
*
*/
public class DescribeKeyPairsRequest extends AmazonWebServiceRequest implements
Serializable, Cloneable,
DryRunSupportedRequest {
/**
*
* One or more key pair names.
*
*
* Default: Describes all your key pairs.
*
*/
private com.amazonaws.internal.SdkInternalList keyNames;
/**
*
* One or more filters.
*
*
* -
*
* fingerprint - The fingerprint of the key pair.
*
*
* -
*
* key-name - The name of the key pair.
*
*
*
*/
private com.amazonaws.internal.SdkInternalList filters;
/**
*
* One or more key pair names.
*
*
* Default: Describes all your key pairs.
*
*
* @return One or more key pair names.
*
* Default: Describes all your key pairs.
*/
public java.util.List getKeyNames() {
if (keyNames == null) {
keyNames = new com.amazonaws.internal.SdkInternalList();
}
return keyNames;
}
/**
*
* One or more key pair names.
*
*
* Default: Describes all your key pairs.
*
*
* @param keyNames
* One or more key pair names.
*
* Default: Describes all your key pairs.
*/
public void setKeyNames(java.util.Collection keyNames) {
if (keyNames == null) {
this.keyNames = null;
return;
}
this.keyNames = new com.amazonaws.internal.SdkInternalList(
keyNames);
}
/**
*
* One or more key pair names.
*
*
* Default: Describes all your key pairs.
*
*
* NOTE: This method appends the values to the existing list (if
* any). Use {@link #setKeyNames(java.util.Collection)} or
* {@link #withKeyNames(java.util.Collection)} if you want to override the
* existing values.
*
*
* @param keyNames
* One or more key pair names.
*
* Default: Describes all your key pairs.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public DescribeKeyPairsRequest withKeyNames(String... keyNames) {
if (this.keyNames == null) {
setKeyNames(new com.amazonaws.internal.SdkInternalList(
keyNames.length));
}
for (String ele : keyNames) {
this.keyNames.add(ele);
}
return this;
}
/**
*
* One or more key pair names.
*
*
* Default: Describes all your key pairs.
*
*
* @param keyNames
* One or more key pair names.
*
* Default: Describes all your key pairs.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public DescribeKeyPairsRequest withKeyNames(
java.util.Collection keyNames) {
setKeyNames(keyNames);
return this;
}
/**
*
* One or more filters.
*
*
* -
*
* fingerprint - The fingerprint of the key pair.
*
*
* -
*
* key-name - The name of the key pair.
*
*
*
*
* @return One or more filters.
*
* -
*
* fingerprint - The fingerprint of the key pair.
*
*
* -
*
* key-name - The name of the key pair.
*
*
*/
public java.util.List getFilters() {
if (filters == null) {
filters = new com.amazonaws.internal.SdkInternalList();
}
return filters;
}
/**
*
* One or more filters.
*
*
* -
*
* fingerprint - The fingerprint of the key pair.
*
*
* -
*
* key-name - The name of the key pair.
*
*
*
*
* @param filters
* One or more filters.
*
* -
*
* fingerprint - The fingerprint of the key pair.
*
*
* -
*
* key-name - The name of the key pair.
*
*
*/
public void setFilters(java.util.Collection filters) {
if (filters == null) {
this.filters = null;
return;
}
this.filters = new com.amazonaws.internal.SdkInternalList(
filters);
}
/**
*
* One or more filters.
*
*
* -
*
* fingerprint - The fingerprint of the key pair.
*
*
* -
*
* key-name - The name of the key pair.
*
*
*
*
* NOTE: This method appends the values to the existing list (if
* any). Use {@link #setFilters(java.util.Collection)} or
* {@link #withFilters(java.util.Collection)} if you want to override the
* existing values.
*
*
* @param filters
* One or more filters.
*
* -
*
* fingerprint - The fingerprint of the key pair.
*
*
* -
*
* key-name - The name of the key pair.
*
*
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public DescribeKeyPairsRequest withFilters(Filter... filters) {
if (this.filters == null) {
setFilters(new com.amazonaws.internal.SdkInternalList(
filters.length));
}
for (Filter ele : filters) {
this.filters.add(ele);
}
return this;
}
/**
*
* One or more filters.
*
*
* -
*
* fingerprint - The fingerprint of the key pair.
*
*
* -
*
* key-name - The name of the key pair.
*
*
*
*
* @param filters
* One or more filters.
*
* -
*
* fingerprint - The fingerprint of the key pair.
*
*
* -
*
* key-name - The name of the key pair.
*
*
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public DescribeKeyPairsRequest withFilters(
java.util.Collection filters) {
setFilters(filters);
return this;
}
/**
* This method is intended for internal use only. Returns the marshaled
* request configured with additional parameters to enable operation
* dry-run.
*/
@Override
public Request getDryRunRequest() {
Request request = new DescribeKeyPairsRequestMarshaller()
.marshall(this);
request.addParameter("DryRun", Boolean.toString(true));
return request;
}
/**
* 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 (getKeyNames() != null)
sb.append("KeyNames: " + getKeyNames() + ",");
if (getFilters() != null)
sb.append("Filters: " + getFilters());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof DescribeKeyPairsRequest == false)
return false;
DescribeKeyPairsRequest other = (DescribeKeyPairsRequest) obj;
if (other.getKeyNames() == null ^ this.getKeyNames() == null)
return false;
if (other.getKeyNames() != null
&& other.getKeyNames().equals(this.getKeyNames()) == false)
return false;
if (other.getFilters() == null ^ this.getFilters() == null)
return false;
if (other.getFilters() != null
&& other.getFilters().equals(this.getFilters()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode
+ ((getKeyNames() == null) ? 0 : getKeyNames().hashCode());
hashCode = prime * hashCode
+ ((getFilters() == null) ? 0 : getFilters().hashCode());
return hashCode;
}
@Override
public DescribeKeyPairsRequest clone() {
return (DescribeKeyPairsRequest) super.clone();
}
}