-
Notifications
You must be signed in to change notification settings - Fork 223
/
com.azure.core.http.HttpPipelinePosition.yml
70 lines (70 loc) · 6.78 KB
/
com.azure.core.http.HttpPipelinePosition.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
66
67
68
69
70
### YamlMime:JavaEnum
uid: "com.azure.core.http.HttpPipelinePosition"
fullName: "com.azure.core.http.HttpPipelinePosition"
name: "HttpPipelinePosition"
nameWithType: "HttpPipelinePosition"
summary: "Enum representing the position in an <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> to place an <xref uid=\"com.azure.core.http.policy.HttpPipelinePolicy\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipelinePolicy\"></xref>."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Enum?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html\">Enum</a>"
methodsRef:
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#valueOf-java.lang.Class-java.lang.String-\">valueOf</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#clone--\">clone</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#compareTo-E-\">compareTo</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#equals-java.lang.Object-\">equals</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#finalize--\">finalize</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#getDeclaringClass--\">getDeclaringClass</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#hashCode--\">hashCode</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#name--\">name</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#ordinal--\">ordinal</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#toString--\">toString</a>"
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
methodsRef:
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public enum **HttpPipelinePosition**</br> extends <a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html\">Enum</a><<xref href=\"com.azure.core.http.HttpPipelinePosition?alt=com.azure.core.http.HttpPipelinePosition&text=HttpPipelinePosition\" data-throw-if-not-resolved=\"False\" />>"
fields:
- uid: "com.azure.core.http.HttpPipelinePosition.PER_CALL"
fullName: "com.azure.core.http.HttpPipelinePosition.PER_CALL"
name: "PER_CALL"
nameWithType: "HttpPipelinePosition.PER_CALL"
summary: "Policy is placed before a <xref uid=\"com.azure.core.http.policy.RetryPolicy\" data-throw-if-not-resolved=\"false\" data-raw-source=\"RetryPolicy\"></xref> and will only be invoked once per pipeline invocation (service call)."
desc: "Policy is placed before a <xref uid=\"com.azure.core.http.policy.RetryPolicy\" data-throw-if-not-resolved=\"false\" data-raw-source=\"RetryPolicy\"></xref> and will only be invoked once per pipeline invocation (service call)."
- uid: "com.azure.core.http.HttpPipelinePosition.PER_RETRY"
fullName: "com.azure.core.http.HttpPipelinePosition.PER_RETRY"
name: "PER_RETRY"
nameWithType: "HttpPipelinePosition.PER_RETRY"
summary: "Policy is placed after a <xref uid=\"com.azure.core.http.policy.RetryPolicy\" data-throw-if-not-resolved=\"false\" data-raw-source=\"RetryPolicy\"></xref> and will be invoked every time a request is sent."
desc: "Policy is placed after a <xref uid=\"com.azure.core.http.policy.RetryPolicy\" data-throw-if-not-resolved=\"false\" data-raw-source=\"RetryPolicy\"></xref> and will be invoked every time a request is sent.\n\nThe policy will be invoked at least once for the initial service call and each time the request is retried."
methods:
- uid: "com.azure.core.http.HttpPipelinePosition.valueOf(java.lang.String)"
fullName: "com.azure.core.http.HttpPipelinePosition.valueOf(String name)"
name: "valueOf(String name)"
nameWithType: "HttpPipelinePosition.valueOf(String name)"
modifiers:
- "static"
parameters:
- name: "name"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public static HttpPipelinePosition valueOf(String name)"
returns:
type: "<xref href=\"com.azure.core.http.HttpPipelinePosition?alt=com.azure.core.http.HttpPipelinePosition&text=HttpPipelinePosition\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.core.http.HttpPipelinePosition.values()"
fullName: "com.azure.core.http.HttpPipelinePosition.values()"
name: "values()"
nameWithType: "HttpPipelinePosition.values()"
modifiers:
- "static"
syntax: "public static HttpPipelinePosition[] values()"
returns:
type: "<xref href=\"com.azure.core.http.HttpPipelinePosition?alt=com.azure.core.http.HttpPipelinePosition&text=HttpPipelinePosition\" data-throw-if-not-resolved=\"False\" />[]"
desc: "Enum representing the position in an <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> to place an <xref uid=\"com.azure.core.http.policy.HttpPipelinePolicy\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipelinePolicy\"></xref>.\n\nThis enum encapsulates the positions where an HTTP pipeline policy can be placed in the HTTP pipeline. The positions are before or after a <xref uid=\"com.azure.core.http.policy.RetryPolicy\" data-throw-if-not-resolved=\"false\" data-raw-source=\"RetryPolicy\"></xref>.\n\nEach position is represented by an enum constant. For example, you can use <xref uid=\"com.azure.core.http.HttpPipelinePosition.PER_CALL\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#PER_CALL\"></xref> to represent the position before a RetryPolicy, and <xref uid=\"com.azure.core.http.HttpPipelinePosition.PER_RETRY\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#PER_RETRY\"></xref> to represent the position after a RetryPolicy.\n\nThe PER\\_CALL position means that the policy will only be invoked once per pipeline invocation (service call), and the PER\\_RETRY position means that the policy will be invoked every time a request is sent (including retries)."
metadata: {}
package: "com.azure.core.http"
artifact: com.azure:azure-core:1.49.1