com.solidfire.element.api

Class StartBulkVolumeReadRequest

java.lang.Object

com.solidfire.element.api.StartBulkVolumeReadRequest

All Implemented Interfaces:

java.io.Serializable

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

StartBulkVolumeReadRequest StartBulkVolumeRead enables you to initialize a bulk volume read session on a specified volume. Only two bulk volume processes can run simultaneously on a volume. When you initialize the session, data is read from a SolidFire storage volume for the purposes of storing the data on an external backup source. The external data is accessed by a web server running on an SF-series node. Communications and server interaction information for external data access is passed by a script running on the storage system. At the start of a bulk volume read operation, a snapshot of the volume is made and the snapshot is deleted when the read is complete. You can also read a snapshot of the volume by entering the ID of the snapshot as a parameter. When you read a previous snapshot, the system does not create a new snapshot of the volume or delete the previous snapshot when the read completes. Note: This process creates a new snapshot if the ID of an existing snapshot is not provided. Snapshots can be created if cluster fullness is at stage 2 or 3. Snapshots are not created when cluster fullness is at stage 4 or 5.

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(java.lang.Long volumeID, java.lang.String format, Optional<java.lang.Long> snapshotID, Optional<java.lang.String> script, Optional<Attributes> scriptParameters, Optional<Attributes> attributes)

Method Summary

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

StartBulkVolumeReadRequest

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

StartBulkVolumeReadRequest

@Since(value="7.0")
public StartBulkVolumeReadRequest(java.lang.Long volumeID,
                                                      java.lang.String format,
                                                      Optional<java.lang.Long> snapshotID,
                                                      Optional<java.lang.String> script,
                                                      Optional<Attributes> scriptParameters,
                                                      Optional<Attributes> attributes)

Method Detail

getVolumeID

public java.lang.Long getVolumeID()

The ID of the volume to be read.

setVolumeID

public void setVolumeID(java.lang.Long volumeID)

getFormat

public java.lang.String getFormat()

The format of the volume data. It can be either of the following formats: 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(java.lang.String format)

getSnapshotID

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

The 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<java.lang.Long> snapshotID)

getScript

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

The executable name of a script. If unspecified, the key and URL is necessary to access SF-series 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<java.lang.String> script)

getScriptParameters

public Optional<Attributes> getScriptParameters()

JSON parameters to pass to the script.

setScriptParameters

public void setScriptParameters(Optional<Attributes> scriptParameters)

getAttributes

public Optional<Attributes> getAttributes()

JSON attributes for the bulk volume job.

setAttributes

public void setAttributes(Optional<Attributes> attributes)

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

asBuilder

public final StartBulkVolumeReadRequest.Builder asBuilder()