oci-monitoring 2.71.0 → 2.73.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.
Files changed (107) hide show
  1. package/index.d.ts +2 -1
  2. package/index.js +2 -1
  3. package/index.js.map +1 -1
  4. package/lib/client.d.ts +92 -48
  5. package/lib/client.js +98 -50
  6. package/lib/client.js.map +1 -1
  7. package/lib/model/aggregated-datapoint.d.ts +2 -1
  8. package/lib/model/aggregated-datapoint.js +2 -1
  9. package/lib/model/aggregated-datapoint.js.map +1 -1
  10. package/lib/model/alarm-dimension-states-collection.d.ts +4 -3
  11. package/lib/model/alarm-dimension-states-collection.js +2 -1
  12. package/lib/model/alarm-dimension-states-collection.js.map +1 -1
  13. package/lib/model/alarm-dimension-states-entry.d.ts +2 -1
  14. package/lib/model/alarm-dimension-states-entry.js +2 -1
  15. package/lib/model/alarm-dimension-states-entry.js.map +1 -1
  16. package/lib/model/alarm-history-collection.d.ts +3 -2
  17. package/lib/model/alarm-history-collection.js +2 -1
  18. package/lib/model/alarm-history-collection.js.map +1 -1
  19. package/lib/model/alarm-history-entry.d.ts +2 -1
  20. package/lib/model/alarm-history-entry.js +2 -1
  21. package/lib/model/alarm-history-entry.js.map +1 -1
  22. package/lib/model/alarm-status-summary.d.ts +12 -11
  23. package/lib/model/alarm-status-summary.js +2 -1
  24. package/lib/model/alarm-status-summary.js.map +1 -1
  25. package/lib/model/alarm-summary.d.ts +19 -11
  26. package/lib/model/alarm-summary.js +2 -1
  27. package/lib/model/alarm-summary.js.map +1 -1
  28. package/lib/model/alarm.d.ts +27 -19
  29. package/lib/model/alarm.js +2 -1
  30. package/lib/model/alarm.js.map +1 -1
  31. package/lib/model/change-alarm-compartment-details.d.ts +2 -1
  32. package/lib/model/change-alarm-compartment-details.js +2 -1
  33. package/lib/model/change-alarm-compartment-details.js.map +1 -1
  34. package/lib/model/create-alarm-details.d.ts +23 -16
  35. package/lib/model/create-alarm-details.js +2 -1
  36. package/lib/model/create-alarm-details.js.map +1 -1
  37. package/lib/model/datapoint.d.ts +3 -1
  38. package/lib/model/datapoint.js +2 -1
  39. package/lib/model/datapoint.js.map +1 -1
  40. package/lib/model/failed-metric-record.d.ts +2 -1
  41. package/lib/model/failed-metric-record.js +2 -1
  42. package/lib/model/failed-metric-record.js.map +1 -1
  43. package/lib/model/index.d.ts +2 -1
  44. package/lib/model/index.js +2 -1
  45. package/lib/model/index.js.map +1 -1
  46. package/lib/model/list-metrics-details.d.ts +3 -1
  47. package/lib/model/list-metrics-details.js +2 -1
  48. package/lib/model/list-metrics-details.js.map +1 -1
  49. package/lib/model/metric-data-details.d.ts +3 -1
  50. package/lib/model/metric-data-details.js +2 -1
  51. package/lib/model/metric-data-details.js.map +1 -1
  52. package/lib/model/metric-data.d.ts +8 -5
  53. package/lib/model/metric-data.js +2 -1
  54. package/lib/model/metric-data.js.map +1 -1
  55. package/lib/model/metric.d.ts +4 -2
  56. package/lib/model/metric.js +2 -1
  57. package/lib/model/metric.js.map +1 -1
  58. package/lib/model/post-metric-data-details.d.ts +2 -1
  59. package/lib/model/post-metric-data-details.js +2 -1
  60. package/lib/model/post-metric-data-details.js.map +1 -1
  61. package/lib/model/post-metric-data-response-details.d.ts +2 -1
  62. package/lib/model/post-metric-data-response-details.js +2 -1
  63. package/lib/model/post-metric-data-response-details.js.map +1 -1
  64. package/lib/model/retrieve-dimension-states-details.d.ts +2 -1
  65. package/lib/model/retrieve-dimension-states-details.js +2 -1
  66. package/lib/model/retrieve-dimension-states-details.js.map +1 -1
  67. package/lib/model/summarize-metrics-data-details.d.ts +5 -4
  68. package/lib/model/summarize-metrics-data-details.js +2 -1
  69. package/lib/model/summarize-metrics-data-details.js.map +1 -1
  70. package/lib/model/suppression.d.ts +4 -2
  71. package/lib/model/suppression.js +2 -1
  72. package/lib/model/suppression.js.map +1 -1
  73. package/lib/model/update-alarm-details.d.ts +23 -17
  74. package/lib/model/update-alarm-details.js +2 -1
  75. package/lib/model/update-alarm-details.js.map +1 -1
  76. package/lib/monitoring-waiter.d.ts +2 -1
  77. package/lib/monitoring-waiter.js +2 -1
  78. package/lib/monitoring-waiter.js.map +1 -1
  79. package/lib/request/change-alarm-compartment-request.d.ts +1 -1
  80. package/lib/request/create-alarm-request.d.ts +1 -1
  81. package/lib/request/delete-alarm-request.d.ts +1 -1
  82. package/lib/request/get-alarm-history-request.d.ts +5 -3
  83. package/lib/request/get-alarm-history-request.js.map +1 -1
  84. package/lib/request/get-alarm-request.d.ts +1 -1
  85. package/lib/request/index.d.ts +2 -1
  86. package/lib/request/index.js +2 -1
  87. package/lib/request/index.js.map +1 -1
  88. package/lib/request/list-alarms-request.d.ts +5 -3
  89. package/lib/request/list-alarms-request.js.map +1 -1
  90. package/lib/request/list-alarms-status-request.d.ts +42 -3
  91. package/lib/request/list-alarms-status-request.js +5 -0
  92. package/lib/request/list-alarms-status-request.js.map +1 -1
  93. package/lib/request/list-metrics-request.d.ts +5 -3
  94. package/lib/request/post-metric-data-request.d.ts +1 -1
  95. package/lib/request/remove-alarm-suppression-request.d.ts +1 -1
  96. package/lib/request/retrieve-dimension-states-request.d.ts +5 -3
  97. package/lib/request/summarize-metrics-data-request.d.ts +1 -1
  98. package/lib/request/update-alarm-request.d.ts +1 -1
  99. package/lib/response/get-alarm-history-response.d.ts +2 -1
  100. package/lib/response/index.d.ts +2 -1
  101. package/lib/response/index.js +2 -1
  102. package/lib/response/index.js.map +1 -1
  103. package/lib/response/list-alarms-response.d.ts +2 -1
  104. package/lib/response/list-alarms-status-response.d.ts +2 -1
  105. package/lib/response/list-metrics-response.d.ts +2 -1
  106. package/lib/response/retrieve-dimension-states-response.d.ts +2 -1
  107. package/package.json +3 -3
package/index.d.ts CHANGED
@@ -2,7 +2,8 @@
2
2
  * Monitoring API
3
3
  * Use the Monitoring API to manage metric queries and alarms for assessing the health, capacity, and performance of your cloud resources.
4
4
  Endpoints vary by operation. For PostMetric, use the `telemetry-ingestion` endpoints; for all other operations, use the `telemetry` endpoints.
5
- For information about monitoring, see [Monitoring Overview](/iaas/Content/Monitoring/Concepts/monitoringoverview.htm).
5
+ For more information, see
6
+ [the Monitoring documentation](/iaas/Content/Monitoring/home.htm).
6
7
 
7
8
  * OpenAPI spec version: 20180401
8
9
  *
package/index.js CHANGED
@@ -3,7 +3,8 @@
3
3
  * Monitoring API
4
4
  * Use the Monitoring API to manage metric queries and alarms for assessing the health, capacity, and performance of your cloud resources.
5
5
  Endpoints vary by operation. For PostMetric, use the `telemetry-ingestion` endpoints; for all other operations, use the `telemetry` endpoints.
6
- For information about monitoring, see [Monitoring Overview](/iaas/Content/Monitoring/Concepts/monitoringoverview.htm).
6
+ For more information, see
7
+ [the Monitoring documentation](/iaas/Content/Monitoring/home.htm).
7
8
 
8
9
  * OpenAPI spec version: 20180401
9
10
  *
package/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../lib/monitoring/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;;;;;;;;;;;;;;;;;;;;AAEH,wDAA0C;AAOjC,4BAAQ;AANjB,oDAAsC;AAK7B,wBAAM;AAJf,0DAA4C;AAMnC,8BAAS;AALlB,qDAAuC;AACvC,2EAA6D;AAK/C,QAAA,gBAAgB,GAAG,MAAM,CAAC,gBAAgB,CAAC;AAC3C,QAAA,gBAAgB,GAAG,iBAAiB,CAAC,gBAAgB,CAAC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../lib/monitoring/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;GAeG;;;;;;;;;;;;;;;;;;;;;;AAEH,wDAA0C;AAOjC,4BAAQ;AANjB,oDAAsC;AAK7B,wBAAM;AAJf,0DAA4C;AAMnC,8BAAS;AALlB,qDAAuC;AACvC,2EAA6D;AAK/C,QAAA,gBAAgB,GAAG,MAAM,CAAC,gBAAgB,CAAC;AAC3C,QAAA,gBAAgB,GAAG,iBAAiB,CAAC,gBAAgB,CAAC"}
package/lib/client.d.ts CHANGED
@@ -2,7 +2,8 @@
2
2
  * Monitoring API
3
3
  * Use the Monitoring API to manage metric queries and alarms for assessing the health, capacity, and performance of your cloud resources.
4
4
  Endpoints vary by operation. For PostMetric, use the `telemetry-ingestion` endpoints; for all other operations, use the `telemetry` endpoints.
5
- For information about monitoring, see [Monitoring Overview](/iaas/Content/Monitoring/Concepts/monitoringoverview.htm).
5
+ For more information, see
6
+ [the Monitoring documentation](/iaas/Content/Monitoring/home.htm).
6
7
 
7
8
  * OpenAPI spec version: 20180401
8
9
  *
@@ -85,20 +86,23 @@ export declare class MonitoringClient {
85
86
  */
86
87
  getWaiters(): MonitoringWaiter;
87
88
  /**
88
- * Moves an alarm into a different compartment within the same tenancy.
89
- * <p>
90
- For information about moving resources between compartments, see [Moving Resources Between Compartments](https://docs.cloud.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).
91
- *
92
- * This operation does not retry by default if the user has not defined a retry configuration.
93
- * @param ChangeAlarmCompartmentRequest
94
- * @return ChangeAlarmCompartmentResponse
95
- * @throws OciError when an error occurs
96
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.71.0/monitoring/ChangeAlarmCompartment.ts.html |here} to see how to use ChangeAlarmCompartment API.
97
- */
89
+ * Moves an alarm into a different compartment within the same tenancy.
90
+ * For more information, see
91
+ * [Moving an Alarm](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/change-compartment-alarm.htm).
92
+ *
93
+ * This operation does not retry by default if the user has not defined a retry configuration.
94
+ * @param ChangeAlarmCompartmentRequest
95
+ * @return ChangeAlarmCompartmentResponse
96
+ * @throws OciError when an error occurs
97
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.73.0/monitoring/ChangeAlarmCompartment.ts.html |here} to see how to use ChangeAlarmCompartment API.
98
+ */
98
99
  changeAlarmCompartment(changeAlarmCompartmentRequest: requests.ChangeAlarmCompartmentRequest): Promise<responses.ChangeAlarmCompartmentResponse>;
99
100
  /**
100
101
  * Creates a new alarm in the specified compartment.
101
- * For important limits information, see [Limits on Monitoring](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#Limits).
102
+ * For more information, see
103
+ * [Creating an Alarm](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/create-alarm.htm).
104
+ * For important limits information, see
105
+ * [Limits on Monitoring](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits).
102
106
  * <p>
103
107
  This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations.
104
108
  * Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests,
@@ -108,12 +112,15 @@ export declare class MonitoringClient {
108
112
  * @param CreateAlarmRequest
109
113
  * @return CreateAlarmResponse
110
114
  * @throws OciError when an error occurs
111
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.71.0/monitoring/CreateAlarm.ts.html |here} to see how to use CreateAlarm API.
115
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.73.0/monitoring/CreateAlarm.ts.html |here} to see how to use CreateAlarm API.
112
116
  */
113
117
  createAlarm(createAlarmRequest: requests.CreateAlarmRequest): Promise<responses.CreateAlarmResponse>;
114
118
  /**
115
119
  * Deletes the specified alarm.
116
- * For important limits information, see [Limits on Monitoring](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#Limits).
120
+ * For more information, see
121
+ * [Deleting an Alarm](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/delete-alarm.htm).
122
+ * For important limits information, see
123
+ * [Limits on Monitoring](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits).
117
124
  * <p>
118
125
  This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations.
119
126
  * Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests,
@@ -123,12 +130,15 @@ export declare class MonitoringClient {
123
130
  * @param DeleteAlarmRequest
124
131
  * @return DeleteAlarmResponse
125
132
  * @throws OciError when an error occurs
126
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.71.0/monitoring/DeleteAlarm.ts.html |here} to see how to use DeleteAlarm API.
133
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.73.0/monitoring/DeleteAlarm.ts.html |here} to see how to use DeleteAlarm API.
127
134
  */
128
135
  deleteAlarm(deleteAlarmRequest: requests.DeleteAlarmRequest): Promise<responses.DeleteAlarmResponse>;
129
136
  /**
130
137
  * Gets the specified alarm.
131
- * For important limits information, see [Limits on Monitoring](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#Limits).
138
+ * For more information, see
139
+ * [Getting an Alarm](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/get-alarm.htm).
140
+ * For important limits information, see
141
+ * [Limits on Monitoring](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits).
132
142
  * <p>
133
143
  This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations.
134
144
  * Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests,
@@ -138,12 +148,15 @@ export declare class MonitoringClient {
138
148
  * @param GetAlarmRequest
139
149
  * @return GetAlarmResponse
140
150
  * @throws OciError when an error occurs
141
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.71.0/monitoring/GetAlarm.ts.html |here} to see how to use GetAlarm API.
151
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.73.0/monitoring/GetAlarm.ts.html |here} to see how to use GetAlarm API.
142
152
  */
143
153
  getAlarm(getAlarmRequest: requests.GetAlarmRequest): Promise<responses.GetAlarmResponse>;
144
154
  /**
145
155
  * Get the history of the specified alarm.
146
- * For important limits information, see [Limits on Monitoring](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#Limits).
156
+ * For more information, see
157
+ * [Getting History of an Alarm](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/get-alarm-history.htm).
158
+ * For important limits information, see
159
+ * [Limits on Monitoring](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits).
147
160
  * <p>
148
161
  This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations.
149
162
  * Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests,
@@ -153,12 +166,15 @@ export declare class MonitoringClient {
153
166
  * @param GetAlarmHistoryRequest
154
167
  * @return GetAlarmHistoryResponse
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.71.0/monitoring/GetAlarmHistory.ts.html |here} to see how to use GetAlarmHistory API.
169
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.73.0/monitoring/GetAlarmHistory.ts.html |here} to see how to use GetAlarmHistory API.
157
170
  */
158
171
  getAlarmHistory(getAlarmHistoryRequest: requests.GetAlarmHistoryRequest): Promise<responses.GetAlarmHistoryResponse>;
159
172
  /**
160
173
  * Lists the alarms for the specified compartment.
161
- * For important limits information, see [Limits on Monitoring](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#Limits).
174
+ * For more information, see
175
+ * [Listing Alarms](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/list-alarm.htm).
176
+ * For important limits information, see
177
+ * [Limits on Monitoring](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits).
162
178
  * <p>
163
179
  This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations.
164
180
  * Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests,
@@ -168,7 +184,7 @@ export declare class MonitoringClient {
168
184
  * @param ListAlarmsRequest
169
185
  * @return ListAlarmsResponse
170
186
  * @throws OciError when an error occurs
171
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.71.0/monitoring/ListAlarms.ts.html |here} to see how to use ListAlarms API.
187
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.73.0/monitoring/ListAlarms.ts.html |here} to see how to use ListAlarms API.
172
188
  */
173
189
  listAlarms(listAlarmsRequest: requests.ListAlarmsRequest): Promise<responses.ListAlarmsResponse>;
174
190
  /**
@@ -207,18 +223,20 @@ export declare class MonitoringClient {
207
223
  * List the status of each alarm in the specified compartment.
208
224
  * Status is collective, across all metric streams in the alarm.
209
225
  * To list alarm status for each metric stream, use {@link #retrieveDimensionStates(RetrieveDimensionStatesRequest) retrieveDimensionStates}.
210
- * The alarm attribute `isNotificationsPerMetricDimensionEnabled` must be set to `true`.
211
- * For important limits information, see [Limits on Monitoring](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#Limits).
226
+ * For more information, see
227
+ * [Listing Alarm Statuses](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/list-alarm-status.htm).
228
+ * For important limits information, see
229
+ * [Limits on Monitoring](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits).
212
230
  * <p>
213
231
  This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations.
214
232
  * Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests,
215
233
  * or transactions, per second (TPS) for a given tenancy.
216
234
  *
217
- * This operation does not retry by default if the user has not defined a retry configuration.
235
+ * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
218
236
  * @param ListAlarmsStatusRequest
219
237
  * @return ListAlarmsStatusResponse
220
238
  * @throws OciError when an error occurs
221
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.71.0/monitoring/ListAlarmsStatus.ts.html |here} to see how to use ListAlarmsStatus API.
239
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.73.0/monitoring/ListAlarmsStatus.ts.html |here} to see how to use ListAlarmsStatus API.
222
240
  */
223
241
  listAlarmsStatus(listAlarmsStatusRequest: requests.ListAlarmsStatusRequest): Promise<responses.ListAlarmsStatusResponse>;
224
242
  /**
@@ -255,8 +273,12 @@ export declare class MonitoringClient {
255
273
  listAlarmsStatusResponseIterator(request: requests.ListAlarmsStatusRequest): AsyncIterableIterator<responses.ListAlarmsStatusResponse>;
256
274
  /**
257
275
  * Returns metric definitions that match the criteria specified in the request. Compartment OCID required.
258
- * For information about metrics, see [Metrics Overview](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#MetricsOverview).
259
- * For important limits information, see [Limits on Monitoring](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#Limits).
276
+ * For more information, see
277
+ * [Listing Metric Definitions](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/list-metric.htm).
278
+ * For information about metrics, see
279
+ * [Metrics Overview](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#MetricsOverview).
280
+ * For important limits information, see
281
+ * [Limits on Monitoring](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits).
260
282
  * <p>
261
283
  Transactions Per Second (TPS) per-tenancy limit for this operation: 10.
262
284
  *
@@ -264,7 +286,7 @@ export declare class MonitoringClient {
264
286
  * @param ListMetricsRequest
265
287
  * @return ListMetricsResponse
266
288
  * @throws OciError when an error occurs
267
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.71.0/monitoring/ListMetrics.ts.html |here} to see how to use ListMetrics API.
289
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.73.0/monitoring/ListMetrics.ts.html |here} to see how to use ListMetrics API.
268
290
  */
269
291
  listMetrics(listMetricsRequest: requests.ListMetricsRequest): Promise<responses.ListMetricsResponse>;
270
292
  /**
@@ -301,8 +323,18 @@ export declare class MonitoringClient {
301
323
  listMetricsResponseIterator(request: requests.ListMetricsRequest): AsyncIterableIterator<responses.ListMetricsResponse>;
302
324
  /**
303
325
  * Publishes raw metric data points to the Monitoring service.
304
- * For more information about publishing metrics, see [Publishing Custom Metrics](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/publishingcustommetrics.htm).
305
- * For important limits information, see [Limits on Monitoring](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#Limits).
326
+ * For a data point to be posted, its timestamp must be near current time (less than two hours in the past and less than 10 minutes in the future).
327
+ * <p>
328
+ For more information about publishing metrics, see
329
+ * [Publishing Custom Metrics](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/publishingcustommetrics.htm)
330
+ * and
331
+ * [Custom Metrics Walkthrough](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/custom-metrics-walkthrough.htm).
332
+ * For information about developing a metric-posting client, see
333
+ * [Developer Guide](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/devtoolslanding.htm).
334
+ * For an example client, see
335
+ * [MonitoringMetricPostExample.java](https://github.com/oracle/oci-java-sdk/blob/master/bmc-examples/src/main/java/MonitoringMetricPostExample.java).
336
+ * For important limits information, see
337
+ * [Limits on Monitoring](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits).
306
338
  * <p>
307
339
  Per-call limits information follows.
308
340
  * <p>
@@ -313,9 +345,10 @@ export declare class MonitoringClient {
313
345
  *A metric group is the combination of a given metric, metric namespace, and tenancy for the purpose of determining limits.
314
346
  * A dimension is a qualifier provided in a metric definition.
315
347
  * A metric stream is an individual set of aggregated data for a metric with zero or more dimension values.
316
- * For more information about metric-related concepts, see [Monitoring Concepts](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#concepts).
348
+ * For more information about metric-related concepts, see
349
+ * [Monitoring Concepts](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#concepts).
317
350
  * <p>
318
- The endpoints for this operation differ from other Monitoring operations. Replace the string `telemetry` with `telemetry-ingestion` in the endpoint, as in the following example:
351
+ **Note:** The endpoints for this operation differ from other Monitoring operations. Replace the string `telemetry` with `telemetry-ingestion` in the endpoint, as in the following example:
319
352
  * <p>
320
353
  https://telemetry-ingestion.eu-frankfurt-1.oraclecloud.com
321
354
  *
@@ -323,12 +356,15 @@ export declare class MonitoringClient {
323
356
  * @param PostMetricDataRequest
324
357
  * @return PostMetricDataResponse
325
358
  * @throws OciError when an error occurs
326
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.71.0/monitoring/PostMetricData.ts.html |here} to see how to use PostMetricData API.
359
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.73.0/monitoring/PostMetricData.ts.html |here} to see how to use PostMetricData API.
327
360
  */
328
361
  postMetricData(postMetricDataRequest: requests.PostMetricDataRequest): Promise<responses.PostMetricDataResponse>;
329
362
  /**
330
363
  * Removes any existing suppression for the specified alarm.
331
- * For important limits information, see [Limits on Monitoring](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#Limits).
364
+ * For more information, see
365
+ * [Removing Suppression from an Alarm](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/remove-alarm-suppression.htm).
366
+ * For important limits information, see
367
+ * [Limits on Monitoring](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits).
332
368
  * <p>
333
369
  This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations.
334
370
  * Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests,
@@ -338,32 +374,37 @@ export declare class MonitoringClient {
338
374
  * @param RemoveAlarmSuppressionRequest
339
375
  * @return RemoveAlarmSuppressionResponse
340
376
  * @throws OciError when an error occurs
341
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.71.0/monitoring/RemoveAlarmSuppression.ts.html |here} to see how to use RemoveAlarmSuppression API.
377
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.73.0/monitoring/RemoveAlarmSuppression.ts.html |here} to see how to use RemoveAlarmSuppression API.
342
378
  */
343
379
  removeAlarmSuppression(removeAlarmSuppressionRequest: requests.RemoveAlarmSuppressionRequest): Promise<responses.RemoveAlarmSuppressionResponse>;
344
380
  /**
345
381
  * Lists the current alarm status of each metric stream, where status is derived from the metric stream's last associated transition.
346
382
  * Optionally filter by status value and one or more dimension key-value pairs.
347
- * This operation is only valid for alarms that have notifications per dimension enabled (`isNotificationsPerMetricDimensionEnabled=true`).
348
- * If `isNotificationsPerMetricDimensionEnabled` for the alarm is false or null, then no results are returned.
383
+ * For more information, see
384
+ * [Listing Metric Stream Status in an Alarm](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/list-alarm-status-metric-stream.htm).
349
385
  * <p>
350
- For important limits information, see [Limits on Monitoring](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#Limits).
351
- *
352
- * This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations.
353
- * Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests,
354
- * or transactions, per second (TPS) for a given tenancy.
386
+ For important limits information, see
387
+ * [Limits on Monitoring](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits).
388
+ * <p>
389
+ This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations.
390
+ * Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests,
391
+ * or transactions, per second (TPS) for a given tenancy.
355
392
  *
356
393
  * This operation does not retry by default if the user has not defined a retry configuration.
357
394
  * @param RetrieveDimensionStatesRequest
358
395
  * @return RetrieveDimensionStatesResponse
359
396
  * @throws OciError when an error occurs
360
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.71.0/monitoring/RetrieveDimensionStates.ts.html |here} to see how to use RetrieveDimensionStates API.
397
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.73.0/monitoring/RetrieveDimensionStates.ts.html |here} to see how to use RetrieveDimensionStates API.
361
398
  */
362
399
  retrieveDimensionStates(retrieveDimensionStatesRequest: requests.RetrieveDimensionStatesRequest): Promise<responses.RetrieveDimensionStatesResponse>;
363
400
  /**
364
401
  * Returns aggregated data that match the criteria specified in the request. Compartment OCID required.
365
- * For information on metric queries, see [Building Metric Queries](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/buildingqueries.htm).
366
- * For important limits information, see [Limits on Monitoring](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#Limits).
402
+ * For more information, see
403
+ * [Querying Metric Data](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/query-metric-landing.htm)
404
+ * and
405
+ * [Creating a Query](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/query-metric.htm).
406
+ * For important limits information, see
407
+ * [Limits on Monitoring](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits).
367
408
  * <p>
368
409
  Transactions Per Second (TPS) per-tenancy limit for this operation: 10.
369
410
  *
@@ -371,12 +412,15 @@ export declare class MonitoringClient {
371
412
  * @param SummarizeMetricsDataRequest
372
413
  * @return SummarizeMetricsDataResponse
373
414
  * @throws OciError when an error occurs
374
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.71.0/monitoring/SummarizeMetricsData.ts.html |here} to see how to use SummarizeMetricsData API.
415
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.73.0/monitoring/SummarizeMetricsData.ts.html |here} to see how to use SummarizeMetricsData API.
375
416
  */
376
417
  summarizeMetricsData(summarizeMetricsDataRequest: requests.SummarizeMetricsDataRequest): Promise<responses.SummarizeMetricsDataResponse>;
377
418
  /**
378
419
  * Updates the specified alarm.
379
- * For important limits information, see [Limits on Monitoring](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#Limits).
420
+ * For more information, see
421
+ * [Updating an Alarm](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/update-alarm.htm).
422
+ * For important limits information, see
423
+ * [Limits on Monitoring](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits).
380
424
  * <p>
381
425
  This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations.
382
426
  * Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests,
@@ -386,7 +430,7 @@ export declare class MonitoringClient {
386
430
  * @param UpdateAlarmRequest
387
431
  * @return UpdateAlarmResponse
388
432
  * @throws OciError when an error occurs
389
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.71.0/monitoring/UpdateAlarm.ts.html |here} to see how to use UpdateAlarm API.
433
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.73.0/monitoring/UpdateAlarm.ts.html |here} to see how to use UpdateAlarm API.
390
434
  */
391
435
  updateAlarm(updateAlarmRequest: requests.UpdateAlarmRequest): Promise<responses.UpdateAlarmResponse>;
392
436
  }