@azure/core-lro package

클래스

LroEngine	폴링을 수행하는 클래스인 LRO 엔진입니다.
Poller	완료 상태에 도달할 때까지 연속 요청을 통해 폴링하는 프로그램의 정의를 나타내는 클래스입니다. 폴러는 작업이 완료될 때까지 메서드를 반복적으로 호출 poll() 하여 요청을 폴링하여 수동으로 실행할 수 있습니다. 또한 를 호출 pollUntilDone() 하고 작업이 완료될 때까지 대기하여 작업이 완료될 때까지 기다리는 방법을 제공합니다. 폴러가 기본 장기 실행 작업을 제공하는 진행 중인 프로세스의 취소를 요청할 수도 있습니다. const poller = new MyPoller(); // Polling just once: await poller.poll(); // We can try to cancel the request here, by calling: // // await poller.cancelOperation(); // // Getting the final result: const result = await poller.pollUntilDone(); Poller는 의 기본 속성 PollOperationState<TResult>집합을 포함해야 하는 폴러의 상태를 나타내는 형식과 로 정의된 반환 형식인 두 가지 형식으로 TResult정의됩니다. Poller 클래스는 폴러 구현에서 Poller의 클래스를 직접 내보내지 않고 PollerLike 형식으로 이미 인스턴스화된 폴러만 내보낼 수 있도록 하는 인터페이스를 구현 PollerLike 합니다. class Client { public async makePoller: PollerLike<MyOperationState, MyResult> { const poller = new MyPoller({}); // It might be preferred to return the poller after the first request is made, // so that some information can be obtained right away. await poller.poll(); return poller; } } const poller: PollerLike<MyOperationState, MyResult> = myClient.makePoller(); 폴러는 생성자를 통해 만들 수 있으며 완료될 때까지 폴링할 수 있습니다. 언제든지 getOperationState 메서드를 통해 폴러의 상태를 지연 없이 가져올 수 있습니다. 언제든지 결과 형식의 중간 형식을 지연 없이 요청할 수 있습니다. 기본 작업이 완료된 것으로 표시되면 폴러가 중지되고 최종 값이 반환됩니다. const poller = myClient.makePoller(); const state: MyOperationState = poller.getOperationState(); // The intermediate result can be obtained at any time. const result: MyResult | undefined = poller.getResult(); // The final result can only be obtained after the poller finishes. const result: MyResult = await poller.pollUntilDone();
PollerCancelledError	작업이 취소되면 PollerCancelledError 인스턴스로 폴러가 거부됩니다.
PollerStoppedError	폴러가 메서드를 통해 stopPolling 수동으로 중지되면 PollerStoppedError 인스턴스와 함께 폴러가 거부됩니다.

인터페이스

CreateHttpPollerOptions	에 대한 옵션입니다 createPoller.
LongRunningOperation	장기 실행 작업에 대한 설명입니다.
LroEngineOptions	LRO 폴러에 대한 옵션입니다.
LroResponse	LRO 응답의 형식입니다.
OperationState	폴러는 트리거를 시작하고 장기 실행 작업을 기다리는 로컬 제어 메커니즘으로 작동하지만 OperationState는 원격 장기 실행 작업의 상태를 문서화합니다. 각 설문 조사 후에 업데이트됩니다.
PollOperation	PollOperation은 원격 장기 실행 작업의 상태에 대한 로컬 참조를 업데이트하는 방법과 동일한 작업의 취소를 요청하는 방법을 정의하는 인터페이스입니다. 또한 언제든지 저장하고 다시 시작할 수 있도록 작업을 serialize하는 메서드가 있습니다.
PollOperationState	PollOperationState에는 장기 실행 작업 폴러를 정의하는 데 필요한 가장 작은 속성 집합의 의견 목록이 포함되어 있습니다. Poller 클래스는 트리거를 시작하고, 대기하고, 잠재적으로 장기 실행 작업을 취소하는 로컬 제어 메커니즘으로 작동하지만, PollOperationState는 원격 장기 실행 작업의 상태를 문서화합니다. 작업이 시작될 때, 완료된 경우 및 취소될 때 적어도 업데이트해야 합니다. 그러나 구현에는 다른 이유로 업데이트할 수 있는 다른 수의 속성이 있을 수 있습니다.
PollerLike	사용자가 작업해야 하는 최소 API만 노출하기 위한 폴러의 추상 표현입니다.
RawResponse	원시 응답의 간단한 형식입니다.
SimplePollerLike	간단한 폴러 인터페이스입니다.

형식 별칭

CancelOnProgress	CancelOnProgress는 Poller의 onProgress 메서드의 반환 값으로 사용됩니다. 사용자가 onProgress를 호출할 때 폴링 작업이 업데이트될 때마다 수신된 새 데이터를 사용하여 콜백으로 호출되는 함수를 전달해야 합니다. onProgress는 추가 업데이트가 원래 콜백에 도달하지 못하게 하는 함수를 반환합니다.
LroResourceLocationConfig	swagger에서 LRO 확장으로 지정된 경우 LRO 결과의 잠재적 위치입니다.
OperationStatus	작업이 지정된 시간에 있을 수 있는 가능한 상태 집합입니다.
PollProgressCallback	PollProgressCallback은 onProgress로 전송되는 콜백 함수의 형식입니다. 이러한 함수는 Poller 클래스의 구현에 의해 정의된 TState를 받습니다.

함수

createHttpPoller<TResult, TState>(LongRunningOperation<unknown>, CreateHttpPollerOptions<TResult, TState>)

장기 실행 작업을 폴링하는 데 사용할 수 있는 폴러를 만듭니다.

함수 세부 정보

createHttpPoller<TResult, TState>(LongRunningOperation<unknown>, CreateHttpPollerOptions<TResult, TState>)

장기 실행 작업을 폴링하는 데 사용할 수 있는 폴러를 만듭니다.

function createHttpPoller<TResult, TState>(lro: LongRunningOperation<unknown>, options?: CreateHttpPollerOptions<TResult, TState>): Promise<SimplePollerLike<TState, TResult>>

매개 변수

lro

LongRunningOperation<unknown>

장기 실행 작업에 대한 설명

options

CreateHttpPollerOptions<TResult, TState>

폴러를 구성하는 옵션

반환

Promise<SimplePollerLike<TState, TResult>>

초기화된 폴러