Table of Contents

Namespace Senzing.Sdk

Classes

SzBadInputException

Defines an exceptional condition when an invalid input value is provided to a Senzing operation preventing the successful completion of that operation.

SzConfigurationException

Defines an exceptional condition when a failure has occurred pertaining to the Senzing configuration.

SzDatabaseConnectionLostException

Extends SzRetryableException to define an exceptional condition where a database connection was lost causing a Senzing operation to fail. Retrying the operation would likely result in the connection being reestablished and the operation succeeding.

SzDatabaseException

Extends SzUnrecoverableException to define an exceptional condition triggered by a database error from which we cannot recover (e.g.: missing or unexpected schema defintion).

SzException

Defines the base exception for Senzing errors. This adds a property for the numeric Senzing error code which can optionally be set.

SzFlags

Provides aggregate SzFlag constants as well as extension methods and utility methods pertaining to SzFlag and SzFlagUsageGroup.

SzLicenseException

Extends SzUnrecoverableException to define an exceptional condition triggered by an invalid, expired or exhausted Senzing license.

SzNotFoundException

Extends SzBadInputException to define an exceptional condition where the provided bad input to a Senzing operation is an identifier that could not be used to successfully locate required data for that operation.

SzNotInitializedException

Extends SzUnrecoverableException to define an exceptional condition triggered by Senzing not being initialized.

SzReplaceConflictException

Describes an exceptional condition when an attempt is made to replace a Senzing value with a new value providing it has not not already been changed, however, the current value is no longer the expected value and has therefore already been changed.

SzRetryTimeoutExceededException

Extends SzRetryableException to define an exceptional condition where an operation failed because a timeout was exceeded. Retrying the operation (possibly with a longer timeout) may result in it completing successfully.

SzRetryableException

Defines an exceptional condition where the failure is an intermittent condition and the operation may be retried with the same parameters with an expectation of success.

SzUnhandledException

Extends SzUnrecoverableException to define an exceptional condition caused by an otherwise unhandled and unexpected failure in the Senzing SDK.

SzUnknownDataSourceException

Extends SzBadInputException to define an exceptional condition where the provided bad input to a Senzing operation is an identifier that could not be used to successfully locate required data for that operation.

SzUnrecoverableException

Defines an exceptional condition where the failure is not recoverable and all operations should be stopped until the system can be modified to resolve the condition causing the failure.

Interfaces

SzConfig

Defines the C# interface to the Senzing config functions.

SzConfigManager

Defines the C# interface to the Senzing config manager functions.

SzDiagnostic

Defines the interface to the Senzing diagnostic functions.

SzEngine

Defines the interface to the Senzing engine functions.

SzEnvironment

Provides a factory interface for obtaining the references to the Senzing SDK singleton instances that have been initialized.

SzProduct

Defines the C# interface to the Senzing product functions.

Enums

SzFlag

Enumerates the Senzing flag values so they can be referred to as bitwise enumerated flags.

SzFlagUsageGroup

Enumerates the various classifications of usage groups for the SzFlag instances.