CreateBatchOptions interface

パッケージ:

@azure/event-hubs

で メソッドを createBatch 構成するための EventHubProducerClientオプション。

• partitionKey : パーティション割り当てを生成するためにハッシュされる値。
• maxSizeInBytes: バッチのサイズの上限。
• abortSignal : 送信操作を取り消す要求を通知します。

使用例:

{
    partitionKey: 'foo',
    maxSizeInBytes: 1024 * 1024 // 1 MB
}

Extends

OperationOptions

プロパティ

maxSizeInBytes	バッチのサイズの上限。 この tryAdd 制限に達すると、関数は を返します false 。
partitionId	このバッチが送信されるパーティション。 この値が設定されている場合、partitionKey を設定できません。
partitionKey	パーティション割り当てを生成するためにハッシュされる値。 これにより、同じ partitionKey を持つメッセージが同じパーティションに格納されます。 この値が設定されている場合、partitionId を設定できません。

継承されたプロパティ

abortSignal	要求を中止するために使用できるシグナル。
tracingOptions	トレースを構成するためのオプション。

プロパティの詳細

maxSizeInBytes

バッチのサイズの上限。 この tryAdd 制限に達すると、関数は を返します false 。

maxSizeInBytes?: number

プロパティ値

number

partitionId

このバッチが送信されるパーティション。 この値が設定されている場合、partitionKey を設定できません。

partitionId?: string

プロパティ値

string

partitionKey

パーティション割り当てを生成するためにハッシュされる値。 これにより、同じ partitionKey を持つメッセージが同じパーティションに格納されます。 この値が設定されている場合、partitionId を設定できません。

partitionKey?: string

プロパティ値

string

継承されたプロパティの詳細

abortSignal

要求を中止するために使用できるシグナル。

abortSignal?: AbortSignalLike

プロパティ値

AbortSignalLike

OperationOptions.abortSignalから継承

tracingOptions

トレースを構成するためのオプション。

tracingOptions?: OperationTracingOptions

プロパティ値

OperationTracingOptions

OperationOptions.tracingOptionsから継承