com.amazonaws.services.apigateway.model

Class GetUsagePlansRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.apigateway.model.GetUsagePlansRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

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

The GET request to get all the usage plans of the caller's account.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
GetUsagePlansRequest()

Method Summary

Modifier and Type	Method and Description
GetUsagePlansRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
String	getKeyId() The identifier of the API key associated with the usage plans.
Integer	getLimit() The number of UsagePlan resources to be returned as the result.
String	getPosition() The zero-based array index specifying the position of the to-be-retrieved UsagePlan resource.
int	hashCode()
void	setKeyId(String keyId) The identifier of the API key associated with the usage plans.
void	setLimit(Integer limit) The number of UsagePlan resources to be returned as the result.
void	setPosition(String position) The zero-based array index specifying the position of the to-be-retrieved UsagePlan resource.
String	toString() Returns a string representation of this object; useful for testing and debugging.
GetUsagePlansRequest	withKeyId(String keyId) The identifier of the API key associated with the usage plans.
GetUsagePlansRequest	withLimit(Integer limit) The number of UsagePlan resources to be returned as the result.
GetUsagePlansRequest	withPosition(String position) The zero-based array index specifying the position of the to-be-retrieved UsagePlan resource.

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

GetUsagePlansRequest

public GetUsagePlansRequest()

Method Detail

setPosition

public void setPosition(String position)

The zero-based array index specifying the position of the to-be-retrieved UsagePlan resource.

Parameters:

position - The zero-based array index specifying the position of the to-be-retrieved UsagePlan resource.

getPosition

public String getPosition()

The zero-based array index specifying the position of the to-be-retrieved UsagePlan resource.

Returns:

The zero-based array index specifying the position of the to-be-retrieved UsagePlan resource.

withPosition

public GetUsagePlansRequest withPosition(String position)

The zero-based array index specifying the position of the to-be-retrieved UsagePlan resource.

Parameters:

position - The zero-based array index specifying the position of the to-be-retrieved UsagePlan resource.

Returns:

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

setKeyId

public void setKeyId(String keyId)

The identifier of the API key associated with the usage plans.

Parameters:

keyId - The identifier of the API key associated with the usage plans.

getKeyId

public String getKeyId()

The identifier of the API key associated with the usage plans.

Returns:

The identifier of the API key associated with the usage plans.

withKeyId

public GetUsagePlansRequest withKeyId(String keyId)

The identifier of the API key associated with the usage plans.

Parameters:

keyId - The identifier of the API key associated with the usage plans.

Returns:

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

setLimit

public void setLimit(Integer limit)

The number of UsagePlan resources to be returned as the result.

Parameters:

limit - The number of UsagePlan resources to be returned as the result.

getLimit

public Integer getLimit()

The number of UsagePlan resources to be returned as the result.

Returns:

The number of UsagePlan resources to be returned as the result.

withLimit

public GetUsagePlansRequest withLimit(Integer limit)

The number of UsagePlan resources to be returned as the result.

Parameters:

limit - The number of UsagePlan resources to be returned as the result.

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 GetUsagePlansRequest 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()