DS3 .NET Software Development Kit  3.0.0
Provides access to the Spectra Logic DS3 API through .NET.
Ds3.Calls.GetJobChunksReadyForClientProcessingSpectraS3Response Class Referenceabstract

Public Member Functions

void Match (Action< TimeSpan, MasterObjectList > success, Action< TimeSpan > retryAfter)
 Convenience overload if the client wants to throw a job gone exception if the job is gone. More...
 
Match< T > (Func< TimeSpan, MasterObjectList, T > success, Func< TimeSpan, T > retryAfter)
 Convenience overload if the client wants to throw a job gone exception if the job is gone. More...
 
abstract void Match (Action< TimeSpan, MasterObjectList > success, Action jobGone, Action< TimeSpan > retryAfter)
 Calls success, jobGone, or retryAfter depending on which response type this actually is. More...
 
abstract T Match< T > (Func< TimeSpan, MasterObjectList, T > success, Func< T > jobGone, Func< TimeSpan, T > retryAfter)
 Calls success, jobGone, or retryAfter depending on which response type this actually is. More...
 

Static Public Member Functions

static GetJobChunksReadyForClientProcessingSpectraS3Response Success (TimeSpan retryAfter, MasterObjectList jobResponse)
 Creates a response object stating that the job has chunks available. More...
 
static GetJobChunksReadyForClientProcessingSpectraS3Response RetryAfter (TimeSpan retryAfter)
 Creates a response object stating that there are no chunks available to process. More...
 

Properties

static GetJobChunksReadyForClientProcessingSpectraS3Response JobGone [get]
 Creates a response object stating that the job does not exist. More...
 

Member Function Documentation

void Ds3.Calls.GetJobChunksReadyForClientProcessingSpectraS3Response.Match ( Action< TimeSpan, MasterObjectList success,
Action< TimeSpan >  retryAfter 
)
inline

Convenience overload if the client wants to throw a job gone exception if the job is gone.

Parameters
success
retryAfter
Returns
abstract void Ds3.Calls.GetJobChunksReadyForClientProcessingSpectraS3Response.Match ( Action< TimeSpan, MasterObjectList success,
Action  jobGone,
Action< TimeSpan >  retryAfter 
)
pure virtual

Calls success, jobGone, or retryAfter depending on which response type this actually is.

Parameters
successThe function to call if the response object is a "success".
jobGoneThe function to call if the response object is "jobGone".
retryAfterThe function to call if the response object is "retryAfter".
T Ds3.Calls.GetJobChunksReadyForClientProcessingSpectraS3Response.Match< T > ( Func< TimeSpan, MasterObjectList, T >  success,
Func< TimeSpan, T >  retryAfter 
)
inline

Convenience overload if the client wants to throw a job gone exception if the job is gone.

Template Parameters
T
Parameters
success
retryAfter
Returns
abstract T Ds3.Calls.GetJobChunksReadyForClientProcessingSpectraS3Response.Match< T > ( Func< TimeSpan, MasterObjectList, T >  success,
Func< T >  jobGone,
Func< TimeSpan, T >  retryAfter 
)
pure virtual

Calls success, jobGone, or retryAfter depending on which response type this actually is.

Parameters
successThe function to call if the response object is a "success".
jobGoneThe function to call if the response object is "jobGone".
retryAfterThe function to call if the response object is "retryAfter".
Returns
What success, jobGone, or retryAfter return.
static GetJobChunksReadyForClientProcessingSpectraS3Response Ds3.Calls.GetJobChunksReadyForClientProcessingSpectraS3Response.RetryAfter ( TimeSpan  retryAfter)
inlinestatic

Creates a response object stating that there are no chunks available to process.

Parameters
retryAfterThe amount of time to wait before asking again.
Returns
The new response instance.
static GetJobChunksReadyForClientProcessingSpectraS3Response Ds3.Calls.GetJobChunksReadyForClientProcessingSpectraS3Response.Success ( TimeSpan  retryAfter,
MasterObjectList  jobResponse 
)
inlinestatic

Creates a response object stating that the job has chunks available.

Parameters
retryAfterThe number of seconds to wait before performing the REST call again if the client already knows about all of the chunks provided.
jobResponseA job response with only the chunks that are available for the client.
Returns
The new response instance.

Property Documentation

GetJobChunksReadyForClientProcessingSpectraS3Response Ds3.Calls.GetJobChunksReadyForClientProcessingSpectraS3Response.JobGone
staticget

Creates a response object stating that the job does not exist.