GetUsagePlanResult (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceResult<ResponseMetadata>
- - com.amazonaws.services.apigateway.model.GetUsagePlanResult

All Implemented Interfaces:

Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GetUsagePlanResult
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

GetUsagePlanResult()

Constructors
Constructor and Description
`GetUsagePlanResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GetUsagePlanResult`	`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.
`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`	`setThrottle(ThrottleSettings throttle)` The request throttle limits of a usage plan.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`GetUsagePlanResult`	`withApiStages(ApiStage... apiStages)` The associated API stages of a usage plan.
`GetUsagePlanResult`	`withApiStages(Collection<ApiStage> apiStages)` The associated API stages of a usage plan.
`GetUsagePlanResult`	`withDescription(String description)` The description of a usage plan.
`GetUsagePlanResult`	`withId(String id)` The identifier of a UsagePlan resource.
`GetUsagePlanResult`	`withName(String name)` The name of a usage plan.
`GetUsagePlanResult`	`withProductCode(String productCode)` The AWS Markeplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace.
`GetUsagePlanResult`	`withQuota(QuotaSettings quota)` The maximum number of permitted requests per a given unit time interval.
`GetUsagePlanResult`	`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
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - GetUsagePlanResult
```
public GetUsagePlanResult()
```
- 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 GetUsagePlanResult 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 GetUsagePlanResult 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 GetUsagePlanResult 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 GetUsagePlanResult 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 GetUsagePlanResult 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 GetUsagePlanResult 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 GetUsagePlanResult 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 GetUsagePlanResult 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.
  - 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 GetUsagePlanResult clone()
```
    Overrides:
    
    clone in class Object

Did this page help you?

Class GetUsagePlanResult

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceResult

Methods inherited from class java.lang.Object

Constructor Detail

GetUsagePlanResult

Method Detail

setId

getId

withId

setName

getName

withName

setDescription

getDescription

withDescription

getApiStages

setApiStages

withApiStages

withApiStages

setThrottle

getThrottle

withThrottle

setQuota

getQuota

withQuota

setProductCode

getProductCode

withProductCode

toString

equals

hashCode

clone