com.amazonaws.services.storagegateway.model

Class UpdateBandwidthRateLimitRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.storagegateway.model.UpdateBandwidthRateLimitRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class UpdateBandwidthRateLimitRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the UpdateBandwidthRateLimit operation.

This operation updates the bandwidth rate limits of a gateway. You can update both the upload and download bandwidth rate limit or specify only one of the two. If you don't set a bandwidth rate limit, the existing rate limit remains.

By default, a gateway's bandwidth rate limits are not set. If you don't set any limit, the gateway does not have any limitations on its bandwidth usage and could potentially use the maximum available bandwidth.

To specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in your request.

See Also:

AWSStorageGateway.updateBandwidthRateLimit(UpdateBandwidthRateLimitRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
UpdateBandwidthRateLimitRequest()

Method Summary

Methods

Modifier and Type	Method and Description
UpdateBandwidthRateLimitRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
Long	getAverageDownloadRateLimitInBitsPerSec() The average download bandwidth rate limit in bits per second.
Long	getAverageUploadRateLimitInBitsPerSec() The average upload bandwidth rate limit in bits per second.
String	getGatewayARN() The Amazon Resource Name (ARN) of the gateway.
int	hashCode()
void	setAverageDownloadRateLimitInBitsPerSec(Long averageDownloadRateLimitInBitsPerSec) The average download bandwidth rate limit in bits per second.
void	setAverageUploadRateLimitInBitsPerSec(Long averageUploadRateLimitInBitsPerSec) The average upload bandwidth rate limit in bits per second.
void	setGatewayARN(String gatewayARN) The Amazon Resource Name (ARN) of the gateway.
String	toString() Returns a string representation of this object; useful for testing and debugging.
UpdateBandwidthRateLimitRequest	withAverageDownloadRateLimitInBitsPerSec(Long averageDownloadRateLimitInBitsPerSec) The average download bandwidth rate limit in bits per second.
UpdateBandwidthRateLimitRequest	withAverageUploadRateLimitInBitsPerSec(Long averageUploadRateLimitInBitsPerSec) The average upload bandwidth rate limit in bits per second.
UpdateBandwidthRateLimitRequest	withGatewayARN(String gatewayARN) The Amazon Resource Name (ARN) of the gateway.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, copyPrivateRequestParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

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

Constructor Detail

UpdateBandwidthRateLimitRequest

public UpdateBandwidthRateLimitRequest()

Method Detail

getGatewayARN

public String getGatewayARN()

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

Constraints:
Length: 50 - 500

Returns:

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

setGatewayARN

public void setGatewayARN(String gatewayARN)

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

Constraints:
Length: 50 - 500

Parameters:

gatewayARN - The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

withGatewayARN

public UpdateBandwidthRateLimitRequest withGatewayARN(String gatewayARN)

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

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

Constraints:
Length: 50 - 500

Parameters:

gatewayARN - The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

Returns:

A reference to this updated object so that method calls can be chained together.

getAverageUploadRateLimitInBitsPerSec

public Long getAverageUploadRateLimitInBitsPerSec()

The average upload bandwidth rate limit in bits per second.

Constraints:
Range: 51200 -

Returns:

The average upload bandwidth rate limit in bits per second.

setAverageUploadRateLimitInBitsPerSec

public void setAverageUploadRateLimitInBitsPerSec(Long averageUploadRateLimitInBitsPerSec)

The average upload bandwidth rate limit in bits per second.

Constraints:
Range: 51200 -

Parameters:

averageUploadRateLimitInBitsPerSec - The average upload bandwidth rate limit in bits per second.

withAverageUploadRateLimitInBitsPerSec

public UpdateBandwidthRateLimitRequest withAverageUploadRateLimitInBitsPerSec(Long averageUploadRateLimitInBitsPerSec)

The average upload bandwidth rate limit in bits per second.

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

Constraints:
Range: 51200 -

Parameters:

averageUploadRateLimitInBitsPerSec - The average upload bandwidth rate limit in bits per second.

Returns:

A reference to this updated object so that method calls can be chained together.

getAverageDownloadRateLimitInBitsPerSec

public Long getAverageDownloadRateLimitInBitsPerSec()

The average download bandwidth rate limit in bits per second.

Constraints:
Range: 102400 -

Returns:

The average download bandwidth rate limit in bits per second.

setAverageDownloadRateLimitInBitsPerSec

public void setAverageDownloadRateLimitInBitsPerSec(Long averageDownloadRateLimitInBitsPerSec)

The average download bandwidth rate limit in bits per second.

Constraints:
Range: 102400 -

Parameters:

averageDownloadRateLimitInBitsPerSec - The average download bandwidth rate limit in bits per second.

withAverageDownloadRateLimitInBitsPerSec

public UpdateBandwidthRateLimitRequest withAverageDownloadRateLimitInBitsPerSec(Long averageDownloadRateLimitInBitsPerSec)

The average download bandwidth rate limit in bits per second.

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

Constraints:
Range: 102400 -

Parameters:

averageDownloadRateLimitInBitsPerSec - The average download bandwidth rate limit in bits per second.

Returns:

A reference to this updated 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()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public UpdateBandwidthRateLimitRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()