@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CreateUsagePlanResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable, Cloneable
Represents a usage plan used to specify who can assess associated API stages. Optionally, target request rate and quota limits can be set. In some cases clients can exceed the targets that you set. Don’t rely on usage plans to control costs. Consider using Amazon Web Services Budgets to monitor costs and WAF to manage API requests.
Constructor and Description |
---|
CreateUsagePlanResult() |
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 Amazon Web Services Marketplace product identifier to associate with the usage plan as a SaaS product on the
Amazon Web Services Marketplace.
|
QuotaSettings |
getQuota()
The target maximum number of permitted requests per a given unit time interval.
|
Map<String,String> |
getTags()
The collection of tags.
|
ThrottleSettings |
getThrottle()
A map containing method level throttling information for API stage in 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 Amazon Web Services Marketplace product identifier to associate with the usage plan as a SaaS product on the
Amazon Web Services Marketplace.
|
void |
setQuota(QuotaSettings quota)
The target 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)
A map containing method level throttling information for API stage in 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 Amazon Web Services Marketplace product identifier to associate with the usage plan as a SaaS product on the
Amazon Web Services Marketplace.
|
CreateUsagePlanResult |
withQuota(QuotaSettings quota)
The target 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)
A map containing method level throttling information for API stage in a usage plan.
|
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata
public void setId(String id)
The identifier of a UsagePlan resource.
id
- The identifier of a UsagePlan resource.public String getId()
The identifier of a UsagePlan resource.
public CreateUsagePlanResult withId(String id)
The identifier of a UsagePlan resource.
id
- The identifier of a UsagePlan resource.public void setName(String name)
The name of a usage plan.
name
- The name of a usage plan.public String getName()
The name of a usage plan.
public CreateUsagePlanResult withName(String name)
The name of a usage plan.
name
- The name of a usage plan.public void setDescription(String description)
The description of a usage plan.
description
- The description of a usage plan.public String getDescription()
The description of a usage plan.
public CreateUsagePlanResult withDescription(String description)
The description of a usage plan.
description
- The description of a usage plan.public List<ApiStage> getApiStages()
The associated API stages of a usage plan.
public void setApiStages(Collection<ApiStage> apiStages)
The associated API stages of a usage plan.
apiStages
- The associated API stages of a usage plan.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.
apiStages
- The associated API stages of a usage plan.public CreateUsagePlanResult withApiStages(Collection<ApiStage> apiStages)
The associated API stages of a usage plan.
apiStages
- The associated API stages of a usage plan.public void setThrottle(ThrottleSettings throttle)
A map containing method level throttling information for API stage in a usage plan.
throttle
- A map containing method level throttling information for API stage in a usage plan.public ThrottleSettings getThrottle()
A map containing method level throttling information for API stage in a usage plan.
public CreateUsagePlanResult withThrottle(ThrottleSettings throttle)
A map containing method level throttling information for API stage in a usage plan.
throttle
- A map containing method level throttling information for API stage in a usage plan.public void setQuota(QuotaSettings quota)
The target maximum number of permitted requests per a given unit time interval.
quota
- The target maximum number of permitted requests per a given unit time interval.public QuotaSettings getQuota()
The target maximum number of permitted requests per a given unit time interval.
public CreateUsagePlanResult withQuota(QuotaSettings quota)
The target maximum number of permitted requests per a given unit time interval.
quota
- The target maximum number of permitted requests per a given unit time interval.public void setProductCode(String productCode)
The Amazon Web Services Marketplace product identifier to associate with the usage plan as a SaaS product on the Amazon Web Services Marketplace.
productCode
- The Amazon Web Services Marketplace product identifier to associate with the usage plan as a SaaS product
on the Amazon Web Services Marketplace.public String getProductCode()
The Amazon Web Services Marketplace product identifier to associate with the usage plan as a SaaS product on the Amazon Web Services Marketplace.
public CreateUsagePlanResult withProductCode(String productCode)
The Amazon Web Services Marketplace product identifier to associate with the usage plan as a SaaS product on the Amazon Web Services Marketplace.
productCode
- The Amazon Web Services Marketplace product identifier to associate with the usage plan as a SaaS product
on the Amazon Web Services Marketplace.public Map<String,String> getTags()
The collection of tags. Each tag element is associated with a given resource.
public void setTags(Map<String,String> tags)
The collection of tags. Each tag element is associated with a given resource.
tags
- The collection of tags. Each tag element is associated with a given resource.public CreateUsagePlanResult withTags(Map<String,String> tags)
The collection of tags. Each tag element is associated with a given resource.
tags
- The collection of tags. Each tag element is associated with a given resource.public CreateUsagePlanResult addTagsEntry(String key, String value)
public CreateUsagePlanResult clearTagsEntries()
public String toString()
toString
in class Object
Object.toString()
public CreateUsagePlanResult clone()