Table of Contents

Namespace BiExcellence.OpenBi.Api.BatchJobs

Classes

BatchJob

A scheduled or event-triggered batch job. Used as both the request and response body.

BatchJobHandler

Metadata describing a batch job handler type registered on the server.

BatchJobHandlerParameter

Metadata describing one parameter a batch job handler accepts.

BatchJobLog

One run of a batch job.

BatchJobLogEntry

One log line written during a batch job run.

BatchJobParameter

A single named/value parameter passed to a batch job handler at run time.

ExecuteBatchJobEventRequest

Request body for running every batch job registered for an event (POST batchjobevents/execute).

ExecuteBatchJobRequest

Request body for running a single batch job now (POST batchjobs/{id}/execute).

OpenBiApiClientBatchJobExtensions

Extension methods for the /batchjobs, /batchjobhandlers and /batchjoblogs REST APIs.

StartedBatchJob

What a detached run answers with - see StartBatchJobAsync.

Interfaces

IBatchJob

A scheduled or event-triggered batch job. Used as both the request and response body.

IBatchJobHandler

Metadata describing a batch job handler type registered on the server.

IBatchJobHandlerParameter

Metadata describing one parameter a batch job handler accepts.

IBatchJobLog

One run of a batch job.

IBatchJobLogEntry

One log line written during a batch job run.

IBatchJobParameter

A single named/value parameter passed to a batch job handler at run time.

IExecuteBatchJobEventRequest

Request body for running every batch job registered for an event (POST batchjobevents/execute).

IExecuteBatchJobRequest

Request body for running a single batch job now (POST batchjobs/{id}/execute).

IStartedBatchJob

What a detached run answers with - see StartBatchJobAsync.