Constructor
# new OsduR2DeliverByQueryTask(osdu_service, data_partition)
Parameters:
| Name | Type | Description |
|---|---|---|
osdu_service |
OsduR2BaseService | An implementation of the OSDU service class to broker communication with the OSDU API services |
data_partition |
string | The data partition against which requests will be made |
Methods
# async execute() → {Object}
Execute the task, querying and delivering in batches based on the set query parameters
A summary of the performed task, including a map of delivered records deliveredRecords, the total count of records for the query totalCount, the number of batches that succeeded batches, the last cursor used (if an error was encountered) lastCursor, and the error that was thrown (if encountered) error
Object
# setQuery(query_params) → {OsduR2UpdateByQueryTask}
Set the query parameters to be used for batched query requests. Query params must have a file kind
Parameters:
| Name | Type | Description |
|---|---|---|
query_params |
Object | Query parameters built using the OsduQueryBuilder |
Itself to allow chaining