com.solidfire.element.api

Class StartBulkVolumeReadRequest

Object

StartBulkVolumeReadRequest

All Implemented Interfaces:

Serializable

public class StartBulkVolumeReadRequest
extends Object
implements Serializable

StartBulkVolumeReadRequest

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StartBulkVolumeReadRequest.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

Constructor Summary

Constructors

Constructor and Description
StartBulkVolumeReadRequest()
StartBulkVolumeReadRequest(Long volumeID, String format, Optional<Long> snapshotID, Optional<String> script, Optional<Object> scriptParameters, Optional<Map<String,Object>> attributes)

Method Summary

Methods

Modifier and Type	Method and Description
StartBulkVolumeReadRequest.Builder	asBuilder()
static StartBulkVolumeReadRequest.Builder	builder()
boolean	equals(Object o)
Optional<Map<String,Object>>	getAttributes() JSON attributes for the bulk volume job.
String	getFormat() The format of the volume data.
Optional<String>	getScript() Executable name of a script.
Optional<Object>	getScriptParameters() JSON parameters to pass to the script.
Optional<Long>	getSnapshotID() ID of a previously created snapshot used for bulk volume reads.
Long	getVolumeID() ID of the volume to be read.
int	hashCode()
void	setAttributes(Optional<Map<String,Object>> attributes)
void	setFormat(String format)
void	setScript(Optional<String> script)
void	setScriptParameters(Optional<Object> scriptParameters)
void	setSnapshotID(Optional<Long> snapshotID)
void	setVolumeID(Long volumeID)
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

StartBulkVolumeReadRequest

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

StartBulkVolumeReadRequest

@Since(value="7.0")
public StartBulkVolumeReadRequest(Long volumeID,
                                     String format,
                                     Optional<Long> snapshotID,
                                     Optional<String> script,
                                     Optional<Object> scriptParameters,
                                     Optional<Map<String,Object>> attributes)

Method Detail

getVolumeID

public Long getVolumeID()

ID of the volume to be read.

setVolumeID

public void setVolumeID(Long volumeID)

getFormat

public String getFormat()

The format of the volume data. Can be either: uncompressed: every byte of the volume is returned without any compression. native: opaque data is returned that is smaller and more efficiently stored and written on a subsequent bulk volume write.

setFormat

public void setFormat(String format)

getSnapshotID

public Optional<Long> getSnapshotID()

ID of a previously created snapshot used for bulk volume reads. If no ID is entered, a snapshot of the current active volume image is made.

setSnapshotID

public void setSnapshotID(Optional<Long> snapshotID)

getScript

public Optional<String> getScript()

Executable name of a script. If no script name is given then the key and URL is necessary to access SolidFire nodes. The script is run on the primary node and the key and URL is returned to the script so the local web server can be contacted.

setScript

public void setScript(Optional<String> script)

getScriptParameters

public Optional<Object> getScriptParameters()

JSON parameters to pass to the script.

setScriptParameters

public void setScriptParameters(Optional<Object> scriptParameters)

getAttributes

public Optional<Map<String,Object>> getAttributes()

JSON attributes for the bulk volume job.

setAttributes

public void setAttributes(Optional<Map<String,Object>> attributes)

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

asBuilder

public final StartBulkVolumeReadRequest.Builder asBuilder()