com.solidfire.element.api

Class StartBulkVolumeWriteRequest

Object

StartBulkVolumeWriteRequest

All Implemented Interfaces:

Serializable

public class StartBulkVolumeWriteRequest
extends Object
implements Serializable

StartBulkVolumeWriteRequest

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StartBulkVolumeWriteRequest.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
StartBulkVolumeWriteRequest.Builder	asBuilder()
static StartBulkVolumeWriteRequest.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.
Long	getVolumeID() ID of the volume to be written to.
int	hashCode()
void	setAttributes(Optional<Map<String,Object>> attributes)
void	setFormat(String format)
void	setScript(Optional<String> script)
void	setScriptParameters(Optional<Object> scriptParameters)
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

StartBulkVolumeWriteRequest

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

StartBulkVolumeWriteRequest

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

Method Detail

getVolumeID

public Long getVolumeID()

ID of the volume to be written to.

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)

getScript

public Optional<String> getScript()

Executable name of a script. If no script name is given then the key and URL are necessary to access SolidFire nodes. The script runs 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 StartBulkVolumeWriteRequest.Builder builder()

asBuilder

public final StartBulkVolumeWriteRequest.Builder asBuilder()