Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface QueuePeekMessagesOptions

Package version

Options to configure QueueClient.peekMessages operation

Hierarchy

  • MessagesPeekOptionalParams
  • CommonOptions
    • QueuePeekMessagesOptions

Index

Properties

Properties

Optional numberOfMessages

numberOfMessages: undefined | number

Optional. A nonzero integer value that specifies the number of messages to retrieve from the queue, up to a maximum of 32. If fewer are visible, the visible messages are returned. By default, a single message is retrieved from the queue with this operation.

Optional requestId

requestId: undefined | string

Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled.

Optional timeoutInSeconds

timeoutInSeconds: undefined | number

The The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Queue Service Operations.

Optional tracingOptions

tracingOptions: OperationTracingOptions

Options to configure spans created when tracing is enabled.

Generated using TypeDoc