Class EventUploadQueue

Queue for uploading events to CDF.

Inheritance

object

BaseUploadQueue<EventCreate>

EventUploadQueue

Implements

IUploadQueue<EventCreate>

IUploadQueue

IDisposable

IAsyncDisposable

Inherited Members

BaseUploadQueue<EventCreate>.Destination

BaseUploadQueue<EventCreate>.Callback

BaseUploadQueue<EventCreate>.DestLogger

BaseUploadQueue<EventCreate>.Enqueue(IEnumerable<EventCreate>)

BaseUploadQueue<EventCreate>.Dequeue()

BaseUploadQueue<EventCreate>.Trigger(CancellationToken)

BaseUploadQueue<EventCreate>.Start(CancellationToken)

BaseUploadQueue<EventCreate>.Dispose(bool)

BaseUploadQueue<EventCreate>.DisposeAsyncCore()

BaseUploadQueue<EventCreate>.Dispose()

BaseUploadQueue<EventCreate>.DisposeAsync()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Cognite.Extractor.Utils

Assembly: ExtractorUtils.dll

Syntax

public class EventUploadQueue : BaseUploadQueue<EventCreate>, IUploadQueue<EventCreate>, IUploadQueue, IDisposable, IAsyncDisposable

Constructors

EventUploadQueue(CogniteDestination, TimeSpan, int, ILogger<CogniteDestination>, Func<QueueUploadResult<EventCreate>, Task>?, string?)

Upload queue for events

Declaration

public EventUploadQueue(CogniteDestination destination, TimeSpan interval, int maxSize, ILogger<CogniteDestination> logger, Func<QueueUploadResult<EventCreate>, Task>? callback, string? bufferPath)

Parameters

Type	Name	Description
CogniteDestination	destination	CogniteDestination to use for uploading
TimeSpan	interval	Interval between each automated push, leave at zero to disable timed pushing
int	maxSize	Max size of queue before pushing, set to zero to disable max size
ILogger<CogniteDestination>	logger	Logger to use
Func<QueueUploadResult<EventCreate>, Task>	callback	Callback after uploading
string	bufferPath	Path to local buffer file for binary buffering of events

Methods

Enqueue(EventCreate)

Enqueue an event

Declaration

public override void Enqueue(EventCreate evt)

Parameters

Type	Name	Description
EventCreate	evt

Overrides

BaseUploadQueue<EventCreate>.Enqueue(EventCreate)

UploadEntries(IEnumerable<EventCreate>, CancellationToken)

Upload events to CDF.

Declaration

[SuppressMessage("Reliability", "CA2007: Do not directly await a Task", Justification = "Awaiter configured by the caller")]
protected override Task<QueueUploadResult<EventCreate>> UploadEntries(IEnumerable<EventCreate> items, CancellationToken token)

Parameters

Type	Name	Description
IEnumerable<EventCreate>	items	Events to upload
CancellationToken	token

Returns

Type	Description
Task<QueueUploadResult<EventCreate>>	An error or the uploaded events

Overrides

BaseUploadQueue<EventCreate>.UploadEntries(IEnumerable<EventCreate>, CancellationToken)

Implements

IUploadQueue<T>

IUploadQueue

IDisposable

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)