com.amazonaws.services.kms.model

Class ListKeysRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.kms.model.ListKeysRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class ListKeysRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the ListKeys operation.

Lists the customer master keys.

See Also:

AWSKMS.listKeys(ListKeysRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ListKeysRequest()

Method Summary

Methods

Modifier and Type	Method and Description
ListKeysRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
Integer	getLimit() Specify this parameter only when paginating results to indicate the maximum number of keys you want listed in the response.
String	getMarker() Use this parameter only when paginating results, and only in a subsequent request after you've received a response where the results are truncated.
int	hashCode()
void	setLimit(Integer limit) Specify this parameter only when paginating results to indicate the maximum number of keys you want listed in the response.
void	setMarker(String marker) Use this parameter only when paginating results, and only in a subsequent request after you've received a response where the results are truncated.
String	toString() Returns a string representation of this object; useful for testing and debugging.
ListKeysRequest	withLimit(Integer limit) Specify this parameter only when paginating results to indicate the maximum number of keys you want listed in the response.
ListKeysRequest	withMarker(String marker) Use this parameter only when paginating results, and only in a subsequent request after you've received a response where the results are truncated.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ListKeysRequest

public ListKeysRequest()

Method Detail

getLimit

public Integer getLimit()

Specify this parameter only when paginating results to indicate the maximum number of keys you want listed in the response. If there are additional keys beyond the maximum you specify, the Truncated response element will be set to true.

Constraints:
Range: 1 - 1000

Returns:

Specify this parameter only when paginating results to indicate the maximum number of keys you want listed in the response. If there are additional keys beyond the maximum you specify, the Truncated response element will be set to true.

setLimit

public void setLimit(Integer limit)

Specify this parameter only when paginating results to indicate the maximum number of keys you want listed in the response. If there are additional keys beyond the maximum you specify, the Truncated response element will be set to true.

Constraints:
Range: 1 - 1000

Parameters:

limit - Specify this parameter only when paginating results to indicate the maximum number of keys you want listed in the response. If there are additional keys beyond the maximum you specify, the Truncated response element will be set to true.

withLimit

public ListKeysRequest withLimit(Integer limit)

Specify this parameter only when paginating results to indicate the maximum number of keys you want listed in the response. If there are additional keys beyond the maximum you specify, the Truncated response element will be set to true.

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

Constraints:
Range: 1 - 1000

Parameters:

limit - Specify this parameter only when paginating results to indicate the maximum number of keys you want listed in the response. If there are additional keys beyond the maximum you specify, the Truncated response element will be set to true.

Returns:

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

getMarker

public String getMarker()

Use this parameter only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the NextMarker in the response you just received.

Constraints:
Length: 1 - 320
Pattern: [\u0020-\u00FF]*

Returns:

Use this parameter only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the NextMarker in the response you just received.

setMarker

public void setMarker(String marker)

Use this parameter only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the NextMarker in the response you just received.

Constraints:
Length: 1 - 320
Pattern: [\u0020-\u00FF]*

Parameters:

marker - Use this parameter only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the NextMarker in the response you just received.

withMarker

public ListKeysRequest withMarker(String marker)

Use this parameter only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the NextMarker in the response you just received.

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

Constraints:
Length: 1 - 320
Pattern: [\u0020-\u00FF]*

Parameters:

marker - Use this parameter only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the NextMarker in the response you just received.

Returns:

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

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

clone

public ListKeysRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()