Class ExtractionRun

Container for reporting to the ExtPipes endpoint in CDF.

Inheritance

object

ExtractionRun

Implements

IAsyncDisposable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Cognite.Extractor.Utils

Assembly: ExtractorUtils.dll

Syntax

public sealed class ExtractionRun : IAsyncDisposable

Constructors

ExtractionRun(ExtractionRunConfig, CogniteDestination, ILogger<ExtractionRun>?)

Constructor, can be called from dependency injection if ExtractionRunConfig has been injected.

Declaration

public ExtractionRun(ExtractionRunConfig config, CogniteDestination destination, ILogger<ExtractionRun>? log = null)

Parameters

Type	Name	Description
ExtractionRunConfig	config	Extraction run config object
CogniteDestination	destination	Cognite
ILogger<ExtractionRun>	log

Properties

Continuous

True if this is a continuous extractor. This means that it should report success after the extractor is started.

Declaration

public bool Continuous { get; set; }

Property Value

Type	Description
bool

Methods

DisposeAsync()

Dispose of the run. Will report success unless the run has already been set to finished.

Declaration

public ValueTask DisposeAsync()

Returns

Type	Description
ValueTask

Report(ExtPipeRunStatus, bool, string?, CancellationToken)

Report extraction pipeline status manually.

Declaration

public Task Report(ExtPipeRunStatus status, bool final, string? message = null, CancellationToken token = default)

Parameters

Type	Name	Description
ExtPipeRunStatus	status	Status to update with
bool	final	True if this should close the pipeline run and set it to finalized. If this is false, the run will continue to report "Seen"
string	message	Optional message
CancellationToken	token	Optional token

Returns

Type	Description
Task

Start()

Begin reporting, will report a success if Continuous is true.

Declaration

public void Start()

Implements

IAsyncDisposable

Extension Methods

DataModelUtils.GetOrCreateResourcesAsync<T, T2>(T2, IEnumerable<InstanceIdentifier>, Func<IEnumerable<InstanceIdentifier>, IEnumerable<SourcedNodeWrite<T>>>, Func<IEnumerable<SourcedNodeWrite<T>>, SanitationMode, (IEnumerable<SourcedNodeWrite<T>>, IEnumerable<CogniteError<SourcedNodeWrite<T>>>)>, int, int, RetryMode, SanitationMode, CancellationToken)