oci-waas 2.4.0 → 2.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE.txt +6 -0
- package/lib/client.d.ts +490 -72
- package/lib/client.js +728 -144
- package/lib/client.js.map +1 -1
- package/lib/request/accept-recommendations-request.d.ts +1 -1
- package/lib/request/cancel-work-request-request.d.ts +1 -1
- package/lib/request/change-address-list-compartment-request.d.ts +1 -1
- package/lib/request/change-certificate-compartment-request.d.ts +1 -1
- package/lib/request/change-custom-protection-rule-compartment-request.d.ts +1 -1
- package/lib/request/change-http-redirect-compartment-request.d.ts +1 -1
- package/lib/request/change-waas-policy-compartment-request.d.ts +1 -1
- package/lib/request/create-address-list-request.d.ts +1 -1
- package/lib/request/create-certificate-request.d.ts +1 -1
- package/lib/request/create-custom-protection-rule-request.d.ts +1 -1
- package/lib/request/create-http-redirect-request.d.ts +1 -1
- package/lib/request/create-waas-policy-request.d.ts +1 -1
- package/lib/request/delete-address-list-request.d.ts +1 -1
- package/lib/request/delete-certificate-request.d.ts +1 -1
- package/lib/request/delete-custom-protection-rule-request.d.ts +1 -1
- package/lib/request/delete-http-redirect-request.d.ts +1 -1
- package/lib/request/delete-waas-policy-request.d.ts +1 -1
- package/lib/request/get-address-list-request.d.ts +1 -1
- package/lib/request/get-certificate-request.d.ts +1 -1
- package/lib/request/get-custom-protection-rule-request.d.ts +1 -1
- package/lib/request/get-device-fingerprint-challenge-request.d.ts +1 -1
- package/lib/request/get-http-redirect-request.d.ts +1 -1
- package/lib/request/get-human-interaction-challenge-request.d.ts +1 -1
- package/lib/request/get-js-challenge-request.d.ts +1 -1
- package/lib/request/get-policy-config-request.d.ts +1 -1
- package/lib/request/get-protection-rule-request.d.ts +1 -1
- package/lib/request/get-protection-settings-request.d.ts +1 -1
- package/lib/request/get-waas-policy-request.d.ts +1 -1
- package/lib/request/get-waf-address-rate-limiting-request.d.ts +1 -1
- package/lib/request/get-waf-config-request.d.ts +1 -1
- package/lib/request/get-work-request-request.d.ts +1 -1
- package/lib/request/list-access-rules-request.d.ts +1 -1
- package/lib/request/list-address-lists-request.d.ts +1 -1
- package/lib/request/list-caching-rules-request.d.ts +1 -1
- package/lib/request/list-captchas-request.d.ts +1 -1
- package/lib/request/list-certificates-request.d.ts +1 -1
- package/lib/request/list-custom-protection-rules-request.d.ts +1 -1
- package/lib/request/list-edge-subnets-request.d.ts +1 -1
- package/lib/request/list-good-bots-request.d.ts +1 -1
- package/lib/request/list-http-redirects-request.d.ts +1 -1
- package/lib/request/list-protection-rules-request.d.ts +1 -1
- package/lib/request/list-recommendations-request.d.ts +1 -1
- package/lib/request/list-threat-feeds-request.d.ts +1 -1
- package/lib/request/list-waas-policies-request.d.ts +1 -1
- package/lib/request/list-waas-policy-custom-protection-rules-request.d.ts +1 -1
- package/lib/request/list-waf-blocked-requests-request.d.ts +1 -1
- package/lib/request/list-waf-logs-request.d.ts +1 -1
- package/lib/request/list-waf-requests-request.d.ts +1 -1
- package/lib/request/list-waf-traffic-request.d.ts +1 -1
- package/lib/request/list-whitelists-request.d.ts +1 -1
- package/lib/request/list-work-requests-request.d.ts +1 -1
- package/lib/request/purge-cache-request.d.ts +1 -1
- package/lib/request/update-access-rules-request.d.ts +1 -1
- package/lib/request/update-address-list-request.d.ts +1 -1
- package/lib/request/update-caching-rules-request.d.ts +1 -1
- package/lib/request/update-captchas-request.d.ts +1 -1
- package/lib/request/update-certificate-request.d.ts +1 -1
- package/lib/request/update-custom-protection-rule-request.d.ts +1 -1
- package/lib/request/update-device-fingerprint-challenge-request.d.ts +1 -1
- package/lib/request/update-good-bots-request.d.ts +1 -1
- package/lib/request/update-http-redirect-request.d.ts +1 -1
- package/lib/request/update-human-interaction-challenge-request.d.ts +1 -1
- package/lib/request/update-js-challenge-request.d.ts +1 -1
- package/lib/request/update-policy-config-request.d.ts +1 -1
- package/lib/request/update-protection-rules-request.d.ts +1 -1
- package/lib/request/update-protection-settings-request.d.ts +1 -1
- package/lib/request/update-threat-feeds-request.d.ts +1 -1
- package/lib/request/update-waas-policy-custom-protection-rules-request.d.ts +1 -1
- package/lib/request/update-waas-policy-request.d.ts +1 -1
- package/lib/request/update-waf-address-rate-limiting-request.d.ts +1 -1
- package/lib/request/update-waf-config-request.d.ts +1 -1
- package/lib/request/update-whitelists-request.d.ts +1 -1
- package/package.json +3 -3
package/lib/client.d.ts
CHANGED
|
@@ -19,6 +19,9 @@ import { WaasWaiter } from "./waas-waiter";
|
|
|
19
19
|
export declare enum RedirectApiKeys {
|
|
20
20
|
ApiKey = 0
|
|
21
21
|
}
|
|
22
|
+
/**
|
|
23
|
+
* This service client does not use circuit breakers by default if the user has not defined a circuit breaker configuration.
|
|
24
|
+
*/
|
|
22
25
|
export declare class RedirectClient {
|
|
23
26
|
protected static serviceEndpointTemplate: string;
|
|
24
27
|
protected "_endpoint": string;
|
|
@@ -68,45 +71,51 @@ export declare class RedirectClient {
|
|
|
68
71
|
getWaiters(): RedirectWaiter;
|
|
69
72
|
/**
|
|
70
73
|
* Moves HTTP Redirect into a different compartment. When provided, If-Match is checked against ETag values of the WAAS policy.
|
|
74
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
71
75
|
* @param ChangeHttpRedirectCompartmentRequest
|
|
72
76
|
* @return ChangeHttpRedirectCompartmentResponse
|
|
73
77
|
* @throws OciError when an error occurs
|
|
74
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
78
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/waas/ChangeHttpRedirectCompartment.ts.html |here} to see how to use ChangeHttpRedirectCompartment API.
|
|
75
79
|
*/
|
|
76
80
|
changeHttpRedirectCompartment(changeHttpRedirectCompartmentRequest: requests.ChangeHttpRedirectCompartmentRequest): Promise<responses.ChangeHttpRedirectCompartmentResponse>;
|
|
77
81
|
/**
|
|
78
82
|
* Creates a new HTTP Redirect on the WAF edge.
|
|
83
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
79
84
|
* @param CreateHttpRedirectRequest
|
|
80
85
|
* @return CreateHttpRedirectResponse
|
|
81
86
|
* @throws OciError when an error occurs
|
|
82
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
87
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/waas/CreateHttpRedirect.ts.html |here} to see how to use CreateHttpRedirect API.
|
|
83
88
|
*/
|
|
84
89
|
createHttpRedirect(createHttpRedirectRequest: requests.CreateHttpRedirectRequest): Promise<responses.CreateHttpRedirectResponse>;
|
|
85
90
|
/**
|
|
86
91
|
* Deletes a redirect.
|
|
92
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
87
93
|
* @param DeleteHttpRedirectRequest
|
|
88
94
|
* @return DeleteHttpRedirectResponse
|
|
89
95
|
* @throws OciError when an error occurs
|
|
90
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
96
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/waas/DeleteHttpRedirect.ts.html |here} to see how to use DeleteHttpRedirect API.
|
|
91
97
|
*/
|
|
92
98
|
deleteHttpRedirect(deleteHttpRedirectRequest: requests.DeleteHttpRedirectRequest): Promise<responses.DeleteHttpRedirectResponse>;
|
|
93
99
|
/**
|
|
94
100
|
* Gets the details of a HTTP Redirect.
|
|
101
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
95
102
|
* @param GetHttpRedirectRequest
|
|
96
103
|
* @return GetHttpRedirectResponse
|
|
97
104
|
* @throws OciError when an error occurs
|
|
98
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
105
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/waas/GetHttpRedirect.ts.html |here} to see how to use GetHttpRedirect API.
|
|
99
106
|
*/
|
|
100
107
|
getHttpRedirect(getHttpRedirectRequest: requests.GetHttpRedirectRequest): Promise<responses.GetHttpRedirectResponse>;
|
|
101
108
|
/**
|
|
102
109
|
* Gets a list of HTTP Redirects.
|
|
110
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
103
111
|
* @param ListHttpRedirectsRequest
|
|
104
112
|
* @return ListHttpRedirectsResponse
|
|
105
113
|
* @throws OciError when an error occurs
|
|
106
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
114
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/waas/ListHttpRedirects.ts.html |here} to see how to use ListHttpRedirects API.
|
|
107
115
|
*/
|
|
108
116
|
listHttpRedirects(listHttpRedirectsRequest: requests.ListHttpRedirectsRequest): Promise<responses.ListHttpRedirectsResponse>;
|
|
109
117
|
/**
|
|
118
|
+
* NOTE: This function is deprecated in favor of listHttpRedirectsRecordIterator function.
|
|
110
119
|
* Creates a new async iterator which will iterate over the models.HttpRedirectSummary objects
|
|
111
120
|
* contained in responses from the listHttpRedirects operation. This iterator will fetch more data from the
|
|
112
121
|
* server as needed.
|
|
@@ -115,24 +124,44 @@ export declare class RedirectClient {
|
|
|
115
124
|
*/
|
|
116
125
|
listAllHttpRedirects(request: requests.ListHttpRedirectsRequest): AsyncIterableIterator<model.HttpRedirectSummary>;
|
|
117
126
|
/**
|
|
127
|
+
* NOTE: This function is deprecated in favor of listHttpRedirectsResponseIterator function.
|
|
118
128
|
* Creates a new async iterator which will iterate over the responses received from the listHttpRedirects operation. This iterator
|
|
119
129
|
* will fetch more data from the server as needed.
|
|
120
130
|
*
|
|
121
131
|
* @param request a request which can be sent to the service operation
|
|
122
132
|
*/
|
|
123
133
|
listAllHttpRedirectsResponses(request: requests.ListHttpRedirectsRequest): AsyncIterableIterator<responses.ListHttpRedirectsResponse>;
|
|
134
|
+
/**
|
|
135
|
+
* Creates a new async iterator which will iterate over the models.HttpRedirectSummary objects
|
|
136
|
+
* contained in responses from the listHttpRedirects operation. This iterator will fetch more data from the
|
|
137
|
+
* server as needed.
|
|
138
|
+
*
|
|
139
|
+
* @param request a request which can be sent to the service operation
|
|
140
|
+
*/
|
|
141
|
+
listHttpRedirectsRecordIterator(request: requests.ListHttpRedirectsRequest): AsyncIterableIterator<model.HttpRedirectSummary>;
|
|
142
|
+
/**
|
|
143
|
+
* Creates a new async iterator which will iterate over the responses received from the listHttpRedirects operation. This iterator
|
|
144
|
+
* will fetch more data from the server as needed.
|
|
145
|
+
*
|
|
146
|
+
* @param request a request which can be sent to the service operation
|
|
147
|
+
*/
|
|
148
|
+
listHttpRedirectsResponseIterator(request: requests.ListHttpRedirectsRequest): AsyncIterableIterator<responses.ListHttpRedirectsResponse>;
|
|
124
149
|
/**
|
|
125
150
|
* Updates the details of a HTTP Redirect, including target and tags. Only the fields specified in the request body will be updated; all other properties will remain unchanged.
|
|
151
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
126
152
|
* @param UpdateHttpRedirectRequest
|
|
127
153
|
* @return UpdateHttpRedirectResponse
|
|
128
154
|
* @throws OciError when an error occurs
|
|
129
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
155
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/waas/UpdateHttpRedirect.ts.html |here} to see how to use UpdateHttpRedirect API.
|
|
130
156
|
*/
|
|
131
157
|
updateHttpRedirect(updateHttpRedirectRequest: requests.UpdateHttpRedirectRequest): Promise<responses.UpdateHttpRedirectResponse>;
|
|
132
158
|
}
|
|
133
159
|
export declare enum WaasApiKeys {
|
|
134
160
|
ApiKey = 0
|
|
135
161
|
}
|
|
162
|
+
/**
|
|
163
|
+
* This service client does not use circuit breakers by default if the user has not defined a circuit breaker configuration.
|
|
164
|
+
*/
|
|
136
165
|
export declare class WaasClient {
|
|
137
166
|
protected static serviceEndpointTemplate: string;
|
|
138
167
|
protected "_endpoint": string;
|
|
@@ -184,18 +213,20 @@ export declare class WaasClient {
|
|
|
184
213
|
* Accepts a list of recommended Web Application Firewall protection rules. Web Application Firewall protection rule recommendations are sets of rules generated by observed traffic patterns through the Web Application Firewall and are meant to optimize the Web Application Firewall's security profile. Only the rules specified in the request body will be updated; all other rules will remain unchanged.
|
|
185
214
|
* <p>
|
|
186
215
|
Use the `GET /waasPolicies/{waasPolicyId}/wafConfig/recommendations` method to view a list of recommended Web Application Firewall protection rules. For more information, see [WAF Protection Rules](https://docs.cloud.oracle.com/iaas/Content/WAF/Tasks/wafprotectionrules.htm).
|
|
216
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
187
217
|
* @param AcceptRecommendationsRequest
|
|
188
218
|
* @return AcceptRecommendationsResponse
|
|
189
219
|
* @throws OciError when an error occurs
|
|
190
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
220
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/waas/AcceptRecommendations.ts.html |here} to see how to use AcceptRecommendations API.
|
|
191
221
|
*/
|
|
192
222
|
acceptRecommendations(acceptRecommendationsRequest: requests.AcceptRecommendationsRequest): Promise<responses.AcceptRecommendationsResponse>;
|
|
193
223
|
/**
|
|
194
224
|
* Cancels a specified work request.
|
|
225
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
195
226
|
* @param CancelWorkRequestRequest
|
|
196
227
|
* @return CancelWorkRequestResponse
|
|
197
228
|
* @throws OciError when an error occurs
|
|
198
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
229
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/waas/CancelWorkRequest.ts.html |here} to see how to use CancelWorkRequest API.
|
|
199
230
|
*/
|
|
200
231
|
cancelWorkRequest(cancelWorkRequestRequest: requests.CancelWorkRequestRequest): Promise<responses.CancelWorkRequestResponse>;
|
|
201
232
|
/**
|
|
@@ -203,66 +234,73 @@ export declare class WaasClient {
|
|
|
203
234
|
* is checked against ETag values of the address list. For information about moving
|
|
204
235
|
* resources between compartments, see [Moving Resources to a Different Compartment](https://docs.cloud.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).
|
|
205
236
|
*
|
|
237
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
206
238
|
* @param ChangeAddressListCompartmentRequest
|
|
207
239
|
* @return ChangeAddressListCompartmentResponse
|
|
208
240
|
* @throws OciError when an error occurs
|
|
209
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
241
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/waas/ChangeAddressListCompartment.ts.html |here} to see how to use ChangeAddressListCompartment API.
|
|
210
242
|
*/
|
|
211
243
|
changeAddressListCompartment(changeAddressListCompartmentRequest: requests.ChangeAddressListCompartmentRequest): Promise<responses.ChangeAddressListCompartmentResponse>;
|
|
212
244
|
/**
|
|
213
245
|
* Moves certificate into a different compartment. When provided, If-Match is checked against ETag values of the certificate.
|
|
214
246
|
* For information about moving resources between compartments, see [Moving Resources to a Different Compartment](https://docs.cloud.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).
|
|
215
247
|
*
|
|
248
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
216
249
|
* @param ChangeCertificateCompartmentRequest
|
|
217
250
|
* @return ChangeCertificateCompartmentResponse
|
|
218
251
|
* @throws OciError when an error occurs
|
|
219
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
252
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/waas/ChangeCertificateCompartment.ts.html |here} to see how to use ChangeCertificateCompartment API.
|
|
220
253
|
*/
|
|
221
254
|
changeCertificateCompartment(changeCertificateCompartmentRequest: requests.ChangeCertificateCompartmentRequest): Promise<responses.ChangeCertificateCompartmentResponse>;
|
|
222
255
|
/**
|
|
223
256
|
* Moves a custom protection rule into a different compartment within the same tenancy. When provided, If-Match is checked against ETag values of the custom protection rule. For information about moving resources between compartments, see [Moving Resources to a Different Compartment](https://docs.cloud.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).
|
|
257
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
224
258
|
* @param ChangeCustomProtectionRuleCompartmentRequest
|
|
225
259
|
* @return ChangeCustomProtectionRuleCompartmentResponse
|
|
226
260
|
* @throws OciError when an error occurs
|
|
227
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
261
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/waas/ChangeCustomProtectionRuleCompartment.ts.html |here} to see how to use ChangeCustomProtectionRuleCompartment API.
|
|
228
262
|
*/
|
|
229
263
|
changeCustomProtectionRuleCompartment(changeCustomProtectionRuleCompartmentRequest: requests.ChangeCustomProtectionRuleCompartmentRequest): Promise<responses.ChangeCustomProtectionRuleCompartmentResponse>;
|
|
230
264
|
/**
|
|
231
265
|
* Moves WAAS policy into a different compartment. When provided, If-Match is checked against ETag values of the WAAS policy.
|
|
232
266
|
* For information about moving resources between compartments, see [Moving Resources to a Different Compartment](https://docs.cloud.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).
|
|
233
267
|
*
|
|
268
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
234
269
|
* @param ChangeWaasPolicyCompartmentRequest
|
|
235
270
|
* @return ChangeWaasPolicyCompartmentResponse
|
|
236
271
|
* @throws OciError when an error occurs
|
|
237
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
272
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/waas/ChangeWaasPolicyCompartment.ts.html |here} to see how to use ChangeWaasPolicyCompartment API.
|
|
238
273
|
*/
|
|
239
274
|
changeWaasPolicyCompartment(changeWaasPolicyCompartmentRequest: requests.ChangeWaasPolicyCompartmentRequest): Promise<responses.ChangeWaasPolicyCompartmentResponse>;
|
|
240
275
|
/**
|
|
241
276
|
* Creates an address list in a set compartment and allows it to be used in a WAAS policy and referenced by access rules. Addresses can be IP addresses and CIDR notations.
|
|
277
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
242
278
|
* @param CreateAddressListRequest
|
|
243
279
|
* @return CreateAddressListResponse
|
|
244
280
|
* @throws OciError when an error occurs
|
|
245
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
281
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/waas/CreateAddressList.ts.html |here} to see how to use CreateAddressList API.
|
|
246
282
|
*/
|
|
247
283
|
createAddressList(createAddressListRequest: requests.CreateAddressListRequest): Promise<responses.CreateAddressListResponse>;
|
|
248
284
|
/**
|
|
249
285
|
* Allows an SSL certificate to be added to a WAAS policy. The Web Application Firewall terminates SSL connections to inspect requests in runtime, and then re-encrypts requests before sending them to the origin for fulfillment.
|
|
250
286
|
* <p>
|
|
251
287
|
For more information, see [WAF Settings](https://docs.cloud.oracle.com/iaas/Content/WAF/Tasks/wafsettings.htm).
|
|
288
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
252
289
|
* @param CreateCertificateRequest
|
|
253
290
|
* @return CreateCertificateResponse
|
|
254
291
|
* @throws OciError when an error occurs
|
|
255
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
292
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/waas/CreateCertificate.ts.html |here} to see how to use CreateCertificate API.
|
|
256
293
|
*/
|
|
257
294
|
createCertificate(createCertificateRequest: requests.CreateCertificateRequest): Promise<responses.CreateCertificateResponse>;
|
|
258
295
|
/**
|
|
259
296
|
* Creates a new custom protection rule in the specified compartment.
|
|
260
297
|
* <p>
|
|
261
298
|
Custom protection rules allow you to create rules in addition to the rulesets provided by the Web Application Firewall service, including rules from [ModSecurity](https://modsecurity.org/). The syntax for custom rules is based on the ModSecurity syntax. For more information about custom protection rules, see [Custom Protection Rules](https://docs.cloud.oracle.com/iaas/Content/WAF/Tasks/customprotectionrules.htm).
|
|
299
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
262
300
|
* @param CreateCustomProtectionRuleRequest
|
|
263
301
|
* @return CreateCustomProtectionRuleResponse
|
|
264
302
|
* @throws OciError when an error occurs
|
|
265
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
303
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/waas/CreateCustomProtectionRule.ts.html |here} to see how to use CreateCustomProtectionRule API.
|
|
266
304
|
*/
|
|
267
305
|
createCustomProtectionRule(createCustomProtectionRuleRequest: requests.CreateCustomProtectionRuleRequest): Promise<responses.CreateCustomProtectionRuleResponse>;
|
|
268
306
|
/**
|
|
@@ -279,158 +317,178 @@ export declare class WaasClient {
|
|
|
279
317
|
All Oracle Cloud Infrastructure resources, including WAAS policies, receive a unique, Oracle-assigned ID called an Oracle Cloud Identifier (OCID). When a resource is created, you can find its OCID in the response. You can also retrieve a resource's OCID by using a list API operation for that resource type, or by viewing the resource in the Console. Fore more information, see [Resource Identifiers](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm).
|
|
280
318
|
* <p>
|
|
281
319
|
**Note:** After sending the POST request, the new object's state will temporarily be `CREATING`. Ensure that the resource's state has changed to `ACTIVE` before use.
|
|
320
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
282
321
|
* @param CreateWaasPolicyRequest
|
|
283
322
|
* @return CreateWaasPolicyResponse
|
|
284
323
|
* @throws OciError when an error occurs
|
|
285
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
324
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/waas/CreateWaasPolicy.ts.html |here} to see how to use CreateWaasPolicy API.
|
|
286
325
|
*/
|
|
287
326
|
createWaasPolicy(createWaasPolicyRequest: requests.CreateWaasPolicyRequest): Promise<responses.CreateWaasPolicyResponse>;
|
|
288
327
|
/**
|
|
289
328
|
* Deletes the address list from the compartment if it is not used.
|
|
329
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
290
330
|
* @param DeleteAddressListRequest
|
|
291
331
|
* @return DeleteAddressListResponse
|
|
292
332
|
* @throws OciError when an error occurs
|
|
293
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
333
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/waas/DeleteAddressList.ts.html |here} to see how to use DeleteAddressList API.
|
|
294
334
|
*/
|
|
295
335
|
deleteAddressList(deleteAddressListRequest: requests.DeleteAddressListRequest): Promise<responses.DeleteAddressListResponse>;
|
|
296
336
|
/**
|
|
297
337
|
* Deletes an SSL certificate from the WAAS service.
|
|
338
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
298
339
|
* @param DeleteCertificateRequest
|
|
299
340
|
* @return DeleteCertificateResponse
|
|
300
341
|
* @throws OciError when an error occurs
|
|
301
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
342
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/waas/DeleteCertificate.ts.html |here} to see how to use DeleteCertificate API.
|
|
302
343
|
*/
|
|
303
344
|
deleteCertificate(deleteCertificateRequest: requests.DeleteCertificateRequest): Promise<responses.DeleteCertificateResponse>;
|
|
304
345
|
/**
|
|
305
346
|
* Deletes a Custom Protection rule.
|
|
347
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
306
348
|
* @param DeleteCustomProtectionRuleRequest
|
|
307
349
|
* @return DeleteCustomProtectionRuleResponse
|
|
308
350
|
* @throws OciError when an error occurs
|
|
309
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
351
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/waas/DeleteCustomProtectionRule.ts.html |here} to see how to use DeleteCustomProtectionRule API.
|
|
310
352
|
*/
|
|
311
353
|
deleteCustomProtectionRule(deleteCustomProtectionRuleRequest: requests.DeleteCustomProtectionRuleRequest): Promise<responses.DeleteCustomProtectionRuleResponse>;
|
|
312
354
|
/**
|
|
313
355
|
* Deletes a policy.
|
|
356
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
314
357
|
* @param DeleteWaasPolicyRequest
|
|
315
358
|
* @return DeleteWaasPolicyResponse
|
|
316
359
|
* @throws OciError when an error occurs
|
|
317
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
360
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/waas/DeleteWaasPolicy.ts.html |here} to see how to use DeleteWaasPolicy API.
|
|
318
361
|
*/
|
|
319
362
|
deleteWaasPolicy(deleteWaasPolicyRequest: requests.DeleteWaasPolicyRequest): Promise<responses.DeleteWaasPolicyResponse>;
|
|
320
363
|
/**
|
|
321
364
|
* Gets the details of an address list.
|
|
365
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
322
366
|
* @param GetAddressListRequest
|
|
323
367
|
* @return GetAddressListResponse
|
|
324
368
|
* @throws OciError when an error occurs
|
|
325
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
369
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/waas/GetAddressList.ts.html |here} to see how to use GetAddressList API.
|
|
326
370
|
*/
|
|
327
371
|
getAddressList(getAddressListRequest: requests.GetAddressListRequest): Promise<responses.GetAddressListResponse>;
|
|
328
372
|
/**
|
|
329
373
|
* Gets the details of an SSL certificate.
|
|
374
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
330
375
|
* @param GetCertificateRequest
|
|
331
376
|
* @return GetCertificateResponse
|
|
332
377
|
* @throws OciError when an error occurs
|
|
333
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
378
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/waas/GetCertificate.ts.html |here} to see how to use GetCertificate API.
|
|
334
379
|
*/
|
|
335
380
|
getCertificate(getCertificateRequest: requests.GetCertificateRequest): Promise<responses.GetCertificateResponse>;
|
|
336
381
|
/**
|
|
337
382
|
* Gets the details of a custom protection rule.
|
|
383
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
338
384
|
* @param GetCustomProtectionRuleRequest
|
|
339
385
|
* @return GetCustomProtectionRuleResponse
|
|
340
386
|
* @throws OciError when an error occurs
|
|
341
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
387
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/waas/GetCustomProtectionRule.ts.html |here} to see how to use GetCustomProtectionRule API.
|
|
342
388
|
*/
|
|
343
389
|
getCustomProtectionRule(getCustomProtectionRuleRequest: requests.GetCustomProtectionRuleRequest): Promise<responses.GetCustomProtectionRuleResponse>;
|
|
344
390
|
/**
|
|
345
391
|
* Gets the device fingerprint challenge settings in the Web Application Firewall configuration for a WAAS policy.
|
|
392
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
346
393
|
* @param GetDeviceFingerprintChallengeRequest
|
|
347
394
|
* @return GetDeviceFingerprintChallengeResponse
|
|
348
395
|
* @throws OciError when an error occurs
|
|
349
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
396
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/waas/GetDeviceFingerprintChallenge.ts.html |here} to see how to use GetDeviceFingerprintChallenge API.
|
|
350
397
|
*/
|
|
351
398
|
getDeviceFingerprintChallenge(getDeviceFingerprintChallengeRequest: requests.GetDeviceFingerprintChallengeRequest): Promise<responses.GetDeviceFingerprintChallengeResponse>;
|
|
352
399
|
/**
|
|
353
400
|
* Gets the human interaction challenge settings in the Web Application Firewall configuration for a WAAS policy.
|
|
401
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
354
402
|
* @param GetHumanInteractionChallengeRequest
|
|
355
403
|
* @return GetHumanInteractionChallengeResponse
|
|
356
404
|
* @throws OciError when an error occurs
|
|
357
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
405
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/waas/GetHumanInteractionChallenge.ts.html |here} to see how to use GetHumanInteractionChallenge API.
|
|
358
406
|
*/
|
|
359
407
|
getHumanInteractionChallenge(getHumanInteractionChallengeRequest: requests.GetHumanInteractionChallengeRequest): Promise<responses.GetHumanInteractionChallengeResponse>;
|
|
360
408
|
/**
|
|
361
409
|
* Gets the JavaScript challenge settings in the Web Application Firewall configuration for a WAAS policy.
|
|
410
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
362
411
|
* @param GetJsChallengeRequest
|
|
363
412
|
* @return GetJsChallengeResponse
|
|
364
413
|
* @throws OciError when an error occurs
|
|
365
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
414
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/waas/GetJsChallenge.ts.html |here} to see how to use GetJsChallenge API.
|
|
366
415
|
*/
|
|
367
416
|
getJsChallenge(getJsChallengeRequest: requests.GetJsChallengeRequest): Promise<responses.GetJsChallengeResponse>;
|
|
368
417
|
/**
|
|
369
418
|
* Gets the configuration of a WAAS policy.
|
|
419
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
370
420
|
* @param GetPolicyConfigRequest
|
|
371
421
|
* @return GetPolicyConfigResponse
|
|
372
422
|
* @throws OciError when an error occurs
|
|
373
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
423
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/waas/GetPolicyConfig.ts.html |here} to see how to use GetPolicyConfig API.
|
|
374
424
|
*/
|
|
375
425
|
getPolicyConfig(getPolicyConfigRequest: requests.GetPolicyConfigRequest): Promise<responses.GetPolicyConfigResponse>;
|
|
376
426
|
/**
|
|
377
427
|
* Gets the details of a protection rule in the Web Application Firewall configuration for a WAAS policy.
|
|
428
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
378
429
|
* @param GetProtectionRuleRequest
|
|
379
430
|
* @return GetProtectionRuleResponse
|
|
380
431
|
* @throws OciError when an error occurs
|
|
381
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
432
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/waas/GetProtectionRule.ts.html |here} to see how to use GetProtectionRule API.
|
|
382
433
|
*/
|
|
383
434
|
getProtectionRule(getProtectionRuleRequest: requests.GetProtectionRuleRequest): Promise<responses.GetProtectionRuleResponse>;
|
|
384
435
|
/**
|
|
385
436
|
* Gets the protection settings in the Web Application Firewall configuration for a WAAS policy.
|
|
437
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
386
438
|
* @param GetProtectionSettingsRequest
|
|
387
439
|
* @return GetProtectionSettingsResponse
|
|
388
440
|
* @throws OciError when an error occurs
|
|
389
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
441
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/waas/GetProtectionSettings.ts.html |here} to see how to use GetProtectionSettings API.
|
|
390
442
|
*/
|
|
391
443
|
getProtectionSettings(getProtectionSettingsRequest: requests.GetProtectionSettingsRequest): Promise<responses.GetProtectionSettingsResponse>;
|
|
392
444
|
/**
|
|
393
445
|
* Gets the details of a WAAS policy.
|
|
446
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
394
447
|
* @param GetWaasPolicyRequest
|
|
395
448
|
* @return GetWaasPolicyResponse
|
|
396
449
|
* @throws OciError when an error occurs
|
|
397
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
450
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/waas/GetWaasPolicy.ts.html |here} to see how to use GetWaasPolicy API.
|
|
398
451
|
*/
|
|
399
452
|
getWaasPolicy(getWaasPolicyRequest: requests.GetWaasPolicyRequest): Promise<responses.GetWaasPolicyResponse>;
|
|
400
453
|
/**
|
|
401
454
|
* Gets the address rate limiting settings of the Web Application Firewall configuration for a WAAS policy.
|
|
455
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
402
456
|
* @param GetWafAddressRateLimitingRequest
|
|
403
457
|
* @return GetWafAddressRateLimitingResponse
|
|
404
458
|
* @throws OciError when an error occurs
|
|
405
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
459
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/waas/GetWafAddressRateLimiting.ts.html |here} to see how to use GetWafAddressRateLimiting API.
|
|
406
460
|
*/
|
|
407
461
|
getWafAddressRateLimiting(getWafAddressRateLimitingRequest: requests.GetWafAddressRateLimitingRequest): Promise<responses.GetWafAddressRateLimitingResponse>;
|
|
408
462
|
/**
|
|
409
463
|
* Gets the Web Application Firewall configuration details for a WAAS policy.
|
|
464
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
410
465
|
* @param GetWafConfigRequest
|
|
411
466
|
* @return GetWafConfigResponse
|
|
412
467
|
* @throws OciError when an error occurs
|
|
413
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
468
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/waas/GetWafConfig.ts.html |here} to see how to use GetWafConfig API.
|
|
414
469
|
*/
|
|
415
470
|
getWafConfig(getWafConfigRequest: requests.GetWafConfigRequest): Promise<responses.GetWafConfigResponse>;
|
|
416
471
|
/**
|
|
417
472
|
* Gets the details of a specified work request.
|
|
473
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
418
474
|
* @param GetWorkRequestRequest
|
|
419
475
|
* @return GetWorkRequestResponse
|
|
420
476
|
* @throws OciError when an error occurs
|
|
421
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
477
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/waas/GetWorkRequest.ts.html |here} to see how to use GetWorkRequest API.
|
|
422
478
|
*/
|
|
423
479
|
getWorkRequest(getWorkRequestRequest: requests.GetWorkRequestRequest): Promise<responses.GetWorkRequestResponse>;
|
|
424
480
|
/**
|
|
425
481
|
* Gets the currently configured access rules for the Web Application Firewall configuration of a specified WAAS policy.
|
|
426
482
|
* The order of the access rules is important. The rules will be checked in the order they are specified and the first matching rule will be used.
|
|
483
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
427
484
|
* @param ListAccessRulesRequest
|
|
428
485
|
* @return ListAccessRulesResponse
|
|
429
486
|
* @throws OciError when an error occurs
|
|
430
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
487
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/waas/ListAccessRules.ts.html |here} to see how to use ListAccessRules API.
|
|
431
488
|
*/
|
|
432
489
|
listAccessRules(listAccessRulesRequest: requests.ListAccessRulesRequest): Promise<responses.ListAccessRulesResponse>;
|
|
433
490
|
/**
|
|
491
|
+
* NOTE: This function is deprecated in favor of listAccessRulesRecordIterator function.
|
|
434
492
|
* Creates a new async iterator which will iterate over the models.AccessRule objects
|
|
435
493
|
* contained in responses from the listAccessRules operation. This iterator will fetch more data from the
|
|
436
494
|
* server as needed.
|
|
@@ -439,21 +497,39 @@ export declare class WaasClient {
|
|
|
439
497
|
*/
|
|
440
498
|
listAllAccessRules(request: requests.ListAccessRulesRequest): AsyncIterableIterator<model.AccessRule>;
|
|
441
499
|
/**
|
|
500
|
+
* NOTE: This function is deprecated in favor of listAccessRulesResponseIterator function.
|
|
442
501
|
* Creates a new async iterator which will iterate over the responses received from the listAccessRules operation. This iterator
|
|
443
502
|
* will fetch more data from the server as needed.
|
|
444
503
|
*
|
|
445
504
|
* @param request a request which can be sent to the service operation
|
|
446
505
|
*/
|
|
447
506
|
listAllAccessRulesResponses(request: requests.ListAccessRulesRequest): AsyncIterableIterator<responses.ListAccessRulesResponse>;
|
|
507
|
+
/**
|
|
508
|
+
* Creates a new async iterator which will iterate over the models.AccessRule objects
|
|
509
|
+
* contained in responses from the listAccessRules operation. This iterator will fetch more data from the
|
|
510
|
+
* server as needed.
|
|
511
|
+
*
|
|
512
|
+
* @param request a request which can be sent to the service operation
|
|
513
|
+
*/
|
|
514
|
+
listAccessRulesRecordIterator(request: requests.ListAccessRulesRequest): AsyncIterableIterator<model.AccessRule>;
|
|
515
|
+
/**
|
|
516
|
+
* Creates a new async iterator which will iterate over the responses received from the listAccessRules operation. This iterator
|
|
517
|
+
* will fetch more data from the server as needed.
|
|
518
|
+
*
|
|
519
|
+
* @param request a request which can be sent to the service operation
|
|
520
|
+
*/
|
|
521
|
+
listAccessRulesResponseIterator(request: requests.ListAccessRulesRequest): AsyncIterableIterator<responses.ListAccessRulesResponse>;
|
|
448
522
|
/**
|
|
449
523
|
* Gets a list of address lists that can be used in a WAAS policy.
|
|
524
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
450
525
|
* @param ListAddressListsRequest
|
|
451
526
|
* @return ListAddressListsResponse
|
|
452
527
|
* @throws OciError when an error occurs
|
|
453
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
528
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/waas/ListAddressLists.ts.html |here} to see how to use ListAddressLists API.
|
|
454
529
|
*/
|
|
455
530
|
listAddressLists(listAddressListsRequest: requests.ListAddressListsRequest): Promise<responses.ListAddressListsResponse>;
|
|
456
531
|
/**
|
|
532
|
+
* NOTE: This function is deprecated in favor of listAddressListsRecordIterator function.
|
|
457
533
|
* Creates a new async iterator which will iterate over the models.AddressListSummary objects
|
|
458
534
|
* contained in responses from the listAddressLists operation. This iterator will fetch more data from the
|
|
459
535
|
* server as needed.
|
|
@@ -462,22 +538,40 @@ export declare class WaasClient {
|
|
|
462
538
|
*/
|
|
463
539
|
listAllAddressLists(request: requests.ListAddressListsRequest): AsyncIterableIterator<model.AddressListSummary>;
|
|
464
540
|
/**
|
|
541
|
+
* NOTE: This function is deprecated in favor of listAddressListsResponseIterator function.
|
|
465
542
|
* Creates a new async iterator which will iterate over the responses received from the listAddressLists operation. This iterator
|
|
466
543
|
* will fetch more data from the server as needed.
|
|
467
544
|
*
|
|
468
545
|
* @param request a request which can be sent to the service operation
|
|
469
546
|
*/
|
|
470
547
|
listAllAddressListsResponses(request: requests.ListAddressListsRequest): AsyncIterableIterator<responses.ListAddressListsResponse>;
|
|
548
|
+
/**
|
|
549
|
+
* Creates a new async iterator which will iterate over the models.AddressListSummary objects
|
|
550
|
+
* contained in responses from the listAddressLists operation. This iterator will fetch more data from the
|
|
551
|
+
* server as needed.
|
|
552
|
+
*
|
|
553
|
+
* @param request a request which can be sent to the service operation
|
|
554
|
+
*/
|
|
555
|
+
listAddressListsRecordIterator(request: requests.ListAddressListsRequest): AsyncIterableIterator<model.AddressListSummary>;
|
|
556
|
+
/**
|
|
557
|
+
* Creates a new async iterator which will iterate over the responses received from the listAddressLists operation. This iterator
|
|
558
|
+
* will fetch more data from the server as needed.
|
|
559
|
+
*
|
|
560
|
+
* @param request a request which can be sent to the service operation
|
|
561
|
+
*/
|
|
562
|
+
listAddressListsResponseIterator(request: requests.ListAddressListsRequest): AsyncIterableIterator<responses.ListAddressListsResponse>;
|
|
471
563
|
/**
|
|
472
564
|
* Gets the currently configured caching rules for the Web Application Firewall configuration of a specified WAAS policy.
|
|
473
565
|
* The rules are processed in the order they are specified in and the first matching rule will be used when processing a request.
|
|
566
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
474
567
|
* @param ListCachingRulesRequest
|
|
475
568
|
* @return ListCachingRulesResponse
|
|
476
569
|
* @throws OciError when an error occurs
|
|
477
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
570
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/waas/ListCachingRules.ts.html |here} to see how to use ListCachingRules API.
|
|
478
571
|
*/
|
|
479
572
|
listCachingRules(listCachingRulesRequest: requests.ListCachingRulesRequest): Promise<responses.ListCachingRulesResponse>;
|
|
480
573
|
/**
|
|
574
|
+
* NOTE: This function is deprecated in favor of listCachingRulesRecordIterator function.
|
|
481
575
|
* Creates a new async iterator which will iterate over the models.CachingRuleSummary objects
|
|
482
576
|
* contained in responses from the listCachingRules operation. This iterator will fetch more data from the
|
|
483
577
|
* server as needed.
|
|
@@ -486,12 +580,28 @@ export declare class WaasClient {
|
|
|
486
580
|
*/
|
|
487
581
|
listAllCachingRules(request: requests.ListCachingRulesRequest): AsyncIterableIterator<model.CachingRuleSummary>;
|
|
488
582
|
/**
|
|
583
|
+
* NOTE: This function is deprecated in favor of listCachingRulesResponseIterator function.
|
|
489
584
|
* Creates a new async iterator which will iterate over the responses received from the listCachingRules operation. This iterator
|
|
490
585
|
* will fetch more data from the server as needed.
|
|
491
586
|
*
|
|
492
587
|
* @param request a request which can be sent to the service operation
|
|
493
588
|
*/
|
|
494
589
|
listAllCachingRulesResponses(request: requests.ListCachingRulesRequest): AsyncIterableIterator<responses.ListCachingRulesResponse>;
|
|
590
|
+
/**
|
|
591
|
+
* Creates a new async iterator which will iterate over the models.CachingRuleSummary objects
|
|
592
|
+
* contained in responses from the listCachingRules operation. This iterator will fetch more data from the
|
|
593
|
+
* server as needed.
|
|
594
|
+
*
|
|
595
|
+
* @param request a request which can be sent to the service operation
|
|
596
|
+
*/
|
|
597
|
+
listCachingRulesRecordIterator(request: requests.ListCachingRulesRequest): AsyncIterableIterator<model.CachingRuleSummary>;
|
|
598
|
+
/**
|
|
599
|
+
* Creates a new async iterator which will iterate over the responses received from the listCachingRules operation. This iterator
|
|
600
|
+
* will fetch more data from the server as needed.
|
|
601
|
+
*
|
|
602
|
+
* @param request a request which can be sent to the service operation
|
|
603
|
+
*/
|
|
604
|
+
listCachingRulesResponseIterator(request: requests.ListCachingRulesRequest): AsyncIterableIterator<responses.ListCachingRulesResponse>;
|
|
495
605
|
/**
|
|
496
606
|
* Gets the list of currently configured CAPTCHA challenges in the Web
|
|
497
607
|
* Application Firewall configuration of a WAAS policy.
|
|
@@ -499,13 +609,15 @@ export declare class WaasClient {
|
|
|
499
609
|
The order of the CAPTCHA challenges is important. The URL for each
|
|
500
610
|
* CAPTCHA will be checked in the order they are created.
|
|
501
611
|
*
|
|
612
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
502
613
|
* @param ListCaptchasRequest
|
|
503
614
|
* @return ListCaptchasResponse
|
|
504
615
|
* @throws OciError when an error occurs
|
|
505
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
616
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/waas/ListCaptchas.ts.html |here} to see how to use ListCaptchas API.
|
|
506
617
|
*/
|
|
507
618
|
listCaptchas(listCaptchasRequest: requests.ListCaptchasRequest): Promise<responses.ListCaptchasResponse>;
|
|
508
619
|
/**
|
|
620
|
+
* NOTE: This function is deprecated in favor of listCaptchasRecordIterator function.
|
|
509
621
|
* Creates a new async iterator which will iterate over the models.Captcha objects
|
|
510
622
|
* contained in responses from the listCaptchas operation. This iterator will fetch more data from the
|
|
511
623
|
* server as needed.
|
|
@@ -514,21 +626,39 @@ export declare class WaasClient {
|
|
|
514
626
|
*/
|
|
515
627
|
listAllCaptchas(request: requests.ListCaptchasRequest): AsyncIterableIterator<model.Captcha>;
|
|
516
628
|
/**
|
|
629
|
+
* NOTE: This function is deprecated in favor of listCaptchasResponseIterator function.
|
|
517
630
|
* Creates a new async iterator which will iterate over the responses received from the listCaptchas operation. This iterator
|
|
518
631
|
* will fetch more data from the server as needed.
|
|
519
632
|
*
|
|
520
633
|
* @param request a request which can be sent to the service operation
|
|
521
634
|
*/
|
|
522
635
|
listAllCaptchasResponses(request: requests.ListCaptchasRequest): AsyncIterableIterator<responses.ListCaptchasResponse>;
|
|
636
|
+
/**
|
|
637
|
+
* Creates a new async iterator which will iterate over the models.Captcha objects
|
|
638
|
+
* contained in responses from the listCaptchas operation. This iterator will fetch more data from the
|
|
639
|
+
* server as needed.
|
|
640
|
+
*
|
|
641
|
+
* @param request a request which can be sent to the service operation
|
|
642
|
+
*/
|
|
643
|
+
listCaptchasRecordIterator(request: requests.ListCaptchasRequest): AsyncIterableIterator<model.Captcha>;
|
|
644
|
+
/**
|
|
645
|
+
* Creates a new async iterator which will iterate over the responses received from the listCaptchas operation. This iterator
|
|
646
|
+
* will fetch more data from the server as needed.
|
|
647
|
+
*
|
|
648
|
+
* @param request a request which can be sent to the service operation
|
|
649
|
+
*/
|
|
650
|
+
listCaptchasResponseIterator(request: requests.ListCaptchasRequest): AsyncIterableIterator<responses.ListCaptchasResponse>;
|
|
523
651
|
/**
|
|
524
652
|
* Gets a list of SSL certificates that can be used in a WAAS policy.
|
|
653
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
525
654
|
* @param ListCertificatesRequest
|
|
526
655
|
* @return ListCertificatesResponse
|
|
527
656
|
* @throws OciError when an error occurs
|
|
528
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
657
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/waas/ListCertificates.ts.html |here} to see how to use ListCertificates API.
|
|
529
658
|
*/
|
|
530
659
|
listCertificates(listCertificatesRequest: requests.ListCertificatesRequest): Promise<responses.ListCertificatesResponse>;
|
|
531
660
|
/**
|
|
661
|
+
* NOTE: This function is deprecated in favor of listCertificatesRecordIterator function.
|
|
532
662
|
* Creates a new async iterator which will iterate over the models.CertificateSummary objects
|
|
533
663
|
* contained in responses from the listCertificates operation. This iterator will fetch more data from the
|
|
534
664
|
* server as needed.
|
|
@@ -537,21 +667,39 @@ export declare class WaasClient {
|
|
|
537
667
|
*/
|
|
538
668
|
listAllCertificates(request: requests.ListCertificatesRequest): AsyncIterableIterator<model.CertificateSummary>;
|
|
539
669
|
/**
|
|
670
|
+
* NOTE: This function is deprecated in favor of listCertificatesResponseIterator function.
|
|
540
671
|
* Creates a new async iterator which will iterate over the responses received from the listCertificates operation. This iterator
|
|
541
672
|
* will fetch more data from the server as needed.
|
|
542
673
|
*
|
|
543
674
|
* @param request a request which can be sent to the service operation
|
|
544
675
|
*/
|
|
545
676
|
listAllCertificatesResponses(request: requests.ListCertificatesRequest): AsyncIterableIterator<responses.ListCertificatesResponse>;
|
|
677
|
+
/**
|
|
678
|
+
* Creates a new async iterator which will iterate over the models.CertificateSummary objects
|
|
679
|
+
* contained in responses from the listCertificates operation. This iterator will fetch more data from the
|
|
680
|
+
* server as needed.
|
|
681
|
+
*
|
|
682
|
+
* @param request a request which can be sent to the service operation
|
|
683
|
+
*/
|
|
684
|
+
listCertificatesRecordIterator(request: requests.ListCertificatesRequest): AsyncIterableIterator<model.CertificateSummary>;
|
|
685
|
+
/**
|
|
686
|
+
* Creates a new async iterator which will iterate over the responses received from the listCertificates operation. This iterator
|
|
687
|
+
* will fetch more data from the server as needed.
|
|
688
|
+
*
|
|
689
|
+
* @param request a request which can be sent to the service operation
|
|
690
|
+
*/
|
|
691
|
+
listCertificatesResponseIterator(request: requests.ListCertificatesRequest): AsyncIterableIterator<responses.ListCertificatesResponse>;
|
|
546
692
|
/**
|
|
547
693
|
* Gets a list of custom protection rules for the specified Web Application Firewall.
|
|
694
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
548
695
|
* @param ListCustomProtectionRulesRequest
|
|
549
696
|
* @return ListCustomProtectionRulesResponse
|
|
550
697
|
* @throws OciError when an error occurs
|
|
551
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
698
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/waas/ListCustomProtectionRules.ts.html |here} to see how to use ListCustomProtectionRules API.
|
|
552
699
|
*/
|
|
553
700
|
listCustomProtectionRules(listCustomProtectionRulesRequest: requests.ListCustomProtectionRulesRequest): Promise<responses.ListCustomProtectionRulesResponse>;
|
|
554
701
|
/**
|
|
702
|
+
* NOTE: This function is deprecated in favor of listCustomProtectionRulesRecordIterator function.
|
|
555
703
|
* Creates a new async iterator which will iterate over the models.CustomProtectionRuleSummary objects
|
|
556
704
|
* contained in responses from the listCustomProtectionRules operation. This iterator will fetch more data from the
|
|
557
705
|
* server as needed.
|
|
@@ -560,21 +708,39 @@ export declare class WaasClient {
|
|
|
560
708
|
*/
|
|
561
709
|
listAllCustomProtectionRules(request: requests.ListCustomProtectionRulesRequest): AsyncIterableIterator<model.CustomProtectionRuleSummary>;
|
|
562
710
|
/**
|
|
711
|
+
* NOTE: This function is deprecated in favor of listCustomProtectionRulesResponseIterator function.
|
|
563
712
|
* Creates a new async iterator which will iterate over the responses received from the listCustomProtectionRules operation. This iterator
|
|
564
713
|
* will fetch more data from the server as needed.
|
|
565
714
|
*
|
|
566
715
|
* @param request a request which can be sent to the service operation
|
|
567
716
|
*/
|
|
568
717
|
listAllCustomProtectionRulesResponses(request: requests.ListCustomProtectionRulesRequest): AsyncIterableIterator<responses.ListCustomProtectionRulesResponse>;
|
|
718
|
+
/**
|
|
719
|
+
* Creates a new async iterator which will iterate over the models.CustomProtectionRuleSummary objects
|
|
720
|
+
* contained in responses from the listCustomProtectionRules operation. This iterator will fetch more data from the
|
|
721
|
+
* server as needed.
|
|
722
|
+
*
|
|
723
|
+
* @param request a request which can be sent to the service operation
|
|
724
|
+
*/
|
|
725
|
+
listCustomProtectionRulesRecordIterator(request: requests.ListCustomProtectionRulesRequest): AsyncIterableIterator<model.CustomProtectionRuleSummary>;
|
|
726
|
+
/**
|
|
727
|
+
* Creates a new async iterator which will iterate over the responses received from the listCustomProtectionRules operation. This iterator
|
|
728
|
+
* will fetch more data from the server as needed.
|
|
729
|
+
*
|
|
730
|
+
* @param request a request which can be sent to the service operation
|
|
731
|
+
*/
|
|
732
|
+
listCustomProtectionRulesResponseIterator(request: requests.ListCustomProtectionRulesRequest): AsyncIterableIterator<responses.ListCustomProtectionRulesResponse>;
|
|
569
733
|
/**
|
|
570
734
|
* Return the list of the tenant's edge node subnets. Use these CIDR blocks to restrict incoming traffic to your origin. These subnets are owned by OCI and forward traffic to customer origins. They are not associated with specific regions or compartments.
|
|
735
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
571
736
|
* @param ListEdgeSubnetsRequest
|
|
572
737
|
* @return ListEdgeSubnetsResponse
|
|
573
738
|
* @throws OciError when an error occurs
|
|
574
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
739
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/waas/ListEdgeSubnets.ts.html |here} to see how to use ListEdgeSubnets API.
|
|
575
740
|
*/
|
|
576
741
|
listEdgeSubnets(listEdgeSubnetsRequest: requests.ListEdgeSubnetsRequest): Promise<responses.ListEdgeSubnetsResponse>;
|
|
577
742
|
/**
|
|
743
|
+
* NOTE: This function is deprecated in favor of listEdgeSubnetsRecordIterator function.
|
|
578
744
|
* Creates a new async iterator which will iterate over the models.EdgeSubnet objects
|
|
579
745
|
* contained in responses from the listEdgeSubnets operation. This iterator will fetch more data from the
|
|
580
746
|
* server as needed.
|
|
@@ -583,24 +749,42 @@ export declare class WaasClient {
|
|
|
583
749
|
*/
|
|
584
750
|
listAllEdgeSubnets(request: requests.ListEdgeSubnetsRequest): AsyncIterableIterator<model.EdgeSubnet>;
|
|
585
751
|
/**
|
|
752
|
+
* NOTE: This function is deprecated in favor of listEdgeSubnetsResponseIterator function.
|
|
586
753
|
* Creates a new async iterator which will iterate over the responses received from the listEdgeSubnets operation. This iterator
|
|
587
754
|
* will fetch more data from the server as needed.
|
|
588
755
|
*
|
|
589
756
|
* @param request a request which can be sent to the service operation
|
|
590
757
|
*/
|
|
591
758
|
listAllEdgeSubnetsResponses(request: requests.ListEdgeSubnetsRequest): AsyncIterableIterator<responses.ListEdgeSubnetsResponse>;
|
|
759
|
+
/**
|
|
760
|
+
* Creates a new async iterator which will iterate over the models.EdgeSubnet objects
|
|
761
|
+
* contained in responses from the listEdgeSubnets operation. This iterator will fetch more data from the
|
|
762
|
+
* server as needed.
|
|
763
|
+
*
|
|
764
|
+
* @param request a request which can be sent to the service operation
|
|
765
|
+
*/
|
|
766
|
+
listEdgeSubnetsRecordIterator(request: requests.ListEdgeSubnetsRequest): AsyncIterableIterator<model.EdgeSubnet>;
|
|
767
|
+
/**
|
|
768
|
+
* Creates a new async iterator which will iterate over the responses received from the listEdgeSubnets operation. This iterator
|
|
769
|
+
* will fetch more data from the server as needed.
|
|
770
|
+
*
|
|
771
|
+
* @param request a request which can be sent to the service operation
|
|
772
|
+
*/
|
|
773
|
+
listEdgeSubnetsResponseIterator(request: requests.ListEdgeSubnetsRequest): AsyncIterableIterator<responses.ListEdgeSubnetsResponse>;
|
|
592
774
|
/**
|
|
593
775
|
* Gets the list of good bots defined in the Web Application Firewall configuration for a WAAS policy.
|
|
594
776
|
* <p>
|
|
595
777
|
The list is sorted by `key`, in ascending order.
|
|
596
778
|
*
|
|
779
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
597
780
|
* @param ListGoodBotsRequest
|
|
598
781
|
* @return ListGoodBotsResponse
|
|
599
782
|
* @throws OciError when an error occurs
|
|
600
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
783
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/waas/ListGoodBots.ts.html |here} to see how to use ListGoodBots API.
|
|
601
784
|
*/
|
|
602
785
|
listGoodBots(listGoodBotsRequest: requests.ListGoodBotsRequest): Promise<responses.ListGoodBotsResponse>;
|
|
603
786
|
/**
|
|
787
|
+
* NOTE: This function is deprecated in favor of listGoodBotsRecordIterator function.
|
|
604
788
|
* Creates a new async iterator which will iterate over the models.GoodBot objects
|
|
605
789
|
* contained in responses from the listGoodBots operation. This iterator will fetch more data from the
|
|
606
790
|
* server as needed.
|
|
@@ -609,22 +793,40 @@ export declare class WaasClient {
|
|
|
609
793
|
*/
|
|
610
794
|
listAllGoodBots(request: requests.ListGoodBotsRequest): AsyncIterableIterator<model.GoodBot>;
|
|
611
795
|
/**
|
|
796
|
+
* NOTE: This function is deprecated in favor of listGoodBotsResponseIterator function.
|
|
612
797
|
* Creates a new async iterator which will iterate over the responses received from the listGoodBots operation. This iterator
|
|
613
798
|
* will fetch more data from the server as needed.
|
|
614
799
|
*
|
|
615
800
|
* @param request a request which can be sent to the service operation
|
|
616
801
|
*/
|
|
617
802
|
listAllGoodBotsResponses(request: requests.ListGoodBotsRequest): AsyncIterableIterator<responses.ListGoodBotsResponse>;
|
|
803
|
+
/**
|
|
804
|
+
* Creates a new async iterator which will iterate over the models.GoodBot objects
|
|
805
|
+
* contained in responses from the listGoodBots operation. This iterator will fetch more data from the
|
|
806
|
+
* server as needed.
|
|
807
|
+
*
|
|
808
|
+
* @param request a request which can be sent to the service operation
|
|
809
|
+
*/
|
|
810
|
+
listGoodBotsRecordIterator(request: requests.ListGoodBotsRequest): AsyncIterableIterator<model.GoodBot>;
|
|
811
|
+
/**
|
|
812
|
+
* Creates a new async iterator which will iterate over the responses received from the listGoodBots operation. This iterator
|
|
813
|
+
* will fetch more data from the server as needed.
|
|
814
|
+
*
|
|
815
|
+
* @param request a request which can be sent to the service operation
|
|
816
|
+
*/
|
|
817
|
+
listGoodBotsResponseIterator(request: requests.ListGoodBotsRequest): AsyncIterableIterator<responses.ListGoodBotsResponse>;
|
|
618
818
|
/**
|
|
619
819
|
* Gets the list of available protection rules for a WAAS policy. Use the `GetWafConfig` operation to view a list of currently configured protection rules for the Web Application Firewall, or use the `ListRecommendations` operation to get a list of recommended protection rules for the Web Application Firewall.
|
|
620
820
|
* The list is sorted by `key`, in ascending order.
|
|
821
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
621
822
|
* @param ListProtectionRulesRequest
|
|
622
823
|
* @return ListProtectionRulesResponse
|
|
623
824
|
* @throws OciError when an error occurs
|
|
624
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
825
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/waas/ListProtectionRules.ts.html |here} to see how to use ListProtectionRules API.
|
|
625
826
|
*/
|
|
626
827
|
listProtectionRules(listProtectionRulesRequest: requests.ListProtectionRulesRequest): Promise<responses.ListProtectionRulesResponse>;
|
|
627
828
|
/**
|
|
829
|
+
* NOTE: This function is deprecated in favor of listProtectionRulesRecordIterator function.
|
|
628
830
|
* Creates a new async iterator which will iterate over the models.ProtectionRule objects
|
|
629
831
|
* contained in responses from the listProtectionRules operation. This iterator will fetch more data from the
|
|
630
832
|
* server as needed.
|
|
@@ -633,24 +835,42 @@ export declare class WaasClient {
|
|
|
633
835
|
*/
|
|
634
836
|
listAllProtectionRules(request: requests.ListProtectionRulesRequest): AsyncIterableIterator<model.ProtectionRule>;
|
|
635
837
|
/**
|
|
838
|
+
* NOTE: This function is deprecated in favor of listProtectionRulesResponseIterator function.
|
|
636
839
|
* Creates a new async iterator which will iterate over the responses received from the listProtectionRules operation. This iterator
|
|
637
840
|
* will fetch more data from the server as needed.
|
|
638
841
|
*
|
|
639
842
|
* @param request a request which can be sent to the service operation
|
|
640
843
|
*/
|
|
641
844
|
listAllProtectionRulesResponses(request: requests.ListProtectionRulesRequest): AsyncIterableIterator<responses.ListProtectionRulesResponse>;
|
|
845
|
+
/**
|
|
846
|
+
* Creates a new async iterator which will iterate over the models.ProtectionRule objects
|
|
847
|
+
* contained in responses from the listProtectionRules operation. This iterator will fetch more data from the
|
|
848
|
+
* server as needed.
|
|
849
|
+
*
|
|
850
|
+
* @param request a request which can be sent to the service operation
|
|
851
|
+
*/
|
|
852
|
+
listProtectionRulesRecordIterator(request: requests.ListProtectionRulesRequest): AsyncIterableIterator<model.ProtectionRule>;
|
|
853
|
+
/**
|
|
854
|
+
* Creates a new async iterator which will iterate over the responses received from the listProtectionRules operation. This iterator
|
|
855
|
+
* will fetch more data from the server as needed.
|
|
856
|
+
*
|
|
857
|
+
* @param request a request which can be sent to the service operation
|
|
858
|
+
*/
|
|
859
|
+
listProtectionRulesResponseIterator(request: requests.ListProtectionRulesRequest): AsyncIterableIterator<responses.ListProtectionRulesResponse>;
|
|
642
860
|
/**
|
|
643
861
|
* Gets the list of recommended Web Application Firewall protection rules.
|
|
644
862
|
* <p>
|
|
645
863
|
Use the `POST /waasPolicies/{waasPolicyId}/actions/acceptWafConfigRecommendations` method to accept recommended Web Application Firewall protection rules. For more information, see [WAF Protection Rules](https://docs.cloud.oracle.com/iaas/Content/WAF/Tasks/wafprotectionrules.htm).
|
|
646
864
|
* The list is sorted by `key`, in ascending order.
|
|
865
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
647
866
|
* @param ListRecommendationsRequest
|
|
648
867
|
* @return ListRecommendationsResponse
|
|
649
868
|
* @throws OciError when an error occurs
|
|
650
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
869
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/waas/ListRecommendations.ts.html |here} to see how to use ListRecommendations API.
|
|
651
870
|
*/
|
|
652
871
|
listRecommendations(listRecommendationsRequest: requests.ListRecommendationsRequest): Promise<responses.ListRecommendationsResponse>;
|
|
653
872
|
/**
|
|
873
|
+
* NOTE: This function is deprecated in favor of listRecommendationsRecordIterator function.
|
|
654
874
|
* Creates a new async iterator which will iterate over the models.Recommendation objects
|
|
655
875
|
* contained in responses from the listRecommendations operation. This iterator will fetch more data from the
|
|
656
876
|
* server as needed.
|
|
@@ -659,24 +879,42 @@ export declare class WaasClient {
|
|
|
659
879
|
*/
|
|
660
880
|
listAllRecommendations(request: requests.ListRecommendationsRequest): AsyncIterableIterator<model.Recommendation>;
|
|
661
881
|
/**
|
|
882
|
+
* NOTE: This function is deprecated in favor of listRecommendationsResponseIterator function.
|
|
662
883
|
* Creates a new async iterator which will iterate over the responses received from the listRecommendations operation. This iterator
|
|
663
884
|
* will fetch more data from the server as needed.
|
|
664
885
|
*
|
|
665
886
|
* @param request a request which can be sent to the service operation
|
|
666
887
|
*/
|
|
667
888
|
listAllRecommendationsResponses(request: requests.ListRecommendationsRequest): AsyncIterableIterator<responses.ListRecommendationsResponse>;
|
|
889
|
+
/**
|
|
890
|
+
* Creates a new async iterator which will iterate over the models.Recommendation objects
|
|
891
|
+
* contained in responses from the listRecommendations operation. This iterator will fetch more data from the
|
|
892
|
+
* server as needed.
|
|
893
|
+
*
|
|
894
|
+
* @param request a request which can be sent to the service operation
|
|
895
|
+
*/
|
|
896
|
+
listRecommendationsRecordIterator(request: requests.ListRecommendationsRequest): AsyncIterableIterator<model.Recommendation>;
|
|
897
|
+
/**
|
|
898
|
+
* Creates a new async iterator which will iterate over the responses received from the listRecommendations operation. This iterator
|
|
899
|
+
* will fetch more data from the server as needed.
|
|
900
|
+
*
|
|
901
|
+
* @param request a request which can be sent to the service operation
|
|
902
|
+
*/
|
|
903
|
+
listRecommendationsResponseIterator(request: requests.ListRecommendationsRequest): AsyncIterableIterator<responses.ListRecommendationsResponse>;
|
|
668
904
|
/**
|
|
669
905
|
* Gets the list of available web application threat intelligence feeds
|
|
670
906
|
* and the actions set for each feed. The list is sorted by `key`,
|
|
671
907
|
* in ascending order.
|
|
672
908
|
*
|
|
909
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
673
910
|
* @param ListThreatFeedsRequest
|
|
674
911
|
* @return ListThreatFeedsResponse
|
|
675
912
|
* @throws OciError when an error occurs
|
|
676
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
913
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/waas/ListThreatFeeds.ts.html |here} to see how to use ListThreatFeeds API.
|
|
677
914
|
*/
|
|
678
915
|
listThreatFeeds(listThreatFeedsRequest: requests.ListThreatFeedsRequest): Promise<responses.ListThreatFeedsResponse>;
|
|
679
916
|
/**
|
|
917
|
+
* NOTE: This function is deprecated in favor of listThreatFeedsRecordIterator function.
|
|
680
918
|
* Creates a new async iterator which will iterate over the models.ThreatFeed objects
|
|
681
919
|
* contained in responses from the listThreatFeeds operation. This iterator will fetch more data from the
|
|
682
920
|
* server as needed.
|
|
@@ -685,21 +923,39 @@ export declare class WaasClient {
|
|
|
685
923
|
*/
|
|
686
924
|
listAllThreatFeeds(request: requests.ListThreatFeedsRequest): AsyncIterableIterator<model.ThreatFeed>;
|
|
687
925
|
/**
|
|
926
|
+
* NOTE: This function is deprecated in favor of listThreatFeedsResponseIterator function.
|
|
688
927
|
* Creates a new async iterator which will iterate over the responses received from the listThreatFeeds operation. This iterator
|
|
689
928
|
* will fetch more data from the server as needed.
|
|
690
929
|
*
|
|
691
930
|
* @param request a request which can be sent to the service operation
|
|
692
931
|
*/
|
|
693
932
|
listAllThreatFeedsResponses(request: requests.ListThreatFeedsRequest): AsyncIterableIterator<responses.ListThreatFeedsResponse>;
|
|
933
|
+
/**
|
|
934
|
+
* Creates a new async iterator which will iterate over the models.ThreatFeed objects
|
|
935
|
+
* contained in responses from the listThreatFeeds operation. This iterator will fetch more data from the
|
|
936
|
+
* server as needed.
|
|
937
|
+
*
|
|
938
|
+
* @param request a request which can be sent to the service operation
|
|
939
|
+
*/
|
|
940
|
+
listThreatFeedsRecordIterator(request: requests.ListThreatFeedsRequest): AsyncIterableIterator<model.ThreatFeed>;
|
|
941
|
+
/**
|
|
942
|
+
* Creates a new async iterator which will iterate over the responses received from the listThreatFeeds operation. This iterator
|
|
943
|
+
* will fetch more data from the server as needed.
|
|
944
|
+
*
|
|
945
|
+
* @param request a request which can be sent to the service operation
|
|
946
|
+
*/
|
|
947
|
+
listThreatFeedsResponseIterator(request: requests.ListThreatFeedsRequest): AsyncIterableIterator<responses.ListThreatFeedsResponse>;
|
|
694
948
|
/**
|
|
695
949
|
* Gets a list of WAAS policies.
|
|
950
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
696
951
|
* @param ListWaasPoliciesRequest
|
|
697
952
|
* @return ListWaasPoliciesResponse
|
|
698
953
|
* @throws OciError when an error occurs
|
|
699
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
954
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/waas/ListWaasPolicies.ts.html |here} to see how to use ListWaasPolicies API.
|
|
700
955
|
*/
|
|
701
956
|
listWaasPolicies(listWaasPoliciesRequest: requests.ListWaasPoliciesRequest): Promise<responses.ListWaasPoliciesResponse>;
|
|
702
957
|
/**
|
|
958
|
+
* NOTE: This function is deprecated in favor of listWaasPoliciesRecordIterator function.
|
|
703
959
|
* Creates a new async iterator which will iterate over the models.WaasPolicySummary objects
|
|
704
960
|
* contained in responses from the listWaasPolicies operation. This iterator will fetch more data from the
|
|
705
961
|
* server as needed.
|
|
@@ -708,21 +964,39 @@ export declare class WaasClient {
|
|
|
708
964
|
*/
|
|
709
965
|
listAllWaasPolicies(request: requests.ListWaasPoliciesRequest): AsyncIterableIterator<model.WaasPolicySummary>;
|
|
710
966
|
/**
|
|
967
|
+
* NOTE: This function is deprecated in favor of listWaasPoliciesResponseIterator function.
|
|
711
968
|
* Creates a new async iterator which will iterate over the responses received from the listWaasPolicies operation. This iterator
|
|
712
969
|
* will fetch more data from the server as needed.
|
|
713
970
|
*
|
|
714
971
|
* @param request a request which can be sent to the service operation
|
|
715
972
|
*/
|
|
716
973
|
listAllWaasPoliciesResponses(request: requests.ListWaasPoliciesRequest): AsyncIterableIterator<responses.ListWaasPoliciesResponse>;
|
|
974
|
+
/**
|
|
975
|
+
* Creates a new async iterator which will iterate over the models.WaasPolicySummary objects
|
|
976
|
+
* contained in responses from the listWaasPolicies operation. This iterator will fetch more data from the
|
|
977
|
+
* server as needed.
|
|
978
|
+
*
|
|
979
|
+
* @param request a request which can be sent to the service operation
|
|
980
|
+
*/
|
|
981
|
+
listWaasPoliciesRecordIterator(request: requests.ListWaasPoliciesRequest): AsyncIterableIterator<model.WaasPolicySummary>;
|
|
982
|
+
/**
|
|
983
|
+
* Creates a new async iterator which will iterate over the responses received from the listWaasPolicies operation. This iterator
|
|
984
|
+
* will fetch more data from the server as needed.
|
|
985
|
+
*
|
|
986
|
+
* @param request a request which can be sent to the service operation
|
|
987
|
+
*/
|
|
988
|
+
listWaasPoliciesResponseIterator(request: requests.ListWaasPoliciesRequest): AsyncIterableIterator<responses.ListWaasPoliciesResponse>;
|
|
717
989
|
/**
|
|
718
990
|
* Gets the list of currently configured custom protection rules for a WAAS policy.
|
|
991
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
719
992
|
* @param ListWaasPolicyCustomProtectionRulesRequest
|
|
720
993
|
* @return ListWaasPolicyCustomProtectionRulesResponse
|
|
721
994
|
* @throws OciError when an error occurs
|
|
722
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
995
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/waas/ListWaasPolicyCustomProtectionRules.ts.html |here} to see how to use ListWaasPolicyCustomProtectionRules API.
|
|
723
996
|
*/
|
|
724
997
|
listWaasPolicyCustomProtectionRules(listWaasPolicyCustomProtectionRulesRequest: requests.ListWaasPolicyCustomProtectionRulesRequest): Promise<responses.ListWaasPolicyCustomProtectionRulesResponse>;
|
|
725
998
|
/**
|
|
999
|
+
* NOTE: This function is deprecated in favor of listWaasPolicyCustomProtectionRulesRecordIterator function.
|
|
726
1000
|
* Creates a new async iterator which will iterate over the models.WaasPolicyCustomProtectionRuleSummary objects
|
|
727
1001
|
* contained in responses from the listWaasPolicyCustomProtectionRules operation. This iterator will fetch more data from the
|
|
728
1002
|
* server as needed.
|
|
@@ -731,21 +1005,39 @@ export declare class WaasClient {
|
|
|
731
1005
|
*/
|
|
732
1006
|
listAllWaasPolicyCustomProtectionRules(request: requests.ListWaasPolicyCustomProtectionRulesRequest): AsyncIterableIterator<model.WaasPolicyCustomProtectionRuleSummary>;
|
|
733
1007
|
/**
|
|
1008
|
+
* NOTE: This function is deprecated in favor of listWaasPolicyCustomProtectionRulesResponseIterator function.
|
|
734
1009
|
* Creates a new async iterator which will iterate over the responses received from the listWaasPolicyCustomProtectionRules operation. This iterator
|
|
735
1010
|
* will fetch more data from the server as needed.
|
|
736
1011
|
*
|
|
737
1012
|
* @param request a request which can be sent to the service operation
|
|
738
1013
|
*/
|
|
739
1014
|
listAllWaasPolicyCustomProtectionRulesResponses(request: requests.ListWaasPolicyCustomProtectionRulesRequest): AsyncIterableIterator<responses.ListWaasPolicyCustomProtectionRulesResponse>;
|
|
1015
|
+
/**
|
|
1016
|
+
* Creates a new async iterator which will iterate over the models.WaasPolicyCustomProtectionRuleSummary objects
|
|
1017
|
+
* contained in responses from the listWaasPolicyCustomProtectionRules operation. This iterator will fetch more data from the
|
|
1018
|
+
* server as needed.
|
|
1019
|
+
*
|
|
1020
|
+
* @param request a request which can be sent to the service operation
|
|
1021
|
+
*/
|
|
1022
|
+
listWaasPolicyCustomProtectionRulesRecordIterator(request: requests.ListWaasPolicyCustomProtectionRulesRequest): AsyncIterableIterator<model.WaasPolicyCustomProtectionRuleSummary>;
|
|
1023
|
+
/**
|
|
1024
|
+
* Creates a new async iterator which will iterate over the responses received from the listWaasPolicyCustomProtectionRules operation. This iterator
|
|
1025
|
+
* will fetch more data from the server as needed.
|
|
1026
|
+
*
|
|
1027
|
+
* @param request a request which can be sent to the service operation
|
|
1028
|
+
*/
|
|
1029
|
+
listWaasPolicyCustomProtectionRulesResponseIterator(request: requests.ListWaasPolicyCustomProtectionRulesRequest): AsyncIterableIterator<responses.ListWaasPolicyCustomProtectionRulesResponse>;
|
|
740
1030
|
/**
|
|
741
1031
|
* Gets the number of blocked requests by a Web Application Firewall feature in five minute blocks, sorted by `timeObserved` in ascending order (starting from oldest data).
|
|
1032
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
742
1033
|
* @param ListWafBlockedRequestsRequest
|
|
743
1034
|
* @return ListWafBlockedRequestsResponse
|
|
744
1035
|
* @throws OciError when an error occurs
|
|
745
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1036
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/waas/ListWafBlockedRequests.ts.html |here} to see how to use ListWafBlockedRequests API.
|
|
746
1037
|
*/
|
|
747
1038
|
listWafBlockedRequests(listWafBlockedRequestsRequest: requests.ListWafBlockedRequestsRequest): Promise<responses.ListWafBlockedRequestsResponse>;
|
|
748
1039
|
/**
|
|
1040
|
+
* NOTE: This function is deprecated in favor of listWafBlockedRequestsRecordIterator function.
|
|
749
1041
|
* Creates a new async iterator which will iterate over the models.WafBlockedRequest objects
|
|
750
1042
|
* contained in responses from the listWafBlockedRequests operation. This iterator will fetch more data from the
|
|
751
1043
|
* server as needed.
|
|
@@ -754,24 +1046,42 @@ export declare class WaasClient {
|
|
|
754
1046
|
*/
|
|
755
1047
|
listAllWafBlockedRequests(request: requests.ListWafBlockedRequestsRequest): AsyncIterableIterator<model.WafBlockedRequest>;
|
|
756
1048
|
/**
|
|
1049
|
+
* NOTE: This function is deprecated in favor of listWafBlockedRequestsResponseIterator function.
|
|
757
1050
|
* Creates a new async iterator which will iterate over the responses received from the listWafBlockedRequests operation. This iterator
|
|
758
1051
|
* will fetch more data from the server as needed.
|
|
759
1052
|
*
|
|
760
1053
|
* @param request a request which can be sent to the service operation
|
|
761
1054
|
*/
|
|
762
1055
|
listAllWafBlockedRequestsResponses(request: requests.ListWafBlockedRequestsRequest): AsyncIterableIterator<responses.ListWafBlockedRequestsResponse>;
|
|
1056
|
+
/**
|
|
1057
|
+
* Creates a new async iterator which will iterate over the models.WafBlockedRequest objects
|
|
1058
|
+
* contained in responses from the listWafBlockedRequests operation. This iterator will fetch more data from the
|
|
1059
|
+
* server as needed.
|
|
1060
|
+
*
|
|
1061
|
+
* @param request a request which can be sent to the service operation
|
|
1062
|
+
*/
|
|
1063
|
+
listWafBlockedRequestsRecordIterator(request: requests.ListWafBlockedRequestsRequest): AsyncIterableIterator<model.WafBlockedRequest>;
|
|
1064
|
+
/**
|
|
1065
|
+
* Creates a new async iterator which will iterate over the responses received from the listWafBlockedRequests operation. This iterator
|
|
1066
|
+
* will fetch more data from the server as needed.
|
|
1067
|
+
*
|
|
1068
|
+
* @param request a request which can be sent to the service operation
|
|
1069
|
+
*/
|
|
1070
|
+
listWafBlockedRequestsResponseIterator(request: requests.ListWafBlockedRequestsRequest): AsyncIterableIterator<responses.ListWafBlockedRequestsResponse>;
|
|
763
1071
|
/**
|
|
764
1072
|
* Gets structured Web Application Firewall event logs for a WAAS
|
|
765
1073
|
* policy. Sorted by the `timeObserved` in ascending order (starting from the
|
|
766
1074
|
* oldest recorded event).
|
|
767
1075
|
*
|
|
1076
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
768
1077
|
* @param ListWafLogsRequest
|
|
769
1078
|
* @return ListWafLogsResponse
|
|
770
1079
|
* @throws OciError when an error occurs
|
|
771
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1080
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/waas/ListWafLogs.ts.html |here} to see how to use ListWafLogs API.
|
|
772
1081
|
*/
|
|
773
1082
|
listWafLogs(listWafLogsRequest: requests.ListWafLogsRequest): Promise<responses.ListWafLogsResponse>;
|
|
774
1083
|
/**
|
|
1084
|
+
* NOTE: This function is deprecated in favor of listWafLogsRecordIterator function.
|
|
775
1085
|
* Creates a new async iterator which will iterate over the models.WafLog objects
|
|
776
1086
|
* contained in responses from the listWafLogs operation. This iterator will fetch more data from the
|
|
777
1087
|
* server as needed.
|
|
@@ -780,24 +1090,42 @@ export declare class WaasClient {
|
|
|
780
1090
|
*/
|
|
781
1091
|
listAllWafLogs(request: requests.ListWafLogsRequest): AsyncIterableIterator<model.WafLog>;
|
|
782
1092
|
/**
|
|
1093
|
+
* NOTE: This function is deprecated in favor of listWafLogsResponseIterator function.
|
|
783
1094
|
* Creates a new async iterator which will iterate over the responses received from the listWafLogs operation. This iterator
|
|
784
1095
|
* will fetch more data from the server as needed.
|
|
785
1096
|
*
|
|
786
1097
|
* @param request a request which can be sent to the service operation
|
|
787
1098
|
*/
|
|
788
1099
|
listAllWafLogsResponses(request: requests.ListWafLogsRequest): AsyncIterableIterator<responses.ListWafLogsResponse>;
|
|
1100
|
+
/**
|
|
1101
|
+
* Creates a new async iterator which will iterate over the models.WafLog objects
|
|
1102
|
+
* contained in responses from the listWafLogs operation. This iterator will fetch more data from the
|
|
1103
|
+
* server as needed.
|
|
1104
|
+
*
|
|
1105
|
+
* @param request a request which can be sent to the service operation
|
|
1106
|
+
*/
|
|
1107
|
+
listWafLogsRecordIterator(request: requests.ListWafLogsRequest): AsyncIterableIterator<model.WafLog>;
|
|
1108
|
+
/**
|
|
1109
|
+
* Creates a new async iterator which will iterate over the responses received from the listWafLogs operation. This iterator
|
|
1110
|
+
* will fetch more data from the server as needed.
|
|
1111
|
+
*
|
|
1112
|
+
* @param request a request which can be sent to the service operation
|
|
1113
|
+
*/
|
|
1114
|
+
listWafLogsResponseIterator(request: requests.ListWafLogsRequest): AsyncIterableIterator<responses.ListWafLogsResponse>;
|
|
789
1115
|
/**
|
|
790
1116
|
* Gets the number of requests managed by a Web Application Firewall
|
|
791
1117
|
* over a specified period of time, including blocked requests. Sorted
|
|
792
1118
|
* by `timeObserved` in ascending order (starting from oldest requests).
|
|
793
1119
|
*
|
|
1120
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
794
1121
|
* @param ListWafRequestsRequest
|
|
795
1122
|
* @return ListWafRequestsResponse
|
|
796
1123
|
* @throws OciError when an error occurs
|
|
797
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1124
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/waas/ListWafRequests.ts.html |here} to see how to use ListWafRequests API.
|
|
798
1125
|
*/
|
|
799
1126
|
listWafRequests(listWafRequestsRequest: requests.ListWafRequestsRequest): Promise<responses.ListWafRequestsResponse>;
|
|
800
1127
|
/**
|
|
1128
|
+
* NOTE: This function is deprecated in favor of listWafRequestsRecordIterator function.
|
|
801
1129
|
* Creates a new async iterator which will iterate over the models.WafRequest objects
|
|
802
1130
|
* contained in responses from the listWafRequests operation. This iterator will fetch more data from the
|
|
803
1131
|
* server as needed.
|
|
@@ -806,23 +1134,41 @@ export declare class WaasClient {
|
|
|
806
1134
|
*/
|
|
807
1135
|
listAllWafRequests(request: requests.ListWafRequestsRequest): AsyncIterableIterator<model.WafRequest>;
|
|
808
1136
|
/**
|
|
1137
|
+
* NOTE: This function is deprecated in favor of listWafRequestsResponseIterator function.
|
|
809
1138
|
* Creates a new async iterator which will iterate over the responses received from the listWafRequests operation. This iterator
|
|
810
1139
|
* will fetch more data from the server as needed.
|
|
811
1140
|
*
|
|
812
1141
|
* @param request a request which can be sent to the service operation
|
|
813
1142
|
*/
|
|
814
1143
|
listAllWafRequestsResponses(request: requests.ListWafRequestsRequest): AsyncIterableIterator<responses.ListWafRequestsResponse>;
|
|
1144
|
+
/**
|
|
1145
|
+
* Creates a new async iterator which will iterate over the models.WafRequest objects
|
|
1146
|
+
* contained in responses from the listWafRequests operation. This iterator will fetch more data from the
|
|
1147
|
+
* server as needed.
|
|
1148
|
+
*
|
|
1149
|
+
* @param request a request which can be sent to the service operation
|
|
1150
|
+
*/
|
|
1151
|
+
listWafRequestsRecordIterator(request: requests.ListWafRequestsRequest): AsyncIterableIterator<model.WafRequest>;
|
|
1152
|
+
/**
|
|
1153
|
+
* Creates a new async iterator which will iterate over the responses received from the listWafRequests operation. This iterator
|
|
1154
|
+
* will fetch more data from the server as needed.
|
|
1155
|
+
*
|
|
1156
|
+
* @param request a request which can be sent to the service operation
|
|
1157
|
+
*/
|
|
1158
|
+
listWafRequestsResponseIterator(request: requests.ListWafRequestsRequest): AsyncIterableIterator<responses.ListWafRequestsResponse>;
|
|
815
1159
|
/**
|
|
816
1160
|
* Gets the Web Application Firewall traffic data for a WAAS policy.
|
|
817
1161
|
* Sorted by `timeObserved` in ascending order (starting from oldest data).
|
|
818
1162
|
*
|
|
1163
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
819
1164
|
* @param ListWafTrafficRequest
|
|
820
1165
|
* @return ListWafTrafficResponse
|
|
821
1166
|
* @throws OciError when an error occurs
|
|
822
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1167
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/waas/ListWafTraffic.ts.html |here} to see how to use ListWafTraffic API.
|
|
823
1168
|
*/
|
|
824
1169
|
listWafTraffic(listWafTrafficRequest: requests.ListWafTrafficRequest): Promise<responses.ListWafTrafficResponse>;
|
|
825
1170
|
/**
|
|
1171
|
+
* NOTE: This function is deprecated in favor of listWafTrafficRecordIterator function.
|
|
826
1172
|
* Creates a new async iterator which will iterate over the models.WafTrafficDatum objects
|
|
827
1173
|
* contained in responses from the listWafTraffic operation. This iterator will fetch more data from the
|
|
828
1174
|
* server as needed.
|
|
@@ -831,21 +1177,39 @@ export declare class WaasClient {
|
|
|
831
1177
|
*/
|
|
832
1178
|
listAllWafTraffic(request: requests.ListWafTrafficRequest): AsyncIterableIterator<model.WafTrafficDatum>;
|
|
833
1179
|
/**
|
|
1180
|
+
* NOTE: This function is deprecated in favor of listWafTrafficResponseIterator function.
|
|
834
1181
|
* Creates a new async iterator which will iterate over the responses received from the listWafTraffic operation. This iterator
|
|
835
1182
|
* will fetch more data from the server as needed.
|
|
836
1183
|
*
|
|
837
1184
|
* @param request a request which can be sent to the service operation
|
|
838
1185
|
*/
|
|
839
1186
|
listAllWafTrafficResponses(request: requests.ListWafTrafficRequest): AsyncIterableIterator<responses.ListWafTrafficResponse>;
|
|
1187
|
+
/**
|
|
1188
|
+
* Creates a new async iterator which will iterate over the models.WafTrafficDatum objects
|
|
1189
|
+
* contained in responses from the listWafTraffic operation. This iterator will fetch more data from the
|
|
1190
|
+
* server as needed.
|
|
1191
|
+
*
|
|
1192
|
+
* @param request a request which can be sent to the service operation
|
|
1193
|
+
*/
|
|
1194
|
+
listWafTrafficRecordIterator(request: requests.ListWafTrafficRequest): AsyncIterableIterator<model.WafTrafficDatum>;
|
|
1195
|
+
/**
|
|
1196
|
+
* Creates a new async iterator which will iterate over the responses received from the listWafTraffic operation. This iterator
|
|
1197
|
+
* will fetch more data from the server as needed.
|
|
1198
|
+
*
|
|
1199
|
+
* @param request a request which can be sent to the service operation
|
|
1200
|
+
*/
|
|
1201
|
+
listWafTrafficResponseIterator(request: requests.ListWafTrafficRequest): AsyncIterableIterator<responses.ListWafTrafficResponse>;
|
|
840
1202
|
/**
|
|
841
1203
|
* Gets the list of whitelists defined in the Web Application Firewall configuration for a WAAS policy.
|
|
1204
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
842
1205
|
* @param ListWhitelistsRequest
|
|
843
1206
|
* @return ListWhitelistsResponse
|
|
844
1207
|
* @throws OciError when an error occurs
|
|
845
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1208
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/waas/ListWhitelists.ts.html |here} to see how to use ListWhitelists API.
|
|
846
1209
|
*/
|
|
847
1210
|
listWhitelists(listWhitelistsRequest: requests.ListWhitelistsRequest): Promise<responses.ListWhitelistsResponse>;
|
|
848
1211
|
/**
|
|
1212
|
+
* NOTE: This function is deprecated in favor of listWhitelistsRecordIterator function.
|
|
849
1213
|
* Creates a new async iterator which will iterate over the models.Whitelist objects
|
|
850
1214
|
* contained in responses from the listWhitelists operation. This iterator will fetch more data from the
|
|
851
1215
|
* server as needed.
|
|
@@ -854,21 +1218,39 @@ export declare class WaasClient {
|
|
|
854
1218
|
*/
|
|
855
1219
|
listAllWhitelists(request: requests.ListWhitelistsRequest): AsyncIterableIterator<model.Whitelist>;
|
|
856
1220
|
/**
|
|
1221
|
+
* NOTE: This function is deprecated in favor of listWhitelistsResponseIterator function.
|
|
857
1222
|
* Creates a new async iterator which will iterate over the responses received from the listWhitelists operation. This iterator
|
|
858
1223
|
* will fetch more data from the server as needed.
|
|
859
1224
|
*
|
|
860
1225
|
* @param request a request which can be sent to the service operation
|
|
861
1226
|
*/
|
|
862
1227
|
listAllWhitelistsResponses(request: requests.ListWhitelistsRequest): AsyncIterableIterator<responses.ListWhitelistsResponse>;
|
|
1228
|
+
/**
|
|
1229
|
+
* Creates a new async iterator which will iterate over the models.Whitelist objects
|
|
1230
|
+
* contained in responses from the listWhitelists operation. This iterator will fetch more data from the
|
|
1231
|
+
* server as needed.
|
|
1232
|
+
*
|
|
1233
|
+
* @param request a request which can be sent to the service operation
|
|
1234
|
+
*/
|
|
1235
|
+
listWhitelistsRecordIterator(request: requests.ListWhitelistsRequest): AsyncIterableIterator<model.Whitelist>;
|
|
1236
|
+
/**
|
|
1237
|
+
* Creates a new async iterator which will iterate over the responses received from the listWhitelists operation. This iterator
|
|
1238
|
+
* will fetch more data from the server as needed.
|
|
1239
|
+
*
|
|
1240
|
+
* @param request a request which can be sent to the service operation
|
|
1241
|
+
*/
|
|
1242
|
+
listWhitelistsResponseIterator(request: requests.ListWhitelistsRequest): AsyncIterableIterator<responses.ListWhitelistsResponse>;
|
|
863
1243
|
/**
|
|
864
1244
|
* Gets a list of subnets (CIDR notation) from which the WAAS EDGE may make requests. The subnets are owned by OCI and forward traffic to your origins. Allow traffic from these subnets to your origins. They are not associated with specific regions or compartments.
|
|
1245
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
865
1246
|
* @param ListWorkRequestsRequest
|
|
866
1247
|
* @return ListWorkRequestsResponse
|
|
867
1248
|
* @throws OciError when an error occurs
|
|
868
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1249
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/waas/ListWorkRequests.ts.html |here} to see how to use ListWorkRequests API.
|
|
869
1250
|
*/
|
|
870
1251
|
listWorkRequests(listWorkRequestsRequest: requests.ListWorkRequestsRequest): Promise<responses.ListWorkRequestsResponse>;
|
|
871
1252
|
/**
|
|
1253
|
+
* NOTE: This function is deprecated in favor of listWorkRequestsRecordIterator function.
|
|
872
1254
|
* Creates a new async iterator which will iterate over the models.WorkRequestSummary objects
|
|
873
1255
|
* contained in responses from the listWorkRequests operation. This iterator will fetch more data from the
|
|
874
1256
|
* server as needed.
|
|
@@ -877,19 +1259,36 @@ export declare class WaasClient {
|
|
|
877
1259
|
*/
|
|
878
1260
|
listAllWorkRequests(request: requests.ListWorkRequestsRequest): AsyncIterableIterator<model.WorkRequestSummary>;
|
|
879
1261
|
/**
|
|
1262
|
+
* NOTE: This function is deprecated in favor of listWorkRequestsResponseIterator function.
|
|
880
1263
|
* Creates a new async iterator which will iterate over the responses received from the listWorkRequests operation. This iterator
|
|
881
1264
|
* will fetch more data from the server as needed.
|
|
882
1265
|
*
|
|
883
1266
|
* @param request a request which can be sent to the service operation
|
|
884
1267
|
*/
|
|
885
1268
|
listAllWorkRequestsResponses(request: requests.ListWorkRequestsRequest): AsyncIterableIterator<responses.ListWorkRequestsResponse>;
|
|
1269
|
+
/**
|
|
1270
|
+
* Creates a new async iterator which will iterate over the models.WorkRequestSummary objects
|
|
1271
|
+
* contained in responses from the listWorkRequests operation. This iterator will fetch more data from the
|
|
1272
|
+
* server as needed.
|
|
1273
|
+
*
|
|
1274
|
+
* @param request a request which can be sent to the service operation
|
|
1275
|
+
*/
|
|
1276
|
+
listWorkRequestsRecordIterator(request: requests.ListWorkRequestsRequest): AsyncIterableIterator<model.WorkRequestSummary>;
|
|
1277
|
+
/**
|
|
1278
|
+
* Creates a new async iterator which will iterate over the responses received from the listWorkRequests operation. This iterator
|
|
1279
|
+
* will fetch more data from the server as needed.
|
|
1280
|
+
*
|
|
1281
|
+
* @param request a request which can be sent to the service operation
|
|
1282
|
+
*/
|
|
1283
|
+
listWorkRequestsResponseIterator(request: requests.ListWorkRequestsRequest): AsyncIterableIterator<responses.ListWorkRequestsResponse>;
|
|
886
1284
|
/**
|
|
887
1285
|
* Performs a purge of the cache for each specified resource. If no resources are passed, the cache for the entire Web Application Firewall will be purged.
|
|
888
1286
|
* For more information, see [Caching Rules](https://docs.cloud.oracle.com/iaas/Content/WAF/Tasks/cachingrules.htm#purge).
|
|
1287
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
889
1288
|
* @param PurgeCacheRequest
|
|
890
1289
|
* @return PurgeCacheResponse
|
|
891
1290
|
* @throws OciError when an error occurs
|
|
892
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1291
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/waas/PurgeCache.ts.html |here} to see how to use PurgeCache API.
|
|
893
1292
|
*/
|
|
894
1293
|
purgeCache(purgeCacheRequest: requests.PurgeCacheRequest): Promise<responses.PurgeCacheResponse>;
|
|
895
1294
|
/**
|
|
@@ -902,18 +1301,20 @@ export declare class WaasClient {
|
|
|
902
1301
|
Access rules can be created by adding a new access rule object to the list without a `key` property specified. A `key` will be generated for the new access rule upon update.
|
|
903
1302
|
* <p>
|
|
904
1303
|
Any existing access rules that are not specified with a `key` in the list of access rules will be deleted upon update.
|
|
1304
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
905
1305
|
* @param UpdateAccessRulesRequest
|
|
906
1306
|
* @return UpdateAccessRulesResponse
|
|
907
1307
|
* @throws OciError when an error occurs
|
|
908
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1308
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/waas/UpdateAccessRules.ts.html |here} to see how to use UpdateAccessRules API.
|
|
909
1309
|
*/
|
|
910
1310
|
updateAccessRules(updateAccessRulesRequest: requests.UpdateAccessRulesRequest): Promise<responses.UpdateAccessRulesResponse>;
|
|
911
1311
|
/**
|
|
912
1312
|
* Updates the details of an address list. Only the fields specified in the request body will be updated; all other properties will remain unchanged.
|
|
1313
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
913
1314
|
* @param UpdateAddressListRequest
|
|
914
1315
|
* @return UpdateAddressListResponse
|
|
915
1316
|
* @throws OciError when an error occurs
|
|
916
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1317
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/waas/UpdateAddressList.ts.html |here} to see how to use UpdateAddressList API.
|
|
917
1318
|
*/
|
|
918
1319
|
updateAddressList(updateAddressListRequest: requests.UpdateAddressListRequest): Promise<responses.UpdateAddressListResponse>;
|
|
919
1320
|
/**
|
|
@@ -924,10 +1325,11 @@ export declare class WaasClient {
|
|
|
924
1325
|
This operation can create, delete, update, and/or reorder caching rules depending on the structure of the request body. Caching rules can be updated by changing the properties of the caching rule object with the rule's key specified in the key field. Any existing caching rules that are not specified with a key in the list of access rules will be deleted upon update.
|
|
925
1326
|
* <p>
|
|
926
1327
|
The order the caching rules are specified in is important. The rules are processed in the order they are specified and the first matching rule will be used when processing a request. Use `ListCachingRules` to view a list of all available caching rules in a compartment.
|
|
1328
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
927
1329
|
* @param UpdateCachingRulesRequest
|
|
928
1330
|
* @return UpdateCachingRulesResponse
|
|
929
1331
|
* @throws OciError when an error occurs
|
|
930
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1332
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/waas/UpdateCachingRules.ts.html |here} to see how to use UpdateCachingRules API.
|
|
931
1333
|
*/
|
|
932
1334
|
updateCachingRules(updateCachingRulesRequest: requests.UpdateCachingRulesRequest): Promise<responses.UpdateCachingRulesResponse>;
|
|
933
1335
|
/**
|
|
@@ -940,26 +1342,29 @@ export declare class WaasClient {
|
|
|
940
1342
|
Any existing CAPTCHA challenges that are not specified with a `key` in the list of CAPTCHA challenges will be deleted upon update.
|
|
941
1343
|
* <p>
|
|
942
1344
|
Query parameters are allowed in CAPTCHA URL.
|
|
1345
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
943
1346
|
* @param UpdateCaptchasRequest
|
|
944
1347
|
* @return UpdateCaptchasResponse
|
|
945
1348
|
* @throws OciError when an error occurs
|
|
946
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1349
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/waas/UpdateCaptchas.ts.html |here} to see how to use UpdateCaptchas API.
|
|
947
1350
|
*/
|
|
948
1351
|
updateCaptchas(updateCaptchasRequest: requests.UpdateCaptchasRequest): Promise<responses.UpdateCaptchasResponse>;
|
|
949
1352
|
/**
|
|
950
1353
|
* It is not possible to update a certificate, only create and delete. Therefore, this operation can only update the display name, freeform tags, and defined tags of a certificate.
|
|
1354
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
951
1355
|
* @param UpdateCertificateRequest
|
|
952
1356
|
* @return UpdateCertificateResponse
|
|
953
1357
|
* @throws OciError when an error occurs
|
|
954
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1358
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/waas/UpdateCertificate.ts.html |here} to see how to use UpdateCertificate API.
|
|
955
1359
|
*/
|
|
956
1360
|
updateCertificate(updateCertificateRequest: requests.UpdateCertificateRequest): Promise<responses.UpdateCertificateResponse>;
|
|
957
1361
|
/**
|
|
958
1362
|
* Updates the configuration of a custom protection rule. Only the fields specified in the request body will be updated; all other properties will remain unchanged.
|
|
1363
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
959
1364
|
* @param UpdateCustomProtectionRuleRequest
|
|
960
1365
|
* @return UpdateCustomProtectionRuleResponse
|
|
961
1366
|
* @throws OciError when an error occurs
|
|
962
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1367
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/waas/UpdateCustomProtectionRule.ts.html |here} to see how to use UpdateCustomProtectionRule API.
|
|
963
1368
|
*/
|
|
964
1369
|
updateCustomProtectionRule(updateCustomProtectionRuleRequest: requests.UpdateCustomProtectionRuleRequest): Promise<responses.UpdateCustomProtectionRuleResponse>;
|
|
965
1370
|
/**
|
|
@@ -968,96 +1373,107 @@ export declare class WaasClient {
|
|
|
968
1373
|
The signature is based on a library of attributes detected via JavaScript listeners; the attributes include OS, screen resolution, fonts, UserAgent, IP address, etc. We are constantly making improvements and considering new libraries to include in our DFC build. We can also exclude attributes from the signature as needed.
|
|
969
1374
|
* <p>
|
|
970
1375
|
DFC collects attributes to generate a hashed signature about a client - if a fingerprint is not possible, then it will result in a block or alert action. Actions can be enforced across multiple devices if they share they have the same fingerprint.
|
|
1376
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
971
1377
|
* @param UpdateDeviceFingerprintChallengeRequest
|
|
972
1378
|
* @return UpdateDeviceFingerprintChallengeResponse
|
|
973
1379
|
* @throws OciError when an error occurs
|
|
974
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1380
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/waas/UpdateDeviceFingerprintChallenge.ts.html |here} to see how to use UpdateDeviceFingerprintChallenge API.
|
|
975
1381
|
*/
|
|
976
1382
|
updateDeviceFingerprintChallenge(updateDeviceFingerprintChallengeRequest: requests.UpdateDeviceFingerprintChallengeRequest): Promise<responses.UpdateDeviceFingerprintChallengeResponse>;
|
|
977
1383
|
/**
|
|
978
1384
|
* Updates the list of good bots in the Web Application Firewall configuration for a policy. Only the fields specified in the request body will be updated, all other configuration properties will remain unchanged.
|
|
979
1385
|
* <p>
|
|
980
1386
|
Good bots allows you to manage access for bots from known providers, such as Google or Baidu. For more information about good bots, see [Bot Management](https://docs.cloud.oracle.com/iaas/Content/WAF/Tasks/botmanagement.htm).
|
|
1387
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
981
1388
|
* @param UpdateGoodBotsRequest
|
|
982
1389
|
* @return UpdateGoodBotsResponse
|
|
983
1390
|
* @throws OciError when an error occurs
|
|
984
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1391
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/waas/UpdateGoodBots.ts.html |here} to see how to use UpdateGoodBots API.
|
|
985
1392
|
*/
|
|
986
1393
|
updateGoodBots(updateGoodBotsRequest: requests.UpdateGoodBotsRequest): Promise<responses.UpdateGoodBotsResponse>;
|
|
987
1394
|
/**
|
|
988
1395
|
* Updates the Human Interaction Challenge (HIC) settings in the Web Application Firewall configuration for a WAAS policy. HIC is a countermeasure that allows the proxy to check the user's browser for various behaviors that distinguish a human presence from a bot.
|
|
1396
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
989
1397
|
* @param UpdateHumanInteractionChallengeRequest
|
|
990
1398
|
* @return UpdateHumanInteractionChallengeResponse
|
|
991
1399
|
* @throws OciError when an error occurs
|
|
992
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1400
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/waas/UpdateHumanInteractionChallenge.ts.html |here} to see how to use UpdateHumanInteractionChallenge API.
|
|
993
1401
|
*/
|
|
994
1402
|
updateHumanInteractionChallenge(updateHumanInteractionChallengeRequest: requests.UpdateHumanInteractionChallengeRequest): Promise<responses.UpdateHumanInteractionChallengeResponse>;
|
|
995
1403
|
/**
|
|
996
1404
|
* Updates the JavaScript challenge settings in the Web Application Firewall configuration for a WAAS policy. JavaScript Challenge validates that the client can accept JavaScript with a binary decision. For more information, see [Bot Management](https://docs.cloud.oracle.com/iaas/Content/WAF/Tasks/botmanagement.htm).
|
|
1405
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
997
1406
|
* @param UpdateJsChallengeRequest
|
|
998
1407
|
* @return UpdateJsChallengeResponse
|
|
999
1408
|
* @throws OciError when an error occurs
|
|
1000
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1409
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/waas/UpdateJsChallenge.ts.html |here} to see how to use UpdateJsChallenge API.
|
|
1001
1410
|
*/
|
|
1002
1411
|
updateJsChallenge(updateJsChallengeRequest: requests.UpdateJsChallengeRequest): Promise<responses.UpdateJsChallengeResponse>;
|
|
1003
1412
|
/**
|
|
1004
1413
|
* Updates the configuration for a WAAS policy. Only the fields specified in the request body will be updated; all other properties will remain unchanged.
|
|
1414
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1005
1415
|
* @param UpdatePolicyConfigRequest
|
|
1006
1416
|
* @return UpdatePolicyConfigResponse
|
|
1007
1417
|
* @throws OciError when an error occurs
|
|
1008
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1418
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/waas/UpdatePolicyConfig.ts.html |here} to see how to use UpdatePolicyConfig API.
|
|
1009
1419
|
*/
|
|
1010
1420
|
updatePolicyConfig(updatePolicyConfigRequest: requests.UpdatePolicyConfigRequest): Promise<responses.UpdatePolicyConfigResponse>;
|
|
1011
1421
|
/**
|
|
1012
1422
|
* Updates the action for each specified protection rule. Requests can either be allowed, blocked, or trigger an alert if they meet the parameters of an applied rule. For more information on protection rules, see [WAF Protection Rules](https://docs.cloud.oracle.com/iaas/Content/WAF/Tasks/wafprotectionrules.htm).
|
|
1013
1423
|
* This operation can update or disable protection rules depending on the structure of the request body.
|
|
1014
1424
|
* Protection rules can be updated by changing the properties of the protection rule object with the rule's key specified in the key field.
|
|
1425
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1015
1426
|
* @param UpdateProtectionRulesRequest
|
|
1016
1427
|
* @return UpdateProtectionRulesResponse
|
|
1017
1428
|
* @throws OciError when an error occurs
|
|
1018
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1429
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/waas/UpdateProtectionRules.ts.html |here} to see how to use UpdateProtectionRules API.
|
|
1019
1430
|
*/
|
|
1020
1431
|
updateProtectionRules(updateProtectionRulesRequest: requests.UpdateProtectionRulesRequest): Promise<responses.UpdateProtectionRulesResponse>;
|
|
1021
1432
|
/**
|
|
1022
1433
|
* Updates the protection settings in the Web Application Firewall configuration for a WAAS policy. Protection settings allow you define what action is taken when a request is blocked by the Web Application Firewall, such as returning a response code or block page. Only the fields specified in the request body will be updated; all other fields will remain unchanged.
|
|
1434
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1023
1435
|
* @param UpdateProtectionSettingsRequest
|
|
1024
1436
|
* @return UpdateProtectionSettingsResponse
|
|
1025
1437
|
* @throws OciError when an error occurs
|
|
1026
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1438
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/waas/UpdateProtectionSettings.ts.html |here} to see how to use UpdateProtectionSettings API.
|
|
1027
1439
|
*/
|
|
1028
1440
|
updateProtectionSettings(updateProtectionSettingsRequest: requests.UpdateProtectionSettingsRequest): Promise<responses.UpdateProtectionSettingsResponse>;
|
|
1029
1441
|
/**
|
|
1030
1442
|
* Updates the action to take when a request's IP address matches an address in the specified threat intelligence feed. Threat intelligence feeds are compiled lists of IP addresses with malicious reputations based on internet intelligence. Only the threat feeds specified in the request body will be updated; all other threat feeds will remain unchanged.
|
|
1443
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1031
1444
|
* @param UpdateThreatFeedsRequest
|
|
1032
1445
|
* @return UpdateThreatFeedsResponse
|
|
1033
1446
|
* @throws OciError when an error occurs
|
|
1034
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1447
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/waas/UpdateThreatFeeds.ts.html |here} to see how to use UpdateThreatFeeds API.
|
|
1035
1448
|
*/
|
|
1036
1449
|
updateThreatFeeds(updateThreatFeedsRequest: requests.UpdateThreatFeedsRequest): Promise<responses.UpdateThreatFeedsResponse>;
|
|
1037
1450
|
/**
|
|
1038
1451
|
* Updates the details of a WAAS policy, including origins and tags. Only the fields specified in the request body will be updated; all other properties will remain unchanged.
|
|
1039
1452
|
* To update platform provided resources such as `GoodBots`, `ProtectionRules`, and `ThreatFeeds`, first retrieve the list of available resources with the related list operation such as `GetThreatFeeds` or `GetProtectionRules`.
|
|
1040
1453
|
* The returned list will contain objects with `key` properties that can be used to update the resource during the `UpdateWaasPolicy` request.
|
|
1454
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1041
1455
|
* @param UpdateWaasPolicyRequest
|
|
1042
1456
|
* @return UpdateWaasPolicyResponse
|
|
1043
1457
|
* @throws OciError when an error occurs
|
|
1044
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1458
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/waas/UpdateWaasPolicy.ts.html |here} to see how to use UpdateWaasPolicy API.
|
|
1045
1459
|
*/
|
|
1046
1460
|
updateWaasPolicy(updateWaasPolicyRequest: requests.UpdateWaasPolicyRequest): Promise<responses.UpdateWaasPolicyResponse>;
|
|
1047
1461
|
/**
|
|
1048
1462
|
* Updates the action for each specified custom protection rule. Only the `DETECT` and `BLOCK` actions can be set. Disabled rules should not be included in the list. For more information on protection rules, see [WAF Protection Rules](https://docs.cloud.oracle.com/iaas/Content/WAF/Tasks/wafprotectionrules.htm).
|
|
1463
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1049
1464
|
* @param UpdateWaasPolicyCustomProtectionRulesRequest
|
|
1050
1465
|
* @return UpdateWaasPolicyCustomProtectionRulesResponse
|
|
1051
1466
|
* @throws OciError when an error occurs
|
|
1052
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1467
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/waas/UpdateWaasPolicyCustomProtectionRules.ts.html |here} to see how to use UpdateWaasPolicyCustomProtectionRules API.
|
|
1053
1468
|
*/
|
|
1054
1469
|
updateWaasPolicyCustomProtectionRules(updateWaasPolicyCustomProtectionRulesRequest: requests.UpdateWaasPolicyCustomProtectionRulesRequest): Promise<responses.UpdateWaasPolicyCustomProtectionRulesResponse>;
|
|
1055
1470
|
/**
|
|
1056
1471
|
* Updates the address rate limiting settings in the Web Application Firewall configuration for a policy. Rate limiting allows you to configure a threshold for the number of requests from a unique IP address for the given period. You can also define the response code for the requests from the same address that exceed the threshold.
|
|
1472
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1057
1473
|
* @param UpdateWafAddressRateLimitingRequest
|
|
1058
1474
|
* @return UpdateWafAddressRateLimitingResponse
|
|
1059
1475
|
* @throws OciError when an error occurs
|
|
1060
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1476
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/waas/UpdateWafAddressRateLimiting.ts.html |here} to see how to use UpdateWafAddressRateLimiting API.
|
|
1061
1477
|
*/
|
|
1062
1478
|
updateWafAddressRateLimiting(updateWafAddressRateLimitingRequest: requests.UpdateWafAddressRateLimitingRequest): Promise<responses.UpdateWafAddressRateLimitingResponse>;
|
|
1063
1479
|
/**
|
|
@@ -1070,10 +1486,11 @@ export declare class WaasClient {
|
|
|
1070
1486
|
The returned list will contain objects with `key` properties that can be used to update the
|
|
1071
1487
|
* resource during the `UpdateWafConfig` request.
|
|
1072
1488
|
*
|
|
1489
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1073
1490
|
* @param UpdateWafConfigRequest
|
|
1074
1491
|
* @return UpdateWafConfigResponse
|
|
1075
1492
|
* @throws OciError when an error occurs
|
|
1076
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1493
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/waas/UpdateWafConfig.ts.html |here} to see how to use UpdateWafConfig API.
|
|
1077
1494
|
*/
|
|
1078
1495
|
updateWafConfig(updateWafConfigRequest: requests.UpdateWafConfigRequest): Promise<responses.UpdateWafConfigResponse>;
|
|
1079
1496
|
/**
|
|
@@ -1086,10 +1503,11 @@ export declare class WaasClient {
|
|
|
1086
1503
|
Whitelists can be created by adding a new whitelist object to the list without a `key` property specified. A `key` will be generated for the new whitelist upon update.
|
|
1087
1504
|
* <p>
|
|
1088
1505
|
Whitelists can be deleted by removing the existing whitelist object from the list. Any existing whitelists that are not specified with a `key` in the list of access rules will be deleted upon update.
|
|
1506
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1089
1507
|
* @param UpdateWhitelistsRequest
|
|
1090
1508
|
* @return UpdateWhitelistsResponse
|
|
1091
1509
|
* @throws OciError when an error occurs
|
|
1092
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1510
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/waas/UpdateWhitelists.ts.html |here} to see how to use UpdateWhitelists API.
|
|
1093
1511
|
*/
|
|
1094
1512
|
updateWhitelists(updateWhitelistsRequest: requests.UpdateWhitelistsRequest): Promise<responses.UpdateWhitelistsResponse>;
|
|
1095
1513
|
}
|