KafkaOutput Schnittstelle

Paket:

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 + "" }"; }

Methodenzusammenfassung

Modifizierer und Typ	Methode und Beschreibung
BrokerAuthenticationMode	authenticationMode() SASL-Mechanismus, der für die Authentifizierung verwendet werden soll. Standard: PLAIN
int	batchSize() Definiert die maximale Anzahl von Nachrichten, die als Batch in einem MessageSet enthalten sind. Standardeinstellung: 10000
String	brokerList() Definiert die BrokerList.
String	dataType() Definiert, wie die Functions-Runtime den Parameterwert behandeln soll. Mögliche Werte: <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() Bei Festlegung auf "true" stellt der Producer sicher, dass Nachrichten genau einmal und in der ursprünglichen Produktionsreihenfolge erfolgreich erstellt werden. default: false
int	maxMessageBytes() Definiert die maximale Größe von Übertragungsnachrichten. Standard: 1 MB
int	maxRetries() Gibt an, wie oft versucht werden soll, eine fehlerhafte Nachricht zu senden. **Hinweis:** Standard: 2 Wiederholungen können zu einer Neuanordnung führen, es sei denn, EnableIdempotence ist auf true festgelegt.
int	messageTimeoutMs() Timeout für lokale Nachrichten. Dieser Wert wird nur lokal erzwungen und begrenzt die Zeit, in der eine generierte Nachricht auf eine erfolgreiche Übermittlung wartet. Eine Zeit von 0 ist unendlich. Dies ist die maximale Zeit für die Übermittlung einer Nachricht (einschließlich Wiederholungsversuche). Ein Übermittlungsfehler tritt auf, wenn entweder die Anzahl der Wiederholungsversuche oder das Nachrichtentimeout überschritten wird. Standardeinstellung: 300000
String	name() Der in function.json verwendete Variablenname.
String	password() SASL-Kennwort mit PLAIN und SASL-SCRAM-.. mechanisms Standard ist Nur-Text security.protocol in librdkafka
BrokerProtocol	protocol() Ruft das Sicherheitsprotokoll ab, das für die Kommunikation mit Brokern verwendet wird, oder legt es fest. Der Standardwert ist PLAINTEXT.
int	requestTimeoutMs() Das ack-Timeout der Produceranforderung in Millisekunden. Standardeinstellung: 5000
String	sslCaLocation() Pfad zur Zertifizierungsstellenzertifikatdatei zum Überprüfen des Brokerzertifikats. ssl.ca.location in librdkafka
String	sslCertificateLocation() Pfad zum Clientzertifikat. ssl.certificate.location in librdkafka
String	sslKeyLocation() Pfad zum privaten Schlüssel (PEM) des Clients, der für die Authentifizierung verwendet wird. Standard "" ssl.key.location in librdkafka
String	sslKeyPassword() Kennwort für das Zertifikat des Clients. ssl.key.password in librdkafka
String	topic() Definiert das Thema.
String	username() SASL-Benutzername mit PLAIN und SASL-SCRAM-.. mechanisms Default: ""

Details zur Methode

authenticationMode

public BrokerAuthenticationMode authenticationMode() default BrokerAuthenticationMode.NOTSET

SASL-Mechanismus, der für die Authentifizierung verwendet werden soll. Standard: PLAIN

Returns:

Der SASL-Mechanismus.

batchSize

public int batchSize() default 10000

Definiert die maximale Anzahl von Nachrichten, die als Batch in einem MessageSet enthalten sind. Standardeinstellung: 10000

Returns:

Die maximale Anzahl von Nachrichten, die in einem MessageSet als Batch verarbeitet werden.

brokerList

public String brokerList()

Definiert die BrokerList.

Returns:

Die brokerList-Namenszeichenfolge.

dataType

public String dataType() default ""

Definiert, wie die Functions-Runtime den Parameterwert behandeln soll. Mögliche Werte:

<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:

Der dataType, der von der Functions-Runtime verwendet wird.

enableIdempotence

public boolean enableIdempotence() default false

Bei Festlegung auf "true" stellt der Producer sicher, dass Nachrichten genau einmal und in der ursprünglichen Produktionsreihenfolge erfolgreich erstellt werden. default: false

Returns:

ob Idempotenz aktiviert ist.

maxMessageBytes

public int maxMessageBytes() default 1000012

Definiert die maximale Größe von Übertragungsnachrichten. Standard: 1 MB

Returns:

Die maximale Trnasmit-Nachrichtengröße.

maxRetries

public int maxRetries() default 2

Gibt an, wie oft versucht werden soll, eine fehlerhafte Nachricht zu senden. **Hinweis:** Standard: 2 Wiederholungen können zu einer Neuanordnung führen, es sei denn, EnableIdempotence ist auf true festgelegt.

Returns:

Die Anzahl der maximalen Wiederholungsversuche.

messageTimeoutMs

public int messageTimeoutMs() default 300000

Timeout für lokale Nachrichten. Dieser Wert wird nur lokal erzwungen und begrenzt die Zeit, in der eine generierte Nachricht auf eine erfolgreiche Übermittlung wartet. Eine Zeit von 0 ist unendlich. Dies ist die maximale Zeit für die Übermittlung einer Nachricht (einschließlich Wiederholungsversuche). Ein Übermittlungsfehler tritt auf, wenn entweder die Anzahl der Wiederholungsversuche oder das Nachrichtentimeout überschritten wird. Standardeinstellung: 300000

Returns:

Das Timeout für lokale Nachrichten.

name

public String name()

Der in function.json verwendete Variablenname.

Returns:

Der in function.json verwendete Variablenname.

password

public String password() default ""

SASL-Kennwort mit PLAIN und SASL-SCRAM-.. mechanisms Standard ist Nur-Text

security.protocol in librdkafka

Returns:

Das SASL-Kennwort.

protocol

public BrokerProtocol protocol() default BrokerProtocol.NOTSET

Ruft das Sicherheitsprotokoll ab, das für die Kommunikation mit Brokern verwendet wird, oder legt es fest. Der Standardwert ist PLAINTEXT.

Returns:

Das Protokoll,

requestTimeoutMs

public int requestTimeoutMs() default 5000

Das ack-Timeout der Produceranforderung in Millisekunden. Standardeinstellung: 5000

Returns:

Das ack-Timeout der Produceranforderung in Millisekunden.

sslCaLocation

public String sslCaLocation() default ""

Pfad zur Zertifizierungsstellenzertifikatdatei zum Überprüfen des Brokerzertifikats. ssl.ca.location in librdkafka

Returns:

Der Speicherort der SSL-Zertifizierungsstelle.

sslCertificateLocation

public String sslCertificateLocation() default ""

Pfad zum Clientzertifikat. ssl.certificate.location in librdkafka

Returns:

Der Speicherort des SSL-Zertifikats.

sslKeyLocation

public String sslKeyLocation() default ""

Pfad zum privaten Schlüssel (PEM) des Clients, der für die Authentifizierung verwendet wird. Standard "" ssl.key.location in librdkafka

Returns:

Der Speicherort des SSL-Schlüssels.

sslKeyPassword

public String sslKeyPassword() default ""

Kennwort für das Zertifikat des Clients. ssl.key.password in librdkafka

Returns:

Das Ssl-Schlüsselkennwort.

topic

public String topic()

Definiert das Thema.

Returns:

Der Name des Themas.

username

public String username() default ""

SASL-Benutzername mit PLAIN und SASL-SCRAM-.. mechanisms Default: ""

Returns:

Der SASL-Benutzername.