oci-healthchecks 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 +122 -17
- package/lib/client.js +183 -34
- package/lib/client.js.map +1 -1
- package/lib/request/change-http-monitor-compartment-request.d.ts +1 -1
- package/lib/request/change-ping-monitor-compartment-request.d.ts +1 -1
- package/lib/request/create-http-monitor-request.d.ts +1 -1
- package/lib/request/create-on-demand-http-probe-request.d.ts +1 -1
- package/lib/request/create-on-demand-ping-probe-request.d.ts +1 -1
- package/lib/request/create-ping-monitor-request.d.ts +1 -1
- package/lib/request/delete-http-monitor-request.d.ts +1 -1
- package/lib/request/delete-ping-monitor-request.d.ts +1 -1
- package/lib/request/get-http-monitor-request.d.ts +1 -1
- package/lib/request/get-ping-monitor-request.d.ts +1 -1
- package/lib/request/list-health-checks-vantage-points-request.d.ts +1 -1
- package/lib/request/list-http-monitors-request.d.ts +1 -1
- package/lib/request/list-http-probe-results-request.d.ts +1 -1
- package/lib/request/list-ping-monitors-request.d.ts +1 -1
- package/lib/request/list-ping-probe-results-request.d.ts +1 -1
- package/lib/request/update-http-monitor-request.d.ts +1 -1
- package/lib/request/update-ping-monitor-request.d.ts +1 -1
- package/package.json +3 -3
package/LICENSE.txt
CHANGED
|
@@ -1,3 +1,9 @@
|
|
|
1
|
+
Copyright (c) 2016, 2018, Oracle and/or its affiliates. All rights reserved.
|
|
2
|
+
|
|
3
|
+
This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 or Apache License 2.0. See below for license terms. You may choose either license.
|
|
4
|
+
|
|
5
|
+
____________________________
|
|
6
|
+
|
|
1
7
|
The Universal Permissive License (UPL), Version 1.0
|
|
2
8
|
|
|
3
9
|
Subject to the condition set forth below, permission is hereby granted to any
|
package/lib/client.d.ts
CHANGED
|
@@ -19,6 +19,9 @@ import * as model from "./model";
|
|
|
19
19
|
import * as responses from "./response";
|
|
20
20
|
export declare enum HealthChecksApiKeys {
|
|
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 HealthChecksClient {
|
|
23
26
|
protected static serviceEndpointTemplate: string;
|
|
24
27
|
protected "_endpoint": string;
|
|
@@ -56,20 +59,22 @@ export declare class HealthChecksClient {
|
|
|
56
59
|
* Moves a monitor into a different compartment. When provided, `If-Match` is checked
|
|
57
60
|
* against ETag values of the resource.
|
|
58
61
|
*
|
|
62
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
59
63
|
* @param ChangeHttpMonitorCompartmentRequest
|
|
60
64
|
* @return ChangeHttpMonitorCompartmentResponse
|
|
61
65
|
* @throws OciError when an error occurs
|
|
62
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
66
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/healthchecks/ChangeHttpMonitorCompartment.ts.html |here} to see how to use ChangeHttpMonitorCompartment API.
|
|
63
67
|
*/
|
|
64
68
|
changeHttpMonitorCompartment(changeHttpMonitorCompartmentRequest: requests.ChangeHttpMonitorCompartmentRequest): Promise<responses.ChangeHttpMonitorCompartmentResponse>;
|
|
65
69
|
/**
|
|
66
70
|
* Moves a monitor into a different compartment. When provided, `If-Match` is checked
|
|
67
71
|
* against ETag values of the resource.
|
|
68
72
|
*
|
|
73
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
69
74
|
* @param ChangePingMonitorCompartmentRequest
|
|
70
75
|
* @return ChangePingMonitorCompartmentResponse
|
|
71
76
|
* @throws OciError when an error occurs
|
|
72
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
77
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/healthchecks/ChangePingMonitorCompartment.ts.html |here} to see how to use ChangePingMonitorCompartment API.
|
|
73
78
|
*/
|
|
74
79
|
changePingMonitorCompartment(changePingMonitorCompartmentRequest: requests.ChangePingMonitorCompartmentRequest): Promise<responses.ChangePingMonitorCompartmentResponse>;
|
|
75
80
|
/**
|
|
@@ -77,10 +82,11 @@ export declare class HealthChecksClient {
|
|
|
77
82
|
* and probes will be initiated from each vantage point to each of the targets at the frequency
|
|
78
83
|
* specified by `intervalInSeconds`.
|
|
79
84
|
*
|
|
85
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
80
86
|
* @param CreateHttpMonitorRequest
|
|
81
87
|
* @return CreateHttpMonitorResponse
|
|
82
88
|
* @throws OciError when an error occurs
|
|
83
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
89
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/healthchecks/CreateHttpMonitor.ts.html |here} to see how to use CreateHttpMonitor API.
|
|
84
90
|
*/
|
|
85
91
|
createHttpMonitor(createHttpMonitorRequest: requests.CreateHttpMonitorRequest): Promise<responses.CreateHttpMonitorResponse>;
|
|
86
92
|
/**
|
|
@@ -89,10 +95,11 @@ export declare class HealthChecksClient {
|
|
|
89
95
|
* <p>
|
|
90
96
|
*Note:* On-demand probe configurations are not saved.
|
|
91
97
|
*
|
|
98
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
92
99
|
* @param CreateOnDemandHttpProbeRequest
|
|
93
100
|
* @return CreateOnDemandHttpProbeResponse
|
|
94
101
|
* @throws OciError when an error occurs
|
|
95
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
102
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/healthchecks/CreateOnDemandHttpProbe.ts.html |here} to see how to use CreateOnDemandHttpProbe API.
|
|
96
103
|
*/
|
|
97
104
|
createOnDemandHttpProbe(createOnDemandHttpProbeRequest: requests.CreateOnDemandHttpProbeRequest): Promise<responses.CreateOnDemandHttpProbeResponse>;
|
|
98
105
|
/**
|
|
@@ -101,10 +108,11 @@ export declare class HealthChecksClient {
|
|
|
101
108
|
* <p>
|
|
102
109
|
*Note:* The on-demand probe configuration is not saved.
|
|
103
110
|
*
|
|
111
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
104
112
|
* @param CreateOnDemandPingProbeRequest
|
|
105
113
|
* @return CreateOnDemandPingProbeResponse
|
|
106
114
|
* @throws OciError when an error occurs
|
|
107
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
115
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/healthchecks/CreateOnDemandPingProbe.ts.html |here} to see how to use CreateOnDemandPingProbe API.
|
|
108
116
|
*/
|
|
109
117
|
createOnDemandPingProbe(createOnDemandPingProbeRequest: requests.CreateOnDemandPingProbeRequest): Promise<responses.CreateOnDemandPingProbeResponse>;
|
|
110
118
|
/**
|
|
@@ -112,60 +120,67 @@ export declare class HealthChecksClient {
|
|
|
112
120
|
* and probes will be initiated from each vantage point to each of the targets at the frequency
|
|
113
121
|
* specified by `intervalInSeconds`.
|
|
114
122
|
*
|
|
123
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
115
124
|
* @param CreatePingMonitorRequest
|
|
116
125
|
* @return CreatePingMonitorResponse
|
|
117
126
|
* @throws OciError when an error occurs
|
|
118
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
127
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/healthchecks/CreatePingMonitor.ts.html |here} to see how to use CreatePingMonitor API.
|
|
119
128
|
*/
|
|
120
129
|
createPingMonitor(createPingMonitorRequest: requests.CreatePingMonitorRequest): Promise<responses.CreatePingMonitorResponse>;
|
|
121
130
|
/**
|
|
122
131
|
* Deletes the HTTP monitor and its configuration. All future probes of this
|
|
123
132
|
* monitor are stopped. Results associated with the monitor are not deleted.
|
|
124
133
|
*
|
|
134
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
125
135
|
* @param DeleteHttpMonitorRequest
|
|
126
136
|
* @return DeleteHttpMonitorResponse
|
|
127
137
|
* @throws OciError when an error occurs
|
|
128
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
138
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/healthchecks/DeleteHttpMonitor.ts.html |here} to see how to use DeleteHttpMonitor API.
|
|
129
139
|
*/
|
|
130
140
|
deleteHttpMonitor(deleteHttpMonitorRequest: requests.DeleteHttpMonitorRequest): Promise<responses.DeleteHttpMonitorResponse>;
|
|
131
141
|
/**
|
|
132
142
|
* Deletes the ping monitor and its configuration. All future probes of this
|
|
133
143
|
* monitor are stopped. Results associated with the monitor are not deleted.
|
|
134
144
|
*
|
|
145
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
135
146
|
* @param DeletePingMonitorRequest
|
|
136
147
|
* @return DeletePingMonitorResponse
|
|
137
148
|
* @throws OciError when an error occurs
|
|
138
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
149
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/healthchecks/DeletePingMonitor.ts.html |here} to see how to use DeletePingMonitor API.
|
|
139
150
|
*/
|
|
140
151
|
deletePingMonitor(deletePingMonitorRequest: requests.DeletePingMonitorRequest): Promise<responses.DeletePingMonitorResponse>;
|
|
141
152
|
/**
|
|
142
153
|
* Gets the configuration for the specified monitor.
|
|
143
154
|
*
|
|
155
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
144
156
|
* @param GetHttpMonitorRequest
|
|
145
157
|
* @return GetHttpMonitorResponse
|
|
146
158
|
* @throws OciError when an error occurs
|
|
147
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
159
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/healthchecks/GetHttpMonitor.ts.html |here} to see how to use GetHttpMonitor API.
|
|
148
160
|
*/
|
|
149
161
|
getHttpMonitor(getHttpMonitorRequest: requests.GetHttpMonitorRequest): Promise<responses.GetHttpMonitorResponse>;
|
|
150
162
|
/**
|
|
151
163
|
* Gets the configuration for the specified ping monitor.
|
|
152
164
|
*
|
|
165
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
153
166
|
* @param GetPingMonitorRequest
|
|
154
167
|
* @return GetPingMonitorResponse
|
|
155
168
|
* @throws OciError when an error occurs
|
|
156
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
169
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/healthchecks/GetPingMonitor.ts.html |here} to see how to use GetPingMonitor API.
|
|
157
170
|
*/
|
|
158
171
|
getPingMonitor(getPingMonitorRequest: requests.GetPingMonitorRequest): Promise<responses.GetPingMonitorResponse>;
|
|
159
172
|
/**
|
|
160
173
|
* Gets information about all vantage points available to the user.
|
|
161
174
|
*
|
|
175
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
162
176
|
* @param ListHealthChecksVantagePointsRequest
|
|
163
177
|
* @return ListHealthChecksVantagePointsResponse
|
|
164
178
|
* @throws OciError when an error occurs
|
|
165
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
179
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/healthchecks/ListHealthChecksVantagePoints.ts.html |here} to see how to use ListHealthChecksVantagePoints API.
|
|
166
180
|
*/
|
|
167
181
|
listHealthChecksVantagePoints(listHealthChecksVantagePointsRequest: requests.ListHealthChecksVantagePointsRequest): Promise<responses.ListHealthChecksVantagePointsResponse>;
|
|
168
182
|
/**
|
|
183
|
+
* NOTE: This function is deprecated in favor of listHealthChecksVantagePointsRecordIterator function.
|
|
169
184
|
* Creates a new async iterator which will iterate over the models.HealthChecksVantagePointSummary objects
|
|
170
185
|
* contained in responses from the listHealthChecksVantagePoints operation. This iterator will fetch more data from the
|
|
171
186
|
* server as needed.
|
|
@@ -174,22 +189,40 @@ export declare class HealthChecksClient {
|
|
|
174
189
|
*/
|
|
175
190
|
listAllHealthChecksVantagePoints(request: requests.ListHealthChecksVantagePointsRequest): AsyncIterableIterator<model.HealthChecksVantagePointSummary>;
|
|
176
191
|
/**
|
|
192
|
+
* NOTE: This function is deprecated in favor of listHealthChecksVantagePointsResponseIterator function.
|
|
177
193
|
* Creates a new async iterator which will iterate over the responses received from the listHealthChecksVantagePoints operation. This iterator
|
|
178
194
|
* will fetch more data from the server as needed.
|
|
179
195
|
*
|
|
180
196
|
* @param request a request which can be sent to the service operation
|
|
181
197
|
*/
|
|
182
198
|
listAllHealthChecksVantagePointsResponses(request: requests.ListHealthChecksVantagePointsRequest): AsyncIterableIterator<responses.ListHealthChecksVantagePointsResponse>;
|
|
199
|
+
/**
|
|
200
|
+
* Creates a new async iterator which will iterate over the models.HealthChecksVantagePointSummary objects
|
|
201
|
+
* contained in responses from the listHealthChecksVantagePoints operation. This iterator will fetch more data from the
|
|
202
|
+
* server as needed.
|
|
203
|
+
*
|
|
204
|
+
* @param request a request which can be sent to the service operation
|
|
205
|
+
*/
|
|
206
|
+
listHealthChecksVantagePointsRecordIterator(request: requests.ListHealthChecksVantagePointsRequest): AsyncIterableIterator<model.HealthChecksVantagePointSummary>;
|
|
207
|
+
/**
|
|
208
|
+
* Creates a new async iterator which will iterate over the responses received from the listHealthChecksVantagePoints operation. This iterator
|
|
209
|
+
* will fetch more data from the server as needed.
|
|
210
|
+
*
|
|
211
|
+
* @param request a request which can be sent to the service operation
|
|
212
|
+
*/
|
|
213
|
+
listHealthChecksVantagePointsResponseIterator(request: requests.ListHealthChecksVantagePointsRequest): AsyncIterableIterator<responses.ListHealthChecksVantagePointsResponse>;
|
|
183
214
|
/**
|
|
184
215
|
* Gets a list of HTTP monitors.
|
|
185
216
|
*
|
|
217
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
186
218
|
* @param ListHttpMonitorsRequest
|
|
187
219
|
* @return ListHttpMonitorsResponse
|
|
188
220
|
* @throws OciError when an error occurs
|
|
189
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
221
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/healthchecks/ListHttpMonitors.ts.html |here} to see how to use ListHttpMonitors API.
|
|
190
222
|
*/
|
|
191
223
|
listHttpMonitors(listHttpMonitorsRequest: requests.ListHttpMonitorsRequest): Promise<responses.ListHttpMonitorsResponse>;
|
|
192
224
|
/**
|
|
225
|
+
* NOTE: This function is deprecated in favor of listHttpMonitorsRecordIterator function.
|
|
193
226
|
* Creates a new async iterator which will iterate over the models.HttpMonitorSummary objects
|
|
194
227
|
* contained in responses from the listHttpMonitors operation. This iterator will fetch more data from the
|
|
195
228
|
* server as needed.
|
|
@@ -198,24 +231,42 @@ export declare class HealthChecksClient {
|
|
|
198
231
|
*/
|
|
199
232
|
listAllHttpMonitors(request: requests.ListHttpMonitorsRequest): AsyncIterableIterator<model.HttpMonitorSummary>;
|
|
200
233
|
/**
|
|
234
|
+
* NOTE: This function is deprecated in favor of listHttpMonitorsResponseIterator function.
|
|
201
235
|
* Creates a new async iterator which will iterate over the responses received from the listHttpMonitors operation. This iterator
|
|
202
236
|
* will fetch more data from the server as needed.
|
|
203
237
|
*
|
|
204
238
|
* @param request a request which can be sent to the service operation
|
|
205
239
|
*/
|
|
206
240
|
listAllHttpMonitorsResponses(request: requests.ListHttpMonitorsRequest): AsyncIterableIterator<responses.ListHttpMonitorsResponse>;
|
|
241
|
+
/**
|
|
242
|
+
* Creates a new async iterator which will iterate over the models.HttpMonitorSummary objects
|
|
243
|
+
* contained in responses from the listHttpMonitors operation. This iterator will fetch more data from the
|
|
244
|
+
* server as needed.
|
|
245
|
+
*
|
|
246
|
+
* @param request a request which can be sent to the service operation
|
|
247
|
+
*/
|
|
248
|
+
listHttpMonitorsRecordIterator(request: requests.ListHttpMonitorsRequest): AsyncIterableIterator<model.HttpMonitorSummary>;
|
|
249
|
+
/**
|
|
250
|
+
* Creates a new async iterator which will iterate over the responses received from the listHttpMonitors operation. This iterator
|
|
251
|
+
* will fetch more data from the server as needed.
|
|
252
|
+
*
|
|
253
|
+
* @param request a request which can be sent to the service operation
|
|
254
|
+
*/
|
|
255
|
+
listHttpMonitorsResponseIterator(request: requests.ListHttpMonitorsRequest): AsyncIterableIterator<responses.ListHttpMonitorsResponse>;
|
|
207
256
|
/**
|
|
208
257
|
* Gets the HTTP probe results for the specified probe or monitor, where
|
|
209
258
|
* the `probeConfigurationId` is the OCID of either a monitor or an
|
|
210
259
|
* on-demand probe.
|
|
211
260
|
*
|
|
261
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
212
262
|
* @param ListHttpProbeResultsRequest
|
|
213
263
|
* @return ListHttpProbeResultsResponse
|
|
214
264
|
* @throws OciError when an error occurs
|
|
215
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
265
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/healthchecks/ListHttpProbeResults.ts.html |here} to see how to use ListHttpProbeResults API.
|
|
216
266
|
*/
|
|
217
267
|
listHttpProbeResults(listHttpProbeResultsRequest: requests.ListHttpProbeResultsRequest): Promise<responses.ListHttpProbeResultsResponse>;
|
|
218
268
|
/**
|
|
269
|
+
* NOTE: This function is deprecated in favor of listHttpProbeResultsRecordIterator function.
|
|
219
270
|
* Creates a new async iterator which will iterate over the models.HttpProbeResultSummary objects
|
|
220
271
|
* contained in responses from the listHttpProbeResults operation. This iterator will fetch more data from the
|
|
221
272
|
* server as needed.
|
|
@@ -224,25 +275,43 @@ export declare class HealthChecksClient {
|
|
|
224
275
|
*/
|
|
225
276
|
listAllHttpProbeResults(request: requests.ListHttpProbeResultsRequest): AsyncIterableIterator<model.HttpProbeResultSummary>;
|
|
226
277
|
/**
|
|
278
|
+
* NOTE: This function is deprecated in favor of listHttpProbeResultsResponseIterator function.
|
|
227
279
|
* Creates a new async iterator which will iterate over the responses received from the listHttpProbeResults operation. This iterator
|
|
228
280
|
* will fetch more data from the server as needed.
|
|
229
281
|
*
|
|
230
282
|
* @param request a request which can be sent to the service operation
|
|
231
283
|
*/
|
|
232
284
|
listAllHttpProbeResultsResponses(request: requests.ListHttpProbeResultsRequest): AsyncIterableIterator<responses.ListHttpProbeResultsResponse>;
|
|
285
|
+
/**
|
|
286
|
+
* Creates a new async iterator which will iterate over the models.HttpProbeResultSummary objects
|
|
287
|
+
* contained in responses from the listHttpProbeResults operation. This iterator will fetch more data from the
|
|
288
|
+
* server as needed.
|
|
289
|
+
*
|
|
290
|
+
* @param request a request which can be sent to the service operation
|
|
291
|
+
*/
|
|
292
|
+
listHttpProbeResultsRecordIterator(request: requests.ListHttpProbeResultsRequest): AsyncIterableIterator<model.HttpProbeResultSummary>;
|
|
293
|
+
/**
|
|
294
|
+
* Creates a new async iterator which will iterate over the responses received from the listHttpProbeResults operation. This iterator
|
|
295
|
+
* will fetch more data from the server as needed.
|
|
296
|
+
*
|
|
297
|
+
* @param request a request which can be sent to the service operation
|
|
298
|
+
*/
|
|
299
|
+
listHttpProbeResultsResponseIterator(request: requests.ListHttpProbeResultsRequest): AsyncIterableIterator<responses.ListHttpProbeResultsResponse>;
|
|
233
300
|
/**
|
|
234
301
|
* Gets a list of configured ping monitors.
|
|
235
302
|
* <p>
|
|
236
303
|
Results are paginated based on `page` and `limit`. The `opc-next-page` header provides
|
|
237
304
|
* a URL for fetching the next page.
|
|
238
305
|
*
|
|
306
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
239
307
|
* @param ListPingMonitorsRequest
|
|
240
308
|
* @return ListPingMonitorsResponse
|
|
241
309
|
* @throws OciError when an error occurs
|
|
242
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
310
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/healthchecks/ListPingMonitors.ts.html |here} to see how to use ListPingMonitors API.
|
|
243
311
|
*/
|
|
244
312
|
listPingMonitors(listPingMonitorsRequest: requests.ListPingMonitorsRequest): Promise<responses.ListPingMonitorsResponse>;
|
|
245
313
|
/**
|
|
314
|
+
* NOTE: This function is deprecated in favor of listPingMonitorsRecordIterator function.
|
|
246
315
|
* Creates a new async iterator which will iterate over the models.PingMonitorSummary objects
|
|
247
316
|
* contained in responses from the listPingMonitors operation. This iterator will fetch more data from the
|
|
248
317
|
* server as needed.
|
|
@@ -251,12 +320,28 @@ export declare class HealthChecksClient {
|
|
|
251
320
|
*/
|
|
252
321
|
listAllPingMonitors(request: requests.ListPingMonitorsRequest): AsyncIterableIterator<model.PingMonitorSummary>;
|
|
253
322
|
/**
|
|
323
|
+
* NOTE: This function is deprecated in favor of listPingMonitorsResponseIterator function.
|
|
254
324
|
* Creates a new async iterator which will iterate over the responses received from the listPingMonitors operation. This iterator
|
|
255
325
|
* will fetch more data from the server as needed.
|
|
256
326
|
*
|
|
257
327
|
* @param request a request which can be sent to the service operation
|
|
258
328
|
*/
|
|
259
329
|
listAllPingMonitorsResponses(request: requests.ListPingMonitorsRequest): AsyncIterableIterator<responses.ListPingMonitorsResponse>;
|
|
330
|
+
/**
|
|
331
|
+
* Creates a new async iterator which will iterate over the models.PingMonitorSummary objects
|
|
332
|
+
* contained in responses from the listPingMonitors operation. This iterator will fetch more data from the
|
|
333
|
+
* server as needed.
|
|
334
|
+
*
|
|
335
|
+
* @param request a request which can be sent to the service operation
|
|
336
|
+
*/
|
|
337
|
+
listPingMonitorsRecordIterator(request: requests.ListPingMonitorsRequest): AsyncIterableIterator<model.PingMonitorSummary>;
|
|
338
|
+
/**
|
|
339
|
+
* Creates a new async iterator which will iterate over the responses received from the listPingMonitors operation. This iterator
|
|
340
|
+
* will fetch more data from the server as needed.
|
|
341
|
+
*
|
|
342
|
+
* @param request a request which can be sent to the service operation
|
|
343
|
+
*/
|
|
344
|
+
listPingMonitorsResponseIterator(request: requests.ListPingMonitorsRequest): AsyncIterableIterator<responses.ListPingMonitorsResponse>;
|
|
260
345
|
/**
|
|
261
346
|
* Returns the results for the specified probe, where the `probeConfigurationId`
|
|
262
347
|
* is the OCID of either a monitor or an on-demand probe.
|
|
@@ -266,13 +351,15 @@ export declare class HealthChecksClient {
|
|
|
266
351
|
* results. If `sortOrder` is unspecified, results are sorted in ascending order by
|
|
267
352
|
* `startTime`.
|
|
268
353
|
*
|
|
354
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
269
355
|
* @param ListPingProbeResultsRequest
|
|
270
356
|
* @return ListPingProbeResultsResponse
|
|
271
357
|
* @throws OciError when an error occurs
|
|
272
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
358
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/healthchecks/ListPingProbeResults.ts.html |here} to see how to use ListPingProbeResults API.
|
|
273
359
|
*/
|
|
274
360
|
listPingProbeResults(listPingProbeResultsRequest: requests.ListPingProbeResultsRequest): Promise<responses.ListPingProbeResultsResponse>;
|
|
275
361
|
/**
|
|
362
|
+
* NOTE: This function is deprecated in favor of listPingProbeResultsRecordIterator function.
|
|
276
363
|
* Creates a new async iterator which will iterate over the models.PingProbeResultSummary objects
|
|
277
364
|
* contained in responses from the listPingProbeResults operation. This iterator will fetch more data from the
|
|
278
365
|
* server as needed.
|
|
@@ -281,21 +368,38 @@ export declare class HealthChecksClient {
|
|
|
281
368
|
*/
|
|
282
369
|
listAllPingProbeResults(request: requests.ListPingProbeResultsRequest): AsyncIterableIterator<model.PingProbeResultSummary>;
|
|
283
370
|
/**
|
|
371
|
+
* NOTE: This function is deprecated in favor of listPingProbeResultsResponseIterator function.
|
|
284
372
|
* Creates a new async iterator which will iterate over the responses received from the listPingProbeResults operation. This iterator
|
|
285
373
|
* will fetch more data from the server as needed.
|
|
286
374
|
*
|
|
287
375
|
* @param request a request which can be sent to the service operation
|
|
288
376
|
*/
|
|
289
377
|
listAllPingProbeResultsResponses(request: requests.ListPingProbeResultsRequest): AsyncIterableIterator<responses.ListPingProbeResultsResponse>;
|
|
378
|
+
/**
|
|
379
|
+
* Creates a new async iterator which will iterate over the models.PingProbeResultSummary objects
|
|
380
|
+
* contained in responses from the listPingProbeResults operation. This iterator will fetch more data from the
|
|
381
|
+
* server as needed.
|
|
382
|
+
*
|
|
383
|
+
* @param request a request which can be sent to the service operation
|
|
384
|
+
*/
|
|
385
|
+
listPingProbeResultsRecordIterator(request: requests.ListPingProbeResultsRequest): AsyncIterableIterator<model.PingProbeResultSummary>;
|
|
386
|
+
/**
|
|
387
|
+
* Creates a new async iterator which will iterate over the responses received from the listPingProbeResults operation. This iterator
|
|
388
|
+
* will fetch more data from the server as needed.
|
|
389
|
+
*
|
|
390
|
+
* @param request a request which can be sent to the service operation
|
|
391
|
+
*/
|
|
392
|
+
listPingProbeResultsResponseIterator(request: requests.ListPingProbeResultsRequest): AsyncIterableIterator<responses.ListPingProbeResultsResponse>;
|
|
290
393
|
/**
|
|
291
394
|
* Updates the configuration of the specified HTTP monitor. Only the fields
|
|
292
395
|
* specified in the request body will be updated; all other configuration
|
|
293
396
|
* properties will remain unchanged.
|
|
294
397
|
*
|
|
398
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
295
399
|
* @param UpdateHttpMonitorRequest
|
|
296
400
|
* @return UpdateHttpMonitorResponse
|
|
297
401
|
* @throws OciError when an error occurs
|
|
298
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
402
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/healthchecks/UpdateHttpMonitor.ts.html |here} to see how to use UpdateHttpMonitor API.
|
|
299
403
|
*/
|
|
300
404
|
updateHttpMonitor(updateHttpMonitorRequest: requests.UpdateHttpMonitorRequest): Promise<responses.UpdateHttpMonitorResponse>;
|
|
301
405
|
/**
|
|
@@ -303,10 +407,11 @@ export declare class HealthChecksClient {
|
|
|
303
407
|
* specified in the request body will be updated; all other configuration properties
|
|
304
408
|
* will remain unchanged.
|
|
305
409
|
*
|
|
410
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
306
411
|
* @param UpdatePingMonitorRequest
|
|
307
412
|
* @return UpdatePingMonitorResponse
|
|
308
413
|
* @throws OciError when an error occurs
|
|
309
|
-
* @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/healthchecks/UpdatePingMonitor.ts.html |here} to see how to use UpdatePingMonitor API.
|
|
310
415
|
*/
|
|
311
416
|
updatePingMonitor(updatePingMonitorRequest: requests.UpdatePingMonitorRequest): Promise<responses.UpdatePingMonitorResponse>;
|
|
312
417
|
}
|