UsagePlanKey (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.apigateway.model.UsagePlanKey

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class UsagePlanKey
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Represents a usage plan key to identify a plan customer.

To associate an API stage with a selected API key in a usage plan, you must create a UsagePlanKey resource to represent the selected ApiKey.

"
Create and Use Usage Plans

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

UsagePlanKey()

Constructors
Constructor and Description
`UsagePlanKey()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`UsagePlanKey`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getId()` The Id of a usage plan key.
`String`	`getName()` The name of a usage plan key.
`String`	`getType()` The type of a usage plan key.
`String`	`getValue()` The value of a usage plan key.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setId(String id)` The Id of a usage plan key.
`void`	`setName(String name)` The name of a usage plan key.
`void`	`setType(String type)` The type of a usage plan key.
`void`	`setValue(String value)` The value of a usage plan key.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`UsagePlanKey`	`withId(String id)` The Id of a usage plan key.
`UsagePlanKey`	`withName(String name)` The name of a usage plan key.
`UsagePlanKey`	`withType(String type)` The type of a usage plan key.
`UsagePlanKey`	`withValue(String value)` The value of a usage plan key.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - UsagePlanKey
```
public UsagePlanKey()
```
- Method Detail
  - setId
```
public void setId(String id)
```
    The Id of a usage plan key.
    
    Parameters:
    
    id - The Id of a usage plan key.
  - getId
```
public String getId()
```
    The Id of a usage plan key.
    
    Returns:
    
    The Id of a usage plan key.
  - withId
```
public UsagePlanKey withId(String id)
```
    The Id of a usage plan key.
    
    Parameters:
    
    id - The Id of a usage plan key.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setType
```
public void setType(String type)
```
    The type of a usage plan key. Currently, the valid key type is API_KEY.
    
    Parameters:
    
    type - The type of a usage plan key. Currently, the valid key type is API_KEY.
  - getType
```
public String getType()
```
    The type of a usage plan key. Currently, the valid key type is API_KEY.
    
    Returns:
    
    The type of a usage plan key. Currently, the valid key type is API_KEY.
  - withType
```
public UsagePlanKey withType(String type)
```
    The type of a usage plan key. Currently, the valid key type is API_KEY.
    
    Parameters:
    
    type - The type of a usage plan key. Currently, the valid key type is API_KEY.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setValue
```
public void setValue(String value)
```
    The value of a usage plan key.
    
    Parameters:
    
    value - The value of a usage plan key.
  - getValue
```
public String getValue()
```
    The value of a usage plan key.
    
    Returns:
    
    The value of a usage plan key.
  - withValue
```
public UsagePlanKey withValue(String value)
```
    The value of a usage plan key.
    
    Parameters:
    
    value - The value of a usage plan key.
    
    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 key.
    
    Parameters:
    
    name - The name of a usage plan key.
  - getName
```
public String getName()
```
    The name of a usage plan key.
    
    Returns:
    
    The name of a usage plan key.
  - withName
```
public UsagePlanKey withName(String name)
```
    The name of a usage plan key.
    
    Parameters:
    
    name - The name of a usage plan key.
    
    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 UsagePlanKey clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class UsagePlanKey

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

UsagePlanKey

Method Detail

setId

getId

withId

setType

getType

withType

setValue

getValue

withValue

setName

getName

withName

toString

equals

hashCode

clone

marshall