Share via

KafkaOutput インターフェイス

  • リファレンス
パッケージ:
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 + "" }"; }

メソッドの概要

修飾子と型 メソッドと説明
BrokerAuthenticationMode authenticationMode()

認証に使用する SASL メカニズム。 既定値: PLAIN
int batchSize()

1 つの MessageSet でバッチ処理されるメッセージの最大数を定義します。 既定値: 10000
String brokerList()

BrokerList を定義します。
String dataType()

Functions ランタイムがパラメーター値をどのように扱うかを定義します。 次のいずれかの値になります。

    <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()

"true" に設定すると、プロデューサーはメッセージが 1 回だけ正常に生成され、元の生成順序で確実に生成されるようにします。 default: false
int maxMessageBytes()

送信メッセージの最大サイズを定義します。 既定値: 1 MB
int maxRetries()

失敗したメッセージの送信を再試行する回数。 **注:** 既定値: EnableIdempotence が true に設定されていない限り、2 回再試行すると並べ替えが発生する可能性があります。

int messageTimeoutMs()

ローカル メッセージのタイムアウト。 この値はローカルにのみ適用され、生成されたメッセージが正常に配信されるまで待機する時間を制限します。 0 の時間は無限です。 これは、メッセージの配信に使用される最大時間 (再試行を含む) です。 配信エラーは、再試行回数またはメッセージのタイムアウトを超えた場合に発生します。 既定値: 300000
String name()

function.json で使用される変数名。
String password()

PLAIN と SASL-SCRAM を使用した SASL パスワード-.. メカニズム 既定値はプレーンテキストです

librdkafka の security.protocol
BrokerProtocol protocol()

ブローカーとの通信に使用されるセキュリティ プロトコルを取得または設定します。既定値は PLAINTEXT です。
int requestTimeoutMs()

プロデューサー要求の確認タイムアウト (ミリ秒単位)。 既定値: 5000
String sslCaLocation()

ブローカーの証明書を検証するための CA 証明書ファイルへのパス。 librdkafka の ssl.ca.location
String sslCertificateLocation()

クライアントの証明書へのパス。 librdkafka の ssl.certificate.location
String sslKeyLocation()

認証に使用されるクライアントの秘密キー (PEM) へのパス。 librdkafka の既定の "" ssl.key.location
String sslKeyPassword()

クライアントの証明書のパスワード。 librdkafka の ssl.key.password
String topic()

トピックを定義します。
String username()

PLAIN と SASL-SCRAM を使用した SASL ユーザー名-.. メカニズム 既定: ""

メソッドの詳細

authenticationMode

public BrokerAuthenticationMode authenticationMode() default BrokerAuthenticationMode.NOTSET

認証に使用する SASL メカニズム。 既定値: PLAIN

Returns:

SASL メカニズム。

batchSize

public int batchSize() default 10000

1 つの MessageSet でバッチ処理されるメッセージの最大数を定義します。 既定値: 10000

Returns:

1 つの MessageSet でバッチ処理されたメッセージの最大数。

brokerList

public String brokerList()

BrokerList を定義します。

Returns:

brokerList 名の文字列。

dataType

public String dataType() default ""

Functions ランタイムがパラメーター値をどのように扱うかを定義します。 次のいずれかの値になります。

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

Functions ランタイムによって使用される dataType。

enableIdempotence

public boolean enableIdempotence() default false

"true" に設定すると、プロデューサーはメッセージが 1 回だけ正常に生成され、元の生成順序で確実に生成されるようにします。 default: false

Returns:

べき等が有効になっているかどうか。

maxMessageBytes

public int maxMessageBytes() default 1000012

送信メッセージの最大サイズを定義します。 既定値: 1 MB

Returns:

最大 trnasmit メッセージ サイズ。

maxRetries

public int maxRetries() default 2

失敗したメッセージの送信を再試行する回数。 **注:** 既定値: EnableIdempotence が true に設定されていない限り、2 回再試行すると並べ替えが発生する可能性があります。

Returns:

最大再試行回数。

messageTimeoutMs

public int messageTimeoutMs() default 300000

ローカル メッセージのタイムアウト。 この値はローカルにのみ適用され、生成されたメッセージが正常に配信されるまで待機する時間を制限します。 0 の時間は無限です。 これは、メッセージの配信に使用される最大時間 (再試行を含む) です。 配信エラーは、再試行回数またはメッセージのタイムアウトを超えた場合に発生します。 既定値: 300000

Returns:

ローカル メッセージのタイムアウト。

name

public String name()

function.json で使用される変数名。

Returns:

function.json で使用される変数名。

password

public String password() default ""

PLAIN と SASL-SCRAM を使用した SASL パスワード-.. メカニズム 既定値はプレーンテキストです

librdkafka の security.protocol

Returns:

SASL パスワード。

protocol

public BrokerProtocol protocol() default BrokerProtocol.NOTSET

ブローカーとの通信に使用されるセキュリティ プロトコルを取得または設定します。既定値は PLAINTEXT です。

Returns:

プロトコル。

requestTimeoutMs

public int requestTimeoutMs() default 5000

プロデューサー要求の確認タイムアウト (ミリ秒単位)。 既定値: 5000

Returns:

プロデューサー要求の確認タイムアウト (ミリ秒単位)。

sslCaLocation

public String sslCaLocation() default ""

ブローカーの証明書を検証するための CA 証明書ファイルへのパス。 librdkafka の ssl.ca.location

Returns:

ssl ca の場所。

sslCertificateLocation

public String sslCertificateLocation() default ""

クライアントの証明書へのパス。 librdkafka の ssl.certificate.location

Returns:

SSL 証明書の場所。

sslKeyLocation

public String sslKeyLocation() default ""

認証に使用されるクライアントの秘密キー (PEM) へのパス。 librdkafka の既定の "" ssl.key.location

Returns:

ssl キーの場所。

sslKeyPassword

public String sslKeyPassword() default ""

クライアントの証明書のパスワード。 librdkafka の ssl.key.password

Returns:

ssl キーのパスワード。

topic

public String topic()

トピックを定義します。

Returns:

トピック名。

username

public String username() default ""

PLAIN と SASL-SCRAM を使用した SASL ユーザー名-.. メカニズム 既定: ""

Returns:

SASL ユーザー名。

適用対象