com.amazonaws.services.storagegateway.model

Class ListGatewaysRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.storagegateway.model.ListGatewaysRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class ListGatewaysRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the ListGateways operation.

This operation lists gateways owned by an AWS account in a region specified in the request. The returned list is ordered by gateway Amazon Resource Name (ARN).

By default, the operation returns a maximum of 100 gateways. This operation supports pagination that allows you to optionally reduce the number of gateways returned in a response.

If you have more gateways than are returned in a response-that is, the response returns only a truncated list of your gateways-the response contains a marker that you can specify in your next request to fetch the next page of gateways.

See Also:

AWSStorageGateway.listGateways(ListGatewaysRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ListGatewaysRequest()

Method Summary

Methods

Modifier and Type	Method and Description
ListGatewaysRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
Integer	getLimit() Specifies that the list of gateways returned be limited to the specified number of items.
String	getMarker() An opaque string that indicates the position at which to begin the returned list of gateways.
int	hashCode()
void	setLimit(Integer limit) Specifies that the list of gateways returned be limited to the specified number of items.
void	setMarker(String marker) An opaque string that indicates the position at which to begin the returned list of gateways.
String	toString() Returns a string representation of this object; useful for testing and debugging.
ListGatewaysRequest	withLimit(Integer limit) Specifies that the list of gateways returned be limited to the specified number of items.
ListGatewaysRequest	withMarker(String marker) An opaque string that indicates the position at which to begin the returned list of gateways.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, 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

ListGatewaysRequest

public ListGatewaysRequest()

Method Detail

getMarker

public String getMarker()

An opaque string that indicates the position at which to begin the returned list of gateways.

Constraints:
Length: 1 - 1000

Returns:

An opaque string that indicates the position at which to begin the returned list of gateways.

setMarker

public void setMarker(String marker)

An opaque string that indicates the position at which to begin the returned list of gateways.

Constraints:
Length: 1 - 1000

Parameters:

marker - An opaque string that indicates the position at which to begin the returned list of gateways.

withMarker

public ListGatewaysRequest withMarker(String marker)

An opaque string that indicates the position at which to begin the returned list of gateways.

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

Constraints:
Length: 1 - 1000

Parameters:

marker - An opaque string that indicates the position at which to begin the returned list of gateways.

Returns:

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

getLimit

public Integer getLimit()

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

Constraints:
Range: 1 -

Returns:

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

setLimit

public void setLimit(Integer limit)

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

Constraints:
Range: 1 -

Parameters:

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

withLimit

public ListGatewaysRequest withLimit(Integer limit)

Specifies that the list of gateways 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 gateways 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

clone

public ListGatewaysRequest 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()