IngestClient
This is an inheritable class when implementing an ingestion service.
Class
- class ClientSDK.Ingest.IngestClient
Methods
LoadAsync
Loads the Client with the information it needs to run
Required Role(s): Any
Resource Authorization: Access to the digital twin associated to the operation that the report definition is associated.
- ClientSDK.Ingest.LoadAsync(List<IngestAgent> ingestAgents)
- Parameters
ingestAgents (List<IngestAgent>) – The collection of ingest agent objects
- Returns
Whether the Client was successfully loaded
- Return type
Task<bool>
RegisterAgentAsync
Registers a new IngestAgent with this Client.
Required Role(s): Any
Resource Authorization: Access to the digital twin associated to the operation that the report definition is associated.
- ClientSDK.Ingest.RegisterAgentAsync(IngestAgent ingestAgent, string ingestAgentName, string agentSubTypeId)
- Parameters
ingestAgent (IngestAgent) – The IngestAgent Object
ingestAgentName (string) – Name of the new Agent
agentSubTypeId (string) – Instrument Agent Digital Twin SubType Id
- Returns
The newly registered Ingest Agent.
- Return type
Task<IngestAgent>
Save
Saves all of the Digital Twin and Configuration Data related to the client.
Required Role(s): Any
Resource Authorization: Access to the digital twin associated to the operation that the report definition is associated.
- ClientSDK.Ingest.Save()
- Returns
Whether the save was successful.
- Return type
Task<IngestAgent>
Properties
Agents
A Collection of Ingest Agents that belong to this client This property is populated when the LoadAsync is called.
- ClientSDK.Ingest.IngestClient.Agents
- Return type
List<IngestAgent>
ConfigurationJson
This property returns the configuration JSON for the Ingest Client. If this property is set, the Save() method will need to be called to persist the change.
- ClientSDK.Ingest.IngestClient.ConfigurationJson
- Returns
The configuration as a JSON string for the IngestClient
- Return type
string
Id
The Twin Reference Id of the Twin that represents the ingest client
- ClientSDK.Ingest.IngestClient.Id
- Return type
string
Logger
This is a class that manages the logging of information for the Client
- ClientSDK.Ingest.IngestClient.Logger
- Return type
IngestLogger
Name
The name of the Ingest Client. If this property is set, the Save() method will need to be called to persist the change.
- ClientSDK.Ingest.IngestClient.Name
- Returns
The name of the IngestClient
- Return type
string