Class OpenBiApiClientEtlTaskExtensions

Namespace

BiExcellence.OpenBi.Api.EtlTasks

Assembly

BiExcellence.OpenBi.Api.Client.dll

Extension methods for the /etltasks REST API.

public static class OpenBiApiClientEtlTaskExtensions

Inheritance

object

OpenBiApiClientEtlTaskExtensions

Methods

CreateEtlTaskAsync(IOpenBiApiClient, EtlTask, CancellationToken)

Creates an ETL task (POST etltasks) and returns it, including the id the server generates when Id is empty. UserId defaults to the caller. A client that picks its own id can use UpdateEtlTaskAsync(IOpenBiApiClient, string, EtlTask, CancellationToken) instead, which creates as well.

public static Task<EtlTask?> CreateEtlTaskAsync(this IOpenBiApiClient client, EtlTask etlTask, CancellationToken cancellationToken = default)

Parameters

client IOpenBiApiClient

etlTask EtlTask

cancellationToken CancellationToken

Returns

Task<EtlTask>

DeleteEtlTaskAsync(IOpenBiApiClient, string, CancellationToken)

Deletes an ETL task (DELETE etltasks/{id}). Its run history under GetEtlTaskLogsAsync(IOpenBiApiClient, string, OpenBiListRequest?, CancellationToken) is kept. Deleting a task that is not there is not an error.

public static Task DeleteEtlTaskAsync(this IOpenBiApiClient client, string id, CancellationToken cancellationToken = default)

Parameters

client IOpenBiApiClient

id string

cancellationToken CancellationToken

Returns

Task

GetEtlTaskAsync(IOpenBiApiClient, string, CancellationToken)

Reads one ETL task (GET etltasks/{id}). Throws OpenBiApiException (404) when there is no such task.

public static Task<EtlTask> GetEtlTaskAsync(this IOpenBiApiClient client, string id, CancellationToken cancellationToken = default)

Parameters

client IOpenBiApiClient

id string

cancellationToken CancellationToken

Returns

Task<EtlTask>

GetEtlTaskLogsAsync(IOpenBiApiClient, string, OpenBiListRequest?, CancellationToken)

Lists the run history of an ETL task, newest first (GET etltasks/{id}/logs): one entry per load, with its outcome, row count and failure message. An unknown task id answers an empty list.

public static Task<OpenBiListResult<EtlTaskLog>> GetEtlTaskLogsAsync(this IOpenBiApiClient client, string taskId, OpenBiListRequest? request = null, CancellationToken cancellationToken = default)

Parameters

client IOpenBiApiClient

taskId string

request OpenBiListRequest

cancellationToken CancellationToken

Returns

Task<OpenBiListResult<EtlTaskLog>>

GetEtlTasksAsync(IOpenBiApiClient, string?, string?, OpenBiListRequest?, CancellationToken)

Lists ETL tasks (GET etltasks), optionally filtered by owner (UserId) and/or Type, both matched exactly.

public static Task<OpenBiListResult<EtlTask>> GetEtlTasksAsync(this IOpenBiApiClient client, string? owner = null, string? type = null, OpenBiListRequest? request = null, CancellationToken cancellationToken = default)

Parameters

client IOpenBiApiClient

owner string

type string

request OpenBiListRequest

cancellationToken CancellationToken

Returns

Task<OpenBiListResult<EtlTask>>

UpdateEtlTaskAsync(IOpenBiApiClient, string, EtlTask, CancellationToken)

Creates or updates the ETL task with the given id (POST etltasks/{id}) - an id that is not there yet is inserted. UserId defaults to the caller.

public static Task<EtlTask?> UpdateEtlTaskAsync(this IOpenBiApiClient client, string id, EtlTask etlTask, CancellationToken cancellationToken = default)

Parameters

client IOpenBiApiClient

id string

etlTask EtlTask

cancellationToken CancellationToken

Returns

Task<EtlTask>