com.amazonaws.services.apigateway.model

Class GetUsagePlansRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.apigateway.model.GetUsagePlansRequest

All Implemented Interfaces:

HandlerContextAware, 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 object for all fields except the handler context.
boolean	equals(Object obj)
String	getKeyId() The identifier of the API key associated with the usage plans.
Integer	getLimit() The maximum number of returned results per page.
String	getPosition() The current pagination position in the paged result set.
int	hashCode()
void	setKeyId(String keyId) The identifier of the API key associated with the usage plans.
void	setLimit(Integer limit) The maximum number of returned results per page.
void	setPosition(String position) The current pagination position in the paged result set.
String	toString() Returns a string representation of this object.
GetUsagePlansRequest	withKeyId(String keyId) The identifier of the API key associated with the usage plans.
GetUsagePlansRequest	withLimit(Integer limit) The maximum number of returned results per page.
GetUsagePlansRequest	withPosition(String position) The current pagination position in the paged result set.

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

GetUsagePlansRequest

public GetUsagePlansRequest()

Method Detail

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 GetUsagePlansRequest 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.

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 maximum number of returned results per page. The default value is 25 and the maximum value is 500.

Parameters:

limit - The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

getLimit

public Integer getLimit()

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

Returns:

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

withLimit

public GetUsagePlansRequest withLimit(Integer limit)

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

Parameters:

limit - The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

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. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

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