PeekMessagesOptions interface
Describes the options passed to the peekMessages method on a receiver.
- Extends
Properties
| from |
The sequence number to start peeking messages from (inclusive). |
| omit |
(Experimental for diagnostic purpose) Specifies whether to omit the body when peeking messages. Default value |
Inherited Properties
| abort |
The signal which can be used to abort requests. |
| tracing |
Options used when tracing is enabled. |
Property Details
fromSequenceNumber
The sequence number to start peeking messages from (inclusive).
fromSequenceNumber?: LongProperty Value
Long
omitMessageBody
(Experimental for diagnostic purpose) Specifies whether to omit the body when peeking messages. Default value false.
omitMessageBody?: booleanProperty Value
boolean
Inherited Property Details
abortSignal
The signal which can be used to abort requests.
abortSignal?: AbortSignalLikeProperty Value
Inherited From OperationOptionsBase.abortSignal
tracingOptions
Options used when tracing is enabled.
tracingOptions?: OperationTracingOptionsProperty Value
Inherited From OperationOptionsBase.tracingOptions