com.amazonaws.services.apigateway.model

Class CreateUsagePlanResult

java.lang.Object

com.amazonaws.AmazonWebServiceResult<ResponseMetadata>

com.amazonaws.services.apigateway.model.CreateUsagePlanResult

All Implemented Interfaces:

Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateUsagePlanResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

Represents a usage plan than can specify who can assess associated API stages with specified request limits and quotas.

In a usage plan, you associate an API by specifying the API's Id and a stage name of the specified API. You add plan customers by adding API keys to the plan.

Create and Use Usage Plans

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CreateUsagePlanResult()

Method Summary

Modifier and Type	Method and Description
CreateUsagePlanResult	addTagsEntry(String key, String value) Add a single Tags entry
CreateUsagePlanResult	clearTagsEntries() Removes all the entries added into Tags.
CreateUsagePlanResult	clone()
boolean	equals(Object obj)
List<ApiStage>	getApiStages() The associated API stages of a usage plan.
String	getDescription() The description of a usage plan.
String	getId() The identifier of a UsagePlan resource.
String	getName() The name of a usage plan.
String	getProductCode() The AWS Markeplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace.
QuotaSettings	getQuota() The maximum number of permitted requests per a given unit time interval.
Map<String,String>	getTags() The collection of tags.
ThrottleSettings	getThrottle() The request throttle limits of a usage plan.
int	hashCode()
void	setApiStages(Collection<ApiStage> apiStages) The associated API stages of a usage plan.
void	setDescription(String description) The description of a usage plan.
void	setId(String id) The identifier of a UsagePlan resource.
void	setName(String name) The name of a usage plan.
void	setProductCode(String productCode) The AWS Markeplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace.
void	setQuota(QuotaSettings quota) The maximum number of permitted requests per a given unit time interval.
void	setTags(Map<String,String> tags) The collection of tags.
void	setThrottle(ThrottleSettings throttle) The request throttle limits of a usage plan.
String	toString() Returns a string representation of this object.
CreateUsagePlanResult	withApiStages(ApiStage... apiStages) The associated API stages of a usage plan.
CreateUsagePlanResult	withApiStages(Collection<ApiStage> apiStages) The associated API stages of a usage plan.
CreateUsagePlanResult	withDescription(String description) The description of a usage plan.
CreateUsagePlanResult	withId(String id) The identifier of a UsagePlan resource.
CreateUsagePlanResult	withName(String name) The name of a usage plan.
CreateUsagePlanResult	withProductCode(String productCode) The AWS Markeplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace.
CreateUsagePlanResult	withQuota(QuotaSettings quota) The maximum number of permitted requests per a given unit time interval.
CreateUsagePlanResult	withTags(Map<String,String> tags) The collection of tags.
CreateUsagePlanResult	withThrottle(ThrottleSettings throttle) The request throttle limits of a usage plan.

Methods inherited from class com.amazonaws.AmazonWebServiceResult

getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateUsagePlanResult

public CreateUsagePlanResult()

Method Detail

setId

public void setId(String id)

The identifier of a UsagePlan resource.

Parameters:

id - The identifier of a UsagePlan resource.

getId

public String getId()

The identifier of a UsagePlan resource.

Returns:

The identifier of a UsagePlan resource.

withId

public CreateUsagePlanResult withId(String id)

The identifier of a UsagePlan resource.

Parameters:

id - The identifier of a UsagePlan resource.

Returns:

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

setName

public void setName(String name)

The name of a usage plan.

Parameters:

name - The name of a usage plan.

getName

public String getName()

The name of a usage plan.

Returns:

The name of a usage plan.

withName

public CreateUsagePlanResult withName(String name)

The name of a usage plan.

Parameters:

name - The name of a 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 a usage plan.

Parameters:

description - The description of a usage plan.

getDescription

public String getDescription()

The description of a usage plan.

Returns:

The description of a usage plan.

withDescription

public CreateUsagePlanResult withDescription(String description)

The description of a usage plan.

Parameters:

description - The description of a 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 a usage plan.

Returns:

The associated API stages of a usage plan.

setApiStages

public void setApiStages(Collection<ApiStage> apiStages)

The associated API stages of a usage plan.

Parameters:

apiStages - The associated API stages of a usage plan.

withApiStages

public CreateUsagePlanResult withApiStages(ApiStage... apiStages)

The associated API stages of a 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 a usage plan.

Returns:

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

withApiStages

public CreateUsagePlanResult withApiStages(Collection<ApiStage> apiStages)

The associated API stages of a usage plan.

Parameters:

apiStages - The associated API stages of a usage plan.

Returns:

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

setThrottle

public void setThrottle(ThrottleSettings throttle)

The request throttle limits of a usage plan.

Parameters:

throttle - The request throttle limits of a usage plan.

getThrottle

public ThrottleSettings getThrottle()

The request throttle limits of a usage plan.

Returns:

The request throttle limits of a usage plan.

withThrottle

public CreateUsagePlanResult withThrottle(ThrottleSettings throttle)

The request throttle limits of a usage plan.

Parameters:

throttle - The request throttle limits of a usage plan.

Returns:

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

setQuota

public void setQuota(QuotaSettings quota)

The maximum number of permitted requests per a given unit time interval.

Parameters:

quota - The maximum number of permitted requests per a given unit time interval.

getQuota

public QuotaSettings getQuota()

The maximum number of permitted requests per a given unit time interval.

Returns:

The maximum number of permitted requests per a given unit time interval.

withQuota

public CreateUsagePlanResult withQuota(QuotaSettings quota)

The maximum number of permitted requests per a given unit time interval.

Parameters:

quota - The maximum number of permitted requests per a given unit time interval.

Returns:

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

setProductCode

public void setProductCode(String productCode)

The AWS Markeplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace.

Parameters:

productCode - The AWS Markeplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace.

getProductCode

public String getProductCode()

The AWS Markeplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace.

Returns:

The AWS Markeplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace.

withProductCode

public CreateUsagePlanResult withProductCode(String productCode)

The AWS Markeplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace.

Parameters:

productCode - The AWS Markeplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace.

Returns:

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

getTags

public Map<String,String> getTags()

The collection of tags. Each tag element is associated with a given resource.

Returns:

The collection of tags. Each tag element is associated with a given resource.

setTags

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

The collection of tags. Each tag element is associated with a given resource.

Parameters:

tags - The collection of tags. Each tag element is associated with a given resource.

withTags

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

The collection of tags. Each tag element is associated with a given resource.

Parameters:

tags - The collection of tags. Each tag element is associated with a given resource.

Returns:

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

addTagsEntry

public CreateUsagePlanResult addTagsEntry(String key,
                                          String value)

Add a single Tags entry

See Also:

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

clearTagsEntries

public CreateUsagePlanResult 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 CreateUsagePlanResult clone()

Overrides:

clone in class Object