Package software.amazon.awssdk.services.apigateway.model

Class UsagePlanKey

java.lang.Object

software.amazon.awssdk.services.apigateway.model.UsagePlanKey

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<UsagePlanKey.Builder,UsagePlanKey>

@Generated("software.amazon.awssdk:codegen")
public class UsagePlanKey
extends Object
implements StructuredPojo, ToCopyableBuilder<UsagePlanKey.Builder,UsagePlanKey>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UsagePlanKey.Builder

Method Summary

Modifier and Type	Method	Description
static UsagePlanKey.Builder	builder()
boolean	equals(Object obj)
int	hashCode()
String	id()	The Id of a usage plan key.
void	marshall(ProtocolMarshaller protocolMarshaller)	Marshalls this structured data using the given ProtocolMarshaller.
String	name()	The name of a usage plan key.
static Class<? extends UsagePlanKey.Builder>	serializableBuilderClass()
UsagePlanKey.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()
String	type()	The type of a usage plan key.
String	value()	The value of a usage plan key.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

id

public String id()

The Id of a usage plan key.

Returns:

The Id of a usage plan key.

type

public String type()

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.

value

public String value()

The value of a usage plan key.

Returns:

The value of a usage plan key.

name

public String name()

The name of a usage plan key.

Returns:

The name of a usage plan key.

toBuilder

public UsagePlanKey.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<UsagePlanKey.Builder,UsagePlanKey>

Returns:

a builder for type T

builder

public static UsagePlanKey.Builder builder()

serializableBuilderClass

public static Class<? extends UsagePlanKey.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString 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.