SubscribeOptions interface

套件:

@azure/event-hubs

在 上 EventHubConsumerClient 設定 subscribe 方法的選項。 例如， { maxBatchSize: 20, maxWaitTimeInSeconds: 120, startPosition: { sequenceNumber: 123 } }

屬性

maxBatchSize	每個批次要求的事件數目
maxWaitTimeInSeconds	在將資料傳遞至使用者程式碼進行處理之前，等待建置要求之訊息計數的時間上限。 如果未提供，則預設為 60 秒。
ownerLevel	要作為此訂用帳戶的擁有者層級訂閱資料分割。
prefetchCount	要求積極和佇列的事件計數，而不考慮是否已要求讀取。
skipParsingBodyAsJson	在接收訊息時，停用用戶端在訊息本文上執行 JSON.parse () 的選項。 如果訊息是以 AMQP 本文類型值或序列傳送，則不適用。 當您偏好直接處理訊息本文中的位元組，而不是用戶端嘗試剖析它時，請使用此選項。
startPosition	如果找不到檢查點，則為開始接收事件之分割區中的事件位置。 如果您想要針對每個分割區使用不同的起始位置，請將資料分割識別碼的對應傳遞至位置。
tracingOptions	設定追蹤的選項。
trackLastEnqueuedEventProperties	指出取用者是否應該在其相關聯的分割區上要求最後排入佇列事件的資訊，並在收到事件時追蹤該資訊。 當追蹤資料分割的最後一個排入佇列事件的相關資訊時，從事件中樞服務收到的每個事件都會包含其否則不會之資料分割的相關中繼資料。 這會導致少量額外的網路頻寬耗用量，在考慮使用事件中樞用戶端定期提出分割區屬性的要求時，通常會是一個偏好的取捨。

屬性詳細資料

maxBatchSize

每個批次要求的事件數目

maxBatchSize?: number

屬性值

number

maxWaitTimeInSeconds

在將資料傳遞至使用者程式碼進行處理之前，等待建置要求之訊息計數的時間上限。 如果未提供，則預設為 60 秒。

maxWaitTimeInSeconds?: number

屬性值

number

ownerLevel

要作為此訂用帳戶的擁有者層級訂閱資料分割。

ownerLevel?: number

屬性值

number

prefetchCount

要求積極和佇列的事件計數，而不考慮是否已要求讀取。

prefetchCount?: number

屬性值

number

skipParsingBodyAsJson

在接收訊息時，停用用戶端在訊息本文上執行 JSON.parse () 的選項。 如果訊息是以 AMQP 本文類型值或序列傳送，則不適用。 當您偏好直接處理訊息本文中的位元組，而不是用戶端嘗試剖析它時，請使用此選項。

skipParsingBodyAsJson?: boolean

屬性值

boolean

startPosition

如果找不到檢查點，則為開始接收事件之分割區中的事件位置。 如果您想要針對每個分割區使用不同的起始位置，請將資料分割識別碼的對應傳遞至位置。

startPosition?: EventPosition | {[partitionId: string]: EventPosition}

屬性值

EventPosition | {[partitionId: string]: EventPosition}

tracingOptions

設定追蹤的選項。

tracingOptions?: OperationTracingOptions

屬性值

OperationTracingOptions

trackLastEnqueuedEventProperties

指出取用者是否應該在其相關聯的分割區上要求最後排入佇列事件的資訊，並在收到事件時追蹤該資訊。

當追蹤資料分割的最後一個排入佇列事件的相關資訊時，從事件中樞服務收到的每個事件都會包含其否則不會之資料分割的相關中繼資料。 這會導致少量額外的網路頻寬耗用量，在考慮使用事件中樞用戶端定期提出分割區屬性的要求時，通常會是一個偏好的取捨。

trackLastEnqueuedEventProperties?: boolean

屬性值

boolean