com.amazonaws.services.apigateway.model

Class GetUsagePlanKeysRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.apigateway.model.GetUsagePlanKeysRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GetUsagePlanKeysRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

The GET request to get all the usage plan keys representing the API keys added to a specified usage plan.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
GetUsagePlanKeysRequest()

Method Summary

Modifier and Type	Method and Description
GetUsagePlanKeysRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
Integer	getLimit() The maximum number of returned results per page.
String	getNameQuery() A query parameter specifying the name of the to-be-returned usage plan keys.
String	getPosition() The current pagination position in the paged result set.
String	getUsagePlanId() The Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved UsagePlanKey resource representing a plan customer.
int	hashCode()
void	setLimit(Integer limit) The maximum number of returned results per page.
void	setNameQuery(String nameQuery) A query parameter specifying the name of the to-be-returned usage plan keys.
void	setPosition(String position) The current pagination position in the paged result set.
void	setUsagePlanId(String usagePlanId) The Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved UsagePlanKey resource representing a plan customer.
String	toString() Returns a string representation of this object; useful for testing and debugging.
GetUsagePlanKeysRequest	withLimit(Integer limit) The maximum number of returned results per page.
GetUsagePlanKeysRequest	withNameQuery(String nameQuery) A query parameter specifying the name of the to-be-returned usage plan keys.
GetUsagePlanKeysRequest	withPosition(String position) The current pagination position in the paged result set.
GetUsagePlanKeysRequest	withUsagePlanId(String usagePlanId) The Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved UsagePlanKey resource representing a plan customer.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GetUsagePlanKeysRequest

public GetUsagePlanKeysRequest()

Method Detail

setUsagePlanId

public void setUsagePlanId(String usagePlanId)

The Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved UsagePlanKey resource representing a plan customer.

Parameters:

usagePlanId - The Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved UsagePlanKey resource representing a plan customer.

getUsagePlanId

public String getUsagePlanId()

The Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved UsagePlanKey resource representing a plan customer.

Returns:

The Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved UsagePlanKey resource representing a plan customer.

withUsagePlanId

public GetUsagePlanKeysRequest withUsagePlanId(String usagePlanId)

The Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved UsagePlanKey resource representing a plan customer.

Parameters:

usagePlanId - The Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved UsagePlanKey resource representing a plan customer.

Returns:

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

setPosition

public void setPosition(String position)

The current pagination position in the paged result set.

Parameters:

position - The current pagination position in the paged result set.

getPosition

public String getPosition()

The current pagination position in the paged result set.

Returns:

The current pagination position in the paged result set.

withPosition

public GetUsagePlanKeysRequest withPosition(String position)

The current pagination position in the paged result set.

Parameters:

position - The current pagination position in the paged result set.

Returns:

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

setLimit

public void setLimit(Integer limit)

The maximum number of returned results per page.

Parameters:

limit - The maximum number of returned results per page.

getLimit

public Integer getLimit()

The maximum number of returned results per page.

Returns:

The maximum number of returned results per page.

withLimit

public GetUsagePlanKeysRequest withLimit(Integer limit)

The maximum number of returned results per page.

Parameters:

limit - The maximum number of returned results per page.

Returns:

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

setNameQuery

public void setNameQuery(String nameQuery)

A query parameter specifying the name of the to-be-returned usage plan keys.

Parameters:

nameQuery - A query parameter specifying the name of the to-be-returned usage plan keys.

getNameQuery

public String getNameQuery()

A query parameter specifying the name of the to-be-returned usage plan keys.

Returns:

A query parameter specifying the name of the to-be-returned usage plan keys.

withNameQuery

public GetUsagePlanKeysRequest withNameQuery(String nameQuery)

A query parameter specifying the name of the to-be-returned usage plan keys.

Parameters:

nameQuery - A query parameter specifying the name of the to-be-returned usage plan keys.

Returns:

Returns a reference to this 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()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public GetUsagePlanKeysRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()