Confluent Consume

Premium Partner

Overview Examples Configuration reference Changelog

Configuration

configobjectrequired

Hide Child Parameters

auto_offset_resetstring

The offset to start from when there is no initial offset in the consumer group.

Allowed values:earliestlatest

Default:latest

bootstrap_serversarray[object]

Set of bootstrap brokers in a {host: host, port: port} list format.

Hide Child Parameters

hoststringrequired

A string representing a host name, such as example.com.

portintegerrequired

An integer representing a port number between 0 and 65535, inclusive.

>= 0<= 65535

cluster_api_keystringrequired

Username/Apikey for SASL authentication.
This field is encrypted.
This field is referenceable.

cluster_api_secretstringrequired

Password/ApiSecret for SASL authentication.
This field is encrypted.
This field is referenceable.

cluster_namestring

An identifier for the Kafka cluster. By default, this field generates a random string. You can also set your own custom cluster identifier. If more than one Kafka plugin is configured without a cluster_name (that is, if the default autogenerated value is removed), these plugins will use the same producer, and by extension, the same cluster. Logs will be sent to the leader of the cluster.

commit_strategystring

The strategy to use for committing offsets.

Allowed values:autooff

Default:auto

confluent_cloud_api_keystring

Apikey for authentication with Confluent Cloud. This allows for management tasks such as creating topics, ACLs, etc.
This field is encrypted.
This field is referenceable.

confluent_cloud_api_secretstring

The corresponding secret for the Confluent Cloud API key.
This field is encrypted.
This field is referenceable.

keepaliveinteger

Keepalive timeout in milliseconds.

Default:60000

keepalive_enabledboolean

Default:false

message_deserializerstring

The deserializer to use for the consumed messages.

Allowed values:jsonnoop

Default:noop

modestring

The mode of operation for the plugin.

Allowed values:http-getserver-sent-events

Default:http-get

schema_registryobject

The plugin-global schema registry configuration.

Hide Child Parameters

confluentobject

Hide Child Parameters

authenticationobjectrequired

Show Child Parameters

ssl_verifyboolean

Set to false to disable SSL certificate verification when connecting to the schema registry.

Default:true

ttlnumber

The TTL in seconds for the schema registry cache.

>= 0<= 3600

urlstring

The URL of the schema registry.

timeoutinteger

Socket timeout in milliseconds.

Default:10000

topicsarray[object]required

The Kafka topics and their configuration you want to consume from.

>= 1 characters

Hide Child Parameters

namestringrequired

schema_registryobjectrequired

The plugin-global schema registry configuration.

Hide Child Parameters

confluentobject

Show Child Parameters

consumerobject

If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.

* Additional properties are NOT allowed.

Hide Child Parameters

idstring

protocolsarray[string]

A set of strings representing HTTP protocols.

Allowed values:grpcgrpcshttphttps

Default:grpc, grpcs, http, https

routeobject

If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.

* Additional properties are NOT allowed.

Hide Child Parameters

idstring

serviceobject

If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.

* Additional properties are NOT allowed.

Hide Child Parameters

idstring

Confluent Consume

Configuration

Did this doc help?

Help us make these docs great!

Still need help