IngestAgentConfiguration

This class can be inherited when implementing ingest agents

Class

class ClientSDK.Ingest.IngestClient

Methods

Load

Loads the definition of the ingest client and all of it’s plugins. This is a virtual method that can be overridden by the implementing class.

  • Required Role(s): Any

ClientSDK.Ingest.Load(string configurationJson)
Parameters

configurationJson (string) – The Configuration represented as a JSON string.

Returns

Whether the Configuration Json was successfully loaded.

Return type

Task<bool>

ToString

Serialized the Configuration to a JSON String.

  • Required Role(s): Any

ClientSDK.Ingest.ToString()
Return type

string

Properties

RunFrequency

Frequency the agent should acquire data

ClientSDK.Ingest.IngestAgentConfiguration.RunFrequency
Return type

TimeSpan

UploadFrequency

Frequency the agent should upload the data

ClientSDK.Ingest.IngestAgentConfiguration.UploadFrequency
Return type

TimeSpan