Class EtlTask

Namespace

BiExcellence.OpenBi.Api.EtlTasks

Assembly

BiExcellence.OpenBi.Api.Client.dll

An ETL (extract-transform-load) task: the record a data load into the server's own tables runs under, and whose runs are collected in EtlTaskLog.

public sealed record EtlTask : IEtlTask

Inheritance

object

EtlTask

Implements

IEtlTask

Properties

Changed

When the task was last saved. Set by the server on every save.

[JsonPropertyName("changed")]
public DateTimeOffset Changed { get; init; }

Property Value

DateTimeOffset

Created

When the task was created. Defaults to the time it was first stored.

[JsonPropertyName("created")]
public DateTimeOffset Created { get; init; }

Property Value

DateTimeOffset

Description

A free-text description of the task.

[JsonPropertyName("description")]
public string? Description { get; init; }

Property Value

string

Id

The task id, a GUID generated by the server when POST etltasks is given none.

[JsonPropertyName("id")]
public string? Id { get; init; }

Property Value

string

TableName

The table the task loads into, as the loading client names it. The server only stores it; the legacy load commands write to ETL_-prefixed tables in the organisation's database.

[JsonPropertyName("tableName")]
public string? TableName { get; init; }

Property Value

string

Type

A caller-defined category of the task, free text. GET etltasks?type= filters on it exactly.

[JsonPropertyName("type")]
public string? Type { get; init; }

Property Value

string

UserId

The username of the task's owner. Defaults to the caller when a save leaves it empty; GET etltasks?owner= filters on it.

[JsonPropertyName("userId")]
public string? UserId { get; init; }

Property Value

string