KafkaOutput Interface

Paquet:

com.microsoft.azure.functions.annotation

public interface KafkaOutput

KafkaOutput(name = « event », topic = « users », brokerList="broker:29092 ») OutputBinding<String<output, final ExecutionContext context) { context.getLogger().info(« Message: » + message); output.setValue(message) ; return « { \"id »: «  » + System.currentTimeMillis() + «  », « description »: «  » + message + «  » } »; }

Résumé de la méthode

Modificateur et type	Méthode et description
BrokerAuthenticationMode	authenticationMode() Mécanisme SASL à utiliser pour l’authentification. Valeur par défaut : PLAIN
int	batchSize() Définit le nombre maximal de messages traités par lot dans un MessageSet. par défaut : 10000
String	brokerList() Définit brokerList.
String	dataType() Définit comment le runtime Functions doit traiter la valeur de paramètre. Les valeurs possibles sont les suivantes : <li> <p>"" or string: treat it as a string whose value is serialized from the parameter </p> </li> <li> <p>binary: treat it as a binary data whose value comes from for example OutputBinding&lt;byte[]&lt;</p> </li>
boolean	enableIdempotence() Lorsqu’il est défini sur « true », le producteur s’assure que les messages sont générés exactement une fois et dans l’ordre de production d’origine. default : false
int	maxMessageBytes() Définit la taille maximale du message de transmission. Valeur par défaut : 1 Mo
int	maxRetries() Nombre de tentatives d’envoi d’un message défaillant. **Remarque :** valeur par défaut : 2 La nouvelle tentative peut entraîner une réorganisation, sauf si EnableIdempotence a la valeur true.
int	messageTimeoutMs() Délai d’expiration des messages locaux. Cette valeur est appliquée uniquement localement et limite le temps d’attente d’une remise réussie d’un message produit. Un temps de 0 est infini. Cette valeur représente le délai maximal de remise d’un message (nouvelles tentatives comprises). Une erreur de remise se produit lorsque le nombre de tentatives ou le délai d’expiration du message sont dépassés. par défaut : 3000000
String	name() Nom de variable utilisé dans function.json.
String	password() Mot de passe SASL avec plain et SASL-SCRAM-.. mécanismes La valeur par défaut est en texte en clair security.protocol dans librdkafka
BrokerProtocol	protocol() Obtient ou définit le protocole de sécurité utilisé pour communiquer avec les répartiteurs par défaut est PLAINTEXT
int	requestTimeoutMs() Délai d’expiration de la demande du producteur en millisecondes. par défaut : 5000
String	sslCaLocation() Chemin d’accès au fichier de certificat d’autorité de certification pour la vérification du certificat du répartiteur. ssl.ca.location dans librdkafka
String	sslCertificateLocation() Chemin d’accès au certificat du client. ssl.certificate.location dans librdkafka
String	sslKeyLocation() Chemin d’accès à la clé privée (PEM) du client utilisée pour l’authentification. Par défaut « » ssl.key.location dans librdkafka
String	sslKeyPassword() Mot de passe du certificat du client. ssl.key.password dans librdkafka
String	topic() Définit la rubrique.
String	username() Nom d’utilisateur SASL avec plain et SASL-SCRAM-.. mécanismes Par défaut : « »

Détails de la méthode

authenticationMode

public BrokerAuthenticationMode authenticationMode() default BrokerAuthenticationMode.NOTSET

Mécanisme SASL à utiliser pour l’authentification. Valeur par défaut : PLAIN

Returns:

Mécanisme SASL.

batchSize

public int batchSize() default 10000

Définit le nombre maximal de messages traités par lot dans un MessageSet. par défaut : 10000

Returns:

Nombre maximal de messages traités par lot dans un Ensemble de messages.

brokerList

public String brokerList()

Définit brokerList.

Returns:

Chaîne de nom brokerList.

dataType

public String dataType() default ""

Définit comment le runtime Functions doit traiter la valeur de paramètre. Les valeurs possibles sont les suivantes :

<li>

  <p>"" or string: treat it as a string whose value is serialized from the parameter </p>

</li>

<li>

  <p>binary: treat it as a binary data whose value comes from for example OutputBinding&lt;byte[]&lt;</p>

</li>

Returns:

DataType qui sera utilisé par le runtime Functions.

enableIdempotence

public boolean enableIdempotence() default false

Lorsqu’il est défini sur « true », le producteur s’assure que les messages sont générés exactement une fois et dans l’ordre de production d’origine. default : false

Returns:

si l’idempotence est activée.

maxMessageBytes

public int maxMessageBytes() default 1000012

Définit la taille maximale du message de transmission. Valeur par défaut : 1 Mo

Returns:

Taille maximale du message trnasmit.

maxRetries

public int maxRetries() default 2

Nombre de tentatives d’envoi d’un message défaillant. **Remarque :** valeur par défaut : 2 La nouvelle tentative peut entraîner une réorganisation, sauf si EnableIdempotence a la valeur true.

Returns:

Nombre maximal de nouvelles tentatives.

messageTimeoutMs

public int messageTimeoutMs() default 300000

Délai d’expiration des messages locaux. Cette valeur est appliquée uniquement localement et limite le temps d’attente d’une remise réussie d’un message produit. Un temps de 0 est infini. Cette valeur représente le délai maximal de remise d’un message (nouvelles tentatives comprises). Une erreur de remise se produit lorsque le nombre de tentatives ou le délai d’expiration du message sont dépassés. par défaut : 3000000

Returns:

Délai d’expiration du message local.

name

public String name()

Nom de variable utilisé dans function.json.

Returns:

Nom de variable utilisé dans function.json.

password

public String password() default ""

Mot de passe SASL avec plain et SASL-SCRAM-.. mécanismes La valeur par défaut est en texte en clair

security.protocol dans librdkafka

Returns:

Mot de passe SASL.

protocol

public BrokerProtocol protocol() default BrokerProtocol.NOTSET

Obtient ou définit le protocole de sécurité utilisé pour communiquer avec les répartiteurs par défaut est PLAINTEXT

Returns:

Protocole.

requestTimeoutMs

public int requestTimeoutMs() default 5000

Délai d’expiration de la demande du producteur en millisecondes. par défaut : 5000

Returns:

Délai d’expiration de la demande du producteur en millisecondes.

sslCaLocation

public String sslCaLocation() default ""

Chemin d’accès au fichier de certificat d’autorité de certification pour la vérification du certificat du répartiteur. ssl.ca.location dans librdkafka

Returns:

Emplacement ssl ca.

sslCertificateLocation

public String sslCertificateLocation() default ""

Chemin d’accès au certificat du client. ssl.certificate.location dans librdkafka

Returns:

Emplacement du certificat ssl.

sslKeyLocation

public String sslKeyLocation() default ""

Chemin d’accès à la clé privée (PEM) du client utilisée pour l’authentification. Par défaut « » ssl.key.location dans librdkafka

Returns:

Emplacement de la clé ssl.

sslKeyPassword

public String sslKeyPassword() default ""

Mot de passe du certificat du client. ssl.key.password dans librdkafka

Returns:

Mot de passe de clé ssl.

topic

public String topic()

Définit la rubrique.

Returns:

Nom de la rubrique.

username

public String username() default ""

Nom d’utilisateur SASL avec plain et SASL-SCRAM-.. mécanismes Par défaut : « »

Returns:

Nom d’utilisateur SASL.