-
Notifications
You must be signed in to change notification settings - Fork 232
/
azure.core.pipeline.policies.SansIOHTTPPolicy.yml
65 lines (55 loc) · 2.28 KB
/
azure.core.pipeline.policies.SansIOHTTPPolicy.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
### YamlMime:PythonClass
uid: azure.core.pipeline.policies.SansIOHTTPPolicy
name: SansIOHTTPPolicy
fullName: azure.core.pipeline.policies.SansIOHTTPPolicy
module: azure.core.pipeline.policies
inheritances:
- typing.Generic
summary: 'Represents a sans I/O policy.
SansIOHTTPPolicy is a base class for policies that only modify or
mutate a request based on the HTTP specification, and do not depend
on the specifics of any particular transport. SansIOHTTPPolicy
subclasses will function in either a Pipeline or an AsyncPipeline,
and can act either before the request is done, or after.
You can optionally make these methods coroutines (or return awaitable objects)
but they will then be tied to AsyncPipeline usage.'
constructor:
syntax: SansIOHTTPPolicy()
methods:
- uid: azure.core.pipeline.policies.SansIOHTTPPolicy.on_exception
name: on_exception
summary: 'Is executed if an exception is raised while executing the next policy.
This method is executed inside the exception handler.'
signature: 'on_exception(request: PipelineRequest[HTTPRequestType]) -> None'
parameters:
- name: request
description: The Pipeline request object
isRequired: true
types:
- <xref:azure.core.pipeline.PipelineRequest>
- uid: azure.core.pipeline.policies.SansIOHTTPPolicy.on_request
name: on_request
summary: Is executed before sending the request from next policy.
signature: 'on_request(request: PipelineRequest[HTTPRequestType]) -> None | Awaitable[None]'
parameters:
- name: request
description: Request to be modified before sent from next policy.
isRequired: true
types:
- <xref:azure.core.pipeline.PipelineRequest>
- uid: azure.core.pipeline.policies.SansIOHTTPPolicy.on_response
name: on_response
summary: Is executed after the request comes back from the policy.
signature: 'on_response(request: PipelineRequest[HTTPRequestType], response: PipelineResponse[HTTPRequestType,
HTTPResponseType]) -> None | Awaitable[None]'
parameters:
- name: request
description: Request to be modified after returning from the policy.
isRequired: true
types:
- <xref:azure.core.pipeline.PipelineRequest>
- name: response
description: Pipeline response object
isRequired: true
types:
- <xref:azure.core.pipeline.PipelineResponse>