Microsoft.SmartPlaces.Facilities.IngestionManager 0.2.1-preview

Prefix Reserved
.NET 6.0 This package targets .NET 6.0. The package is compatible with this framework or higher.
This is a prerelease version of Microsoft.SmartPlaces.Facilities.IngestionManager.
There is a newer prerelease version of this package available.
See the version list below for details. 
dotnet add package Microsoft.SmartPlaces.Facilities.IngestionManager --version 0.2.1-preview                

                    
                

            
NuGet\Install-Package Microsoft.SmartPlaces.Facilities.IngestionManager -Version 0.2.1-preview
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="Microsoft.SmartPlaces.Facilities.IngestionManager" Version="0.2.1-preview" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add Microsoft.SmartPlaces.Facilities.IngestionManager --version 0.2.1-preview                

                    
                

            
#r "nuget: Microsoft.SmartPlaces.Facilities.IngestionManager, 0.2.1-preview"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
// Install Microsoft.SmartPlaces.Facilities.IngestionManager as a Cake Addin
#addin nuget:?package=Microsoft.SmartPlaces.Facilities.IngestionManager&version=0.2.1-preview&prerelease

// Install Microsoft.SmartPlaces.Facilities.IngestionManager as a Cake Tool
#tool nuget:?package=Microsoft.SmartPlaces.Facilities.IngestionManager&version=0.2.1-preview&prerelease

IngestionManager

This library provides a way to load an Azure Digital Twins instances with twins and relationships from another DTDL-based graph of twins.

Interfaces and Classes

Interface: IGraphIngestionProcessor

Description Methods for ingesting a graph from a source graph and inserting into a target graph

Method: IngestionFromApiAsync

Description

Starts the Ingestion Process from a source to a target graph. The implementation of the derived class is responsible for exposing its configuration through its constructor.

Parameters

None

Returns

An awaitable task.

Interface: IInputGraphManager

Description Methods for accessing an input graph source

Method: TryGetDtmi

Description

Get a DTMI for an interfaceType

Parameters

Name Description
interfaceType The name of the interface
dtmi The found dtmi

Returns

true if the DTMi is found, otherwise false

Method: GetTwinGraphAsync

Description

Loads a twin graph from a source based on a passed in graph query

Parameters

Name Description
query A well-formed graph query

Returns

A JsonDocument containing the results of the query

Method: GetOrganizationQuery

Description

Gets a graph query to return an organization

Parameters

None

Returns

A graph query string which can be passed to GetTwinsGraphAsync

Method: GetBuildingsForSiteQuery

Description

Gets a graph query to return all the buildings on a site

Parameters

None

Returns

A graph query string which can be passed to GetTwinsGraphAsync

Method: GetFloorQuery

Description

Gets a graph query to return all the floors for a building

Parameters

None

Returns

A graph query string which can be passed to GetTwinsGraphAsync

Method: GetBuildingsThingsQuery

Description

Gets a graph query to return all the things in a building

Parameters

None

Returns

A graph query string which can be passed to GetTwinsGraphAsync

Method: GetPointsForThingQuery

Description

Gets a graph query to return all the points for a thing

Parameters

None

Returns

A graph query string which can be passed to GetTwinsGraphAsync

Interface: IInputGraphManagerOptions

Description Configuration interface for the InputGraphManager

Interface: IOutputGraphManager

Description

Methods for working with an output graph

Method: GetModelAsync

Description

Loads the model for a graph

Parameters

None

Returns

A collection of strings which describe the model used by the output graph

Method: UploadGraphAsync

Description

Loads the twins and relationships into an output graph

Parameters

None

Returns

None

Interface: ITelemetryIngestionProcessor

Description

Methods for ingesting event data telemetry to a target

Method: IngestFromEventHubAsync

Description

Ingests the passed in data from Event Hub into a target

Parameters

Name Description
telemetryData An instance of event hub event data

Returns

None

Interface: ITwinMappingIndexer

Description

Methods for working with a cache store of sourceIDs to Digital Twin Ids

Method: UpsertTwinIndexAsync

Description

Add or update a mapping to the cache

Parameters

Name Description
sourceId The source device key from the source graph
twinId The target twin id for the target graph

Returns

None

Method: GetTwinIndexAsync

Description

Get a mapping from the cache for a passed in sourceId

Parameters

Name Description
sourceId The source device key from the source graph

Returns

The twinId for the target graph

Class: IngestionManagerOptions

Description

An implementation of IIngestionManagerOptions which allows the consumer to specify the connection and configuration information needed to connect to the target Azure Digital Twins instance

Properties | Name | Description | | --- | --- | | AzureDigitalTwinsEndpoint | The Url for the Azure Digital Twins instance to target. | | MaxRetryAttempts | The number of times to retry create twin attempts per twin/relationship. | | RetryDelayInMs | The delay in milliseconds between retry create twin attempts per twin/relationship. Defaults to 50ms. | | AdtResource | Gets or sets the resource to be used when generating a Token for accessing Azure Digital Twins. This needs to be changed when working with non-public clouds. Defaults to https://digitaltwins.azure.net/.default. | | MaxDegreeOfParallelism | Gets or sets the maximum number parallel threads to use when uploading to Azure Digital Twins. Defaults to 10 threads. |

Class: IngestionProcessorBase

Description

Abstract Base class for loading a site graph from input source to output target. Implements IGraphIngestionProcessor

Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on Microsoft.SmartPlaces.Facilities.IngestionManager:

Package Downloads
Microsoft.SmartPlaces.Facilities.IngestionManager.Mapped

Support for converting from a Mapped DTDL-based Ontology to a different DTDL Based Ontology

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
0.6.3-preview 60 9/5/2024
0.6.2-preview 91 9/4/2024
0.6.1-preview 118 2/2/2024
0.6.0-preview 634 1/31/2024
0.5.14-preview 104 7/18/2023
0.5.5-preview 608 6/16/2023
0.5.3-preview 131 6/14/2023
0.4.2-preview 264 5/4/2023
0.4.0-preview 488 2/17/2023
0.3.12-preview 542 12/12/2022
0.3.11-preview 187 12/8/2022
0.3.10-preview 201 12/2/2022
0.3.9-preview 153 11/30/2022
0.3.8-preview 194 11/12/2022
0.2.2-preview 107 11/8/2022
0.2.1-preview 240 11/4/2022
0.2.0-preview 104 11/3/2022
0.1.8-preview 172 11/1/2022
0.1.7-preview 113 10/31/2022
0.1.6-preview 186 10/26/2022
0.1.3-preview 127 10/20/2022
0.1.2-preview 225 10/19/2022
0.1.1-preview 187 10/13/2022
0.1.0-preview 191 10/13/2022