Data Sources¶
TL;DR — This page lists the public Framework functions in the
Data Sourcescategory.
When to use¶
Use this page when you need source-backed signatures, declaring types, and XML doc comments for this function category.
Each entry uses the short function name as the table-of-contents label. Expand an entry to inspect its source file, signature, and XML doc comments.
The functions on this page are grouped by responsibility so related operations stay together.
Identity and hook selection¶
Named¶
Source file, signature, and docstring
Member DataSourceBuilder.Named(string name)
Kind function
Declaring Type DataSourceBuilder
Source File QaaS.Framework.SDK/DataSourceObjects/DataSourceBuilder.cs
Signature
public DataSourceBuilder Named(string name)
Docstring
Sets the name used for the current Framework data source builder instance.
HookNamed¶
Source file, signature, and docstring
Member DataSourceBuilder.HookNamed(string hookName)
Kind function
Declaring Type DataSourceBuilder
Source File QaaS.Framework.SDK/DataSourceObjects/DataSourceBuilder.cs
Signature
public DataSourceBuilder HookNamed(string hookName)
Docstring
Sets the hook implementation name used by the current Framework data source builder instance.
Data source selection¶
AddDataSourceName¶
Source file, signature, and docstring
Member DataSourceBuilder.AddDataSourceName(string dataSourceName)
Kind function
Declaring Type DataSourceBuilder
Source File QaaS.Framework.SDK/DataSourceObjects/DataSourceBuilder.cs
Signature
public DataSourceBuilder AddDataSourceName(string dataSourceName)
Docstring
Adds the supplied data source name to the current Framework data source builder instance.
RemoveDataSourceName¶
Source file, signature, and docstring
Member DataSourceBuilder.RemoveDataSourceName(string dataSourceName)
Kind function
Declaring Type DataSourceBuilder
Source File QaaS.Framework.SDK/DataSourceObjects/DataSourceBuilder.cs
Signature
public DataSourceBuilder RemoveDataSourceName(string dataSourceName)
Docstring
Removes the configured data source name from the current Framework data source builder instance.
RemoveDataSourceNameAt¶
Source file, signature, and docstring
Member DataSourceBuilder.RemoveDataSourceNameAt(int index)
Kind function
Declaring Type DataSourceBuilder
Source File QaaS.Framework.SDK/DataSourceObjects/DataSourceBuilder.cs
Signature
public DataSourceBuilder RemoveDataSourceNameAt(int index)
Docstring
Removes the configured data source name at the specified index from the current Framework data source builder instance.
AddDataSourcePattern¶
Source file, signature, and docstring
Member DataSourceBuilder.AddDataSourcePattern(string dataSourcePattern)
Kind function
Declaring Type DataSourceBuilder
Source File QaaS.Framework.SDK/DataSourceObjects/DataSourceBuilder.cs
Signature
public DataSourceBuilder AddDataSourcePattern(string dataSourcePattern)
Docstring
Adds the supplied data source pattern to the current Framework data source builder instance.
RemoveDataSourcePattern¶
Source file, signature, and docstring
Member DataSourceBuilder.RemoveDataSourcePattern(string dataSourcePattern)
Kind function
Declaring Type DataSourceBuilder
Source File QaaS.Framework.SDK/DataSourceObjects/DataSourceBuilder.cs
Signature
public DataSourceBuilder RemoveDataSourcePattern(string dataSourcePattern)
Docstring
Removes the configured data source pattern from the current Framework data source builder instance.
RemoveDataSourcePatternAt¶
Source file, signature, and docstring
Member DataSourceBuilder.RemoveDataSourcePatternAt(int index)
Kind function
Declaring Type DataSourceBuilder
Source File QaaS.Framework.SDK/DataSourceObjects/DataSourceBuilder.cs
Signature
public DataSourceBuilder RemoveDataSourcePatternAt(int index)
Docstring
Removes the configured data source pattern at the specified index from the current Framework data source builder instance.
Configuration¶
WithSerializer¶
Source file, signature, and docstring
Member DataSourceBuilder.WithSerializer(SerializeConfig serializeConfig)
Kind function
Declaring Type DataSourceBuilder
Source File QaaS.Framework.SDK/DataSourceObjects/DataSourceBuilder.cs
Signature
public DataSourceBuilder WithSerializer(SerializeConfig serializeConfig)
Docstring
Sets the serializer configuration used by the current Framework data source builder instance.
WithDeserializer¶
Source file, signature, and docstring
Member DataSourceBuilder.WithDeserializer(DeserializeConfig deserializeConfig)
Kind function
Declaring Type DataSourceBuilder
Source File QaaS.Framework.SDK/DataSourceObjects/DataSourceBuilder.cs
Signature
public DataSourceBuilder WithDeserializer(DeserializeConfig deserializeConfig)
Docstring
Sets the deserializer configuration used by the current Framework data source builder instance.
Collection helpers¶
RemoveConfiguration¶
Source file, signature, and docstring
Member DataSourceBuilder.RemoveConfiguration()
Kind function
Declaring Type DataSourceBuilder
Source File QaaS.Framework.SDK/DataSourceObjects/DataSourceBuilder.cs
Signature
public DataSourceBuilder RemoveConfiguration()
Docstring
Clears the current generator configuration.
After this call, the builder holds an empty configuration until a new one is supplied.
UpdateConfiguration¶
Source file, signature, and docstring
Member DataSourceBuilder.UpdateConfiguration(object configuration)
Kind function
Declaring Type DataSourceBuilder
Source File QaaS.Framework.SDK/DataSourceObjects/DataSourceBuilder.cs
Signature
public DataSourceBuilder UpdateConfiguration(object configuration)
Docstring
Merges the supplied patch into the generator configuration stored on the current Framework data source builder instance.
Use this method when only part of the generator configuration should change. Fields omitted from the patch are preserved from the current GeneratorConfiguration tree.
General¶
IsLazy¶
Source file, signature, and docstring
Member DataSourceBuilder.IsLazy()
Kind function
Declaring Type DataSourceBuilder
Source File QaaS.Framework.SDK/DataSourceObjects/DataSourceBuilder.cs
Signature
public DataSourceBuilder IsLazy()
Docstring
Marks the data source for lazy resolution.
Configure¶
Source file, signature, and docstring
Member DataSourceBuilder.Configure(object configuration)
Kind function
Declaring Type DataSourceBuilder
Source File QaaS.Framework.SDK/DataSourceObjects/DataSourceBuilder.cs
Signature
public DataSourceBuilder Configure(object configuration)
Docstring
Replaces the generator configuration with the supplied object.
The supplied object is serialized to JSON and loaded into the builder as the new generator configuration.
Register¶
Source file, signature, and docstring
Member DataSourceBuilder.Register()
Kind function
Declaring Type DataSourceBuilder
Source File QaaS.Framework.SDK/DataSourceObjects/DataSourceBuilder.cs
Signature
public DataSource Register()
Docstring
Registers the configured data source definition and returns the resulting data source descriptor.
Registration produces the immutable data-source descriptor that is later resolved against generator hooks during execution build.