/
RequestPolicyOptions.yml
58 lines (57 loc) · 2.11 KB
/
RequestPolicyOptions.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
### YamlMime:TSType
name: RequestPolicyOptions
uid: '@azure/storage-file-share.RequestPolicyOptions'
package: '@azure/storage-file-share'
summary: Optional properties that can be used when creating a RequestPolicy.
fullName: RequestPolicyOptions
remarks: ''
isDeprecated: false
type: class
constructors:
- name: RequestPolicyOptions(HttpPipelineLogger)
uid: '@azure/storage-file-share.RequestPolicyOptions.constructor'
package: '@azure/storage-file-share'
summary: ''
remarks: ''
isDeprecated: false
syntax:
content: 'new RequestPolicyOptions(_logger?: HttpPipelineLogger)'
parameters:
- id: _logger
type: <xref uid="@azure/core-http.HttpPipelineLogger" />
description: ''
methods:
- name: log(HttpPipelineLogLevel, string)
uid: '@azure/storage-file-share.RequestPolicyOptions.log'
package: '@azure/storage-file-share'
summary: >-
Attempt to log the provided message to the provided logger. If no logger
was provided or if
the log level does not meet the logger's threshold, then nothing will be
logged.
remarks: ''
isDeprecated: false
syntax:
content: 'function log(logLevel: HttpPipelineLogLevel, message: string)'
parameters:
- id: logLevel
type: <xref uid="@azure/core-http.HttpPipelineLogLevel" />
description: The log level of this log.
- id: message
type: string
description: The message of this log.
- name: shouldLog(HttpPipelineLogLevel)
uid: '@azure/storage-file-share.RequestPolicyOptions.shouldLog'
package: '@azure/storage-file-share'
summary: Get whether or not a log with the provided log level should be logged.
remarks: ''
isDeprecated: false
syntax:
content: 'function shouldLog(logLevel: HttpPipelineLogLevel): boolean'
parameters:
- id: logLevel
type: <xref uid="@azure/core-http.HttpPipelineLogLevel" />
description: The log level of the log that will be logged.
return:
description: Whether or not a log with the provided log level should be logged.
type: boolean