com.amazonaws.services.apigateway.model

Class CreateUsagePlanRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.apigateway.model.CreateUsagePlanRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

The POST request to create a usage plan with the name, description, throttle limits and quota limits, as well as the associated API stages, specified in the payload.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateUsagePlanRequest()

Method Summary

Modifier and Type	Method and Description
CreateUsagePlanRequest	addTagsEntry(String key, String value) Add a single Tags entry
CreateUsagePlanRequest	clearTagsEntries() Removes all the entries added into Tags.
CreateUsagePlanRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
List<ApiStage>	getApiStages() The associated API stages of the usage plan.
String	getDescription() The description of the usage plan.
String	getName() [Required] The name of the usage plan.
QuotaSettings	getQuota() The quota of the usage plan.
Map<String,String>	getTags() The key-value map of strings.
ThrottleSettings	getThrottle() The throttling limits of the usage plan.
int	hashCode()
void	setApiStages(Collection<ApiStage> apiStages) The associated API stages of the usage plan.
void	setDescription(String description) The description of the usage plan.
void	setName(String name) [Required] The name of the usage plan.
void	setQuota(QuotaSettings quota) The quota of the usage plan.
void	setTags(Map<String,String> tags) The key-value map of strings.
void	setThrottle(ThrottleSettings throttle) The throttling limits of the usage plan.
String	toString() Returns a string representation of this object.
CreateUsagePlanRequest	withApiStages(ApiStage... apiStages) The associated API stages of the usage plan.
CreateUsagePlanRequest	withApiStages(Collection<ApiStage> apiStages) The associated API stages of the usage plan.
CreateUsagePlanRequest	withDescription(String description) The description of the usage plan.
CreateUsagePlanRequest	withName(String name) [Required] The name of the usage plan.
CreateUsagePlanRequest	withQuota(QuotaSettings quota) The quota of the usage plan.
CreateUsagePlanRequest	withTags(Map<String,String> tags) The key-value map of strings.
CreateUsagePlanRequest	withThrottle(ThrottleSettings throttle) The throttling limits of the usage plan.

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

CreateUsagePlanRequest

public CreateUsagePlanRequest()

Method Detail

setName

public void setName(String name)

[Required] The name of the usage plan.

Parameters:

name - [Required] The name of the usage plan.

getName

public String getName()

[Required] The name of the usage plan.

Returns:

[Required] The name of the usage plan.

withName

public CreateUsagePlanRequest withName(String name)

[Required] The name of the usage plan.

Parameters:

name - [Required] The name of the usage plan.

Returns:

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

setDescription

public void setDescription(String description)

The description of the usage plan.

Parameters:

description - The description of the usage plan.

getDescription

public String getDescription()

The description of the usage plan.

Returns:

The description of the usage plan.

withDescription

public CreateUsagePlanRequest withDescription(String description)

The description of the usage plan.

Parameters:

description - The description of the usage plan.

Returns:

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

getApiStages

public List<ApiStage> getApiStages()

The associated API stages of the usage plan.

Returns:

The associated API stages of the usage plan.

setApiStages

public void setApiStages(Collection<ApiStage> apiStages)

The associated API stages of the usage plan.

Parameters:

apiStages - The associated API stages of the usage plan.

withApiStages

public CreateUsagePlanRequest withApiStages(ApiStage... apiStages)

The associated API stages of the usage plan.

NOTE: This method appends the values to the existing list (if any). Use setApiStages(java.util.Collection) or withApiStages(java.util.Collection) if you want to override the existing values.

Parameters:

apiStages - The associated API stages of the usage plan.

Returns:

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

withApiStages

public CreateUsagePlanRequest withApiStages(Collection<ApiStage> apiStages)

The associated API stages of the usage plan.

Parameters:

apiStages - The associated API stages of the usage plan.

Returns:

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

setThrottle

public void setThrottle(ThrottleSettings throttle)

The throttling limits of the usage plan.

Parameters:

throttle - The throttling limits of the usage plan.

getThrottle

public ThrottleSettings getThrottle()

The throttling limits of the usage plan.

Returns:

The throttling limits of the usage plan.

withThrottle

public CreateUsagePlanRequest withThrottle(ThrottleSettings throttle)

The throttling limits of the usage plan.

Parameters:

throttle - The throttling limits of the usage plan.

Returns:

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

setQuota

public void setQuota(QuotaSettings quota)

The quota of the usage plan.

Parameters:

quota - The quota of the usage plan.

getQuota

public QuotaSettings getQuota()

The quota of the usage plan.

Returns:

The quota of the usage plan.

withQuota

public CreateUsagePlanRequest withQuota(QuotaSettings quota)

The quota of the usage plan.

Parameters:

quota - The quota of the usage plan.

Returns:

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

getTags

public Map<String,String> getTags()

The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

Returns:

The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

setTags

public void setTags(Map<String,String> tags)

The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

Parameters:

tags - The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

withTags

public CreateUsagePlanRequest withTags(Map<String,String> tags)

The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

Parameters:

tags - The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

Returns:

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

addTagsEntry

public CreateUsagePlanRequest addTagsEntry(String key,
                                           String value)

Add a single Tags entry

See Also:

withTags(java.util.Map<java.lang.String, java.lang.String>)

clearTagsEntries

public CreateUsagePlanRequest clearTagsEntries()

Removes all the entries added into Tags.

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