StartBulkVolumeReadRequest Class |
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.
Inheritance HierarchyNamespace: SolidFire.Element.Api
Assembly: SolidFire.SDK (in SolidFire.SDK.dll) Version: 12.3.0.0
SyntaxC#
public class StartBulkVolumeReadRequest : RpcBase
The StartBulkVolumeReadRequest type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | StartBulkVolumeReadRequest | Initializes a new instance of the StartBulkVolumeReadRequest class |
Properties| Name | Description | |
|---|---|---|
 | Attributes |
JSON attributes for the bulk volume job.
|
| Format |
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.
|
| Script |
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.
|
| ScriptParameters |
JSON parameters to pass to the script.
|
| SnapshotID |
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.
|
| VolumeID |
The ID of the volume to be read.
|
Methods| Name | Description | |
|---|---|---|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ToString |
Builds a json-enabled string of all the properties and their values in this class.
(Inherited from RpcBase.) |
See Also