EventDataBatch interface

패키지:

@azure/event-hubs

이벤트 허브에 이벤트를 보내는 데 사용할 수 있는 이벤트 일괄 처리를 나타내는 인터페이스입니다.

일괄 처리를 만들려면 createBatch()EventHubProducerClient 메서드를 사용합니다. 일괄 처리를 보내려면 동일한 클라이언트에서 sendBatch() 메서드를 사용합니다. 일괄 처리를 채우려면 일괄 처리 자체에서 tryAdd() 메서드를 사용합니다.

속성

count	일괄 처리에 추가된 이벤트 수입니다.
maxSizeInBytes	일괄 처리의 최대 크기(바이트)입니다. 일괄 처리의 tryAdd 함수는 추가되는 이벤트로 인해 일괄 처리의 크기가 이 제한을 초과하는 경우 false 반환합니다. createBatch() EventHubProducerClient 메서드를 사용하여 maxSizeInBytes를 설정합니다.
sizeInBytes	추가된 이벤트가 단일 AMQP 메시지로 인코딩된 후 일괄 처리의 크기(바이트)입니다.

메서드

tryAdd(EventData | AmqpAnnotatedMessage, TryAddOptions)

일괄 처리의 크기 제한에서 허용되는 경우 일괄 처리에 이벤트를 추가합니다. 참고: 다음 이벤트에 대해 다시 호출하기 전에 항상 이 메서드의 반환 값을 확인해야 합니다.

속성 세부 정보

count

일괄 처리에 추가된 이벤트 수입니다.

count: number

속성 값

number

maxSizeInBytes

일괄 처리의 최대 크기(바이트)입니다. 일괄 처리의 tryAdd 함수는 추가되는 이벤트로 인해 일괄 처리의 크기가 이 제한을 초과하는 경우 false 반환합니다. createBatch() EventHubProducerClient 메서드를 사용하여 maxSizeInBytes를 설정합니다.

maxSizeInBytes: number

속성 값

number

sizeInBytes

추가된 이벤트가 단일 AMQP 메시지로 인코딩된 후 일괄 처리의 크기(바이트)입니다.

sizeInBytes: number

속성 값

number

메서드 세부 정보

tryAdd(EventData | AmqpAnnotatedMessage, TryAddOptions)

일괄 처리의 크기 제한에서 허용되는 경우 일괄 처리에 이벤트를 추가합니다. 참고: 다음 이벤트에 대해 다시 호출하기 전에 항상 이 메서드의 반환 값을 확인해야 합니다.

function tryAdd(eventData: EventData | AmqpAnnotatedMessage, options?: TryAddOptions): boolean

매개 변수

eventData

EventData | AmqpAnnotatedMessage

개별 이벤트 데이터 개체 또는 AmqpAnnotatedMessage입니다.

options

TryAddOptions

반환

boolean

이벤트 데이터가 일괄 처리에 추가되었는지 여부를 나타내는 부울 값입니다.