com.solidfire.element.api

Class ListVolumesRequest

java.lang.Object

com.solidfire.element.api.ListVolumesRequest

All Implemented Interfaces:

java.io.Serializable

public class ListVolumesRequest
extends java.lang.Object
implements java.io.Serializable

ListVolumesRequest The ListVolumes method enables you to retrieve a list of volumes that are in a cluster. You can specify the volumes you want to return in the list by using the available parameters.

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<java.lang.Long> startVolumeID, Optional<java.lang.Long> limit, Optional<java.lang.String> volumeStatus, Optional<java.lang.Long[]> accounts, Optional<java.lang.Boolean> isPaired, Optional<java.lang.Long[]> volumeIDs, Optional<java.lang.String> volumeName, Optional<java.lang.Boolean> includeVirtualVolumes, Optional<java.lang.String[]> protectionSchemes)
ListVolumesRequest(Optional<java.lang.Long> startVolumeID, Optional<java.lang.Long> limit, Optional<java.lang.String> volumeStatus, Optional<java.lang.Long[]> accounts, Optional<java.lang.Boolean> isPaired, Optional<java.lang.Long[]> volumeIDs, Optional<java.lang.String> volumeName, Optional<java.lang.String[]> protectionSchemes)

Method Summary

Modifier and Type	Method and Description
ListVolumesRequest.Builder	asBuilder()
static ListVolumesRequest.Builder	builder()
boolean	equals(java.lang.Object o)
Optional<java.lang.Long[]>	getAccounts() Returns only the volumes owned by the accounts you specify here.
Optional<java.lang.Boolean>	getIncludeVirtualVolumes() Specifies that virtual volumes are included in the response by default.
Optional<java.lang.Boolean>	getIsPaired() Returns volumes that are paired or not paired.
Optional<java.lang.Long>	getLimit() Specifies the maximum number of volume results that are returned.
Optional<java.lang.String[]>	getProtectionSchemes() Only volumes that are using one of the protection schemes in this set are returned.
Optional<java.lang.Long>	getStartVolumeID() Only volumes with an ID greater than or equal to this value are returned.
Optional<java.lang.Long[]>	getVolumeIDs() A list of volume IDs.
Optional<java.lang.String>	getVolumeName() Only volume object information matching the volume name is returned.
Optional<java.lang.String>	getVolumeStatus() Only volumes with a status equal to the status value are returned.
int	hashCode()
void	setAccounts(Optional<java.lang.Long[]> accounts)
void	setIncludeVirtualVolumes(Optional<java.lang.Boolean> includeVirtualVolumes)
void	setIsPaired(Optional<java.lang.Boolean> isPaired)
void	setLimit(Optional<java.lang.Long> limit)
void	setProtectionSchemes(Optional<java.lang.String[]> protectionSchemes)
void	setStartVolumeID(Optional<java.lang.Long> startVolumeID)
void	setVolumeIDs(Optional<java.lang.Long[]> volumeIDs)
void	setVolumeName(Optional<java.lang.String> volumeName)
void	setVolumeStatus(Optional<java.lang.String> volumeStatus)
java.util.Map<java.lang.String,java.lang.Object>	toMap()
java.lang.String	toString()

Methods inherited from class java.lang.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<java.lang.Long> startVolumeID,
                                              Optional<java.lang.Long> limit,
                                              Optional<java.lang.String> volumeStatus,
                                              Optional<java.lang.Long[]> accounts,
                                              Optional<java.lang.Boolean> isPaired,
                                              Optional<java.lang.Long[]> volumeIDs,
                                              Optional<java.lang.String> volumeName,
                                              Optional<java.lang.String[]> protectionSchemes)

ListVolumesRequest

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

Method Detail

getStartVolumeID

public Optional<java.lang.Long> getStartVolumeID()

Only volumes with an ID greater than or equal to this value are returned. Mutually exclusive with the volumeIDs parameter.

setStartVolumeID

public void setStartVolumeID(Optional<java.lang.Long> startVolumeID)

getLimit

public Optional<java.lang.Long> getLimit()

Specifies the maximum number of volume results that are returned. Mutually exclusive with the volumeIDs parameter.

setLimit

public void setLimit(Optional<java.lang.Long> limit)

getVolumeStatus

public Optional<java.lang.String> getVolumeStatus()

Only volumes with a status equal to the status value are returned. Possible values are: creating snapshotting active deleted

setVolumeStatus

public void setVolumeStatus(Optional<java.lang.String> volumeStatus)

getAccounts

public Optional<java.lang.Long[]> getAccounts()

Returns only the volumes owned by the accounts you specify here. Mutually exclusive with the volumeIDs parameter.

setAccounts

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

getIsPaired

public Optional<java.lang.Boolean> getIsPaired()

Returns volumes that are paired or not paired. Possible values are: true: Returns all paired volumes. false: Returns all volumes that are not paired.

setIsPaired

public void setIsPaired(Optional<java.lang.Boolean> isPaired)

getVolumeIDs

public Optional<java.lang.Long[]> getVolumeIDs()

A list of volume IDs. If you supply this parameter, other parameters operate only on this set of volumes. Mutually exclusive with the accounts, startVolumeID, and limit parameters.

setVolumeIDs

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

getVolumeName

public Optional<java.lang.String> getVolumeName()

Only volume object information matching the volume name is returned.

setVolumeName

public void setVolumeName(Optional<java.lang.String> volumeName)

getIncludeVirtualVolumes

public Optional<java.lang.Boolean> getIncludeVirtualVolumes()

Specifies that virtual volumes are included in the response by default. To exclude virtual volumes, set to false.

setIncludeVirtualVolumes

public void setIncludeVirtualVolumes(Optional<java.lang.Boolean> includeVirtualVolumes)

getProtectionSchemes

public Optional<java.lang.String[]> getProtectionSchemes()

Only volumes that are using one of the protection schemes in this set are returned.

setProtectionSchemes

public void setProtectionSchemes(Optional<java.lang.String[]> protectionSchemes)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toMap

public java.util.Map<java.lang.String,java.lang.Object> toMap()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

builder

public static ListVolumesRequest.Builder builder()

asBuilder

public final ListVolumesRequest.Builder asBuilder()