Pipeline interface
Представляет собой конвейер для выполнения HTTPS-запроса к URL-адресу. Конвейеры могут иметь несколько политик для управления обработкой каждого запроса до и после его выполнения на сервере.
Методы
| add |
Добавьте новую политику в конвейер. |
| clone() | Дублирует этот конвейер, чтобы разрешить изменение существующего, не изменяя его. |
| get |
Возвращает текущий набор политик в конвейере в том порядке, в котором они будут применены к запросу. Позже в списке ближе к выполнению запроса. |
| remove |
Удалите политику из конвейера. |
| send |
Использует конвейер для выполнения запроса HTTPS. |
Сведения о методе
addPolicy(PipelinePolicy, AddPipelineOptions)
Добавьте новую политику в конвейер.
function addPolicy(policy: PipelinePolicy, options?: AddPipelineOptions)Параметры
- policy
- PipelinePolicy
Политика, которая управляет запросом.
- options
- AddPipelineOptions
Набор параметров для выполнения политики.
clone()
Дублирует этот конвейер, чтобы разрешить изменение существующего, не изменяя его.
function clone(): PipelineВозвращаемое значение
getOrderedPolicies()
Возвращает текущий набор политик в конвейере в том порядке, в котором они будут применены к запросу. Позже в списке ближе к выполнению запроса.
function getOrderedPolicies(): PipelinePolicy[]Возвращаемое значение
removePolicy({ name?: string, phase?: PipelinePhase })
Удалите политику из конвейера.
function removePolicy(options: { name?: string, phase?: PipelinePhase }): PipelinePolicy[]Параметры
- options
-
{ name?: string, phase?: PipelinePhase }
Параметры, позволяющие указать, какие политики следует удалить.
Возвращаемое значение
sendRequest(HttpsClient, PipelineRequest)
Использует конвейер для выполнения запроса HTTPS.
function sendRequest(httpsClient: HttpsClient, request: PipelineRequest): Promise<PipelineResponse>Параметры
- httpsClient
- HttpsClient
HttpsClient, который фактически выполняет запрос.
- request
- PipelineRequest
Запрос, который нужно сделать.
Возвращаемое значение
Promise<PipelineResponse>
