oci-monitoring
Advanced tools
Comparing version 2.3.1 to 2.4.0
@@ -78,3 +78,3 @@ /** | ||
* @throws OciError when an error occurs | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.3.1/monitoring/ChangeAlarmCompartment.ts.html |here} to see how to use ChangeAlarmCompartment API. | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.4.0/monitoring/ChangeAlarmCompartment.ts.html |here} to see how to use ChangeAlarmCompartment API. | ||
*/ | ||
@@ -93,3 +93,3 @@ changeAlarmCompartment(changeAlarmCompartmentRequest: requests.ChangeAlarmCompartmentRequest): Promise<responses.ChangeAlarmCompartmentResponse>; | ||
* @throws OciError when an error occurs | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.3.1/monitoring/CreateAlarm.ts.html |here} to see how to use CreateAlarm API. | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.4.0/monitoring/CreateAlarm.ts.html |here} to see how to use CreateAlarm API. | ||
*/ | ||
@@ -108,3 +108,3 @@ createAlarm(createAlarmRequest: requests.CreateAlarmRequest): Promise<responses.CreateAlarmResponse>; | ||
* @throws OciError when an error occurs | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.3.1/monitoring/DeleteAlarm.ts.html |here} to see how to use DeleteAlarm API. | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.4.0/monitoring/DeleteAlarm.ts.html |here} to see how to use DeleteAlarm API. | ||
*/ | ||
@@ -123,3 +123,3 @@ deleteAlarm(deleteAlarmRequest: requests.DeleteAlarmRequest): Promise<responses.DeleteAlarmResponse>; | ||
* @throws OciError when an error occurs | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.3.1/monitoring/GetAlarm.ts.html |here} to see how to use GetAlarm API. | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.4.0/monitoring/GetAlarm.ts.html |here} to see how to use GetAlarm API. | ||
*/ | ||
@@ -138,3 +138,3 @@ getAlarm(getAlarmRequest: requests.GetAlarmRequest): Promise<responses.GetAlarmResponse>; | ||
* @throws OciError when an error occurs | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.3.1/monitoring/GetAlarmHistory.ts.html |here} to see how to use GetAlarmHistory API. | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.4.0/monitoring/GetAlarmHistory.ts.html |here} to see how to use GetAlarmHistory API. | ||
*/ | ||
@@ -153,3 +153,3 @@ getAlarmHistory(getAlarmHistoryRequest: requests.GetAlarmHistoryRequest): Promise<responses.GetAlarmHistoryResponse>; | ||
* @throws OciError when an error occurs | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.3.1/monitoring/ListAlarms.ts.html |here} to see how to use ListAlarms API. | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.4.0/monitoring/ListAlarms.ts.html |here} to see how to use ListAlarms API. | ||
*/ | ||
@@ -183,3 +183,3 @@ listAlarms(listAlarmsRequest: requests.ListAlarmsRequest): Promise<responses.ListAlarmsResponse>; | ||
* @throws OciError when an error occurs | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.3.1/monitoring/ListAlarmsStatus.ts.html |here} to see how to use ListAlarmsStatus API. | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.4.0/monitoring/ListAlarmsStatus.ts.html |here} to see how to use ListAlarmsStatus API. | ||
*/ | ||
@@ -212,3 +212,3 @@ listAlarmsStatus(listAlarmsStatusRequest: requests.ListAlarmsStatusRequest): Promise<responses.ListAlarmsStatusResponse>; | ||
* @throws OciError when an error occurs | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.3.1/monitoring/ListMetrics.ts.html |here} to see how to use ListMetrics API. | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.4.0/monitoring/ListMetrics.ts.html |here} to see how to use ListMetrics API. | ||
*/ | ||
@@ -254,3 +254,3 @@ listMetrics(listMetricsRequest: requests.ListMetricsRequest): Promise<responses.ListMetricsResponse>; | ||
* @throws OciError when an error occurs | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.3.1/monitoring/PostMetricData.ts.html |here} to see how to use PostMetricData API. | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.4.0/monitoring/PostMetricData.ts.html |here} to see how to use PostMetricData API. | ||
*/ | ||
@@ -269,3 +269,3 @@ postMetricData(postMetricDataRequest: requests.PostMetricDataRequest): Promise<responses.PostMetricDataResponse>; | ||
* @throws OciError when an error occurs | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.3.1/monitoring/RemoveAlarmSuppression.ts.html |here} to see how to use RemoveAlarmSuppression API. | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.4.0/monitoring/RemoveAlarmSuppression.ts.html |here} to see how to use RemoveAlarmSuppression API. | ||
*/ | ||
@@ -283,3 +283,3 @@ removeAlarmSuppression(removeAlarmSuppressionRequest: requests.RemoveAlarmSuppressionRequest): Promise<responses.RemoveAlarmSuppressionResponse>; | ||
* @throws OciError when an error occurs | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.3.1/monitoring/SummarizeMetricsData.ts.html |here} to see how to use SummarizeMetricsData API. | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.4.0/monitoring/SummarizeMetricsData.ts.html |here} to see how to use SummarizeMetricsData API. | ||
*/ | ||
@@ -298,5 +298,5 @@ summarizeMetricsData(summarizeMetricsDataRequest: requests.SummarizeMetricsDataRequest): Promise<responses.SummarizeMetricsDataResponse>; | ||
* @throws OciError when an error occurs | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.3.1/monitoring/UpdateAlarm.ts.html |here} to see how to use UpdateAlarm API. | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.4.0/monitoring/UpdateAlarm.ts.html |here} to see how to use UpdateAlarm API. | ||
*/ | ||
updateAlarm(updateAlarmRequest: requests.UpdateAlarmRequest): Promise<responses.UpdateAlarmResponse>; | ||
} |
@@ -149,3 +149,3 @@ "use strict"; | ||
* @throws OciError when an error occurs | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.3.1/monitoring/ChangeAlarmCompartment.ts.html |here} to see how to use ChangeAlarmCompartment API. | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.4.0/monitoring/ChangeAlarmCompartment.ts.html |here} to see how to use ChangeAlarmCompartment API. | ||
*/ | ||
@@ -209,3 +209,3 @@ changeAlarmCompartment(changeAlarmCompartmentRequest) { | ||
* @throws OciError when an error occurs | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.3.1/monitoring/CreateAlarm.ts.html |here} to see how to use CreateAlarm API. | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.4.0/monitoring/CreateAlarm.ts.html |here} to see how to use CreateAlarm API. | ||
*/ | ||
@@ -275,3 +275,3 @@ createAlarm(createAlarmRequest) { | ||
* @throws OciError when an error occurs | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.3.1/monitoring/DeleteAlarm.ts.html |here} to see how to use DeleteAlarm API. | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.4.0/monitoring/DeleteAlarm.ts.html |here} to see how to use DeleteAlarm API. | ||
*/ | ||
@@ -333,3 +333,3 @@ deleteAlarm(deleteAlarmRequest) { | ||
* @throws OciError when an error occurs | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.3.1/monitoring/GetAlarm.ts.html |here} to see how to use GetAlarm API. | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.4.0/monitoring/GetAlarm.ts.html |here} to see how to use GetAlarm API. | ||
*/ | ||
@@ -399,3 +399,3 @@ getAlarm(getAlarmRequest) { | ||
* @throws OciError when an error occurs | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.3.1/monitoring/GetAlarmHistory.ts.html |here} to see how to use GetAlarmHistory API. | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.4.0/monitoring/GetAlarmHistory.ts.html |here} to see how to use GetAlarmHistory API. | ||
*/ | ||
@@ -471,3 +471,3 @@ getAlarmHistory(getAlarmHistoryRequest) { | ||
* @throws OciError when an error occurs | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.3.1/monitoring/ListAlarms.ts.html |here} to see how to use ListAlarms API. | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.4.0/monitoring/ListAlarms.ts.html |here} to see how to use ListAlarms API. | ||
*/ | ||
@@ -563,3 +563,3 @@ listAlarms(listAlarmsRequest) { | ||
* @throws OciError when an error occurs | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.3.1/monitoring/ListAlarmsStatus.ts.html |here} to see how to use ListAlarmsStatus API. | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.4.0/monitoring/ListAlarmsStatus.ts.html |here} to see how to use ListAlarmsStatus API. | ||
*/ | ||
@@ -653,3 +653,3 @@ listAlarmsStatus(listAlarmsStatusRequest) { | ||
* @throws OciError when an error occurs | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.3.1/monitoring/ListMetrics.ts.html |here} to see how to use ListMetrics API. | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.4.0/monitoring/ListMetrics.ts.html |here} to see how to use ListMetrics API. | ||
*/ | ||
@@ -754,3 +754,3 @@ listMetrics(listMetricsRequest) { | ||
* @throws OciError when an error occurs | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.3.1/monitoring/PostMetricData.ts.html |here} to see how to use PostMetricData API. | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.4.0/monitoring/PostMetricData.ts.html |here} to see how to use PostMetricData API. | ||
*/ | ||
@@ -814,3 +814,3 @@ postMetricData(postMetricDataRequest) { | ||
* @throws OciError when an error occurs | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.3.1/monitoring/RemoveAlarmSuppression.ts.html |here} to see how to use RemoveAlarmSuppression API. | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.4.0/monitoring/RemoveAlarmSuppression.ts.html |here} to see how to use RemoveAlarmSuppression API. | ||
*/ | ||
@@ -871,3 +871,3 @@ removeAlarmSuppression(removeAlarmSuppressionRequest) { | ||
* @throws OciError when an error occurs | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.3.1/monitoring/SummarizeMetricsData.ts.html |here} to see how to use SummarizeMetricsData API. | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.4.0/monitoring/SummarizeMetricsData.ts.html |here} to see how to use SummarizeMetricsData API. | ||
*/ | ||
@@ -934,3 +934,3 @@ summarizeMetricsData(summarizeMetricsDataRequest) { | ||
* @throws OciError when an error occurs | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.3.1/monitoring/UpdateAlarm.ts.html |here} to see how to use UpdateAlarm API. | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.4.0/monitoring/UpdateAlarm.ts.html |here} to see how to use UpdateAlarm API. | ||
*/ | ||
@@ -937,0 +937,0 @@ updateAlarm(updateAlarmRequest) { |
@@ -23,3 +23,3 @@ /** | ||
/** | ||
* Description for this alarm history entry. Avoid entering confidential information. | ||
* Description for this alarm history entry. | ||
* <p> | ||
@@ -26,0 +26,0 @@ Example 1 - alarm state history entry: `The alarm state is FIRING` |
@@ -52,2 +52,3 @@ /** | ||
* Timestamp for the transition of the alarm state. For example, the time when the alarm transitioned from OK to Firing. | ||
* Note: A three-minute lag for this value accounts for any late-arriving metrics. | ||
* <p> | ||
@@ -54,0 +55,0 @@ Example: `2019-02-01T01:02:29.600Z` |
@@ -38,3 +38,2 @@ /** | ||
* A user-friendly name for the alarm. It does not have to be unique, and it's changeable. | ||
* Avoid entering confidential information. | ||
* <p> | ||
@@ -70,4 +69,4 @@ This name is sent as the title for notifications related to this alarm. | ||
* rule condition has been met. The query must specify a metric, statistic, interval, and trigger | ||
* rule (threshold or absence). Supported values for interval: `1m`-`60m` (also `1h`). You can optionally | ||
* specify dimensions and grouping functions. Supported grouping functions: `grouping()`, `groupBy()`. | ||
* rule (threshold or absence). Supported values for interval depend on the specified time range. More | ||
* interval values are supported for smaller time ranges. Supported grouping functions: `grouping()`, `groupBy()`. | ||
* For details about Monitoring Query Language (MQL), see [Monitoring Query Language (MQL) Reference](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Reference/mql.htm). | ||
@@ -74,0 +73,0 @@ * For available dimensions, review the metric definition for the supported service. |
@@ -38,3 +38,2 @@ /** | ||
* A user-friendly name for the alarm. It does not have to be unique, and it's changeable. | ||
* Avoid entering confidential information. | ||
* <p> | ||
@@ -77,5 +76,4 @@ This name is sent as the title for notifications related to this alarm. | ||
/** | ||
* Resource group specified as a filter for metric data retrieved by the alarm. A resource group is a custom string that can be used as a filter. Only one resource group can be applied per metric. | ||
* Resource group to match for metric data retrieved by the alarm. A resource group is a custom string that you can match when retrieving custom metrics. Only one resource group can be applied per metric. | ||
* A valid resourceGroup value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($). | ||
* Avoid entering confidential information. | ||
* <p> | ||
@@ -91,3 +89,4 @@ Example: `frontend-fleet` | ||
* rule condition has been met. The query must specify a metric, statistic, interval, and trigger | ||
* rule (threshold or absence). Supported values for interval: `1m`-`60m` (also `1h`). You can optionally | ||
* rule (threshold or absence). Supported values for interval depend on the specified time range. More | ||
* interval values are supported for smaller time ranges. You can optionally | ||
* specify dimensions and grouping functions. Supported grouping functions: `grouping()`, `groupBy()`. | ||
@@ -150,3 +149,3 @@ * For details about Monitoring Query Language (MQL), see [Monitoring Query Language (MQL) Reference](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Reference/mql.htm). | ||
* to operators for resolving the alarm condition. Consider adding links to standard runbook | ||
* practices. Avoid entering confidential information. | ||
* practices. | ||
* <p> | ||
@@ -158,2 +157,10 @@ Example: `High CPU usage alert. Follow runbook instructions for resolution.` | ||
/** | ||
* The format to use for notification messages sent from this alarm. The formats are: | ||
* * `RAW` - Raw JSON blob. Default value. | ||
* * `PRETTY_JSON`: JSON with new lines and indents. | ||
* * `ONS_OPTIMIZED`: Simplified, user-friendly layout. Applies only to messages sent through the Notifications service to the following subscription types: Email. | ||
* | ||
*/ | ||
"messageFormat"?: Alarm.MessageFormat; | ||
/** | ||
* A list of destinations to which the notifications for this alarm will be delivered. | ||
@@ -241,2 +248,12 @@ * Each destination is represented by an [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) related to the supported destination service. | ||
} | ||
enum MessageFormat { | ||
Raw = "RAW", | ||
PrettyJson = "PRETTY_JSON", | ||
OnsOptimized = "ONS_OPTIMIZED", | ||
/** | ||
* This value is used if a service returns a value for this enum that is not recognized by this | ||
* version of the SDK. | ||
*/ | ||
UnknownValue = "UNKNOWN_VALUE" | ||
} | ||
enum LifecycleState { | ||
@@ -243,0 +260,0 @@ Active = "ACTIVE", |
@@ -53,2 +53,13 @@ "use strict"; | ||
})(Severity = Alarm.Severity || (Alarm.Severity = {})); | ||
let MessageFormat; | ||
(function (MessageFormat) { | ||
MessageFormat["Raw"] = "RAW"; | ||
MessageFormat["PrettyJson"] = "PRETTY_JSON"; | ||
MessageFormat["OnsOptimized"] = "ONS_OPTIMIZED"; | ||
/** | ||
* This value is used if a service returns a value for this enum that is not recognized by this | ||
* version of the SDK. | ||
*/ | ||
MessageFormat["UnknownValue"] = "UNKNOWN_VALUE"; | ||
})(MessageFormat = Alarm.MessageFormat || (Alarm.MessageFormat = {})); | ||
let LifecycleState; | ||
@@ -55,0 +66,0 @@ (function (LifecycleState) { |
@@ -19,4 +19,2 @@ /** | ||
* The configuration details for creating an alarm. | ||
* <p> | ||
**Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. | ||
* | ||
@@ -65,3 +63,3 @@ */ | ||
/** | ||
* Resource group that you want to use as a filter. The alarm retrieves metric data associated with the specified resource group only. Only one resource group can be applied per metric. | ||
* Resource group that you want to match. A null value returns only metric data that has no resource groups. The alarm retrieves metric data associated with the specified resource group only. Only one resource group can be applied per metric. | ||
* A valid resourceGroup value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($). | ||
@@ -79,3 +77,4 @@ * Avoid entering confidential information. | ||
* rule condition has been met. The query must specify a metric, statistic, interval, and trigger | ||
* rule (threshold or absence). Supported values for interval: `1m`-`60m` (also `1h`). You can optionally | ||
* rule (threshold or absence). Supported values for interval depend on the specified time range. More | ||
* interval values are supported for smaller time ranges. You can optionally | ||
* specify dimensions and grouping functions. Supported grouping functions: `grouping()`, `groupBy()`. | ||
@@ -145,2 +144,10 @@ * For details about Monitoring Query Language (MQL), see [Monitoring Query Language (MQL) Reference](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Reference/mql.htm). | ||
/** | ||
* The format to use for notification messages sent from this alarm. The formats are: | ||
* * `RAW` - Raw JSON blob. Default value. | ||
* * `PRETTY_JSON`: JSON with new lines and indents. | ||
* * `ONS_OPTIMIZED`: Simplified, user-friendly layout. Applies only to messages sent through the Notifications service to the following subscription types: Email. | ||
* | ||
*/ | ||
"messageFormat"?: CreateAlarmDetails.MessageFormat; | ||
/** | ||
* A list of destinations to which the notifications for this alarm will be delivered. | ||
@@ -196,4 +203,9 @@ * Each destination is represented by an [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) related to the supported destination service. | ||
export declare namespace CreateAlarmDetails { | ||
enum MessageFormat { | ||
Raw = "RAW", | ||
PrettyJson = "PRETTY_JSON", | ||
OnsOptimized = "ONS_OPTIMIZED" | ||
} | ||
function getJsonObj(obj: CreateAlarmDetails): object; | ||
function getDeserializedJsonObj(obj: CreateAlarmDetails): object; | ||
} |
@@ -41,2 +41,8 @@ "use strict"; | ||
(function (CreateAlarmDetails) { | ||
let MessageFormat; | ||
(function (MessageFormat) { | ||
MessageFormat["Raw"] = "RAW"; | ||
MessageFormat["PrettyJson"] = "PRETTY_JSON"; | ||
MessageFormat["OnsOptimized"] = "ONS_OPTIMIZED"; | ||
})(MessageFormat = CreateAlarmDetails.MessageFormat || (CreateAlarmDetails.MessageFormat = {})); | ||
function getJsonObj(obj) { | ||
@@ -43,0 +49,0 @@ const jsonObj = Object.assign(Object.assign({}, obj), { |
@@ -39,5 +39,4 @@ /** | ||
/** | ||
* Resource group that you want to use as a filter. The specified resource group must exist in the definition of the posted metric. Only one resource group can be applied per metric. | ||
* Resource group that you want to match. A null value returns only metric data that has no resource groups. The specified resource group must exist in the definition of the posted metric. Only one resource group can be applied per metric. | ||
* A valid resourceGroup value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($). | ||
* Avoid entering confidential information. | ||
* <p> | ||
@@ -52,3 +51,3 @@ Example: `frontend-fleet` | ||
* <p> | ||
Example: { \"resourceId\": \"<var><instance_OCID></var>\" } | ||
Example: `\"resourceId\": \"ocid1.instance.region1.phx.exampleuniqueID\"` | ||
* | ||
@@ -55,0 +54,0 @@ */ |
@@ -33,3 +33,3 @@ /** | ||
/** | ||
* Resource group to assign to the metric. A resource group is a custom string that can be used as a filter. Only one resource group can be applied per metric. | ||
* Resource group to assign to the metric. A resource group is a custom string that you can match when retrieving custom metrics. Only one resource group can be applied per metric. | ||
* A valid resourceGroup value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($). | ||
@@ -36,0 +36,0 @@ * Avoid entering confidential information. |
@@ -25,5 +25,6 @@ /** | ||
* * Metric streams* within data points: 2,000. | ||
* * Time range returned for 1-day resolution: 90 days. | ||
* * Time range returned for 1-hour resolution: 90 days. | ||
* * Time range returned for 5-minute resolution: 30 days. | ||
* * Time range returned for any other resolution: 7 days. | ||
* * Time range returned for 1-minute resolution: 7 days. | ||
* <p> | ||
@@ -46,5 +47,4 @@ *A metric stream is an individual set of aggregated data for a metric, typically specific to a single resource. | ||
/** | ||
* Resource group provided with the posted metric. A resource group is a custom string that can be used as a filter. Only one resource group can be applied per metric. | ||
* Resource group provided with the posted metric. A resource group is a custom string that you can match when retrieving custom metrics. Only one resource group can be applied per metric. | ||
* A valid resourceGroup value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($). | ||
* Avoid entering confidential information. | ||
* <p> | ||
@@ -92,3 +92,3 @@ Example: `frontend-fleet` | ||
* frequency. The resolution must be equal or less than the interval in the query. The default | ||
* resolution is 1m (one minute). Supported values: `1m`-`60m` (also `1h`). | ||
* resolution is 1m (one minute). Supported values: `1m`-`60m`, `1h`-`24h`, `1d`. | ||
* <p> | ||
@@ -95,0 +95,0 @@ Example: `5m` |
@@ -37,5 +37,4 @@ /** | ||
/** | ||
* Resource group provided with the posted metric. A resource group is a custom string that can be used as a filter. Only one resource group can be applied per metric. | ||
* Resource group provided with the posted metric. A resource group is a custom string that you can match when retrieving custom metrics. Only one resource group can be applied per metric. | ||
* A valid resourceGroup value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($). | ||
* Avoid entering confidential information. | ||
* <p> | ||
@@ -42,0 +41,0 @@ Example: `frontend-fleet` |
@@ -30,5 +30,4 @@ /** | ||
/** | ||
* Resource group that you want to use as a filter. The specified resource group must exist in the definition of the posted metric. Only one resource group can be applied per metric. | ||
* Resource group that you want to match. A null value returns only metric data that has no resource groups. The specified resource group must exist in the definition of the posted metric. Only one resource group can be applied per metric. | ||
* A valid resourceGroup value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($). | ||
* Avoid entering confidential information. | ||
* <p> | ||
@@ -41,4 +40,5 @@ Example: `frontend-fleet` | ||
* The Monitoring Query Language (MQL) expression to use when searching for metric data points to | ||
* aggregate. The query must specify a metric, statistic, and interval. Supported values for | ||
* interval: `1m`-`60m` (also `1h`). You can optionally specify dimensions and grouping functions. | ||
* aggregate. The query must specify a metric, statistic, and interval. | ||
* Supported values for interval depend on the specified time range. More interval values are supported for smaller time ranges. | ||
* You can optionally specify dimensions and grouping functions. | ||
* Supported grouping functions: `grouping()`, `groupBy()`. | ||
@@ -80,3 +80,3 @@ * <p> | ||
* frequency. The resolution must be equal or less than the interval in the query. The default | ||
* resolution is 1m (one minute). Supported values: `1m`-`60m` (also `1h`). | ||
* resolution is 1m (one minute). Supported values: `1m`-`60m`, `1h`-`24h`, `1d`. | ||
* <p> | ||
@@ -83,0 +83,0 @@ Example: `5m` |
@@ -19,4 +19,2 @@ /** | ||
* For information about alarms, see [Alarms Overview](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#AlarmsOverview). | ||
* <p> | ||
**Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. | ||
* | ||
@@ -23,0 +21,0 @@ */ |
@@ -19,4 +19,2 @@ /** | ||
* The configuration details for updating an alarm. | ||
* <p> | ||
**Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. | ||
* | ||
@@ -65,3 +63,3 @@ */ | ||
/** | ||
* Resource group that you want to use as a filter. The alarm retrieves metric data associated with the specified resource group only. Only one resource group can be applied per metric. | ||
* Resource group that you want to match. A null value returns only metric data that has no resource groups. The alarm retrieves metric data associated with the specified resource group only. Only one resource group can be applied per metric. | ||
* A valid resourceGroup value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($). | ||
@@ -79,3 +77,4 @@ * Avoid entering confidential information. | ||
* rule condition has been met. The query must specify a metric, statistic, interval, and trigger | ||
* rule (threshold or absence). Supported values for interval: `1m`-`60m` (also `1h`). You can optionally | ||
* rule (threshold or absence). Supported values for interval depend on the specified time range. More | ||
* interval values are supported for smaller time ranges. You can optionally | ||
* specify dimensions and grouping functions. Supported grouping functions: `grouping()`, `groupBy()`. | ||
@@ -145,2 +144,10 @@ * For details about Monitoring Query Language (MQL), see [Monitoring Query Language (MQL) Reference](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Reference/mql.htm). | ||
/** | ||
* The format to use for notification messages sent from this alarm. The formats are: | ||
* * `RAW` - Raw JSON blob. Default value. | ||
* * `PRETTY_JSON`: JSON with new lines and indents. | ||
* * `ONS_OPTIMIZED`: Simplified, user-friendly layout. Applies only to messages sent through the Notifications service to the following subscription types: Email. | ||
* | ||
*/ | ||
"messageFormat"?: UpdateAlarmDetails.MessageFormat; | ||
/** | ||
* A list of destinations to which the notifications for this alarm will be delivered. | ||
@@ -196,4 +203,9 @@ * Each destination is represented by an [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) related to the supported destination service. | ||
export declare namespace UpdateAlarmDetails { | ||
enum MessageFormat { | ||
Raw = "RAW", | ||
PrettyJson = "PRETTY_JSON", | ||
OnsOptimized = "ONS_OPTIMIZED" | ||
} | ||
function getJsonObj(obj: UpdateAlarmDetails): object; | ||
function getDeserializedJsonObj(obj: UpdateAlarmDetails): object; | ||
} |
@@ -41,2 +41,8 @@ "use strict"; | ||
(function (UpdateAlarmDetails) { | ||
let MessageFormat; | ||
(function (MessageFormat) { | ||
MessageFormat["Raw"] = "RAW"; | ||
MessageFormat["PrettyJson"] = "PRETTY_JSON"; | ||
MessageFormat["OnsOptimized"] = "ONS_OPTIMIZED"; | ||
})(MessageFormat = UpdateAlarmDetails.MessageFormat || (UpdateAlarmDetails.MessageFormat = {})); | ||
function getJsonObj(obj) { | ||
@@ -43,0 +49,0 @@ const jsonObj = Object.assign(Object.assign({}, obj), { |
@@ -16,3 +16,3 @@ /** | ||
/** | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.3.1/monitoring/ChangeAlarmCompartment.ts.html |here} to see how to use ChangeAlarmCompartmentRequest. | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.4.0/monitoring/ChangeAlarmCompartment.ts.html |here} to see how to use ChangeAlarmCompartmentRequest. | ||
*/ | ||
@@ -19,0 +19,0 @@ export interface ChangeAlarmCompartmentRequest extends common.BaseRequest { |
@@ -16,3 +16,3 @@ /** | ||
/** | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.3.1/monitoring/CreateAlarm.ts.html |here} to see how to use CreateAlarmRequest. | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.4.0/monitoring/CreateAlarm.ts.html |here} to see how to use CreateAlarmRequest. | ||
*/ | ||
@@ -19,0 +19,0 @@ export interface CreateAlarmRequest extends common.BaseRequest { |
@@ -15,3 +15,3 @@ /** | ||
/** | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.3.1/monitoring/DeleteAlarm.ts.html |here} to see how to use DeleteAlarmRequest. | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.4.0/monitoring/DeleteAlarm.ts.html |here} to see how to use DeleteAlarmRequest. | ||
*/ | ||
@@ -18,0 +18,0 @@ export interface DeleteAlarmRequest extends common.BaseRequest { |
@@ -15,3 +15,3 @@ /** | ||
/** | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.3.1/monitoring/GetAlarmHistory.ts.html |here} to see how to use GetAlarmHistoryRequest. | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.4.0/monitoring/GetAlarmHistory.ts.html |here} to see how to use GetAlarmHistoryRequest. | ||
*/ | ||
@@ -18,0 +18,0 @@ export interface GetAlarmHistoryRequest extends common.BaseRequest { |
@@ -15,3 +15,3 @@ /** | ||
/** | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.3.1/monitoring/GetAlarm.ts.html |here} to see how to use GetAlarmRequest. | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.4.0/monitoring/GetAlarm.ts.html |here} to see how to use GetAlarmRequest. | ||
*/ | ||
@@ -18,0 +18,0 @@ export interface GetAlarmRequest extends common.BaseRequest { |
@@ -15,3 +15,3 @@ /** | ||
/** | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.3.1/monitoring/ListAlarms.ts.html |here} to see how to use ListAlarmsRequest. | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.4.0/monitoring/ListAlarms.ts.html |here} to see how to use ListAlarmsRequest. | ||
*/ | ||
@@ -18,0 +18,0 @@ export interface ListAlarmsRequest extends common.BaseRequest { |
@@ -15,3 +15,3 @@ /** | ||
/** | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.3.1/monitoring/ListAlarmsStatus.ts.html |here} to see how to use ListAlarmsStatusRequest. | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.4.0/monitoring/ListAlarmsStatus.ts.html |here} to see how to use ListAlarmsStatusRequest. | ||
*/ | ||
@@ -18,0 +18,0 @@ export interface ListAlarmsStatusRequest extends common.BaseRequest { |
@@ -16,3 +16,3 @@ /** | ||
/** | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.3.1/monitoring/ListMetrics.ts.html |here} to see how to use ListMetricsRequest. | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.4.0/monitoring/ListMetrics.ts.html |here} to see how to use ListMetricsRequest. | ||
*/ | ||
@@ -19,0 +19,0 @@ export interface ListMetricsRequest extends common.BaseRequest { |
@@ -16,3 +16,3 @@ /** | ||
/** | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.3.1/monitoring/PostMetricData.ts.html |here} to see how to use PostMetricDataRequest. | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.4.0/monitoring/PostMetricData.ts.html |here} to see how to use PostMetricDataRequest. | ||
*/ | ||
@@ -19,0 +19,0 @@ export interface PostMetricDataRequest extends common.BaseRequest { |
@@ -15,3 +15,3 @@ /** | ||
/** | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.3.1/monitoring/RemoveAlarmSuppression.ts.html |here} to see how to use RemoveAlarmSuppressionRequest. | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.4.0/monitoring/RemoveAlarmSuppression.ts.html |here} to see how to use RemoveAlarmSuppressionRequest. | ||
*/ | ||
@@ -18,0 +18,0 @@ export interface RemoveAlarmSuppressionRequest extends common.BaseRequest { |
@@ -16,3 +16,3 @@ /** | ||
/** | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.3.1/monitoring/SummarizeMetricsData.ts.html |here} to see how to use SummarizeMetricsDataRequest. | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.4.0/monitoring/SummarizeMetricsData.ts.html |here} to see how to use SummarizeMetricsDataRequest. | ||
*/ | ||
@@ -19,0 +19,0 @@ export interface SummarizeMetricsDataRequest extends common.BaseRequest { |
@@ -16,3 +16,3 @@ /** | ||
/** | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.3.1/monitoring/UpdateAlarm.ts.html |here} to see how to use UpdateAlarmRequest. | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.4.0/monitoring/UpdateAlarm.ts.html |here} to see how to use UpdateAlarmRequest. | ||
*/ | ||
@@ -19,0 +19,0 @@ export interface UpdateAlarmRequest extends common.BaseRequest { |
{ | ||
"name": "oci-monitoring", | ||
"version": "2.3.1", | ||
"version": "2.4.0", | ||
"description": "OCI NodeJS client for Monitoring", | ||
@@ -18,4 +18,4 @@ "repository": { | ||
"dependencies": { | ||
"oci-common": "2.3.1", | ||
"oci-workrequests": "2.3.1" | ||
"oci-common": "2.4.0", | ||
"oci-workrequests": "2.4.0" | ||
}, | ||
@@ -22,0 +22,0 @@ "publishConfig": { |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
404503
5733
+ Addedoci-common@2.4.0(transitive)
+ Addedoci-workrequests@2.4.0(transitive)
- Removedoci-common@2.3.1(transitive)
- Removedoci-workrequests@2.3.1(transitive)
Updatedoci-common@2.4.0
Updatedoci-workrequests@2.4.0