-
Notifications
You must be signed in to change notification settings - Fork 250
/
com.azure.core.http.policy.HttpLogDetailLevel.yml
118 lines (118 loc) · 8.78 KB
/
com.azure.core.http.policy.HttpLogDetailLevel.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
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
### YamlMime:JavaEnum
uid: "com.azure.core.http.policy.HttpLogDetailLevel"
fullName: "com.azure.core.http.policy.HttpLogDetailLevel"
name: "HttpLogDetailLevel"
nameWithType: "HttpLogDetailLevel"
summary: "The `HttpLogDetailLevel` class is an enumeration of the levels of detail to log on HTTP messages."
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 **HttpLogDetailLevel**</br> extends <a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html\">Enum</a><<xref href=\"com.azure.core.http.policy.HttpLogDetailLevel?alt=com.azure.core.http.policy.HttpLogDetailLevel&text=HttpLogDetailLevel\" data-throw-if-not-resolved=\"False\" />>"
fields:
- uid: "com.azure.core.http.policy.HttpLogDetailLevel.BASIC"
fullName: "com.azure.core.http.policy.HttpLogDetailLevel.BASIC"
name: "BASIC"
nameWithType: "HttpLogDetailLevel.BASIC"
summary: "Logs only URLs, HTTP methods, and time to finish the request."
desc: "Logs only URLs, HTTP methods, and time to finish the request."
- uid: "com.azure.core.http.policy.HttpLogDetailLevel.BODY"
fullName: "com.azure.core.http.policy.HttpLogDetailLevel.BODY"
name: "BODY"
nameWithType: "HttpLogDetailLevel.BODY"
summary: "Logs everything in BASIC, plus all the request and response body."
desc: "Logs everything in BASIC, plus all the request and response body. Note that only payloads in plain text or plain text encoded in GZIP will be logged. The response body will be buffered into memory even if it is never consumed by an application, possibly impacting performance."
- uid: "com.azure.core.http.policy.HttpLogDetailLevel.BODY_AND_HEADERS"
fullName: "com.azure.core.http.policy.HttpLogDetailLevel.BODY_AND_HEADERS"
name: "BODY_AND_HEADERS"
nameWithType: "HttpLogDetailLevel.BODY_AND_HEADERS"
summary: "Logs everything in HEADERS and BODY."
desc: "Logs everything in HEADERS and BODY. Values of the headers will be logged only for allowed headers. See <xref uid=\"com.azure.core.http.policy.HttpLogOptions.getAllowedHeaderNames()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpLogOptions#getAllowedHeaderNames()\"></xref>. The response body will be buffered into memory even if it is never consumed by an application, possibly impacting performance."
- uid: "com.azure.core.http.policy.HttpLogDetailLevel.HEADERS"
fullName: "com.azure.core.http.policy.HttpLogDetailLevel.HEADERS"
name: "HEADERS"
nameWithType: "HttpLogDetailLevel.HEADERS"
summary: "Logs everything in BASIC, plus all the request and response headers."
desc: "Logs everything in BASIC, plus all the request and response headers. Values of the headers will be logged only for allowed headers. See <xref uid=\"com.azure.core.http.policy.HttpLogOptions.getAllowedHeaderNames()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpLogOptions#getAllowedHeaderNames()\"></xref>."
- uid: "com.azure.core.http.policy.HttpLogDetailLevel.NONE"
fullName: "com.azure.core.http.policy.HttpLogDetailLevel.NONE"
name: "NONE"
nameWithType: "HttpLogDetailLevel.NONE"
summary: "Logging is turned off."
desc: "Logging is turned off."
methods:
- uid: "com.azure.core.http.policy.HttpLogDetailLevel.shouldLogBody()"
fullName: "com.azure.core.http.policy.HttpLogDetailLevel.shouldLogBody()"
name: "shouldLogBody()"
nameWithType: "HttpLogDetailLevel.shouldLogBody()"
summary: "Whether a body should be logged."
syntax: "public boolean shouldLogBody()"
desc: "Whether a body should be logged."
returns:
description: "Whether a body should be logged."
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.core.http.policy.HttpLogDetailLevel.shouldLogHeaders()"
fullName: "com.azure.core.http.policy.HttpLogDetailLevel.shouldLogHeaders()"
name: "shouldLogHeaders()"
nameWithType: "HttpLogDetailLevel.shouldLogHeaders()"
summary: "Whether headers should be logged."
syntax: "public boolean shouldLogHeaders()"
desc: "Whether headers should be logged."
returns:
description: "Whether headers should be logged."
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.core.http.policy.HttpLogDetailLevel.shouldLogUrl()"
fullName: "com.azure.core.http.policy.HttpLogDetailLevel.shouldLogUrl()"
name: "shouldLogUrl()"
nameWithType: "HttpLogDetailLevel.shouldLogUrl()"
summary: "Whether a URL should be logged."
syntax: "public boolean shouldLogUrl()"
desc: "Whether a URL should be logged."
returns:
description: "Whether a URL should be logged."
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.core.http.policy.HttpLogDetailLevel.valueOf(java.lang.String)"
fullName: "com.azure.core.http.policy.HttpLogDetailLevel.valueOf(String name)"
name: "valueOf(String name)"
nameWithType: "HttpLogDetailLevel.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 HttpLogDetailLevel valueOf(String name)"
returns:
type: "<xref href=\"com.azure.core.http.policy.HttpLogDetailLevel?alt=com.azure.core.http.policy.HttpLogDetailLevel&text=HttpLogDetailLevel\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.core.http.policy.HttpLogDetailLevel.values()"
fullName: "com.azure.core.http.policy.HttpLogDetailLevel.values()"
name: "values()"
nameWithType: "HttpLogDetailLevel.values()"
modifiers:
- "static"
syntax: "public static HttpLogDetailLevel[] values()"
returns:
type: "<xref href=\"com.azure.core.http.policy.HttpLogDetailLevel?alt=com.azure.core.http.policy.HttpLogDetailLevel&text=HttpLogDetailLevel\" data-throw-if-not-resolved=\"False\" />[]"
desc: "The `HttpLogDetailLevel` class is an enumeration of the levels of detail to log on HTTP messages.\n\nThis class is useful when you need to control the amount of information that is logged during the execution of HTTP requests. It provides several levels of detail, ranging from no logging at all to logging of headers and body content.\n\n**Code sample:**\n\nIn this example, an `HttpLogOptions` is created and the log level is set to `HttpLogDetailLevel.BODY_AND_HEADERS`. This means that the URL, HTTP method, headers, and body content of each request and response will be logged. The `HttpLogOptions` is then used to create an `HttpLoggingPolicy`, which can then be added to the pipeline.\n\n```java\nHttpLogOptions logOptions = new HttpLogOptions();\n logOptions.setLogLevel(HttpLogDetailLevel.BODY_AND_HEADERS);\n HttpLoggingPolicy loggingPolicy = new HttpLoggingPolicy(logOptions);\n```"
metadata: {}
package: "com.azure.core.http.policy"
artifact: com.azure:azure-core:1.50.0