com.solidfire.element.api

Class ListActiveVolumesRequest

java.lang.Object

com.solidfire.element.api.ListActiveVolumesRequest

All Implemented Interfaces:

java.io.Serializable

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

ListActiveVolumesRequest ListActiveVolumes enables you to return the list of active volumes currently in the system. The list of volumes is returned sorted in VolumeID order and can be returned in multiple parts (pages).

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListActiveVolumesRequest.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

Constructor Summary

Constructors

Constructor and Description
ListActiveVolumesRequest()
ListActiveVolumesRequest(Optional<java.lang.Long> startVolumeID, Optional<java.lang.Long> limit)
ListActiveVolumesRequest(Optional<java.lang.Long> startVolumeID, Optional<java.lang.Long> limit, Optional<java.lang.Boolean> includeVirtualVolumes)

Method Summary

Modifier and Type	Method and Description
ListActiveVolumesRequest.Builder	asBuilder()
static ListActiveVolumesRequest.Builder	builder()
boolean	equals(java.lang.Object o)
Optional<java.lang.Boolean>	getIncludeVirtualVolumes() Specifies that virtual volumes are included in the response by default.
Optional<java.lang.Long>	getLimit() Maximum number of Volume Info objects to return.
Optional<java.lang.Long>	getStartVolumeID() Starting VolumeID to return.
int	hashCode()
void	setIncludeVirtualVolumes(Optional<java.lang.Boolean> includeVirtualVolumes)
void	setLimit(Optional<java.lang.Long> limit)
void	setStartVolumeID(Optional<java.lang.Long> startVolumeID)
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

ListActiveVolumesRequest

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

ListActiveVolumesRequest

@Since(value="7.0")
public ListActiveVolumesRequest(Optional<java.lang.Long> startVolumeID,
                                                    Optional<java.lang.Long> limit)

ListActiveVolumesRequest

@Since(value="9.0")
public ListActiveVolumesRequest(Optional<java.lang.Long> startVolumeID,
                                                    Optional<java.lang.Long> limit,
                                                    Optional<java.lang.Boolean> includeVirtualVolumes)

Method Detail

getStartVolumeID

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

Starting VolumeID to return. If no volume exists with this VolumeID, the next volume by VolumeID order is used as the start of the list. To page through the list, pass the VolumeID of the last volume in the previous response + 1.

setStartVolumeID

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

getLimit

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

Maximum number of Volume Info objects to return. A value of 0 (zero) returns all volumes (unlimited).

setLimit

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

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)

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 ListActiveVolumesRequest.Builder builder()

asBuilder

public final ListActiveVolumesRequest.Builder asBuilder()