API StabilityLongTerm

The updateKafkaEventForwarder() GraphQL mutation is used to update a Kafka event forwarder and return it.

For more information on event forwarders, see the Event Forwarders documentation page. You may also want to look at the Event Forwarding and the Events page for related information.

Syntax

Below is the syntax for the updateKafkaEventForwarder() mutation field:

graphql
updateKafkaEventForwarder(
     input: UpdateKafkaEventForwarder!
   ): KafkaEventForwarder!

Given Datatypes

For the given datatype, updateKafkaEventForwarder(), there are several parameters that may be given. Below is a list of them along with their datatypes and a description of each:

Table: UpdateKafkaEventForwarder

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column.
Table last updated: Sep 23, 2024
descriptionstringyes  Description of the event forwarder.
enabledboolean   Whether the event forwarder enabled,
idstringyes  The unique identifier of the event forwarder.
namestringyes  The name of the event forwarder.
propertiesstringyes  The Kafka producer configuration used to forward events in the form of properties (x.y.z=abc). See Kafka Configuration.
topicstringyes  The Kafka topic to which the events should be forwarded.

Returned Datatypes

The returned datatype KafkaEventForwarder has its own parameters. Below is a list of them along with their datatypes and a description of each:

Table: KafkaEventForwarder

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column.
Table last updated: Sep 25, 2024
enabledbooleanyes  Whether the event forwarder is enabled.
descriptionstringyes  The description of the event forwarder.
idstringyes  The unique identifier of the event forwarder.
namestringyes  The name of the event forwarder.
propertiesstringyes  The Kafka producer configuration used to forward events in the form of properties (x.y.z=abc). See Kafka Configuration.
topicstringyes  The Kafka topic where the events should be forwarded.