QueueReceiveMessageOptions interface

  • 참조
패키지:
@azure/storage-queue

receiveMessages 작업을 구성하는 옵션

Extends

MessagesDequeueOptionalParams,CommonOptions

상속된 속성

abortSignal

중단 컨트롤러의 신호입니다. 네트워크 요청을 보내고 응답을 기다리는 것을 모두 중단하는 데 사용할 수 있습니다.
customHeaders

는 요청이 전송되기 전에 적용됩니다.
numberOfMessages

(선택 사항) 최대 32까지 큐에서 검색할 메시지 수를 지정하는 0이 아닌 정수 값입니다. 표시 가능한 수가 더 적으면 해당 표시 가능한 메시지가 반환됩니다. 기본적으로 이 작업으로는 메시지에서 단일 메시지가 검색됩니다.
onDownloadProgress

다운로드 진행 시 발생하는 콜백입니다.
onUploadProgress

업로드 진행 시 발생하는 콜백입니다.
requestId

저장소 분석 로깅을 사용하도록 설정되어 있으면 분석 로그에 기록되는 1KB 문자 제한의 클라이언트에서 생성한 불투명 값을 제공합니다.
serializerOptions

XML 구문 분석/빌드 동작을 재정의하는 옵션입니다.
shouldDeserialize

HttpOperationResponse를 역직렬화해야 하는지 여부입니다. 정의되지 않은 경우 HttpOperationResponse를 역직렬화해야 합니다.
timeout

요청이 자동으로 종료되기 전에 걸릴 수 있는 시간(밀리초)입니다. 요청이 종료되면 이 AbortError throw됩니다.
timeoutInSeconds

시간 제한 매개 변수는 초 단위로 표시됩니다. 자세한 내용은 큐 서비스 작업에 대한 시간 제한 설정을 참조하세요.
tracingContext

추적: 범위를 만들 때 사용되는 컨텍스트입니다.
tracingOptions

추적을 사용할 때 생성되는 범위를 구성하는 옵션입니다.
visibilityTimeout

(선택 사항) 서버 시간을 기준으로 새로운 표시 제한 시간 값(초)을 지정합니다. 기본값은 30초입니다. 지정된 값은 1초보다 크거나 같아야 하며 버전 2011-08-18 이전의 REST 프로토콜 버전에서 7일보다 크거나 2시간보다 클 수 없습니다. 메시지의 표시 제한 시간은 만료 시간보다 큰 값으로 설정할 수 있습니다.

상속된 속성 세부 정보

abortSignal

중단 컨트롤러의 신호입니다. 네트워크 요청을 보내고 응답을 기다리는 것을 모두 중단하는 데 사용할 수 있습니다.

abortSignal?: AbortSignalLike

속성 값

AbortSignalLike

MessagesDequeueOptionalParams.abortSignal에서 상속됨

customHeaders

는 요청이 전송되기 전에 적용됩니다.

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

속성 값

{[key: string]: string}

MessagesDequeueOptionalParams.customHeaders에서 상속됨

numberOfMessages

(선택 사항) 최대 32까지 큐에서 검색할 메시지 수를 지정하는 0이 아닌 정수 값입니다. 표시 가능한 수가 더 적으면 해당 표시 가능한 메시지가 반환됩니다. 기본적으로 이 작업으로는 메시지에서 단일 메시지가 검색됩니다.

numberOfMessages?: number

속성 값

number

MessagesDequeueOptionalParams.numberOfMessages에서 상속됨

onDownloadProgress

다운로드 진행 시 발생하는 콜백입니다.

onDownloadProgress?: (progress: TransferProgressEvent) => void

속성 값

(progress: TransferProgressEvent) => void

MessagesDequeueOptionalParams.onDownloadProgress에서 상속됨

onUploadProgress

업로드 진행 시 발생하는 콜백입니다.

onUploadProgress?: (progress: TransferProgressEvent) => void

속성 값

(progress: TransferProgressEvent) => void

MessagesDequeueOptionalParams.onUploadProgress에서 상속됨

requestId

저장소 분석 로깅을 사용하도록 설정되어 있으면 분석 로그에 기록되는 1KB 문자 제한의 클라이언트에서 생성한 불투명 값을 제공합니다.

requestId?: string

속성 값

string

MessagesDequeueOptionalParams.requestId에서 상속됨

serializerOptions

XML 구문 분석/빌드 동작을 재정의하는 옵션입니다.

serializerOptions?: SerializerOptions

속성 값

SerializerOptions

MessagesDequeueOptionalParams.serializerOptions에서 상속됨

shouldDeserialize

HttpOperationResponse를 역직렬화해야 하는지 여부입니다. 정의되지 않은 경우 HttpOperationResponse를 역직렬화해야 합니다.

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

속성 값

boolean | (response: HttpOperationResponse) => boolean

MessagesDequeueOptionalParams.shouldDeserialize에서 상속됨

timeout

요청이 자동으로 종료되기 전에 걸릴 수 있는 시간(밀리초)입니다. 요청이 종료되면 이 AbortError throw됩니다.

timeout?: number

속성 값

number

MessagesDequeueOptionalParams.timeout에서 상속됨

timeoutInSeconds

시간 제한 매개 변수는 초 단위로 표시됩니다. 자세한 내용은 큐 서비스 작업에 대한 시간 제한 설정을 참조하세요.

timeoutInSeconds?: number

속성 값

number

MessagesDequeueOptionalParams.timeoutInSeconds에서 상속됨

tracingContext

추적: 범위를 만들 때 사용되는 컨텍스트입니다.

tracingContext?: Context

속성 값

@azure/core-tracing.Context

MessagesDequeueOptionalParams.tracingContext에서 상속됨

tracingOptions

추적을 사용할 때 생성되는 범위를 구성하는 옵션입니다.

tracingOptions?: OperationTracingOptions

속성 값

OperationTracingOptions

CommonOptions.tracingOptions에서 상속됨

visibilityTimeout

(선택 사항) 서버 시간을 기준으로 새로운 표시 제한 시간 값(초)을 지정합니다. 기본값은 30초입니다. 지정된 값은 1초보다 크거나 같아야 하며 버전 2011-08-18 이전의 REST 프로토콜 버전에서 7일보다 크거나 2시간보다 클 수 없습니다. 메시지의 표시 제한 시간은 만료 시간보다 큰 값으로 설정할 수 있습니다.

visibilityTimeout?: number

속성 값

number

MessagesDequeueOptionalParams.visibilityTimeout에서 상속됨