EventHubBufferedProducerClientOptions interface

套件:

@azure/event-hubs

描述可在建立 EventHubBufferedProducerClient時提供的選項。

Extends

EventHubClientOptions

屬性

enableIdempotentRetries	指出 EventHubProducerClient 是否應該啟用向事件中樞分割區的等冪發佈。 如果啟用，產生者將只能直接發佈至數據分割;它將無法發佈至事件中樞網關以進行自動分割路由，也無法使用分割區索引鍵。 默認值：false
maxEventBufferLengthPerPartition	可在指定數據分割的指定時間緩衝發佈的事件總數。 默認值：1500
maxWaitTimeInMs	在發佈部分完整批次之前，等候在緩衝區中加入佇列的新事件所花費的時間量。 預設值：1 秒。
onSendEventsErrorHandler	批次無法發佈時要呼叫的處理程式。
onSendEventsSuccessHandler	成功發佈批次之後所要呼叫的處理程式。

繼承的屬性

customEndpointAddress	連接到事件中樞服務時要使用的自定義端點。 當您的網路不允許連線到標準 Azure 事件中樞端點位址，但允許透過中繼連線時，這非常有用。 範例：“https://my.custom.endpoint:100/"
identifier	用來識別用戶端的唯一名稱。 如果未提供，則會使用 GUID 作為標識符
retryOptions	針對用戶端上所有作業設定重試原則的選項。 例如，{ "maxRetries": 4 } 或 { "maxRetries": 4, "retryDelayInMs": 30000 }。
userAgent	附加至傳遞至事件中樞服務之內建使用者代理程式字串的值。
webSocketOptions	透過 Web 套接字設定 AMQP 連線通道的選項。

屬性詳細資料

enableIdempotentRetries

指出 EventHubProducerClient 是否應該啟用向事件中樞分割區的等冪發佈。 如果啟用，產生者將只能直接發佈至數據分割;它將無法發佈至事件中樞網關以進行自動分割路由，也無法使用分割區索引鍵。 默認值：false

enableIdempotentRetries?: boolean

屬性值

boolean

maxEventBufferLengthPerPartition

可在指定數據分割的指定時間緩衝發佈的事件總數。

默認值：1500

maxEventBufferLengthPerPartition?: number

屬性值

number

maxWaitTimeInMs

在發佈部分完整批次之前，等候在緩衝區中加入佇列的新事件所花費的時間量。

預設值：1 秒。

maxWaitTimeInMs?: number

屬性值

number

onSendEventsErrorHandler

批次無法發佈時要呼叫的處理程式。

onSendEventsErrorHandler: (ctx: OnSendEventsErrorContext) => void

屬性值

(ctx: OnSendEventsErrorContext) => void

onSendEventsSuccessHandler

成功發佈批次之後所要呼叫的處理程式。

onSendEventsSuccessHandler?: (ctx: OnSendEventsSuccessContext) => void

屬性值

(ctx: OnSendEventsSuccessContext) => void

繼承的屬性詳細資料

customEndpointAddress

連接到事件中樞服務時要使用的自定義端點。 當您的網路不允許連線到標準 Azure 事件中樞端點位址，但允許透過中繼連線時，這非常有用。

範例：“https://my.custom.endpoint:100/"

customEndpointAddress?: string

屬性值

string

繼承自EventHubClientOptions.customEndpointAddress

identifier

用來識別用戶端的唯一名稱。 如果未提供，則會使用 GUID 作為標識符

identifier?: string

屬性值

string

繼承自EventHubClientOptions.identifier

retryOptions

針對用戶端上所有作業設定重試原則的選項。 例如，{ "maxRetries": 4 } 或 { "maxRetries": 4, "retryDelayInMs": 30000 }。

retryOptions?: RetryOptions

屬性值

RetryOptions

繼承自EventHubClientOptions.retryOptions

userAgent

附加至傳遞至事件中樞服務之內建使用者代理程式字串的值。

userAgent?: string

屬性值

string

繼承自EventHubClientOptions.userAgent

webSocketOptions

透過 Web 套接字設定 AMQP 連線通道的選項。

webSocketOptions?: WebSocketOptions

屬性值

WebSocketOptions

繼承自EventHubClientOptions.webSocketOptions