com.amazonaws.services.ec2.model

Class DescribeKeyPairsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ec2.model.DescribeKeyPairsRequest

All Implemented Interfaces:

DryRunSupportedRequest<DescribeKeyPairsRequest>, Serializable

public class DescribeKeyPairsRequest
extends AmazonWebServiceRequest
implements Serializable, DryRunSupportedRequest<DescribeKeyPairsRequest>

Container for the parameters to the DescribeKeyPairs operation.

The DescribeKeyPairs operation returns information about key pairs available to you. If you specify key pairs, information about those key pairs is returned. Otherwise, information for all registered key pairs is returned.

See Also:

AmazonEC2.describeKeyPairs(DescribeKeyPairsRequest), Serialized Form

Constructor Summary

Constructors

Constructor and Description
DescribeKeyPairsRequest()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
Request<DescribeKeyPairsRequest>	getDryRunRequest() This method is intended for internal use only.
List<Filter>	getFilters() A list of filters used to match properties for KeyPairs.
List<String>	getKeyNames() The optional list of key pair names to describe.
int	hashCode()
void	setFilters(Collection<Filter> filters) A list of filters used to match properties for KeyPairs.
void	setKeyNames(Collection<String> keyNames) The optional list of key pair names to describe.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribeKeyPairsRequest	withFilters(Collection<Filter> filters) A list of filters used to match properties for KeyPairs.
DescribeKeyPairsRequest	withFilters(Filter... filters) A list of filters used to match properties for KeyPairs.
DescribeKeyPairsRequest	withKeyNames(Collection<String> keyNames) The optional list of key pair names to describe.
DescribeKeyPairsRequest	withKeyNames(String... keyNames) The optional list of key pair names to describe.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setRequestCredentials, setRequestMetricCollector, withRequestMetricCollector

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeKeyPairsRequest

public DescribeKeyPairsRequest()

Method Detail

getKeyNames

public List<String> getKeyNames()

The optional list of key pair names to describe.

Returns:

The optional list of key pair names to describe.

setKeyNames

public void setKeyNames(Collection<String> keyNames)

The optional list of key pair names to describe.

Parameters:

keyNames - The optional list of key pair names to describe.

withKeyNames

public DescribeKeyPairsRequest withKeyNames(String... keyNames)

The optional list of key pair names to describe.

Returns a reference to this object so that method calls can be chained together.

Parameters:

keyNames - The optional list of key pair names to describe.

Returns:

A reference to this updated object so that method calls can be chained together.

withKeyNames

public DescribeKeyPairsRequest withKeyNames(Collection<String> keyNames)

The optional list of key pair names to describe.

Returns a reference to this object so that method calls can be chained together.

Parameters:

keyNames - The optional list of key pair names to describe.

Returns:

A reference to this updated object so that method calls can be chained together.

getFilters

public List<Filter> getFilters()

A list of filters used to match properties for KeyPairs. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

Returns:

A list of filters used to match properties for KeyPairs. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

setFilters

public void setFilters(Collection<Filter> filters)

A list of filters used to match properties for KeyPairs. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

Parameters:

filters - A list of filters used to match properties for KeyPairs. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

withFilters

public DescribeKeyPairsRequest withFilters(Filter... filters)

A list of filters used to match properties for KeyPairs. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

Returns a reference to this object so that method calls can be chained together.

Parameters:

filters - A list of filters used to match properties for KeyPairs. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

Returns:

A reference to this updated object so that method calls can be chained together.

withFilters

public DescribeKeyPairsRequest withFilters(Collection<Filter> filters)

A list of filters used to match properties for KeyPairs. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

Returns a reference to this object so that method calls can be chained together.

Parameters:

filters - A list of filters used to match properties for KeyPairs. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

Returns:

A reference to this updated object so that method calls can be chained together.

getDryRunRequest

public Request<DescribeKeyPairsRequest> getDryRunRequest()

This method is intended for internal use only. Returns the marshaled request configured with additional parameters to enable operation dry-run.

Specified by:

getDryRunRequest in interface DryRunSupportedRequest<DescribeKeyPairsRequest>

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object