software.amazon.awssdk.services.apigateway.model

Class UpdateUsageRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateUsageRequest.Builder,UpdateUsageRequest>

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

The PATCH request to grant a temporary extension to the remaining quota of a usage plan associated with a specified API key.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UpdateUsageRequest.Builder

Method Summary

Modifier and Type	Method and Description
static UpdateUsageRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasPatchOperations() For responses, this returns true if the service returned a value for the PatchOperations property.
String	keyId() The identifier of the API key associated with the usage plan in which a temporary extension is granted to the remaining quota.
List<PatchOperation>	patchOperations() For more information about supported patch operations, see Patch Operations.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateUsageRequest.Builder>	serializableBuilderClass()
UpdateUsageRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	usagePlanId() The Id of the usage plan associated with the usage data.

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

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

usagePlanId

public final String usagePlanId()

The Id of the usage plan associated with the usage data.

Returns:

The Id of the usage plan associated with the usage data.

keyId

public final String keyId()

The identifier of the API key associated with the usage plan in which a temporary extension is granted to the remaining quota.

Returns:

The identifier of the API key associated with the usage plan in which a temporary extension is granted to the remaining quota.

hasPatchOperations

public final boolean hasPatchOperations()

For responses, this returns true if the service returned a value for the PatchOperations property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

patchOperations

public final List<PatchOperation> patchOperations()

For more information about supported patch operations, see Patch Operations.

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasPatchOperations() method.

Returns:

For more information about supported patch operations, see Patch Operations.

toBuilder

public UpdateUsageRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateUsageRequest.Builder,UpdateUsageRequest>

Specified by:

toBuilder in class ApiGatewayRequest

builder

public static UpdateUsageRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

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

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo