Class DestinationUtilsUnstable

Unstable version of DestinationUtils, containing methods to register clients.

Inheritance

object

DestinationUtilsUnstable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Cognite.Extractor.Utils.Unstable

Assembly: ExtractorUtils.dll

Syntax

public static class DestinationUtilsUnstable

Methods

AddCogniteClient(IServiceCollection, string?, string?, bool, bool, bool, bool)

Adds a configured Cognite client to the services collection as a transient service

Declaration

public static void AddCogniteClient(this IServiceCollection services, string? appId, string? userAgent = null, bool setLogger = false, bool setMetrics = false, bool setHttpClient = true, bool required = true)

Parameters

Type	Name	Description
IServiceCollection	services	The service collection
string	appId	Identifier of the application using the Cognite API
string	userAgent	User-Agent header. If added, should conform to RFC 7231: 'Product/Version (Optional comment)'
bool	setLogger	If true, a ILogger logger is created and used by the client to log calls to the Cognite API (enabled in debug mode)
bool	setMetrics	If true, a CogniteSdk.IMetrics metrics collector is created and used by the client to report metrics on the number and duration of API requests
bool	setHttpClient	Default true. If false CogniteSdk Client.Builder is not added to the ServiceCollection. If this is false it must be added before this method is called.
bool	required	True to fail if cognite configuration is missing

AddCogniteDestination(IServiceCollection)

Add CogniteDestination and CogniteDestinationWithIDM to services.

Declaration

public static void AddCogniteDestination(this IServiceCollection services)

Parameters

Type	Name	Description
IServiceCollection	services	Service collection to add to

Configure(Builder, ConnectionConfig, string?, string?, IAuthenticator?, ILogger<Client>?, IMetrics?)

Configure a CogniteSdk Client.Builder according to the config object

Declaration

public static Client.Builder Configure(this Client.Builder clientBuilder, ConnectionConfig config, string? appId, string? userAgent = null, IAuthenticator? auth = null, ILogger<Client>? logger = null, IMetrics? metrics = null)

Parameters

Type	Name	Description
Client.Builder	clientBuilder	This builder
ConnectionConfig	config	A ConnectionConfig configuration object
string	appId	Identifier of the application using the Cognite API
string	userAgent	User-agent header
IAuthenticator	auth	A IAuthenticator authenticator used to obtain bearer access token
ILogger<Client>	logger	A ILogger logger that the client can use to log calls to the Cognite API (enabled in debug mode)
IMetrics	metrics	A CogniteSdk.IMetrics metrics collector, that the client can use to report metrics on the number and duration of API requests

Returns

Type	Description
Client.Builder	A configured builder

Exceptions

Type	Condition
ConfigurationException	Thrown when config is null or the configured project is empty

ConfigureSslPolicy(CertificateConfig)

Configure global handling of SSL certificates. This must be called to ignore certificates if you require the .NET standard 2.0 version of the library, since .NET framework lacks local ignoring of SSL errors.

Declaration

public static void ConfigureSslPolicy(CertificateConfig config)

Parameters

Type	Name	Description
CertificateConfig	config