software.amazon.awssdk.services.apigateway.model

Class UpdateUsagePlanRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.apigateway.model.ApiGatewayRequest

software.amazon.awssdk.services.apigateway.model.UpdateUsagePlanRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateUsagePlanRequest.Builder,UpdateUsagePlanRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class UpdateUsagePlanRequest
extends ApiGatewayRequest
implements ToCopyableBuilder<UpdateUsagePlanRequest.Builder,UpdateUsagePlanRequest>

The PATCH request to update a usage plan of a given plan Id.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UpdateUsagePlanRequest.Builder

Method Summary

Modifier and Type	Method and Description
static UpdateUsagePlanRequest.Builder	builder()
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
List<PatchOperation>	patchOperations() A list of update operations to be applied to the specified resource and in the order specified in this list.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateUsagePlanRequest.Builder>	serializableBuilderClass()
UpdateUsagePlanRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
String	usagePlanId() [Required] The Id of the to-be-updated usage plan.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

usagePlanId

public String usagePlanId()

[Required] The Id of the to-be-updated usage plan.

Returns:

[Required] The Id of the to-be-updated usage plan.

patchOperations

public List<PatchOperation> patchOperations()

A list of update operations to be applied to the specified resource and in the order specified in this list.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

A list of update operations to be applied to the specified resource and in the order specified in this list.

toBuilder

public UpdateUsagePlanRequest.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<UpdateUsagePlanRequest.Builder,UpdateUsagePlanRequest>

Specified by:

toBuilder in class ApiGatewayRequest

Returns:

a builder for type T

builder

public static UpdateUsagePlanRequest.Builder builder()

serializableBuilderClass

public static Class<? extends UpdateUsagePlanRequest.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

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.