| |
Options |
Name |
Purpose |
|
|
|
OpenEdge.Messaging.IConsumer Build ()
|
/**
Construct a consumer from the current state of this consumer builder.
*/
|
|
|
|
OpenEdge.Core.Collections.IStringKeyedMap ConstructTopicKeyDeserializers (IStringKeyedMap)
|
/**
Pre-constructs all of the topic key deserializers
*/
|
|
|
|
OpenEdge.Core.Collections.IStringKeyedMap ConstructTopicValueDeserializers (IStringKeyedMap)
|
/**
Pre-constructs all of the topic body deserializers
*/
|
|
|
|
ConvertAutoOffsetReset (IStringStringMap)
|
/**
Convert the auto offset reset property to a string value that librdkafka understands
when its stored in the configuration as an enum.
*/
|
|
|
|
ConvertIsolationLevel (IStringStringMap)
|
/*
Convert isolation level property to a string value that librdkafka understands
when its stored in the configuration as an enum.
*/
|
|
|
|
CopyOptionsToConsumerMap (IStringStringMap)
|
|
|
|
|
CopySubscriptionsToBIO (IList, IConsumerDelegate)
|
|
|
|
|
OpenEdge.Messaging.Kafka.KafkaConsumerBuilder Create ()
|
/**
Create a kafka specific consumer builder.
*/
|
|
|
|
OpenEdge.Messaging.IDeserializer CreateBodyDeserializer ()
|
/**
Construct the value deserializer for the consumer.
*/
|
|
|
|
OpenEdge.Messaging.Internal.IConsumerDelegate CreateConsumerDelegate ()
|
/*
Create the BIO consumer. This is marked as protected so it can be overridden for unit tests.
*/
|
|
|
|
OpenEdge.Messaging.Kafka.IOptionFilter CreateConsumerOptionFilter ()
|
|
|
|
|
OpenEdge.Messaging.Kafka.IOptionValidator CreateConsumerOptionValidator ()
|
/**
Create the consumer option validator. By default this returns UNKNOWN.
Override this to provide an actual implementation.
*/
|
|
|
|
OpenEdge.Messaging.IDeserializer CreateDeserializer (character)
|
/**
Construct a deserializer from the identified property name.
*/
|
|
|
|
OpenEdge.Messaging.IDeserializer CreateDeserializer (Object, character, character)
|
/**
Construct a deserializer from a property value. This can be either an OpenEdge.Core.String
that holds the name of a class that implements OpenEdge.Messaging.IDeserializer, or it can be
be an actual instance of OpenEdge.Messaging.IDeserializer.
If the name of a deserializer class is provided, the class must have a no-argument contructor,
and will be instantiated and cheked to ensure it implements IDeserializer
@param deserializerObj an instance of IDeserializer or a string holding the name of the deserializer
@param deserializerPropertyName the name of the property to include in messages if an error occurs
@param topicName if not unknown, this value is included in messages if an error occurs
@return an deserializer that implements OpenEdge.Messaging.IDeserializer
*/
|
|
|
|
OpenEdge.Messaging.Kafka.KafkaConsumer CreateKafkaConsumer (IConsumerDelegate, IStringStringMap, IStringKeyedMap)
|
|
|
|
|
OpenEdge.Messaging.IDeserializer CreateKeyDeserializer ()
|
/**
Construct the key deserializer for the consumer.
*/
|
|
|
|
OpenEdge.Messaging.Kafka.IOptionFilter CreateTopicOptionFilter ()
|
|
|
|
|
OpenEdge.Messaging.Kafka.IOptionValidator CreateTopicOptionValidator ()
|
/**
Create the per-topic option validator. The validator
is here to prevent the application from setting configuration
values that are completely unsupported by the underlying implementation.
*/
|
|
|
|
LOGICAL FilterOption (character)
|
/**
@Override
*/
|
|
|
|
Progress.Lang.Object GetOptionAsObject (character)
|
/*
Override for GetOptionStringValue from ConfigBuilder to make it easier to access
from utility functions.
*/
|
|
|
|
Progress.Lang.Object GetOptionObjectValue (character)
|
/**
Override for GetOptionStringValue from ConfigBuilder to make it easier to access
from utility functions.
*/
|
|
|
|
CHARACTER GetOptionStringValue (character)
|
/**
Override for GetOptionStringValue from ConfigBuilder to make it easier to access
from utility functions.
*/
|
|
|
|
OpenEdge.Messaging.Kafka.KafkaConsumerBuilder SetAutoDeleteConsumerGroup (logical)
|
/*
Specify whether the consumer group should be automatically deleted when the consumer object is
garbage collected.
@param autoDeleteConsumerGroup whether or not to automatically delete consumer group.
@return This consumer builder.
*/
|
|
|
|
OpenEdge.Messaging.Kafka.KafkaConsumerBuilder SetAutoOffsetReset (AutoOffsetReset)
|
/**
Action to take when there is no initial offset in offset store or the desired offset is out of range:
'smallest','earliest' - automatically reset the offset to the smallest offset
'largest','latest' - automatically reset the offset to the largest offset
'error' - trigger an error.
@param autoOffsetReset The action to take when there is no initial offset store
@return This consumer builder.
*/
|
|
|
|
OpenEdge.Messaging.Kafka.KafkaConsumerBuilder SetAutoOffsetReset (character)
|
/**
Action to take when there is no initial offset in offset store or the desired offset is out of range:
'smallest','earliest' - automatically reset the offset to the smallest offset
'largest','latest' - automatically reset the offset to the largest offset
'error' - trigger an error.
@param autoOffsetReset The action to take when there is no initial offset store
@return This consumer builder.
*/
|
|
|
|
OpenEdge.Messaging.Kafka.KafkaConsumerBuilder SetBootstrapServers (character)
|
/*
Configure the consumer with an initial list of Kafka brokers to which
to connect.
The format of the string is expected to be a comma delimited list in the form of
<host>:<port>[,<host>:<port>...]
@return This consumer builder.
*/
|
|
|
|
OpenEdge.Messaging.Kafka.KafkaConsumerBuilder SetBootstrapServers (URI)
|
/**
Configure the consumer with an initial Kafka broker to which
to connect. Each URI needs to provide a host and port which is
used to locate a Kafka broker
@return This consumer builder.
*/
|
|
|
|
OpenEdge.Messaging.Kafka.KafkaConsumerBuilder SetBootstrapServers (URI[])
|
/*
Configure the consumer with an initial list of Kafka brokers to which
to connect. The URI needs to provide a host and port that will be used
to locate a Kafka broker.
@return This consumer builder.
*/
|
|
|
|
OpenEdge.Messaging.Kafka.KafkaConsumerBuilder SetClientId (character)
|
/**
Configure the client id of the Kafka consumer.
@param clientId the Client id
*/
|
|
|
|
OpenEdge.Messaging.Kafka.KafkaConsumerBuilder SetEnableAutoCommit (logical)
|
/**
Automatically and periodically commit offsets in the background.
@param enableAutoCommit True if auto commit of offsets should be turned on.
@return This consumer builder.
*/
|
|
|
|
OpenEdge.Messaging.Kafka.KafkaConsumerBuilder SetEnableAutoOffsetStore (logical)
|
/**
Automatically store offset of last message provided to application. The offset store is an in-memory store of the next offset to (auto-)commit for each partition.
@param enableAutoOffsetStore True if auto offset store should be turned on.
@return This consumer builder.
*/
|
|
|
|
OpenEdge.Messaging.Kafka.KafkaConsumerBuilder SetGroupId (character)
|
/**
Configure the group id of the Kafka consumer. A group id is required
in order to for the client to participate in a subscriber group.
@param groupId A value that identifies the client's membership within a subscriber group
*/
|
|
|
|
OpenEdge.Messaging.Kafka.KafkaConsumerBuilder SetIsolationLevel (character)
|
/**
Controls how to read messages written transactionally. Can be specified as one of following:Â
"read_committed"Â - only return transactional messages which have been committed.Â
"read_uncommitted"Â - return all messages, even transactional messages which have been aborted.
@param isolationLevel The isolation level of messages read.
@return This consumer builder.
*/
|
|
|
|
OpenEdge.Messaging.Kafka.KafkaConsumerBuilder SetIsolationLevel (IsolationLevel)
|
/**
Controls how to read messages written transactionally. Can be specified as one of following:Â
IsolationLevel.ReadCommitted - only return transactional messages which have been committed.Â
IsolationLevel.ReadUncommitted - return all messages, even transactional messages which have been aborted.
@param isolationLevel The isolation level of messages read.
@return This consumer builder.
*/
|
|
|
|
OpenEdge.Messaging.ConsumerBuilder SetKeyDeserializer (character)
|
/**
Provide the name of a class which must implement OpenEdge.Messaging.IDeserializer.
An instance of this class will be created to convert the partition keys of messages
from MEMPTR to LONGCHAR.
@param keyDeserializerClassName The name of a class that implements OpenEdge.Messaging.IDeserializer.
The Consumer will use an instance of this class to deserialize record partition keys.
@return This consumer builder.
*/
|
|
|
|
OpenEdge.Messaging.ConsumerBuilder SetKeyDeserializer (IDeserializer)
|
/**
Provide an implementation of a deserializer that will be used to convert
the partition key of messages from MEMPTR to LONGCHAR.
@param valueDeserializer An instance of an OpenEdge.Messaging.IDeserializer that will be used
by any constructed Consumer to deserialize record partition keys.
@return This consumer builder.
*/
|
|
|
|
OpenEdge.Messaging.ConsumerBuilder SetKeyDeserializerCodePage (character)
|
/**
Set the codepage used to deserialize string based message partition key.
@param characterEncoding The name of a code page that will be used by the consumer's deserializer
to convert MEMPTR values to LONGCHAR.
@return This consumer builder.
*/
|
|
|
|
OpenEdge.Messaging.Kafka.KafkaConsumerBuilder SetMaxPollInterval (int64)
|
/**
Maximum allowed time between calls to consume messages for consumers. If this interval
is exceeded the consumer is considered failed and the group will rebalance in order to reassign the partitions to another consumer
group member.
@param pollInterval The maximum poll interval for consuming messages.
@return This consumer builder.
*/
|
|
|
|
OpenEdge.Messaging.Kafka.KafkaConsumerBuilder SetSASLMechanism (SASLMechanisms)
|
/**
Set the security mechanism to be used by the consumer.
@return This consumer builder.
*/
|
|
|
|
OpenEdge.Messaging.Kafka.KafkaConsumerBuilder SetSASLPassword (character)
|
/**
Set the SASL password.
@param saslPassword The password
@return This consumer builder.
*/
|
|
|
|
OpenEdge.Messaging.Kafka.KafkaConsumerBuilder SetSASLUserName (character)
|
/**
Set the security username to be used by the consumer.
@param saslUserName The security username .
@return This consumer builder.
*/
|
|
|
|
OpenEdge.Messaging.Kafka.KafkaConsumerBuilder SetSecurityProtocol (character)
|
|
|
|
|
OpenEdge.Messaging.Kafka.KafkaConsumerBuilder SetSecurityProtocol (SecurityProtocol)
|
|
|
|
|
OpenEdge.Messaging.Kafka.KafkaConsumerBuilder SetSessionTimeout (int64)
|
/**
Client group session and failure detection timeout. The consumer sends periodic heartbeats (heartbeat.interval.ms) to indicate its liveness to the broker.
If no hearts are received by the broker for a group member within the session timeout, the broker will remove the consumer from the group and trigger a rebalance.
The unit of measure is milliseconds.
@param timeout The session timeout.
@return This consumer builder.
*/
|
|
|
|
OpenEdge.Messaging.Kafka.KafkaConsumerBuilder SetStrictConfigNames (logical)
|
/*
Specify whether errors from kafka broker that indicate unsupported configuration names
are returned to the ABL as an error, or if the error is quietly ignored.
@param enforceStrictConfigNames whether to enforce strict config names .
@return This consumer builder.
*/
|