Pipeline interface
URL に対して HTTPS 要求を行うためのパイプラインを表します。 パイプラインには、サーバーに対して行われる前と後の各要求の操作を管理するための複数のポリシーを含めることができます。
メソッド
| add |
パイプラインに新しいポリシーを追加します。 |
| clone() | このパイプラインを複製して、既存のパイプラインを変更せずに変更できるようにします。 |
| get |
要求に適用される順序で、パイプライン内の現在のポリシー セットを返します。 一覧の後半では、要求がいつ実行されているかに近い状態になります。 |
| remove |
パイプラインからポリシーを削除します。 |
| send |
パイプラインを使用して HTTPS 要求を行います。 |
メソッドの詳細
addPolicy(PipelinePolicy, AddPipelineOptions)
パイプラインに新しいポリシーを追加します。
function addPolicy(policy: PipelinePolicy, options?: AddPipelineOptions)パラメーター
- policy
- PipelinePolicy
要求を操作するポリシー。
- options
- AddPipelineOptions
ポリシーを実行する必要がある場合の一連のオプション。
clone()
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>
