com.amazonaws.services.opsworks.model

Class DescribeVolumesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.opsworks.model.DescribeVolumesRequest

All Implemented Interfaces:

Serializable

public class DescribeVolumesRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the DescribeVolumes operation.

Describes an instance's Amazon EBS volumes.

NOTE: You must specify at least one of the parameters.

Required Permissions : To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions .

See Also:

AWSOpsWorks.describeVolumes(DescribeVolumesRequest), Serialized Form

Constructor Summary

Constructors

Constructor and Description
DescribeVolumesRequest()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getInstanceId() The instance ID.
String	getRaidArrayId() The RAID array ID.
String	getStackId() A stack ID.
List<String>	getVolumeIds() Am array of volume IDs.
int	hashCode()
void	setInstanceId(String instanceId) The instance ID.
void	setRaidArrayId(String raidArrayId) The RAID array ID.
void	setStackId(String stackId) A stack ID.
void	setVolumeIds(Collection<String> volumeIds) Am array of volume IDs.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribeVolumesRequest	withInstanceId(String instanceId) The instance ID.
DescribeVolumesRequest	withRaidArrayId(String raidArrayId) The RAID array ID.
DescribeVolumesRequest	withStackId(String stackId) A stack ID.
DescribeVolumesRequest	withVolumeIds(Collection<String> volumeIds) Am array of volume IDs.
DescribeVolumesRequest	withVolumeIds(String... volumeIds) Am array of volume IDs.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setRequestCredentials, setRequestMetricCollector, withRequestMetricCollector

Methods inherited from class java.lang.Object

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

Constructor Detail

DescribeVolumesRequest

public DescribeVolumesRequest()

Method Detail

getInstanceId

public String getInstanceId()

The instance ID. If you use this parameter, DescribeVolumes returns descriptions of the volumes associated with the specified instance.

Returns:

The instance ID. If you use this parameter, DescribeVolumes returns descriptions of the volumes associated with the specified instance.

setInstanceId

public void setInstanceId(String instanceId)

The instance ID. If you use this parameter, DescribeVolumes returns descriptions of the volumes associated with the specified instance.

Parameters:

instanceId - The instance ID. If you use this parameter, DescribeVolumes returns descriptions of the volumes associated with the specified instance.

withInstanceId

public DescribeVolumesRequest withInstanceId(String instanceId)

The instance ID. If you use this parameter, DescribeVolumes returns descriptions of the volumes associated with the specified instance.

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

Parameters:

instanceId - The instance ID. If you use this parameter, DescribeVolumes returns descriptions of the volumes associated with the specified instance.

Returns:

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

getStackId

public String getStackId()

A stack ID. The action describes the stack's registered Amazon EBS volumes.

Returns:

A stack ID. The action describes the stack's registered Amazon EBS volumes.

setStackId

public void setStackId(String stackId)

A stack ID. The action describes the stack's registered Amazon EBS volumes.

Parameters:

stackId - A stack ID. The action describes the stack's registered Amazon EBS volumes.

withStackId

public DescribeVolumesRequest withStackId(String stackId)

A stack ID. The action describes the stack's registered Amazon EBS volumes.

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

Parameters:

stackId - A stack ID. The action describes the stack's registered Amazon EBS volumes.

Returns:

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

getRaidArrayId

public String getRaidArrayId()

The RAID array ID. If you use this parameter, DescribeVolumes returns descriptions of the volumes associated with the specified RAID array.

Returns:

The RAID array ID. If you use this parameter, DescribeVolumes returns descriptions of the volumes associated with the specified RAID array.

setRaidArrayId

public void setRaidArrayId(String raidArrayId)

The RAID array ID. If you use this parameter, DescribeVolumes returns descriptions of the volumes associated with the specified RAID array.

Parameters:

raidArrayId - The RAID array ID. If you use this parameter, DescribeVolumes returns descriptions of the volumes associated with the specified RAID array.

withRaidArrayId

public DescribeVolumesRequest withRaidArrayId(String raidArrayId)

The RAID array ID. If you use this parameter, DescribeVolumes returns descriptions of the volumes associated with the specified RAID array.

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

Parameters:

raidArrayId - The RAID array ID. If you use this parameter, DescribeVolumes returns descriptions of the volumes associated with the specified RAID array.

Returns:

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

getVolumeIds

public List<String> getVolumeIds()

Am array of volume IDs. If you use this parameter, DescribeVolumes returns descriptions of the specified volumes. Otherwise, it returns a description of every volume.

Returns:

Am array of volume IDs. If you use this parameter, DescribeVolumes returns descriptions of the specified volumes. Otherwise, it returns a description of every volume.

setVolumeIds

public void setVolumeIds(Collection<String> volumeIds)

Am array of volume IDs. If you use this parameter, DescribeVolumes returns descriptions of the specified volumes. Otherwise, it returns a description of every volume.

Parameters:

volumeIds - Am array of volume IDs. If you use this parameter, DescribeVolumes returns descriptions of the specified volumes. Otherwise, it returns a description of every volume.

withVolumeIds

public DescribeVolumesRequest withVolumeIds(String... volumeIds)

Am array of volume IDs. If you use this parameter, DescribeVolumes returns descriptions of the specified volumes. Otherwise, it returns a description of every volume.

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

Parameters:

volumeIds - Am array of volume IDs. If you use this parameter, DescribeVolumes returns descriptions of the specified volumes. Otherwise, it returns a description of every volume.

Returns:

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

withVolumeIds

public DescribeVolumesRequest withVolumeIds(Collection<String> volumeIds)

Am array of volume IDs. If you use this parameter, DescribeVolumes returns descriptions of the specified volumes. Otherwise, it returns a description of every volume.

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

Parameters:

volumeIds - Am array of volume IDs. If you use this parameter, DescribeVolumes returns descriptions of the specified volumes. Otherwise, it returns a description of every volume.

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