com.solidfire.element.api

Class ListVolumesRequest

Object

ListVolumesRequest

All Implemented Interfaces:

Serializable

public class ListVolumesRequest
extends Object
implements Serializable

ListVolumesRequest

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListVolumesRequest.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

Constructor Summary

Constructors

Constructor and Description
ListVolumesRequest()
ListVolumesRequest(Optional<Long> startVolumeID, Optional<Long> limit, Optional<String> volumeStatus, Optional<Long[]> accounts, Optional<Boolean> isPaired)
ListVolumesRequest(Optional<Long> startVolumeID, Optional<Long> limit, Optional<String> volumeStatus, Optional<Long[]> accounts, Optional<Boolean> isPaired, Optional<Long[]> volumeIDs)

Method Summary

Methods

Modifier and Type	Method and Description
ListVolumesRequest.Builder	asBuilder()
static ListVolumesRequest.Builder	builder()
boolean	equals(Object o)
Optional<Long[]>	getAccounts() If specified, only fetch volumes which belong to the provided accounts.
Optional<Boolean>	getIsPaired() If specified, only fetch volumes which are paired (if true) or non-paired (if false).
Optional<Long>	getLimit() The maximum number of volumes to return from the API.
Optional<Long>	getStartVolumeID() The ID of the first volume to list.
Optional<Long[]>	getVolumeIDs() If specified, only fetch volumes specified in this list.
Optional<String>	getVolumeStatus() If specified, filter to only volumes with the provided status.
int	hashCode()
void	setAccounts(Optional<Long[]> accounts)
void	setIsPaired(Optional<Boolean> isPaired)
void	setLimit(Optional<Long> limit)
void	setStartVolumeID(Optional<Long> startVolumeID)
void	setVolumeIDs(Optional<Long[]> volumeIDs)
void	setVolumeStatus(Optional<String> volumeStatus)
Map<String,Object>	toMap()
String	toString()

Methods inherited from class Object

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

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

ListVolumesRequest

@Since(value="7.0")
public ListVolumesRequest()

ListVolumesRequest

@Since(value="7.0")
public ListVolumesRequest(Optional<Long> startVolumeID,
                             Optional<Long> limit,
                             Optional<String> volumeStatus,
                             Optional<Long[]> accounts,
                             Optional<Boolean> isPaired)

ListVolumesRequest

@Since(value="9.0")
public ListVolumesRequest(Optional<Long> startVolumeID,
                             Optional<Long> limit,
                             Optional<String> volumeStatus,
                             Optional<Long[]> accounts,
                             Optional<Boolean> isPaired,
                             Optional<Long[]> volumeIDs)

Method Detail

getStartVolumeID

public Optional<Long> getStartVolumeID()

The ID of the first volume to list. This can be useful for paging results. By default, this starts at the lowest VolumeID.

setStartVolumeID

public void setStartVolumeID(Optional<Long> startVolumeID)

getLimit

public Optional<Long> getLimit()

The maximum number of volumes to return from the API.

setLimit

public void setLimit(Optional<Long> limit)

getVolumeStatus

public Optional<String> getVolumeStatus()

If specified, filter to only volumes with the provided status. By default, list all volumes.

setVolumeStatus

public void setVolumeStatus(Optional<String> volumeStatus)

getAccounts

public Optional<Long[]> getAccounts()

If specified, only fetch volumes which belong to the provided accounts. By default, list volumes for all accounts.

setAccounts

public void setAccounts(Optional<Long[]> accounts)

getIsPaired

public Optional<Boolean> getIsPaired()

If specified, only fetch volumes which are paired (if true) or non-paired (if false). By default, list all volumes regardless of their pairing status.

setIsPaired

public void setIsPaired(Optional<Boolean> isPaired)

getVolumeIDs

public Optional<Long[]> getVolumeIDs()

If specified, only fetch volumes specified in this list. This option cannot be specified if startVolumeID, limit, or accounts option is specified.

setVolumeIDs

public void setVolumeIDs(Optional<Long[]> volumeIDs)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toMap

public Map<String,Object> toMap()

toString

public String toString()

Overrides:

toString in class Object

builder

public static ListVolumesRequest.Builder builder()

asBuilder

public final ListVolumesRequest.Builder asBuilder()