DS3 .NET Software Development Kit
3.0.0
Provides access to the Spectra Logic DS3 API through .NET.
|
Public Member Functions | |
IJob | StartWriteJob (string bucket, IEnumerable< Ds3Object > objectsToWrite, long?maxBlobSize=null, IHelperStrategy< string > helperStrategy=null) |
Runs a DS3 bulk PUT request with a set of objects and returns an interface that can PUT individual objects efficiently to the server. More... | |
IJob | StartReadJob (string bucket, IEnumerable< Ds3Object > objectsToRead, IHelperStrategy< string > helperStrategy=null) |
Runs a DS3 bulk GET request with a set of objects and returns an interface that can GET individual objects efficiently from the server. More... | |
IJob | StartReadAllJob (string bucket, IHelperStrategy< string > helperStrategy=null) |
Runs a DS3 bulk GET request for all of the objects in a bucket. More... | |
IPartialReadJob | StartPartialReadJob (string bucket, IEnumerable< string > fullObjects, IEnumerable< Ds3PartialObject > partialObjects, IHelperStrategy< Ds3PartialObject > helperStrategy=null) |
Runs a DS3 bulk GET request with a set of partial object transfers and returns an interface that can GET individual object parts efficiently from the server. More... | |
IEnumerable< Ds3Object > | ListObjects (string bucketName) |
Returns information about all of the objects in a bucket. More... | |
IEnumerable< Ds3Object > | ListObjects (string bucketName, string keyPrefix) |
Returns information about all of the objects in a bucket whose names start with a given prefix. More... | |
void | EnsureBucketExists (string bucketName) |
Creates a bucket if it does not exist. More... | |
IJob | RecoverWriteJob (Guid jobId, IHelperStrategy< string > helperStrategy=null) |
Determines the state of an existing bulk PUT job and returns an interface that can PUT the remaining objects efficiently. More... | |
void Ds3.Helpers.IDs3ClientHelpers.EnsureBucketExists | ( | string | bucketName | ) |
Creates a bucket if it does not exist.
bucketName |
Implemented in Ds3.Helpers.Ds3ClientHelpers.
IEnumerable<Ds3Object> Ds3.Helpers.IDs3ClientHelpers.ListObjects | ( | string | bucketName | ) |
Returns information about all of the objects in a bucket.
Note that this method requests 1,000 objects at a time as they are consumed. Thus, if a bucket contains 2,500 objects and you call helpers.ListObjects("bucket").Take(1500).ToList() then the client will issue exactly two requests.
bucketName |
Implemented in Ds3.Helpers.Ds3ClientHelpers.
IEnumerable<Ds3Object> Ds3.Helpers.IDs3ClientHelpers.ListObjects | ( | string | bucketName, |
string | keyPrefix | ||
) |
Returns information about all of the objects in a bucket whose names start with a given prefix.
bucketName | |
keyPrefix |
Implemented in Ds3.Helpers.Ds3ClientHelpers.
IJob Ds3.Helpers.IDs3ClientHelpers.RecoverWriteJob | ( | Guid | jobId, |
IHelperStrategy< string > | helperStrategy = null |
||
) |
Determines the state of an existing bulk PUT job and returns an interface that can PUT the remaining objects efficiently.
jobId | |
helperStrategy |
Implemented in Ds3.Helpers.Ds3ClientHelpers.
IPartialReadJob Ds3.Helpers.IDs3ClientHelpers.StartPartialReadJob | ( | string | bucket, |
IEnumerable< string > | fullObjects, | ||
IEnumerable< Ds3PartialObject > | partialObjects, | ||
IHelperStrategy< Ds3PartialObject > | helperStrategy = null |
||
) |
Runs a DS3 bulk GET request with a set of partial object transfers and returns an interface that can GET individual object parts efficiently from the server.
Note that you can get multiple ranges within the same object at the same time, but those ranges must be non-overlapping.
bucket | The name of the bucket to get the objects from. |
fullObjects | The list of full objects to get. |
partialObjects | The object parts to get. |
helperStrategy |
Implemented in Ds3.Helpers.Ds3ClientHelpers.
IJob Ds3.Helpers.IDs3ClientHelpers.StartReadAllJob | ( | string | bucket, |
IHelperStrategy< string > | helperStrategy = null |
||
) |
Runs a DS3 bulk GET request for all of the objects in a bucket.
bucket | The name of the bucket to get the objects from. |
helperStrategy |
Implemented in Ds3.Helpers.Ds3ClientHelpers.
IJob Ds3.Helpers.IDs3ClientHelpers.StartReadJob | ( | string | bucket, |
IEnumerable< Ds3Object > | objectsToRead, | ||
IHelperStrategy< string > | helperStrategy = null |
||
) |
Runs a DS3 bulk GET request with a set of objects and returns an interface that can GET individual objects efficiently from the server.
bucket | The name of the bucket to get the objects from. |
objectsToRead | The object names to get. |
helperStrategy |
Implemented in Ds3.Helpers.Ds3ClientHelpers.
IJob Ds3.Helpers.IDs3ClientHelpers.StartWriteJob | ( | string | bucket, |
IEnumerable< Ds3Object > | objectsToWrite, | ||
long? | maxBlobSize = null , |
||
IHelperStrategy< string > | helperStrategy = null |
||
) |
Runs a DS3 bulk PUT request with a set of objects and returns an interface that can PUT individual objects efficiently to the server.
bucket | The name of the bucket to put the objects to. |
objectsToWrite | The object names and sizes to put. |
maxBlobSize | The (optional) maximum size for the parts of the objects to transmit. |
helperStrategy |
Implemented in Ds3.Helpers.Ds3ClientHelpers.