Data Sync Server Documentation Index
Configuration Reference Home

Third Party Kafka Sync Destination Plugin

Note: this component is designated "advanced", which means that objects of this type are not expected to be created or altered in most environments. If you believe that such a change is necessary, you may want to contact support in order to understand the potential impact of that change.

Third Party Kafka Sync Destination Plugins provide Kafka sync destination plugin implementations created in third-party code using the UnboundID server SDK.

↓Parent Component
↓Properties
↓dsconfig Usage

Parent Component

The Third Party Kafka Sync Destination Plugin component inherits from the Kafka Sync Destination Plugin

Properties

The properties supported by this managed object are as follows:


Basic Properties: Advanced Properties:
↓ description  None
↓ extension-class
↓ extension-argument

Basic Properties

description

Description
A description for this Sync Destination Plugin
Default Value
None
Allowed Values
A string
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

extension-class (Read-Only)

Description
The fully-qualified name of the Java class providing the logic for the Third Party Kafka Sync Destination Plugin.
Default Value
None
Allowed Values
The fully-qualified name of a Java class that extends or implements com.unboundid.directory.sdk.sync.api.KafkaSyncDestinationPlugin
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

extension-argument

Description
The set of arguments used to customize the behavior for the Third Party Kafka Sync Destination Plugin. Each configuration property should be given in the form 'name=value'.
Default Value
None
Allowed Values
A string
Multi-Valued
Yes
Required
No
Admin Action Required
None. Modification requires no further action


dsconfig Usage

To list the configured Sync Destination Plugins:

dsconfig list-sync-destination-plugins
     [--property {propertyName}] ...

To view the configuration for an existing Sync Destination Plugin:

dsconfig get-sync-destination-plugin-prop
     --plugin-name {name}
     [--tab-delimited]
     [--script-friendly]
     [--property {propertyName}] ...

To update the configuration for an existing Sync Destination Plugin:

dsconfig set-sync-destination-plugin-prop
     --plugin-name {name}
     (--set|--add|--remove) {propertyName}:{propertyValue}
     [(--set|--add|--remove) {propertyName}:{propertyValue}] ...

To create a new Third Party Kafka Sync Destination Plugin:

dsconfig create-sync-destination-plugin
     --plugin-name {name}
     --type third-party
     --set extension-class:{propertyValue}
     [--set {propertyName}:{propertyValue}] ...

To delete an existing Sync Destination Plugin:

dsconfig delete-sync-destination-plugin
     --plugin-name {name}