com.amazonaws.services.storagegateway.model

Class DescribeVTLDevicesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.storagegateway.model.DescribeVTLDevicesRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class DescribeVTLDevicesRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the DescribeVTLDevices operation.

Returns a description of virtual tape library (VTL) devices for the specified gateway. In the response, AWS Storage Gateway returns VTL device information.

The list of VTL devices must be from one gateway.

See Also:

AWSStorageGateway.describeVTLDevices(DescribeVTLDevicesRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeVTLDevicesRequest()

Method Summary

Methods

Modifier and Type	Method and Description
DescribeVTLDevicesRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
String	getGatewayARN() The Amazon Resource Name (ARN) of the gateway.
Integer	getLimit() Specifies that the number of VTL devices described be limited to the specified number.
String	getMarker() An opaque string that indicates the position at which to begin describing the VTL devices.
List<String>	getVTLDeviceARNs() An array of strings, where each string represents the Amazon Resource Name (ARN) of a VTL device.
int	hashCode()
void	setGatewayARN(String gatewayARN) The Amazon Resource Name (ARN) of the gateway.
void	setLimit(Integer limit) Specifies that the number of VTL devices described be limited to the specified number.
void	setMarker(String marker) An opaque string that indicates the position at which to begin describing the VTL devices.
void	setVTLDeviceARNs(Collection<String> vTLDeviceARNs) An array of strings, where each string represents the Amazon Resource Name (ARN) of a VTL device.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribeVTLDevicesRequest	withGatewayARN(String gatewayARN) The Amazon Resource Name (ARN) of the gateway.
DescribeVTLDevicesRequest	withLimit(Integer limit) Specifies that the number of VTL devices described be limited to the specified number.
DescribeVTLDevicesRequest	withMarker(String marker) An opaque string that indicates the position at which to begin describing the VTL devices.
DescribeVTLDevicesRequest	withVTLDeviceARNs(Collection<String> vTLDeviceARNs) An array of strings, where each string represents the Amazon Resource Name (ARN) of a VTL device.
DescribeVTLDevicesRequest	withVTLDeviceARNs(String... vTLDeviceARNs) An array of strings, where each string represents the Amazon Resource Name (ARN) of a VTL device.

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

DescribeVTLDevicesRequest

public DescribeVTLDevicesRequest()

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

getVTLDeviceARNs

public List<String> getVTLDeviceARNs()

An array of strings, where each string represents the Amazon Resource Name (ARN) of a VTL device. All of the specified VTL devices must be from the same gateway. If no VTL devices are specified, the result will contain all devices on the specified gateway.

Returns:

An array of strings, where each string represents the Amazon Resource Name (ARN) of a VTL device. All of the specified VTL devices must be from the same gateway. If no VTL devices are specified, the result will contain all devices on the specified gateway.

setVTLDeviceARNs

public void setVTLDeviceARNs(Collection<String> vTLDeviceARNs)

An array of strings, where each string represents the Amazon Resource Name (ARN) of a VTL device. All of the specified VTL devices must be from the same gateway. If no VTL devices are specified, the result will contain all devices on the specified gateway.

Parameters:

vTLDeviceARNs - An array of strings, where each string represents the Amazon Resource Name (ARN) of a VTL device. All of the specified VTL devices must be from the same gateway. If no VTL devices are specified, the result will contain all devices on the specified gateway.

withVTLDeviceARNs

public DescribeVTLDevicesRequest withVTLDeviceARNs(String... vTLDeviceARNs)

An array of strings, where each string represents the Amazon Resource Name (ARN) of a VTL device. All of the specified VTL devices must be from the same gateway. If no VTL devices are specified, the result will contain all devices on the specified gateway.

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

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

Parameters:

vTLDeviceARNs - An array of strings, where each string represents the Amazon Resource Name (ARN) of a VTL device. All of the specified VTL devices must be from the same gateway. If no VTL devices are specified, the result will contain all devices on the specified gateway.

Returns:

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

withVTLDeviceARNs

public DescribeVTLDevicesRequest withVTLDeviceARNs(Collection<String> vTLDeviceARNs)

An array of strings, where each string represents the Amazon Resource Name (ARN) of a VTL device. All of the specified VTL devices must be from the same gateway. If no VTL devices are specified, the result will contain all devices on the specified gateway.

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

Parameters:

vTLDeviceARNs - An array of strings, where each string represents the Amazon Resource Name (ARN) of a VTL device. All of the specified VTL devices must be from the same gateway. If no VTL devices are specified, the result will contain all devices on the specified gateway.

Returns:

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

getMarker

public String getMarker()

An opaque string that indicates the position at which to begin describing the VTL devices.

Constraints:
Length: 1 - 1000

Returns:

An opaque string that indicates the position at which to begin describing the VTL devices.

setMarker

public void setMarker(String marker)

An opaque string that indicates the position at which to begin describing the VTL devices.

Constraints:
Length: 1 - 1000

Parameters:

marker - An opaque string that indicates the position at which to begin describing the VTL devices.

withMarker

public DescribeVTLDevicesRequest withMarker(String marker)

An opaque string that indicates the position at which to begin describing the VTL devices.

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 describing the VTL devices.

Returns:

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

getLimit

public Integer getLimit()

Specifies that the number of VTL devices described be limited to the specified number.

Constraints:
Range: 1 -

Returns:

Specifies that the number of VTL devices described be limited to the specified number.

setLimit

public void setLimit(Integer limit)

Specifies that the number of VTL devices described be limited to the specified number.

Constraints:
Range: 1 -

Parameters:

limit - Specifies that the number of VTL devices described be limited to the specified number.

withLimit

public DescribeVTLDevicesRequest withLimit(Integer limit)

Specifies that the number of VTL devices described be limited to the specified number.

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

Constraints:
Range: 1 -

Parameters:

limit - Specifies that the number of VTL devices described be limited to the specified number.

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 DescribeVTLDevicesRequest 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()