com.amazonaws.services.apigateway.model

Class UpdateUsageRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.apigateway.model.UpdateUsageRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class UpdateUsageRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

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

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
UpdateUsageRequest()

Method Summary

Modifier and Type	Method and Description
UpdateUsageRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getKeyId() The identifier of the API key associated with the usage plan in which a temporary extension is granted to the remaining quota.
List<PatchOperation>	getPatchOperations() For more information about supported patch operations, see Patch Operations.
String	getUsagePlanId() The Id of the usage plan associated with the usage data.
int	hashCode()
void	setKeyId(String keyId) The identifier of the API key associated with the usage plan in which a temporary extension is granted to the remaining quota.
void	setPatchOperations(Collection<PatchOperation> patchOperations) For more information about supported patch operations, see Patch Operations.
void	setUsagePlanId(String usagePlanId) The Id of the usage plan associated with the usage data.
String	toString() Returns a string representation of this object.
UpdateUsageRequest	withKeyId(String keyId) The identifier of the API key associated with the usage plan in which a temporary extension is granted to the remaining quota.
UpdateUsageRequest	withPatchOperations(Collection<PatchOperation> patchOperations) For more information about supported patch operations, see Patch Operations.
UpdateUsageRequest	withPatchOperations(PatchOperation... patchOperations) For more information about supported patch operations, see Patch Operations.
UpdateUsageRequest	withUsagePlanId(String usagePlanId) The Id of the usage plan associated with the usage data.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UpdateUsageRequest

public UpdateUsageRequest()

Method Detail

setUsagePlanId

public void setUsagePlanId(String usagePlanId)

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

Parameters:

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

getUsagePlanId

public String getUsagePlanId()

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

Returns:

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

withUsagePlanId

public UpdateUsageRequest withUsagePlanId(String usagePlanId)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setKeyId

public void setKeyId(String keyId)

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

Parameters:

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

getKeyId

public String getKeyId()

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.

withKeyId

public UpdateUsageRequest withKeyId(String keyId)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

getPatchOperations

public List<PatchOperation> getPatchOperations()

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

Returns:

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

setPatchOperations

public void setPatchOperations(Collection<PatchOperation> patchOperations)

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

Parameters:

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

withPatchOperations

public UpdateUsageRequest withPatchOperations(PatchOperation... patchOperations)

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

NOTE: This method appends the values to the existing list (if any). Use setPatchOperations(java.util.Collection) or withPatchOperations(java.util.Collection) if you want to override the existing values.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

withPatchOperations

public UpdateUsageRequest withPatchOperations(Collection<PatchOperation> patchOperations)

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

Parameters:

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

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. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

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 UpdateUsageRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()