Ds3.Helpers.IBaseJob< TSelf, TItem > Interface Template Reference

Public Member Functions
TSelf	WithMaxParallelRequests (int maxParallelRequests)
	Must always be called before the Transfer method. More...
TSelf	WithCancellationToken (CancellationToken cancellationToken)
	Must always be called before the Transfer method. More...
void	Transfer (Func< TItem, Stream > createStreamForTransferItem)
	Performs all GETs or PUTs for the job (depending on the type of job). More...

Properties
Guid	JobId [get]
	The id that allows the client to track job status and recover or delete jobs in the case of a failure during transfer. More...
string	BucketName [get]
	The name of the bucket that this job is transferring to. More...

Events
Action< long >	DataTransferred
	Fires handlers with the amount of additional data that's been transferred when a part of a job is transferred. More...
Action< TItem >	ItemCompleted
	Fires handlers with the name of each transferred item as their transfers finish. More...

Member Function Documentation

void Ds3.Helpers.IBaseJob< TSelf, TItem >.Transfer

(

Func< TItem, Stream >

createStreamForTransferItem

)

Performs all GETs or PUTs for the job (depending on the type of job).

This method uses DS3 cache handling requests to efficiently transfer objects and handles multiplexing single object streams when the DS3 job response splits individual objects into multiple requests. It also performs requests in parallel for situations where doing so can improve performance.

See also

FileHelpers.BuildFileGetter, FileHelpers.BuildFilePutter

Parameters

createStreamForTransferItem

Opens a stream for a given transfer item.

TSelf Ds3.Helpers.IBaseJob< TSelf, TItem >.WithCancellationToken

(

CancellationToken

cancellationToken

)

Must always be called before the Transfer method.

Allows the client to stop transferring to a job using a CancellationTokenSource. Note that this does not cancel a job, and the job can be resumed later. If you'd like to cancel a job, use IDs3Client.DeleteJob().

Parameters

cancellationToken

Returns

This IJob instance.

TSelf Ds3.Helpers.IBaseJob< TSelf, TItem >.WithMaxParallelRequests

(

int

maxParallelRequests

)

Must always be called before the Transfer method.

Specifies The maximum number of simultaneous transfers to or from the server for this particular job.

Parameters

maxParallelRequests

Returns

This IJob instance.

Property Documentation

string Ds3.Helpers.IBaseJob< TSelf, TItem >.BucketName

get

The name of the bucket that this job is transferring to.

Guid Ds3.Helpers.IBaseJob< TSelf, TItem >.JobId

get

The id that allows the client to track job status and recover or delete jobs in the case of a failure during transfer.

Event Documentation

Action<long> Ds3.Helpers.IBaseJob< TSelf, TItem >.DataTransferred

Fires handlers with the amount of additional data that's been transferred when a part of a job is transferred.

Action<TItem> Ds3.Helpers.IBaseJob< TSelf, TItem >.ItemCompleted

Fires handlers with the name of each transferred item as their transfers finish.