Quaero.DW.Batch

Quaero.DW.Batch

Quaero.DW.Batch Class

public class Quaero.DW.Batch : Quaero.DW.Links;
Object that holds the batch upload state for scans and document queue uploads.

batchID Field

System.String (Quaero.DW.Batch)batch.batchID;
Unique ID of this batch. See JSON batchid.

queue Field

System.String (Quaero.DW.Batch)batch.queue;
Name of the processing queue this batch will upload to. See JSON queue.

is_closed Property

System.Boolean (Quaero.DW.Batch)batch.is_closed;
If true, this batch was closed or canceled.

upload() Method

Quaero.DW.Batch Quaero.DW.Batch.upload(System.String src, System.String name);
Upload one file to the queue.

Parameters

src
Fully qualified path to the file.
[System.String]
name
Name of file on the server. Optional; defaults to the base name of src.
[System.String]

Returns

Itself.
[Quaero.DW.Batch]

upload_req() Method

System.Net.Http.HttpRequestMessage Quaero.DW.Batch.upload_req(System.String src, System.String name);
Create a request to upload another file.

Parameters

src
Fully qualified path to the file.
[System.String]
name
Name of file on the server. Optional; defaults to the base name of src.
[System.String]

Returns

close() Method

Quaero.DW.Done Quaero.DW.Batch.close();
Close the queue and place all the files ready for processing.

Returns

close_req() Method

System.Net.Http.HttpRequestMessage Quaero.DW.Batch.close_req();
Build a REST request to close the queue.

Returns

cancel() Method

Quaero.DW.Done Quaero.DW.Batch.cancel();
Cancel the batch and delete all the files on the server. Local files are not affected.

Returns

cancel_req() Method

System.Net.Http.HttpRequestMessage Quaero.DW.Batch.cancel_req();
Build a REST request to cancel the batch.

Returns