Share via

ReceiveEventsOptions interface

  • Reference
Package:
@azure/eventgrid-namespaces

Receive Events Options

Extends
ReceiveEventsOptionalParams

Inherited Properties

abortSignal

The signal which can be used to abort requests.
maxEvents

Max Events count to be received. Minimum value is 1, while maximum value is 100 events. If not specified, the default value is 1.
maxWaitTime

Max wait time value for receive operation in Seconds. It is the time in seconds that the server approximately waits for the availability of an event and responds to the request. If an event is available, the broker responds immediately to the client. Minimum value is 10 seconds, while maximum value is 120 seconds. If not specified, the default value is 60 seconds.
onResponse

A function to be called each time a response is received from the server while performing the requested operation. May be called multiple times.
requestOptions

Options used when creating and sending HTTP requests for this operation.
tracingOptions

Options used when tracing is enabled.

Inherited Property Details

abortSignal

The signal which can be used to abort requests.

abortSignal?: AbortSignalLike

Property Value

AbortSignalLike

Inherited From ReceiveEventsOptionalParams.abortSignal

maxEvents

Max Events count to be received. Minimum value is 1, while maximum value is 100 events. If not specified, the default value is 1.

maxEvents?: number

Property Value

number

Inherited From ReceiveEventsOptionalParams.maxEvents

maxWaitTime

Max wait time value for receive operation in Seconds. It is the time in seconds that the server approximately waits for the availability of an event and responds to the request. If an event is available, the broker responds immediately to the client. Minimum value is 10 seconds, while maximum value is 120 seconds. If not specified, the default value is 60 seconds.

maxWaitTime?: number

Property Value

number

Inherited From ReceiveEventsOptionalParams.maxWaitTime

onResponse

A function to be called each time a response is received from the server while performing the requested operation. May be called multiple times.

onResponse?: RawResponseCallback

Property Value

RawResponseCallback

Inherited From ReceiveEventsOptionalParams.onResponse

requestOptions

Options used when creating and sending HTTP requests for this operation.

requestOptions?: OperationRequestOptions

Property Value

OperationRequestOptions

Inherited From ReceiveEventsOptionalParams.requestOptions

tracingOptions

Options used when tracing is enabled.

tracingOptions?: OperationTracingOptions

Property Value

OperationTracingOptions

Inherited From ReceiveEventsOptionalParams.tracingOptions