Class SzGrpcConfig

SzConfig Access the Senzing Config module via gRPC

Hierarchy

  • SzGrpcBase
    • SzGrpcConfig

Implements

  • SzConfig

Properties

grpcConnectionReadyTimeOut productId

Methods

getDataSourceRegistry getDeadlineFromNow registerDataSource registerDataSources unregisterDataSource verifyConfig waitForReady

Accessors

definition

Properties

grpcConnectionReadyTimeOut

grpcConnectionReadyTimeOut: number = DEFAULT_CONNECTION_READY_TIMEOUT

productId

productId: string = "5050"

See https://github.com/senzing-garage/knowledge-base/blob/main/lists/senzing-component-ids.md

Methods

getDataSourceRegistry

  • getDataSourceRegistry(): Promise<{ DSRC_CODE: string; DSRC_ID: number }[]>

  • Returns a JSON document of data sources contained in an in-memory configuration.

    Returns Promise<{ DSRC_CODE: string; DSRC_ID: number }[]>

    containing a JSON document listing all of the data sources.

ProtectedgetDeadlineFromNow

  • getDeadlineFromNow(secondsFromNow?: number): Date

  • Parameters

    • OptionalsecondsFromNow: number

    Returns Date

registerDataSource

  • registerDataSource(dataSourceCode: string): Promise<string>

  • Adds a data source to an existing in-memory configuration.

    Parameters

    • dataSourceCode: string

      Name of data source code to add.

    Returns Promise<string>

    JSON document listing the newly created data source

registerDataSources

  • registerDataSources(dataSourceCodes: string[]): Promise<string[]>

  • Adds multiple data sources to an existing in-memory configuration.

    Parameters

    • dataSourceCodes: string[]

    Returns Promise<string[]>

    JSON documents for each datasource listing the newly created data source

unregisterDataSource

  • unregisterDataSource(dataSourceCode: string): Promise<unknown>

  • Removes a data source from an existing in-memory configuration. or SzGrpcConfig#importConfig methods.

    Parameters

    • dataSourceCode: string

      Name of data source code to delete.

    Returns Promise<unknown>

    for async flow control

verifyConfig

  • verifyConfig(configDefinition?: string): Promise<unknown>

  • Parameters

    • OptionalconfigDefinition: string

    Returns Promise<unknown>

waitForReady

  • waitForReady(deadline: Date, cb: (error: null | Error) => void): any

  • Wait for the client to be ready. The callback will be called when the client has successfully connected to the server, and it will be called with an error if the attempt to connect to the server has unrecoverablly failed or if the deadline expires. This function will make the channel start connecting if it has not already done so.

    Parameters

    • deadline: Date
    • cb: (error: null | Error) => void

    Returns any

Accessors

definition

  • get definition(): string

  • Returns string

  • set definition(value: string): void

  • Parameters

    • value: string

    Returns void

Settings

Member Visibility

On This Page

Properties
Methods
Accessors