QueueReceiveMessageOptions interface

Paquete:

@azure/storage-queue

Opciones para configurar la operación receiveMessages

Extends

MessagesDequeueOptionalParams,CommonOptions

Propiedades heredadas

abortSignal	Señal de un controlador de anulación. Se puede usar para anular el envío de una solicitud de red y esperar una respuesta.
customHeaders	se aplicará antes de enviar la solicitud.
numberOfMessages	Opcional. Valor entero distinto de cero que especifica el número de mensajes que se deben recuperar de la cola, hasta un máximo de 32. Si hay un número menor de mensajes visibles, se devuelven los mensajes visibles. De forma predeterminada, con esta operación se recupera un solo mensaje de la cola.
onDownloadProgress	Devolución de llamada que se desencadena tras el progreso de la descarga.
onUploadProgress	Devolución de llamada que se desencadena tras el progreso de la carga.
requestId	Proporciona un valor opaco generado por el cliente con un límite de caracteres de 1 KB registrado en los registros de análisis cuando está habilitado registro del análisis de almacenamiento.
serializerOptions	Opciones para invalidar el comportamiento de compilación y análisis de XML.
shouldDeserialize	Si se debe deserializar o no HttpOperationResponse. Si esto no está definido, se debe deserializar HttpOperationResponse.
timeout	El número de milisegundos que puede tomar una solicitud antes de finalizarse automáticamente. Si se finaliza la solicitud, se produce una AbortError excepción .
timeoutInSeconds	El parámetro Tiempo de espera se expresa en segundos. Para obtener más información, consulte Establecer tiempos de espera para operaciones de Queue Service.
tracingContext	Seguimiento: contexto usado al crear intervalos.
tracingOptions	Opciones para configurar intervalos creados al habilitar el seguimiento.
visibilityTimeout	Opcional. Especifica el nuevo valor del tiempo de espera de visibilidad, en segundos, relativo a la hora del servidor. El valor predeterminado es 30 segundos. Un valor especificado debe ser mayor o igual que 1 segundo y no puede ser mayor que 7 días o superior a 2 horas en las versiones del protocolo REST anteriores a la versión 2011-08-18. El tiempo de espera de visibilidad de un mensaje puede establecerse en un valor posterior a la hora de expiración.

Detalles de las propiedades heredadas

abortSignal

Señal de un controlador de anulación. Se puede usar para anular el envío de una solicitud de red y esperar una respuesta.

abortSignal?: AbortSignalLike

Valor de propiedad

AbortSignalLike

Heredado deMessagesDequeueOptionalParams.abortSignal

customHeaders

se aplicará antes de enviar la solicitud.

customHeaders?: {[key: string]: string}

Valor de propiedad

{[key: string]: string}

Heredado deMessagesDequeueOptionalParams.customHeaders

numberOfMessages

Opcional. Valor entero distinto de cero que especifica el número de mensajes que se deben recuperar de la cola, hasta un máximo de 32. Si hay un número menor de mensajes visibles, se devuelven los mensajes visibles. De forma predeterminada, con esta operación se recupera un solo mensaje de la cola.

numberOfMessages?: number

Valor de propiedad

number

Heredado deMessagesDequeueOptionalParams.numberOfMessages

onDownloadProgress

Devolución de llamada que se desencadena tras el progreso de la descarga.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Valor de propiedad

(progress: TransferProgressEvent) => void

Heredado deMessagesDequeueOptionalParams.onDownloadProgress

onUploadProgress

Devolución de llamada que se desencadena tras el progreso de la carga.

onUploadProgress?: (progress: TransferProgressEvent) => void

Valor de propiedad

(progress: TransferProgressEvent) => void

Heredado deMessagesDequeueOptionalParams.onUploadProgress

requestId

Proporciona un valor opaco generado por el cliente con un límite de caracteres de 1 KB registrado en los registros de análisis cuando está habilitado registro del análisis de almacenamiento.

requestId?: string

Valor de propiedad

string

Heredado deMessagesDequeueOptionalParams.requestId

serializerOptions

Opciones para invalidar el comportamiento de compilación y análisis de XML.

serializerOptions?: SerializerOptions

Valor de propiedad

SerializerOptions

Heredado deMessagesDequeueOptionalParams.serializerOptions

shouldDeserialize

Si se debe deserializar o no HttpOperationResponse. Si esto no está definido, se debe deserializar HttpOperationResponse.

shouldDeserialize?: boolean | (response: HttpOperationResponse) => boolean

Valor de propiedad

boolean | (response: HttpOperationResponse) => boolean

Heredado deMessagesDequeueOptionalParams.shouldDeserialize

timeout

El número de milisegundos que puede tomar una solicitud antes de finalizarse automáticamente. Si se finaliza la solicitud, se produce una AbortError excepción .

timeout?: number

Valor de propiedad

number

Se hereda deMessagesDequeueOptionalParams.timeout

timeoutInSeconds

El parámetro Tiempo de espera se expresa en segundos. Para obtener más información, consulte Establecer tiempos de espera para operaciones de Queue Service.

timeoutInSeconds?: number

Valor de propiedad

number

Heredado deMessagesDequeueOptionalParams.timeoutInSeconds

tracingContext

Seguimiento: contexto usado al crear intervalos.

tracingContext?: Context

Valor de propiedad

@azure/core-tracing.Context

Heredado deMessagesDequeueOptionalParams.tracingContext

tracingOptions

Opciones para configurar intervalos creados al habilitar el seguimiento.

tracingOptions?: OperationTracingOptions

Valor de propiedad

OperationTracingOptions

Se hereda deCommonOptions.tracingOptions

visibilityTimeout

Opcional. Especifica el nuevo valor del tiempo de espera de visibilidad, en segundos, relativo a la hora del servidor. El valor predeterminado es 30 segundos. Un valor especificado debe ser mayor o igual que 1 segundo y no puede ser mayor que 7 días o superior a 2 horas en las versiones del protocolo REST anteriores a la versión 2011-08-18. El tiempo de espera de visibilidad de un mensaje puede establecerse en un valor posterior a la hora de expiración.

visibilityTimeout?: number

Valor de propiedad

number

Heredado deMessagesDequeueOptionalParams.visibilityTimeout