Class OpenBiBatchJobExtensions

Extension methods for batch jobs.

Inheritance

object

OpenBiBatchJobExtensions

Namespace: BiExcellence.OpenBi.Api.Commands.BatchJobs

Assembly: BiExcellence.OpenBi.Api.BatchJob.dll

Syntax

public static class OpenBiBatchJobExtensions

Methods

CreateBatchJobAsync(IOpenBiSession, IBatchJob, CancellationToken)

Creates or updates a batch job.

Declaration

public static Task CreateBatchJobAsync(this IOpenBiSession session, IBatchJob batchJob, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
IOpenBiSession	session	The session.
IBatchJob	batchJob	The batch job.
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
Task

DeleteBatchJobAsync(IOpenBiSession, IBatchJob, CancellationToken)

Deletes a batch job.

Declaration

public static Task DeleteBatchJobAsync(this IOpenBiSession session, IBatchJob batchJob, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
IOpenBiSession	session	The session.
IBatchJob	batchJob	The batch job.
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
Task

DeleteBatchJobAsync(IOpenBiSession, int, CancellationToken)

Deletes a batch job by id.

Declaration

public static Task DeleteBatchJobAsync(this IOpenBiSession session, int batchJobId, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
IOpenBiSession	session	The session.
int	batchJobId	The batch job id.
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
Task

DeleteBatchJobsAsync(IOpenBiSession, IEnumerable<IBatchJob>, CancellationToken)

Deletes batch jobs.

Declaration

public static Task DeleteBatchJobsAsync(this IOpenBiSession session, IEnumerable<IBatchJob> batchJobs, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
IOpenBiSession	session	The session.
IEnumerable<IBatchJob>	batchJobs	The batch jobs.
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
Task

DeleteBatchJobsAsync(IOpenBiSession, IEnumerable<int>, CancellationToken)

Deletes batch jobs by id.

Declaration

public static Task DeleteBatchJobsAsync(this IOpenBiSession session, IEnumerable<int> ids, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
IOpenBiSession	session	The session.
IEnumerable<int>	ids	The batch job ids.
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
Task

ExecuteBatchJobAsync(IOpenBiSessionHttpClient, IBatchJob, IEnumerable<KeyValuePair<string, string>>, CancellationToken)

Executes a batch job immediately.

Declaration

public static IAsyncEnumerable<IBatchJobLogEntry> ExecuteBatchJobAsync(this IOpenBiSessionHttpClient session, IBatchJob batchJob, IEnumerable<KeyValuePair<string, string>> parameters, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
IOpenBiSessionHttpClient	session	The session.
IBatchJob	batchJob	The batch job.
IEnumerable<KeyValuePair<string, string>>	parameters	The parameters.
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
IAsyncEnumerable<IBatchJobLogEntry>	The response of the batch job run.

ExecuteBatchJobAsync(IOpenBiSessionHttpClient, IBatchJob, CancellationToken)

Executes a batch job immediately.

Declaration

public static IAsyncEnumerable<IBatchJobLogEntry> ExecuteBatchJobAsync(this IOpenBiSessionHttpClient session, IBatchJob batchJob, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
IOpenBiSessionHttpClient	session	The session.
IBatchJob	batchJob	The batch job.
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
IAsyncEnumerable<IBatchJobLogEntry>	The response of the batch job run.

ExecuteBatchJobAsync(IOpenBiSessionHttpClient, int, IEnumerable<KeyValuePair<string, string>>?, CancellationToken)

Executes a batch job immediately.

Declaration

public static IAsyncEnumerable<IBatchJobLogEntry> ExecuteBatchJobAsync(this IOpenBiSessionHttpClient session, int batchJobId, IEnumerable<KeyValuePair<string, string>>? parameters, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
IOpenBiSessionHttpClient	session	The session.
int	batchJobId	The batch job id.
IEnumerable<KeyValuePair<string, string>>	parameters	The parameters.
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
IAsyncEnumerable<IBatchJobLogEntry>	The response of the batch job run.

ExecuteBatchJobAsync(IOpenBiSessionHttpClient, int, CancellationToken)

Executes a batch job immediately.

Declaration

public static IAsyncEnumerable<IBatchJobLogEntry> ExecuteBatchJobAsync(this IOpenBiSessionHttpClient session, int batchJobId, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
IOpenBiSessionHttpClient	session	The session.
int	batchJobId	The batch job id.
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
IAsyncEnumerable<IBatchJobLogEntry>	The response of the batch job run.

ExecuteEventBatchJobsAsync(IOpenBiSessionHttpClient, string, string, IEnumerable<KeyValuePair<string, string>>?, CancellationToken)

Executes all batch jobs for an event name and event value.

Declaration

public static IAsyncEnumerable<IBatchJobLogEntry> ExecuteEventBatchJobsAsync(this IOpenBiSessionHttpClient session, string eventName, string eventValue, IEnumerable<KeyValuePair<string, string>>? parameters, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
IOpenBiSessionHttpClient	session	The session.
string	eventName	The event name.
string	eventValue	The event value.
IEnumerable<KeyValuePair<string, string>>	parameters	The parameters.
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
IAsyncEnumerable<IBatchJobLogEntry>	The response of the batch job run.

ExecuteEventBatchJobsAsync(IOpenBiSessionHttpClient, string, string, CancellationToken)

Executes all batch jobs for an event name and event value.

Declaration

public static IAsyncEnumerable<IBatchJobLogEntry> ExecuteEventBatchJobsAsync(this IOpenBiSessionHttpClient session, string eventName, string eventValue, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
IOpenBiSessionHttpClient	session	The session.
string	eventName	The event name.
string	eventValue	The event value.
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
IAsyncEnumerable<IBatchJobLogEntry>	The response of the batch job run.

GetBatchJobByIdAsync(IOpenBiSession, int, CancellationToken)

Returns an batch job by its id.

Declaration

public static Task<IBatchJob?> GetBatchJobByIdAsync(this IOpenBiSession session, int id, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
IOpenBiSession	session
int	id
CancellationToken	cancellationToken

Returns

Type	Description
Task<IBatchJob>

GetBatchJobHandlersAsync(IOpenBiSession, CancellationToken)

Returns all batch job handlers.

Declaration

public static Task<IList<IBatchJobHandler>> GetBatchJobHandlersAsync(this IOpenBiSession session, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
IOpenBiSession	session	The session.
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
Task<IList<IBatchJobHandler>>

GetBatchJobLogEntriesByBatchJobLogId(IOpenBiSession, long)

Returns batch job log entries for a batch job log.

Declaration

public static IListRequest<IBatchJobLogEntry> GetBatchJobLogEntriesByBatchJobLogId(this IOpenBiSession session, long batchJobLogId)

Parameters

Type	Name	Description
IOpenBiSession	session	The session.
long	batchJobLogId	The batch job log id.

Returns

Type	Description
IListRequest<IBatchJobLogEntry>

GetBatchJobLogs(IOpenBiSession)

Returns batch job logs.

Declaration

public static IListRequest<IBatchJobLog> GetBatchJobLogs(this IOpenBiSession session)

Parameters

Type	Name	Description
IOpenBiSession	session

Returns

Type	Description
IListRequest<IBatchJobLog>

GetBatchJobLogsByBatchJobId(IOpenBiSession, int)

Returns batch job logs for a batch job.

Declaration

public static IListRequest<IBatchJobLog> GetBatchJobLogsByBatchJobId(this IOpenBiSession session, int batchJobId)

Parameters

Type	Name	Description
IOpenBiSession	session	The session.
int	batchJobId	The batch job id.

Returns

Type	Description
IListRequest<IBatchJobLog>

GetBatchJobs(IOpenBiSession)

Returns batch jobs.

Declaration

public static IListRequest<IBatchJob> GetBatchJobs(this IOpenBiSession session)

Parameters

Type	Name	Description
IOpenBiSession	session	The session.

Returns

Type	Description
IListRequest<IBatchJob>