Interface IIntegrationSink
Interface for types that can consume errors and write them to some sink (integrations API).
Namespace: Cognite.Extractor.Utils.Unstable.Tasks
Assembly: ExtractorUtils.dll
Syntax
public interface IIntegrationSinkMethods
| Edit this page View SourceFlush(CancellationToken)
Flush the sink, ensuring all errors and tasks are written.
Declaration
Task Flush(CancellationToken token)Parameters
| Type | Name | Description |
|---|---|---|
| CancellationToken | token |
Returns
| Type | Description |
|---|---|
| Task |
ReportError(ExtractorError)
Write an error to the sink.
Declaration
void ReportError(ExtractorError error)Parameters
| Type | Name | Description |
|---|---|---|
| ExtractorError | error |
ReportTaskEnd(string, TaskUpdatePayload?, DateTime?)
Report that a task has ended.
Declaration
void ReportTaskEnd(string taskName, TaskUpdatePayload? update = null, DateTime? timestamp = null)Parameters
| Type | Name | Description |
|---|---|---|
| string | taskName | Name of task that ended. |
| TaskUpdatePayload | update | Content of the task update. |
| DateTime? | timestamp | When the task ended, defaults to current time. |
ReportTaskStart(string, TaskUpdatePayload?, DateTime?)
Report that a task has started.
Declaration
void ReportTaskStart(string taskName, TaskUpdatePayload? update = null, DateTime? timestamp = null)Parameters
| Type | Name | Description |
|---|---|---|
| string | taskName | Name of task that started. |
| TaskUpdatePayload | update | Content of the task update. |
| DateTime? | timestamp | When the task started, defaults to current time. |
RunPeriodicCheckIn(CancellationToken, StartupRequest, TimeSpan?)
Run the sink, automatically flushing at regular intervals.
Declaration
Task RunPeriodicCheckIn(CancellationToken token, StartupRequest startupPayload, TimeSpan? interval = null)Parameters
| Type | Name | Description |
|---|---|---|
| CancellationToken | token | Cancellation token. |
| StartupRequest | startupPayload | Payload to send to the startup endpoint before beginning to report periodic check-ins. |
| TimeSpan? | interval | Interval. If left out, uses an implementation-defined default. |
Returns
| Type | Description |
|---|---|
| Task |