EventHubBufferedProducerClient class

패키지:

@azure/event-hubs

는 EventHubBufferedProducerClient특정 이벤트 허브에 이벤트를 게시하는 데 사용됩니다.

는 EventHubBufferedProducerClient 이벤트를 즉시 게시하지 않습니다. 대신, 이벤트가 버퍼링되므로 일괄 처리가 가득 차거나 maxWaitTimeInMs 새 이벤트가 큐에 없는 상태로 경과된 경우 효율적으로 일괄 처리 및 게시할 수 있습니다.

이벤트가 큐에 추가될 때 지정된 옵션에 따라 파티션에 자동으로 할당되거나, 지정된 파티션 키에 따라 그룹화되거나, 특별히 요청된 파티션이 할당될 수 있습니다.

이 모델은 이벤트가 게시될 시기에 대해 비결정적 타이밍의 비용으로 호출자에서 일괄 처리 관리의 부담을 전환하기 위한 것입니다. 고려해야 할 추가 절차 사항도 있습니다.

• 애플리케이션이 충돌하면 버퍼의 이벤트가 게시되지 않습니다. 데이터 손실을 방지하기 위해 호출자는 및 onSendEventsErrorHandler 처리기를 사용하여 onSendEventsSuccessHandler 게시 진행률을 추적하는 것이 좋습니다.
• 파티션 키를 지정하는 이벤트는 다른 생산자와 동일한 키를 사용하는 이벤트와 다른 파티션을 할당할 수 있습니다.
• 파티션을 일시적으로 사용할 수 없게 되는 드문 경우 는 EventHubBufferedProducerClient 다른 생산자보다 복구하는 데 더 오래 걸릴 수 있습니다.

결정적 결과를 사용하여 이벤트를 즉시 게시하는 것이 중요한 시나리오에서는 파티션 키가 다른 게시자와 일치하는 파티션에 할당되었는지 또는 가용성 극대화가 요구 사항인 경우 를 사용하는 EventHubProducerClient 것이 좋습니다.

생성자

EventHubBufferedProducerClient(string, EventHubBufferedProducerClientOptions)	클래스는 EventHubBufferedProducerClient 이벤트 허브에 이벤트를 보내는 데 사용됩니다. parmeter를 options 사용하여 재시도 정책 또는 프록시 설정을 구성합니다.
EventHubBufferedProducerClient(string, string, EventHubBufferedProducerClientOptions)	클래스는 EventHubBufferedProducerClient 이벤트 허브에 이벤트를 보내는 데 사용됩니다. parmeter를 options 사용하여 재시도 정책 또는 프록시 설정을 구성합니다.
EventHubBufferedProducerClient(string, string, TokenCredential | NamedKeyCredential | SASCredential, EventHubBufferedProducerClientOptions)	클래스는 EventHubBufferedProducerClient 이벤트 허브에 이벤트를 보내는 데 사용됩니다. parmeter를 options 사용하여 재시도 정책 또는 프록시 설정을 구성합니다.

속성

eventHubName	이 클라이언트가 만들어지는 이벤트 허브 instance 이름입니다.
fullyQualifiedNamespace	이 클라이언트가 만들어지는 Event Hub instance 정규화된 네임스페이스입니다. 이는 .servicebus.windows.net 유사할 수 있습니다.
identifier	이 EventHubBufferedProducerClient를 식별하는 데 사용되는 이름입니다. 지정하지 않았거나 비어 있으면 임의의 고유 항목이 생성됩니다.

메서드

close(BufferedCloseOptions)	이벤트 허브 instance 대한 AMQP 연결을 닫고 연결 끊김이 완료되면 해결될 프라미스를 반환합니다. 이렇게 하면 연결을 닫기 전에 큐에 추가된 이벤트가 서비스로 플러시될 때까지 기다립니다. 플러시하지 않고 닫려면 옵션을 false로 flush 설정합니다.
enqueueEvent(EventData | AmqpAnnotatedMessage, EnqueueEventOptions)	이벤트 허브에 게시할 버퍼에 이벤트를 큐에 넣습니다. 이 메서드를 호출할 때 버퍼에 용량이 없으면 공간을 사용할 수 있을 때까지 기다렸다가 이벤트가 큐에 추가되었는지 확인합니다. 이 호출이 반환되면 이벤트가 버퍼에 수락되었지만 아직 게시되지 않았을 수 있습니다. 버퍼가 처리될 때 게시는 나중에 비결정적 지점에서 수행됩니다.
enqueueEvents(EventData[] | AmqpAnnotatedMessage[], EnqueueEventOptions)	이벤트 허브에 게시할 버퍼에 이벤트를 큐에 넣습니다. 이 메서드를 호출할 때 버퍼에 용량이 없으면 공간을 사용할 수 있을 때까지 기다렸다가 이벤트가 큐에 추가되었는지 확인합니다. 이 호출이 반환되면 이벤트가 버퍼에 수락되었지만 아직 게시되지 않았을 수 있습니다. 버퍼가 처리될 때 게시는 나중에 비결정적 지점에서 수행됩니다.
flush(BufferedFlushOptions)	버퍼의 모든 이벤트를 즉시 게시하려고 시도합니다. 이로 인해 여러 일괄 처리가 게시될 수 있으며, 각 일괄 처리기의 결과는 및 onSendEventsErrorHandler 처리기에 의해 onSendEventsSuccessHandler 개별적으로 보고됩니다.
getEventHubProperties(GetEventHubPropertiesOptions)	이벤트 허브 런타임 정보를 제공합니다.
getPartitionIds(GetPartitionIdsOptions)	이벤트 허브와 연결된 각 파티션에 대한 ID를 제공합니다.
getPartitionProperties(string, GetPartitionPropertiesOptions)	지정된 파티션의 상태에 대한 정보를 제공합니다.

생성자 세부 정보

EventHubBufferedProducerClient(string, EventHubBufferedProducerClientOptions)

클래스는 EventHubBufferedProducerClient 이벤트 허브에 이벤트를 보내는 데 사용됩니다. parmeter를 options 사용하여 재시도 정책 또는 프록시 설정을 구성합니다.

new EventHubBufferedProducerClient(connectionString: string, options: EventHubBufferedProducerClientOptions)

매개 변수

connectionString

string

Event Hub instance 연결하는 데 사용할 연결 문자열입니다. 공유 키 속성과 이벤트 허브 경로가 이 연결 문자열에 포함되어야 합니다. 예: 'Endpoint=sb://my-servicebus-namespace.servicebus.windows.net/;SharedAccessKeyName=my-SA-name; SharedAccessKey=my-SA-key; EntityPath=my-event-hub-name'.

options

EventHubBufferedProducerClientOptions

클라이언트를 구성할 때 적용할 옵션 집합입니다.

• retryOptions : 클라이언트의 모든 작업에 대한 재시도 정책을 구성합니다. 예를 들어 { "maxRetries": 4 } 또는 { "maxRetries": 4, "retryDelayInMs": 30000 }입니다.
• webSocketOptions: 웹 소켓을 통해 AMQP 연결의 채널링을 구성합니다.
• userAgent : 서비스에 전달되는 기본 제공 사용자 에이전트 문자열에 추가할 문자열입니다.

EventHubBufferedProducerClient(string, string, EventHubBufferedProducerClientOptions)

클래스는 EventHubBufferedProducerClient 이벤트 허브에 이벤트를 보내는 데 사용됩니다. parmeter를 options 사용하여 재시도 정책 또는 프록시 설정을 구성합니다.

new EventHubBufferedProducerClient(connectionString: string, eventHubName: string, options: EventHubBufferedProducerClientOptions)

매개 변수

connectionString

string

Event Hubs 네임스페이스에 연결하는 데 사용할 연결 문자열입니다. 공유 키 속성은 이 연결 문자열에 포함되지만 이벤트 허브 경로에는 포함되지 않을 것으로 예상됩니다(예: 'Endpoint=sb://my-servicebus-namespace.servicebus.windows.net/;SharedAccessKeyName=my-SA-name; SharedAccessKey=my-SA-key;'.

eventHubName

string

클라이언트를 연결할 특정 이벤트 허브의 이름입니다.

options

EventHubBufferedProducerClientOptions

클라이언트를 구성할 때 적용할 옵션 집합입니다.

• retryOptions : 클라이언트의 모든 작업에 대한 재시도 정책을 구성합니다. 예를 들어 { "maxRetries": 4 } 또는 { "maxRetries": 4, "retryDelayInMs": 30000 }입니다.
• webSocketOptions: 웹 소켓을 통해 AMQP 연결의 채널링을 구성합니다.
• userAgent : 서비스에 전달되는 기본 제공 사용자 에이전트 문자열에 추가할 문자열입니다.

EventHubBufferedProducerClient(string, string, TokenCredential | NamedKeyCredential | SASCredential, EventHubBufferedProducerClientOptions)

클래스는 EventHubBufferedProducerClient 이벤트 허브에 이벤트를 보내는 데 사용됩니다. parmeter를 options 사용하여 재시도 정책 또는 프록시 설정을 구성합니다.

new EventHubBufferedProducerClient(fullyQualifiedNamespace: string, eventHubName: string, credential: TokenCredential | NamedKeyCredential | SASCredential, options: EventHubBufferedProducerClientOptions)

매개 변수

fullyQualifiedNamespace

string

.servicebus.windows.net 유사할 수 있는 전체 네임스페이스입니다.

eventHubName

string

클라이언트를 연결할 특정 이벤트 허브의 이름입니다.

credential

TokenCredential | NamedKeyCredential | SASCredential

클라이언트가 토큰을 가져와 Azure Event Hubs 서비스와의 연결을 인증하는 데 사용하는 자격 증명 개체입니다. AAD 인증을 지원하는 자격 증명을 만들려면 @azure/ID를 참조하세요. 연결 문자열을 AzureNamedKeyCredential 사용하지 않고 를 전달 SharedAccessKeyNameSharedAccessKey 하려는 경우 @azure/core-auth에서 를 사용합니다. 이러한 필드는 의 및 key 필드에 각각 매핑 name 됩니다AzureNamedKeyCredential. 연결 문자열을 AzureSASCredential 사용하지 않고 를 전달 SharedAccessSignature 하려는 경우 @azure/core-auth에서 를 사용합니다. 이 필드는 의 에 signature 매핑됩니다 AzureSASCredential.

options

EventHubBufferedProducerClientOptions

클라이언트를 구성할 때 적용할 옵션 집합입니다.

• retryOptions : 클라이언트의 모든 작업에 대한 재시도 정책을 구성합니다. 예를 들어 { "maxRetries": 4 } 또는 { "maxRetries": 4, "retryDelayInMs": 30000 }입니다.
• webSocketOptions: 웹 소켓을 통해 AMQP 연결의 채널링을 구성합니다.
• userAgent : 서비스에 전달되는 기본 제공 사용자 에이전트 문자열에 추가할 문자열입니다.

속성 세부 정보

eventHubName

이 클라이언트가 만들어지는 이벤트 허브 instance 이름입니다.

string eventHubName

속성 값

string

fullyQualifiedNamespace

이 클라이언트가 만들어지는 Event Hub instance 정규화된 네임스페이스입니다. 이는 .servicebus.windows.net 유사할 수 있습니다.

string fullyQualifiedNamespace

속성 값

string

identifier

이 EventHubBufferedProducerClient를 식별하는 데 사용되는 이름입니다. 지정하지 않았거나 비어 있으면 임의의 고유 항목이 생성됩니다.

identifier: string

속성 값

string

메서드 세부 정보

close(BufferedCloseOptions)

이벤트 허브 instance 대한 AMQP 연결을 닫고 연결 끊김이 완료되면 해결될 프라미스를 반환합니다.

이렇게 하면 연결을 닫기 전에 큐에 추가된 이벤트가 서비스로 플러시될 때까지 기다립니다. 플러시하지 않고 닫려면 옵션을 false로 flush 설정합니다.

function close(options?: BufferedCloseOptions): Promise<void>

매개 변수

options

BufferedCloseOptions

작업 호출에 적용할 옵션 집합입니다.

반환

Promise<void>

Promise

enqueueEvent(EventData | AmqpAnnotatedMessage, EnqueueEventOptions)

이벤트 허브에 게시할 버퍼에 이벤트를 큐에 넣습니다. 이 메서드를 호출할 때 버퍼에 용량이 없으면 공간을 사용할 수 있을 때까지 기다렸다가 이벤트가 큐에 추가되었는지 확인합니다.

이 호출이 반환되면 이벤트가 버퍼에 수락되었지만 아직 게시되지 않았을 수 있습니다. 버퍼가 처리될 때 게시는 나중에 비결정적 지점에서 수행됩니다.

function enqueueEvent(event: EventData | AmqpAnnotatedMessage, options?: EnqueueEventOptions): Promise<number>

매개 변수

event

EventData | AmqpAnnotatedMessage

options

EnqueueEventOptions

이벤트가 연결된 이벤트 허브로 전송되는 방식에 영향을 주도록 지정할 수 있는 옵션 집합입니다.

• abortSignal : enqueueEvent 작업을 취소하는 데 사용되는 신호입니다.
• partitionId : 이 이벤트 집합이 전송될 파티션입니다. 설정된 경우 를 partitionKey 설정할 수 없습니다.
• partitionKey : 파티션 할당을 생성하기 위해 해시되는 값입니다. 설정된 경우 를 partitionId 설정할 수 없습니다.

반환

Promise<number>

모든 파티션에서 현재 버퍼링되고 게시되기를 기다리는 총 이벤트 수입니다.

enqueueEvents(EventData[] | AmqpAnnotatedMessage[], EnqueueEventOptions)

이벤트 허브에 게시할 버퍼에 이벤트를 큐에 넣습니다. 이 메서드를 호출할 때 버퍼에 용량이 없으면 공간을 사용할 수 있을 때까지 기다렸다가 이벤트가 큐에 추가되었는지 확인합니다.

이 호출이 반환되면 이벤트가 버퍼에 수락되었지만 아직 게시되지 않았을 수 있습니다. 버퍼가 처리될 때 게시는 나중에 비결정적 지점에서 수행됩니다.

function enqueueEvents(events: EventData[] | AmqpAnnotatedMessage[], options?: EnqueueEventOptions): Promise<number>

매개 변수

events

EventData[] | AmqpAnnotatedMessage[]

EventData 또는 AmqpAnnotatedMessage의 배열입니다.

options

EnqueueEventOptions

이벤트가 연결된 이벤트 허브로 전송되는 방식에 영향을 주도록 지정할 수 있는 옵션 집합입니다.

• abortSignal : enqueueEvents 작업을 취소하는 데 사용되는 신호입니다.
• partitionId : 이 이벤트 집합이 전송될 파티션입니다. 설정된 경우 를 partitionKey 설정할 수 없습니다.
• partitionKey : 파티션 할당을 생성하기 위해 해시되는 값입니다. 설정된 경우 를 partitionId 설정할 수 없습니다.

반환

Promise<number>

모든 파티션에서 현재 버퍼링되고 게시되기를 기다리는 총 이벤트 수입니다.

flush(BufferedFlushOptions)

버퍼의 모든 이벤트를 즉시 게시하려고 시도합니다. 이로 인해 여러 일괄 처리가 게시될 수 있으며, 각 일괄 처리기의 결과는 및 onSendEventsErrorHandler 처리기에 의해 onSendEventsSuccessHandler 개별적으로 보고됩니다.

function flush(options?: BufferedFlushOptions): Promise<void>

매개 변수

options

BufferedFlushOptions

작업 호출에 적용할 옵션 집합입니다.

반환

Promise<void>

getEventHubProperties(GetEventHubPropertiesOptions)

이벤트 허브 런타임 정보를 제공합니다.

function getEventHubProperties(options?: GetEventHubPropertiesOptions): Promise<EventHubProperties>

매개 변수

options

GetEventHubPropertiesOptions

작업 호출에 적용할 옵션 집합입니다.

반환

Promise<EventHubProperties>

Event Hub instance 대한 정보로 해결되는 약속입니다.

getPartitionIds(GetPartitionIdsOptions)

이벤트 허브와 연결된 각 파티션에 대한 ID를 제공합니다.

function getPartitionIds(options?: GetPartitionIdsOptions): Promise<string[]>

매개 변수

options

GetPartitionIdsOptions

작업 호출에 적용할 옵션 집합입니다.

반환

Promise<string[]>

이벤트 허브와 연결된 각 파티션의 ID를 나타내는 문자열 배열로 확인되는 프라미스입니다.

getPartitionProperties(string, GetPartitionPropertiesOptions)

지정된 파티션의 상태에 대한 정보를 제공합니다.

function getPartitionProperties(partitionId: string, options?: GetPartitionPropertiesOptions): Promise<PartitionProperties>

매개 변수

partitionId

string

정보가 필요한 파티션의 ID입니다.

options

GetPartitionPropertiesOptions

작업 호출에 적용할 옵션 집합입니다.

반환

Promise<PartitionProperties>

파티션의 상태에 대한 정보로 확인되는 프라미스입니다.