com.amazonaws.services.apigateway.model

Class GetUsagePlanKeysRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.apigateway.model.GetUsagePlanKeysRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

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 request.
boolean	equals(Object obj)
Integer	getLimit() A query parameter specifying the maximum number usage plan keys returned by the GET request.
String	getNameQuery() A query parameter specifying the name of the to-be-returned usage plan keys.
String	getPosition() A query parameter specifying the zero-based index specifying the position of a usage plan key.
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) A query parameter specifying the maximum number usage plan keys returned by the GET request.
void	setNameQuery(String nameQuery) A query parameter specifying the name of the to-be-returned usage plan keys.
void	setPosition(String position) A query parameter specifying the zero-based index specifying the position of a usage plan key.
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) A query parameter specifying the maximum number usage plan keys returned by the GET request.
GetUsagePlanKeysRequest	withNameQuery(String nameQuery) A query parameter specifying the name of the to-be-returned usage plan keys.
GetUsagePlanKeysRequest	withPosition(String position) A query parameter specifying the zero-based index specifying the position of a usage plan key.
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

getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, 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)

A query parameter specifying the zero-based index specifying the position of a usage plan key.

Parameters:

position - A query parameter specifying the zero-based index specifying the position of a usage plan key.

getPosition

public String getPosition()

A query parameter specifying the zero-based index specifying the position of a usage plan key.

Returns:

A query parameter specifying the zero-based index specifying the position of a usage plan key.

withPosition

public GetUsagePlanKeysRequest withPosition(String position)

A query parameter specifying the zero-based index specifying the position of a usage plan key.

Parameters:

position - A query parameter specifying the zero-based index specifying the position of a usage plan key.

Returns:

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

setLimit

public void setLimit(Integer limit)

A query parameter specifying the maximum number usage plan keys returned by the GET request.

Parameters:

limit - A query parameter specifying the maximum number usage plan keys returned by the GET request.

getLimit

public Integer getLimit()

A query parameter specifying the maximum number usage plan keys returned by the GET request.

Returns:

A query parameter specifying the maximum number usage plan keys returned by the GET request.

withLimit

public GetUsagePlanKeysRequest withLimit(Integer limit)

A query parameter specifying the maximum number usage plan keys returned by the GET request.

Parameters:

limit - A query parameter specifying the maximum number usage plan keys returned by the GET request.

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 request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()