com.amazonaws.services.storagegateway.model

Class ListVolumesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.storagegateway.model.ListVolumesRequest

All Implemented Interfaces:

Serializable

public class ListVolumesRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the ListVolumes operation.

This operation lists the iSCSI stored volumes of a gateway. Results are sorted by volume ARN. The response includes only the volume ARNs. If you want additional volume information, use the DescribeStorediSCSIVolumes API.

The operation supports pagination. By default, the operation returns a maximum of up to 100 volumes. You can optionally specify the Limit field in the body to limit the number of volumes in the response. If the number of volumes returned in the response is truncated, the response includes a Marker field. You can use this Marker value in your subsequent request to retrieve the next set of volumes.

See Also:

AWSStorageGateway.listVolumes(ListVolumesRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ListVolumesRequest()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getGatewayARN() The Amazon Resource Name (ARN) of the gateway.
Integer	getLimit() Specifies that the list of volumes returned be limited to the specified number of items.
String	getMarker() A string that indicates the position at which to begin the returned list of volumes.
int	hashCode()
void	setGatewayARN(String gatewayARN) The Amazon Resource Name (ARN) of the gateway.
void	setLimit(Integer limit) Specifies that the list of volumes returned be limited to the specified number of items.
void	setMarker(String marker) A string that indicates the position at which to begin the returned list of volumes.
String	toString() Returns a string representation of this object; useful for testing and debugging.
ListVolumesRequest	withGatewayARN(String gatewayARN) The Amazon Resource Name (ARN) of the gateway.
ListVolumesRequest	withLimit(Integer limit) Specifies that the list of volumes returned be limited to the specified number of items.
ListVolumesRequest	withMarker(String marker) A string that indicates the position at which to begin the returned list of volumes.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

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

Methods inherited from class java.lang.Object

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

Constructor Detail

ListVolumesRequest

public ListVolumesRequest()

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

getMarker

public String getMarker()

A string that indicates the position at which to begin the returned list of volumes. Obtain the marker from the response of a previous List iSCSI Volumes request.

Constraints:
Length: 1 - 1000

Returns:

A string that indicates the position at which to begin the returned list of volumes. Obtain the marker from the response of a previous List iSCSI Volumes request.

setMarker

public void setMarker(String marker)

A string that indicates the position at which to begin the returned list of volumes. Obtain the marker from the response of a previous List iSCSI Volumes request.

Constraints:
Length: 1 - 1000

Parameters:

marker - A string that indicates the position at which to begin the returned list of volumes. Obtain the marker from the response of a previous List iSCSI Volumes request.

withMarker

public ListVolumesRequest withMarker(String marker)

A string that indicates the position at which to begin the returned list of volumes. Obtain the marker from the response of a previous List iSCSI Volumes request.

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

Constraints:
Length: 1 - 1000

Parameters:

marker - A string that indicates the position at which to begin the returned list of volumes. Obtain the marker from the response of a previous List iSCSI Volumes request.

Returns:

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

getLimit

public Integer getLimit()

Specifies that the list of volumes returned be limited to the specified number of items.

Constraints:
Range: 1 -

Returns:

Specifies that the list of volumes returned be limited to the specified number of items.

setLimit

public void setLimit(Integer limit)

Specifies that the list of volumes returned be limited to the specified number of items.

Constraints:
Range: 1 -

Parameters:

limit - Specifies that the list of volumes returned be limited to the specified number of items.

withLimit

public ListVolumesRequest withLimit(Integer limit)

Specifies that the list of volumes returned be limited to the specified number of items.

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

Constraints:
Range: 1 -

Parameters:

limit - Specifies that the list of volumes returned be limited to the specified number of items.

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