com.amazonaws.services.ec2.model.DescribeKeyPairsRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ec2 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.ec2.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
import com.amazonaws.Request;
import com.amazonaws.services.ec2.model.transform.DescribeKeyPairsRequestMarshaller;
/**
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DescribeKeyPairsRequest extends AmazonWebServiceRequest implements Serializable, Cloneable, DryRunSupportedRequest {
/**
*
* The filters.
*
*
* -
*
* key-pair-id - The ID of the key pair.
*
*
* -
*
* fingerprint - The fingerprint of the key pair.
*
*
* -
*
* key-name - The name of the key pair.
*
*
* -
*
* tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned
* a tag with a specific key, regardless of the tag value.
*
*
* -
*
* tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in
* the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
* the key Owner and the value TeamA, specify tag:Owner for the filter name
* and TeamA for the filter value.
*
*
*
*/
private com.amazonaws.internal.SdkInternalList filters;
/**
*
* The key pair names.
*
*
* Default: Describes all of your key pairs.
*
*/
private com.amazonaws.internal.SdkInternalList keyNames;
/**
*
* The IDs of the key pairs.
*
*/
private com.amazonaws.internal.SdkInternalList keyPairIds;
/**
*
* If true, the public key material is included in the response.
*
*
* Default: false
*
*/
private Boolean includePublicKey;
/**
*
* The filters.
*
*
* -
*
* key-pair-id - The ID of the key pair.
*
*
* -
*
* fingerprint - The fingerprint of the key pair.
*
*
* -
*
* key-name - The name of the key pair.
*
*
* -
*
* tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned
* a tag with a specific key, regardless of the tag value.
*
*
* -
*
* tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in
* the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
* the key Owner and the value TeamA, specify tag:Owner for the filter name
* and TeamA for the filter value.
*
*
*
*
* @return The filters.
*
* -
*
* key-pair-id - The ID of the key pair.
*
*
* -
*
* fingerprint - The fingerprint of the key pair.
*
*
* -
*
* key-name - The name of the key pair.
*
*
* -
*
* tag-key - The key of a tag assigned to the resource. Use this filter to find all resources
* assigned a tag with a specific key, regardless of the tag value.
*
*
* -
*
* tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag
* key in the filter name and the tag value as the filter value. For example, to find all resources that
* have a tag with the key Owner and the value TeamA, specify
* tag:Owner for the filter name and TeamA for the filter value.
*
*
*/
public java.util.List getFilters() {
if (filters == null) {
filters = new com.amazonaws.internal.SdkInternalList();
}
return filters;
}
/**
*
* The filters.
*
*
* -
*
* key-pair-id - The ID of the key pair.
*
*
* -
*
* fingerprint - The fingerprint of the key pair.
*
*
* -
*
* key-name - The name of the key pair.
*
*
* -
*
* tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned
* a tag with a specific key, regardless of the tag value.
*
*
* -
*
* tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in
* the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
* the key Owner and the value TeamA, specify tag:Owner for the filter name
* and TeamA for the filter value.
*
*
*
*
* @param filters
* The filters.
*
* -
*
* key-pair-id - The ID of the key pair.
*
*
* -
*
* fingerprint - The fingerprint of the key pair.
*
*
* -
*
* key-name - The name of the key pair.
*
*
* -
*
* tag-key - The key of a tag assigned to the resource. Use this filter to find all resources
* assigned a tag with a specific key, regardless of the tag value.
*
*
* -
*
* tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag
* key in the filter name and the tag value as the filter value. For example, to find all resources that have
* a tag with the key Owner and the value TeamA, specify tag:Owner for
* the filter name and TeamA for the filter value.
*
*
*/
public void setFilters(java.util.Collection filters) {
if (filters == null) {
this.filters = null;
return;
}
this.filters = new com.amazonaws.internal.SdkInternalList(filters);
}
/**
*
* The filters.
*
*
* -
*
* key-pair-id - The ID of the key pair.
*
*
* -
*
* fingerprint - The fingerprint of the key pair.
*
*
* -
*
* key-name - The name of the key pair.
*
*
* -
*
* tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned
* a tag with a specific key, regardless of the tag value.
*
*
* -
*
* tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in
* the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
* the key Owner and the value TeamA, specify tag:Owner for the filter name
* and TeamA for the filter value.
*
*
*
*
* 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
* The filters.
*
* -
*
* key-pair-id - The ID of the key pair.
*
*
* -
*
* fingerprint - The fingerprint of the key pair.
*
*
* -
*
* key-name - The name of the key pair.
*
*
* -
*
* tag-key - The key of a tag assigned to the resource. Use this filter to find all resources
* assigned a tag with a specific key, regardless of the tag value.
*
*
* -
*
* tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag
* key in the filter name and the tag value as the filter value. For example, to find all resources that have
* a tag with the key Owner and the value TeamA, specify tag:Owner for
* the filter name and TeamA for the filter value.
*
*
* @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;
}
/**
*
* The filters.
*
*
* -
*
* key-pair-id - The ID of the key pair.
*
*
* -
*
* fingerprint - The fingerprint of the key pair.
*
*
* -
*
* key-name - The name of the key pair.
*
*
* -
*
* tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned
* a tag with a specific key, regardless of the tag value.
*
*
* -
*
* tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in
* the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
* the key Owner and the value TeamA, specify tag:Owner for the filter name
* and TeamA for the filter value.
*
*
*
*
* @param filters
* The filters.
*
* -
*
* key-pair-id - The ID of the key pair.
*
*
* -
*
* fingerprint - The fingerprint of the key pair.
*
*
* -
*
* key-name - The name of the key pair.
*
*
* -
*
* tag-key - The key of a tag assigned to the resource. Use this filter to find all resources
* assigned a tag with a specific key, regardless of the tag value.
*
*
* -
*
* tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag
* key in the filter name and the tag value as the filter value. For example, to find all resources that have
* a tag with the key Owner and the value TeamA, specify tag:Owner for
* the filter name and TeamA for the filter value.
*
*
* @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;
}
/**
*
* The key pair names.
*
*
* Default: Describes all of your key pairs.
*
*
* @return The key pair names.
*
* Default: Describes all of your key pairs.
*/
public java.util.List getKeyNames() {
if (keyNames == null) {
keyNames = new com.amazonaws.internal.SdkInternalList();
}
return keyNames;
}
/**
*
* The key pair names.
*
*
* Default: Describes all of your key pairs.
*
*
* @param keyNames
* The key pair names.
*
* Default: Describes all of 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);
}
/**
*
* The key pair names.
*
*
* Default: Describes all of 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
* The key pair names.
*
* Default: Describes all of 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;
}
/**
*
* The key pair names.
*
*
* Default: Describes all of your key pairs.
*
*
* @param keyNames
* The key pair names.
*
* Default: Describes all of 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;
}
/**
*
* The IDs of the key pairs.
*
*
* @return The IDs of the key pairs.
*/
public java.util.List getKeyPairIds() {
if (keyPairIds == null) {
keyPairIds = new com.amazonaws.internal.SdkInternalList();
}
return keyPairIds;
}
/**
*
* The IDs of the key pairs.
*
*
* @param keyPairIds
* The IDs of the key pairs.
*/
public void setKeyPairIds(java.util.Collection keyPairIds) {
if (keyPairIds == null) {
this.keyPairIds = null;
return;
}
this.keyPairIds = new com.amazonaws.internal.SdkInternalList(keyPairIds);
}
/**
*
* The IDs of the key pairs.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setKeyPairIds(java.util.Collection)} or {@link #withKeyPairIds(java.util.Collection)} if you want to
* override the existing values.
*
*
* @param keyPairIds
* The IDs of the key pairs.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeKeyPairsRequest withKeyPairIds(String... keyPairIds) {
if (this.keyPairIds == null) {
setKeyPairIds(new com.amazonaws.internal.SdkInternalList(keyPairIds.length));
}
for (String ele : keyPairIds) {
this.keyPairIds.add(ele);
}
return this;
}
/**
*
* The IDs of the key pairs.
*
*
* @param keyPairIds
* The IDs of the key pairs.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeKeyPairsRequest withKeyPairIds(java.util.Collection keyPairIds) {
setKeyPairIds(keyPairIds);
return this;
}
/**
*
* If true, the public key material is included in the response.
*
*
* Default: false
*
*
* @param includePublicKey
* If true, the public key material is included in the response.
*
* Default: false
*/
public void setIncludePublicKey(Boolean includePublicKey) {
this.includePublicKey = includePublicKey;
}
/**
*
* If true, the public key material is included in the response.
*
*
* Default: false
*
*
* @return If true, the public key material is included in the response.
*
* Default: false
*/
public Boolean getIncludePublicKey() {
return this.includePublicKey;
}
/**
*
* If true, the public key material is included in the response.
*
*
* Default: false
*
*
* @param includePublicKey
* If true, the public key material is included in the response.
*
* Default: false
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeKeyPairsRequest withIncludePublicKey(Boolean includePublicKey) {
setIncludePublicKey(includePublicKey);
return this;
}
/**
*
* If true, the public key material is included in the response.
*
*
* Default: false
*
*
* @return If true, the public key material is included in the response.
*
* Default: false
*/
public Boolean isIncludePublicKey() {
return this.includePublicKey;
}
/**
* 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. 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 (getFilters() != null)
sb.append("Filters: ").append(getFilters()).append(",");
if (getKeyNames() != null)
sb.append("KeyNames: ").append(getKeyNames()).append(",");
if (getKeyPairIds() != null)
sb.append("KeyPairIds: ").append(getKeyPairIds()).append(",");
if (getIncludePublicKey() != null)
sb.append("IncludePublicKey: ").append(getIncludePublicKey());
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.getFilters() == null ^ this.getFilters() == null)
return false;
if (other.getFilters() != null && other.getFilters().equals(this.getFilters()) == false)
return false;
if (other.getKeyNames() == null ^ this.getKeyNames() == null)
return false;
if (other.getKeyNames() != null && other.getKeyNames().equals(this.getKeyNames()) == false)
return false;
if (other.getKeyPairIds() == null ^ this.getKeyPairIds() == null)
return false;
if (other.getKeyPairIds() != null && other.getKeyPairIds().equals(this.getKeyPairIds()) == false)
return false;
if (other.getIncludePublicKey() == null ^ this.getIncludePublicKey() == null)
return false;
if (other.getIncludePublicKey() != null && other.getIncludePublicKey().equals(this.getIncludePublicKey()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getFilters() == null) ? 0 : getFilters().hashCode());
hashCode = prime * hashCode + ((getKeyNames() == null) ? 0 : getKeyNames().hashCode());
hashCode = prime * hashCode + ((getKeyPairIds() == null) ? 0 : getKeyPairIds().hashCode());
hashCode = prime * hashCode + ((getIncludePublicKey() == null) ? 0 : getIncludePublicKey().hashCode());
return hashCode;
}
@Override
public DescribeKeyPairsRequest clone() {
return (DescribeKeyPairsRequest) super.clone();
}
}