Interface IKafkaProducerEndpointBuilder

Builds the KafkaProducerEndpoint.

Inherited Members

IProducerEndpointBuilder<IKafkaProducerEndpointBuilder>.SerializeUsing(IMessageSerializer)

IProducerEndpointBuilder<IKafkaProducerEndpointBuilder>.Encrypt(EncryptionSettings)

IProducerEndpointBuilder<IKafkaProducerEndpointBuilder>.UseStrategy(IProduceStrategy)

IProducerEndpointBuilder<IKafkaProducerEndpointBuilder>.ProduceDirectly()

IProducerEndpointBuilder<IKafkaProducerEndpointBuilder>.ProduceToOutbox()

IProducerEndpointBuilder<IKafkaProducerEndpointBuilder>.EnableChunking(Int32, Boolean)

IProducerEndpointBuilder<IKafkaProducerEndpointBuilder>.AddHeader(String, Object)

IProducerEndpointBuilder<IKafkaProducerEndpointBuilder>.AddHeader<TMessage>(String, Object)

IProducerEndpointBuilder<IKafkaProducerEndpointBuilder>.AddHeader<TMessage>(String, Func<IOutboundEnvelope<TMessage>, Object>)

IProducerEndpointBuilder<IKafkaProducerEndpointBuilder>.WithMessageId<TMessage>(Func<IOutboundEnvelope<TMessage>, Object>)

IEndpointBuilder<IKafkaProducerEndpointBuilder>.MessageType

IEndpointBuilder<IKafkaProducerEndpointBuilder>.WithName(String)

IEndpointBuilder<IKafkaProducerEndpointBuilder>.UseSerializer(IMessageSerializer)

IEndpointBuilder<IKafkaProducerEndpointBuilder>.WithEncryption(EncryptionSettings)

IEndpointBuilder<IKafkaProducerEndpointBuilder>.ValidateMessage(Boolean)

IEndpointBuilder<IKafkaProducerEndpointBuilder>.DisableMessageValidation()

Namespace: Silverback.Messaging.Configuration.Kafka

Assembly: Silverback.Integration.Kafka.dll

Syntax

public interface IKafkaProducerEndpointBuilder : IProducerEndpointBuilder<IKafkaProducerEndpointBuilder>, IEndpointBuilder<IKafkaProducerEndpointBuilder>

Methods

Configure(Action<KafkaProducerConfig>)

Configures the Kafka client properties.

Declaration

IKafkaProducerEndpointBuilder Configure(Action<KafkaProducerConfig> configAction)

Parameters

Type	Name	Description
System.Action<KafkaProducerConfig>	configAction	An System.Action<T> that takes the KafkaProducerConfig and configures it.

Returns

Type	Description
IKafkaProducerEndpointBuilder	The IKafkaProducerEndpointBuilder so that additional calls can be chained.

ProduceTo(Func<IOutboundEnvelope, IServiceProvider, String>, Func<IOutboundEnvelope, IServiceProvider, Int32>)

Specifies the name of the topic and optionally the target partition.

Declaration

IKafkaProducerEndpointBuilder ProduceTo(Func<IOutboundEnvelope, IServiceProvider, string> topicNameFunction, Func<IOutboundEnvelope, IServiceProvider, int> partitionFunction = null)

Parameters

Type	Name	Description
System.Func<IOutboundEnvelope, System.IServiceProvider, System.String>	topicNameFunction	The function returning the topic name for the message being produced. If the function returns null the message will not be produced.
System.Func<IOutboundEnvelope, System.IServiceProvider, System.Int32>	partitionFunction	The optional function returning the target partition index for the message being produced. If null the partition is automatically derived from the message key (use KafkaKeyMemberAttribute to specify a message key, otherwise a random one will be generated).

Returns

Type	Description
IKafkaProducerEndpointBuilder	The IKafkaProducerEndpointBuilder so that additional calls can be chained.

ProduceTo(Func<IOutboundEnvelope, String>, Func<IOutboundEnvelope, Int32>)

Specifies the name of the topic and optionally the target partition.

Declaration

IKafkaProducerEndpointBuilder ProduceTo(Func<IOutboundEnvelope, string> topicNameFunction, Func<IOutboundEnvelope, int> partitionFunction = null)

Parameters

Type	Name	Description
System.Func<IOutboundEnvelope, System.String>	topicNameFunction	The function returning the topic name for the message being produced. If the function returns null the message will not be produced.
System.Func<IOutboundEnvelope, System.Int32>	partitionFunction	The optional function returning the target partition index for the message being produced. If null the partition is automatically derived from the message key (use KafkaKeyMemberAttribute to specify a message key, otherwise a random one will be generated).

Returns

Type	Description
IKafkaProducerEndpointBuilder	The IKafkaProducerEndpointBuilder so that additional calls can be chained.

ProduceTo(String, Func<IOutboundEnvelope, String[]>, Func<IOutboundEnvelope, Int32>)

Specifies the name of the topic and optionally the target partition.

Declaration

IKafkaProducerEndpointBuilder ProduceTo(string topicNameFormatString, Func<IOutboundEnvelope, string[]> topicNameArgumentsFunction, Func<IOutboundEnvelope, int> partitionFunction = null)

Parameters

Type	Name	Description
System.String	topicNameFormatString	The endpoint name format string that will be combined with the arguments returned by the topicNameArgumentsFunction using a string.Format.
System.Func<IOutboundEnvelope, System.String[]>	topicNameArgumentsFunction	The function returning the arguments to be used to format the string.
System.Func<IOutboundEnvelope, System.Int32>	partitionFunction	The optional function returning the target partition index for the message being produced. If null the partition is automatically derived from the message key (use KafkaKeyMemberAttribute to specify a message key, otherwise a random one will be generated).

Returns

Type	Description
IKafkaProducerEndpointBuilder	The IKafkaProducerEndpointBuilder so that additional calls can be chained.

ProduceTo(String, Nullable<Int32>)

Specifies the name of the topic and optionally the target partition.

Declaration

IKafkaProducerEndpointBuilder ProduceTo(string topicName, int? partition = null)

Parameters

Type	Name	Description
System.String	topicName	The name of the topic.
System.Nullable<System.Int32>	partition	The optional partition index. If null the partition is automatically derived from the message key (use KafkaKeyMemberAttribute to specify a message key, otherwise a random one will be generated).

Returns

Type	Description
IKafkaProducerEndpointBuilder	The IKafkaProducerEndpointBuilder so that additional calls can be chained.

ProduceTo<TMessage>(Func<IOutboundEnvelope<TMessage>, IServiceProvider, String>, Func<IOutboundEnvelope<TMessage>, IServiceProvider, Int32>)

Specifies the name of the topic and optionally the target partition.

Declaration

IKafkaProducerEndpointBuilder ProduceTo<TMessage>(Func<IOutboundEnvelope<TMessage>, IServiceProvider, string> topicNameFunction, Func<IOutboundEnvelope<TMessage>, IServiceProvider, int> partitionFunction = null)

    where TMessage : class

Parameters

Type	Name	Description
System.Func<IOutboundEnvelope<TMessage>, System.IServiceProvider, System.String>	topicNameFunction	The function returning the topic name for the message being produced. If the function returns null the message will not be produced.
System.Func<IOutboundEnvelope<TMessage>, System.IServiceProvider, System.Int32>	partitionFunction	The optional function returning the target partition index for the message being produced. If null the partition is automatically derived from the message key (use KafkaKeyMemberAttribute to specify a message key, otherwise a random one will be generated).

Returns

Type	Description
IKafkaProducerEndpointBuilder	The IKafkaProducerEndpointBuilder so that additional calls can be chained.

Type Parameters

Name	Description
TMessage	The type of the messages being produced.

ProduceTo<TMessage>(Func<IOutboundEnvelope<TMessage>, String>, Func<IOutboundEnvelope<TMessage>, Int32>)

Specifies the name of the topic and optionally the target partition.

Declaration

IKafkaProducerEndpointBuilder ProduceTo<TMessage>(Func<IOutboundEnvelope<TMessage>, string> topicNameFunction, Func<IOutboundEnvelope<TMessage>, int> partitionFunction = null)

    where TMessage : class

Parameters

Type	Name	Description
System.Func<IOutboundEnvelope<TMessage>, System.String>	topicNameFunction	The function returning the topic name for the message being produced. If the function returns null the message will not be produced.
System.Func<IOutboundEnvelope<TMessage>, System.Int32>	partitionFunction	The optional function returning the target partition index for the message being produced. If null the partition is automatically derived from the message key (use KafkaKeyMemberAttribute to specify a message key, otherwise a random one will be generated).

Returns

Type	Description
IKafkaProducerEndpointBuilder	The IKafkaProducerEndpointBuilder so that additional calls can be chained.

Type Parameters

Name	Description
TMessage	The type of the messages being produced.

ProduceTo<TMessage>(String, Func<IOutboundEnvelope<TMessage>, String[]>, Func<IOutboundEnvelope<TMessage>, Int32>)

Specifies the name of the topic and optionally the target partition.

Declaration

IKafkaProducerEndpointBuilder ProduceTo<TMessage>(string topicNameFormatString, Func<IOutboundEnvelope<TMessage>, string[]> topicNameArgumentsFunction, Func<IOutboundEnvelope<TMessage>, int> partitionFunction = null)

    where TMessage : class

Parameters

Type	Name	Description
System.String	topicNameFormatString	The endpoint name format string that will be combined with the arguments returned by the topicNameArgumentsFunction using a string.Format.
System.Func<IOutboundEnvelope<TMessage>, System.String[]>	topicNameArgumentsFunction	The function returning the arguments to be used to format the string.
System.Func<IOutboundEnvelope<TMessage>, System.Int32>	partitionFunction	The optional function returning the target partition index for the message being produced. If null the partition is automatically derived from the message key (use KafkaKeyMemberAttribute to specify a message key, otherwise a random one will be generated).

Returns

Type	Description
IKafkaProducerEndpointBuilder	The IKafkaProducerEndpointBuilder so that additional calls can be chained.

Type Parameters

Name	Description
TMessage	The type of the messages being produced.

UseEndpointNameResolver<TResolver>()

Specifies the type of the IKafkaProducerEndpointNameResolver to be used to resolve the actual endpoint name and partition.

Declaration

IKafkaProducerEndpointBuilder UseEndpointNameResolver<TResolver>()

    where TResolver : IKafkaProducerEndpointNameResolver

Returns

Type	Description
IKafkaProducerEndpointBuilder	The IKafkaProducerEndpointBuilder so that additional calls can be chained.

Type Parameters

Name	Description
TResolver	The type of the IKafkaProducerEndpointNameResolver to be used.

WithKafkaKey<TMessage>(Func<IOutboundEnvelope<TMessage>, Object>)

Uses the specified value provider function to set the kafka key for each produced message.

Declaration

IKafkaProducerEndpointBuilder WithKafkaKey<TMessage>(Func<IOutboundEnvelope<TMessage>, object> valueProvider)

    where TMessage : class

Parameters

Type	Name	Description
System.Func<IOutboundEnvelope<TMessage>, System.Object>	valueProvider	The value provider function.

Returns

Type	Description
IKafkaProducerEndpointBuilder	The endpoint builder so that additional calls can be chained.

Type Parameters

Name	Description
TMessage	The type of the messages to be enriched.

Extension Methods

ProducerEndpointBuilderSerializeAsJsonUsingNewtonsoftExtensions.SerializeAsJsonUsingNewtonsoft<TBuilder>(IProducerEndpointBuilder<TBuilder>, Action<INewtonsoftJsonMessageSerializerBuilder>)

ProducerEndpointBuilderSerializeAsAvroExtensions.SerializeAsAvro<TBuilder>(IProducerEndpointBuilder<TBuilder>, Action<IAvroMessageSerializerBuilder>)