Skip to main content

terafoundation_kafka_connector / index

index

Variables​

default​

const default: object

Defined in: index.ts:8

Type Declaration​

config_schema()​

config_schema(): object

Returns​

object

brokers​

brokers: object

brokers.default​

default: string[]

brokers.doc​

doc: string = 'List of seed brokers for the kafka environment'

brokers.format​

format: ArrayConstructor = Array

caCertificate​

caCertificate: object

caCertificate.default​

default: undefined = undefined

caCertificate.doc​

doc: string = 'CA certificate string (PEM format) for verifying the broker's key. If provided `ssl_ca_location` will be ignored.'

caCertificate.format​

format: string = 'optional_string'

rdkafka_options​

rdkafka_options: object

rdkafka_options.default​

default: object = {}

rdkafka_options.doc​

doc: string = 'Additional rdkafka configuration options. See https://github.com/edenhill/librdkafka/blob/master/CONFIGURATION.md for available options.'

rdkafka_options.format​

format: ObjectConstructor = Object

security_protocol​

security_protocol: object

security_protocol.default​

default: string = 'plaintext'

security_protocol.doc​

doc: string = 'Protocol used to communicate with brokers'

security_protocol.format​

format: string[]

ssl_ca_location​

ssl_ca_location: object

ssl_ca_location.default​

default: undefined = undefined

ssl_ca_location.doc​

doc: string = 'File or directory path to CA certificate(s) for verifying the broker's key. Ignored if `caCertificate` is provided.'

ssl_ca_location.format​

format: string = 'optional_string'

ssl_certificate_location​

ssl_certificate_location: object

ssl_certificate_location.default​

default: undefined = undefined

ssl_certificate_location.doc​

doc: string = 'Path to client's public key (PEM) used for authentication'

ssl_certificate_location.format​

format: string = 'optional_string'

ssl_crl_location​

ssl_crl_location: object

ssl_crl_location.default​

default: undefined = undefined

ssl_crl_location.doc​

doc: string = 'Path to CRL for verifying broker's certificate validity'

ssl_crl_location.format​

format: string = 'optional_string'

ssl_key_location​

ssl_key_location: object

ssl_key_location.default​

default: undefined = undefined

ssl_key_location.doc​

doc: string = 'Path to client's private key (PEM) used for authentication'

ssl_key_location.format​

format: string = 'optional_string'

ssl_key_password​

ssl_key_password: object

ssl_key_password.default​

default: undefined = undefined

ssl_key_password.doc​

doc: string = 'Private key passphrase'

ssl_key_password.format​

format: string = 'optional_string'

createClient()​

createClient(customConfig, systemLogger, settings): Promise<{ client: KafkaConsumer; logger: Logger; }>

Parameters​
ParameterType
customConfigKafkaConnectorConfig
systemLoggerLogger
settingsany
Returns​

Promise<{ client: KafkaConsumer; logger: Logger; }>

References​

connectorConfig​

Re-exports connectorConfig

createClient​

Re-exports createClient

encryptKafka​

Re-exports encryptKafka

KafkaAdminResult​

Re-exports KafkaAdminResult

KafkaAdminSettings​

Re-exports KafkaAdminSettings

kafkaBrokers​

Re-exports kafkaBrokers

KafkaClientSettings​

Re-exports KafkaClientSettings

KafkaConnectorConfig​

Re-exports KafkaConnectorConfig

KafkaConsumerOptions​

Re-exports KafkaConsumerOptions

KafkaConsumerResult​

Re-exports KafkaConsumerResult

KafkaConsumerSettings​

Re-exports KafkaConsumerSettings

KafkaProducerOptions​

Re-exports KafkaProducerOptions

KafkaProducerResult​

Re-exports KafkaProducerResult

KafkaProducerSettings​

Re-exports KafkaProducerSettings

makeAdminClient​

Re-exports makeAdminClient

makeConsumerClient​

Re-exports makeConsumerClient

makeProducerClient​

Re-exports makeProducerClient

RDKafkaOptions​

Re-exports RDKafkaOptions