com.solidfire.element.api

Class StartBulkVolumeWriteRequest

java.lang.Object

com.solidfire.element.api.StartBulkVolumeWriteRequest

All Implemented Interfaces:

java.io.Serializable

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

StartBulkVolumeWriteRequest StartBulkVolumeWrite enables you to initialize a bulk volume write session on a specified volume. Only two bulk volume processes can run simultaneously on a volume. When you initialize the write session, data is written to a SolidFire storage volume from 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.

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

Method Summary

Modifier and Type	Method and Description
StartBulkVolumeWriteRequest.Builder	asBuilder()
static StartBulkVolumeWriteRequest.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.
java.lang.Long	getVolumeID() The ID of the volume to be written to.
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	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

StartBulkVolumeWriteRequest

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

StartBulkVolumeWriteRequest

@Since(value="7.0")
public StartBulkVolumeWriteRequest(java.lang.Long volumeID,
                                                       java.lang.String format,
                                                       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 written to.

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)

getScript

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

The executable name of a script. If unspecified, the key and URL are necessary to access SF-series 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<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 StartBulkVolumeWriteRequest.Builder builder()

asBuilder

public final StartBulkVolumeWriteRequest.Builder asBuilder()