@dynatrace-sdk/client-classic-environment-v2 3.6.7 → 3.6.8

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 (20) hide show
  1. package/CHANGELOG.md +4 -0
  2. package/README.md +51 -37
  3. package/cjs/index.js +21 -11
  4. package/esm/index.js +21 -11
  5. package/package.json +1 -1
  6. package/types/packages/client/classic-environment-v2/src/lib/apis/logs-api.d.ts +13 -2
  7. package/types/packages/client/classic-environment-v2/src/lib/apis/synthetic-network-availability-monitors-api.d.ts +5 -5
  8. package/types/packages/client/classic-environment-v2/src/lib/models/constraint.d.ts +4 -0
  9. package/types/packages/client/classic-environment-v2/src/lib/models/index.d.ts +2 -2
  10. package/types/packages/client/classic-environment-v2/src/lib/models/{synthetic-multi-protocol-monitor-constraint-dto-properties.d.ts → synthetic-monitor-constraint-dto-properties.d.ts} +1 -1
  11. package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-monitor-constraint-dto.d.ts +14 -0
  12. package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-monitor-outage-handling-settings-dto.d.ts +3 -3
  13. package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-monitor-performance-threshold-dto.d.ts +2 -2
  14. package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-monitor-performance-thresholds-dto.d.ts +1 -1
  15. package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-dto-type.d.ts +4 -3
  16. package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-dto.d.ts +5 -2
  17. package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-step-dto.d.ts +2 -2
  18. package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-update-dto.d.ts +1 -1
  19. package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-request-configuration-dto.d.ts +2 -2
  20. package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-constraint-dto.d.ts +0 -14
package/CHANGELOG.md CHANGED
@@ -2,6 +2,10 @@
2
2
 
3
3
  @dynatrace-sdk/client-classic-environment-v2
4
4
 
5
+ ## 3.6.8
6
+
7
+ Updated required scopes for `getMonitors` operation and minor documentation updates.
8
+
5
9
  ## 3.6.7
6
10
 
7
11
  ### Patch Changes
package/README.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # @dynatrace-sdk/client-classic-environment-v2
2
2
 
3
- [![npm](https://img.shields.io/badge/npm-v3.6.7-blue)](https://www.npmjs.com/package/@dynatrace-sdk/client-classic-environment-v2/v/3.6.7)
3
+ [![npm](https://img.shields.io/badge/npm-v3.6.8-blue)](https://www.npmjs.com/package/@dynatrace-sdk/client-classic-environment-v2/v/3.6.8)
4
4
  [![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
5
5
 
6
6
 
@@ -5325,11 +5325,24 @@ Refresh cluster limit using Cluster Management Console (CMC)
5325
5325
 
5326
5326
  2. On the environment details page, in the **Cluster overload prevention settings** section, select the **Refresh cluster limit**.
5327
5327
 
5328
+
5328
5329
  **High-cardinality attributes:**
5329
5330
 
5330
5331
  Unique log data attributes (high-cardinality attributes) such as `span_id` and `trace_id` generate unnecessarily excessive facet lists that may impact log viewer performance. Because of this, they aren't listed in log viewer facets. You can still use them in a log viewer advanced search query.
5331
5332
 
5332
5333
 
5334
+ **Error handling:**
5335
+
5336
+ The following HTTP status codes are considered retryable:
5337
+
5338
+ * 429 Too Many Requests
5339
+ * 502 Bad Gateway
5340
+ * 503 Service Unavailable
5341
+ * 504 Gateway Timeout
5342
+
5343
+ It is recommended to use an exponential backoff strategy for retrying requests.
5344
+
5345
+
5333
5346
 
5334
5347
  </div>
5335
5348
 
@@ -5356,7 +5369,7 @@ Unique log data attributes (high-cardinality attributes) such as `span_id` and `
5356
5369
 
5357
5370
  | Error Type | Error Message |
5358
5371
  |---|---|
5359
- |ErrorEnvelopeError|Failed. The input is invalid. \| Failed. This is due either to the status of your licensing agreement or because you&apos;ve exhausted your [DPS license](https://www.dynatrace.com/support/help/shortlink/dynatrace-platform-subscription). \| Failed. The requested resource doesn&apos;t exist. This may happen when no ActiveGate is available with the Log Analytics Collector module enabled. \| Failed. Request payload size is too big. This may happen when the payload byte size exceeds the limit or when the ingested payload is a JSON array with the size exceeding the limit. \| Failed. Too Many Requests. This may happen when ActiveGate is unable to process more requests at the moment or when log ingest is disabled. \| Failed. The server either does not recognize the request method, or it lacks the ability to fulfil the request. In Log Monitoring Classic, this may happen when indexed log storage is not enabled. \| Failed. The server is currently unable to handle the request. This may happen when ActiveGate is overloaded. \| Client side error. \| Server side error.|
5372
+ |ErrorEnvelopeError|Failed. The input is invalid. \| Failed. This is due either to the status of your licensing agreement or because you&apos;ve exhausted your [DPS license](https://www.dynatrace.com/support/help/shortlink/dynatrace-platform-subscription). \| Failed. The requested resource doesn&apos;t exist. This may happen when no ActiveGate is available with the Log Analytics Collector module enabled. \| Failed. Request payload size is too big. This may happen when the payload byte size exceeds the limit or when the ingested payload is a JSON array with the size exceeding the limit. \| Failed. Too Many Requests. This may happen when ActiveGate is unable to process more requests at the moment or when log ingest is disabled. Retryable with exponential backoff strategy. \| Failed. The server either does not recognize the request method, or it lacks the ability to fulfil the request. In Log Monitoring Classic, this may happen when indexed log storage is not enabled. \| Failed. The server is currently unable to handle the request. This may happen when ActiveGate is overloaded. Retryable with exponential backoff strategy. \| Client side error. \| Server side error.|
5360
5373
 
5361
5374
 
5362
5375
  <details>
@@ -11521,7 +11534,7 @@ import { syntheticNetworkAvailabilityMonitorsClient } from '@dynatrace-sdk/clien
11521
11534
  Creates a synthetic monitor definition. Currently network availability monitors only. | maturity=EARLY_ADOPTER
11522
11535
 
11523
11536
  **Required scope:** environment-api:synthetic-monitors:write
11524
- **Required permission:** environment:roles:viewer
11537
+ **Required permission:** environment:roles:manage-settings
11525
11538
 
11526
11539
 
11527
11540
 
@@ -11583,7 +11596,7 @@ const data =
11583
11596
  Deletes a synthetic monitor definition for the given monitor ID. Currently network availability monitors only. | maturity=EARLY_ADOPTER
11584
11597
 
11585
11598
  **Required scope:** environment-api:synthetic-monitors:write
11586
- **Required permission:** environment:roles:viewer
11599
+ **Required permission:** environment:roles:manage-settings
11587
11600
 
11588
11601
 
11589
11602
 
@@ -11645,7 +11658,7 @@ const data =
11645
11658
  Gets a synthetic monitor definition for the given monitor ID. Currently network availability monitors only. | maturity=EARLY_ADOPTER
11646
11659
 
11647
11660
  **Required scope:** environment-api:synthetic-monitors:read
11648
- **Required permission:** environment:roles:viewer
11661
+ **Required permission:** environment:roles:manage-settings
11649
11662
 
11650
11663
 
11651
11664
 
@@ -11707,7 +11720,7 @@ const data =
11707
11720
  Gets all synthetic monitors. Currently network availability monitors only. | maturity=EARLY_ADOPTER
11708
11721
 
11709
11722
  **Required scope:** environment-api:synthetic-monitors:read
11710
- **Required permission:** environment:roles:viewer
11723
+ **Required permission:** environment:roles:manage-settings
11711
11724
 
11712
11725
 
11713
11726
 
@@ -11767,7 +11780,7 @@ const data =
11767
11780
  Updates a synthetic monitor definition for the given monitor ID. Currently network availability monitors only. | maturity=EARLY_ADOPTER
11768
11781
 
11769
11782
  **Required scope:** environment-api:synthetic-monitors:write
11770
- **Required permission:** environment:roles:viewer
11783
+ **Required permission:** environment:roles:manage-settings
11771
11784
 
11772
11785
 
11773
11786
 
@@ -13071,6 +13084,7 @@ A constraint on the values accepted for a settings property.
13071
13084
  | --- | --- | --- |
13072
13085
  |customMessage|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A custom message for invalid values. |
13073
13086
  |customValidatorId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of a custom validator. |
13087
+ |disallowDangerousRegex|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Whether to disallow usage of dangerous regexes |
13074
13088
  |maxLength|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The maximum allowed length of string values. |
13075
13089
  |maximum|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The maximum allowed value. |
13076
13090
  |minLength|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The minimum required length of string values. |
@@ -16208,13 +16222,28 @@ A list of synthetic locations.
16208
16222
  | --- | --- | --- |
16209
16223
  |locations<sup>*required</sup>|Array&lt;<a href="#locationcollectionelement">LocationCollectionElement</a>&gt;|A list of synthetic locations. |
16210
16224
 
16225
+ ### SyntheticMonitorConstraintDto
16226
+
16227
+ Synthetic monitor constraint.
16228
+
16229
+ | Name | Type | Description |
16230
+ | --- | --- | --- |
16231
+ |properties<sup>*required</sup>|<a href="#syntheticmonitorconstraintdtoproperties" target="_blank" rel="noopener noreferrer">SyntheticMonitorConstraintDtoProperties</a>|The properties of the constraint. |
16232
+ |type<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Constraint type. |
16233
+
16234
+ ### SyntheticMonitorConstraintDtoProperties
16235
+
16236
+ The properties of the constraint.
16237
+
16238
+ **type**: Record&lt;string, string | undefined&gt;
16239
+
16211
16240
  ### SyntheticMonitorListDto
16212
16241
 
16213
16242
  List of available synthetic monitors.
16214
16243
 
16215
16244
  | Name | Type | Description |
16216
16245
  | --- | --- | --- |
16217
- |monitors|Array&lt;<a href="#syntheticmonitorsummarydto" target="_blank" rel="noopener noreferrer">SyntheticMonitorSummaryDto</a>&gt;|List of monitors. |
16246
+ |monitors|Array&lt;<a href="#syntheticmonitorsummarydto">SyntheticMonitorSummaryDto</a>&gt;|List of monitors. |
16218
16247
 
16219
16248
  ### SyntheticMonitorOutageHandlingSettingsDto
16220
16249
 
@@ -16222,11 +16251,11 @@ Outage handling configuration.
16222
16251
 
16223
16252
  | Name | Type | Description |
16224
16253
  | --- | --- | --- |
16225
- |globalConsecutiveOutageCountThreshold|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Number of consecutive failures for all locations. |
16226
- |globalOutages|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Generate a problem and send an alert when the monitor is unavailable at all configured locations. |
16254
+ |globalConsecutiveOutageCountThreshold<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Number of consecutive failures for all locations. |
16255
+ |globalOutages<sup>*required</sup>|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Generate a problem and send an alert when the monitor is unavailable at all configured locations. |
16227
16256
  |localConsecutiveOutageCountThreshold|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Number of consecutive failures. |
16228
16257
  |localLocationOutageCountThreshold|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Number of failing locations. |
16229
- |localOutages|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Generate a problem and send an alert when the monitor is unavailable for one or more consecutive runs at any location. |
16258
+ |localOutages<sup>*required</sup>|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Generate a problem and send an alert when the monitor is unavailable for one or more consecutive runs at any location. |
16230
16259
 
16231
16260
  ### SyntheticMonitorPerformanceThresholdDto
16232
16261
 
@@ -16237,8 +16266,8 @@ The performance threshold rule.
16237
16266
  |aggregation|"AVG" &#124; "MAX" &#124; "MIN"|Aggregation type <i>default:</i> <code>"AVG"</code>|
16238
16267
  |dealertingSamples|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Number of most recent non-violating request executions that closes the problem |
16239
16268
  |samples|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Number of request executions in analyzed sliding window (sliding window size) |
16240
- |stepIndex|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Specify the step's index to which a threshold applies. |
16241
- |threshold|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Notify if monitor request takes longer than <em>X</em> milliseconds to execute. |
16269
+ |stepIndex<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Specify the step's index to which a threshold applies. |
16270
+ |threshold<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Notify if monitor request takes longer than <em>X</em> milliseconds to execute. |
16242
16271
  |violatingSamples|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Number of violating request executions in analyzed sliding window |
16243
16272
 
16244
16273
  ### SyntheticMonitorPerformanceThresholdsDto
@@ -16247,8 +16276,8 @@ Performance thresholds configuration.
16247
16276
 
16248
16277
  | Name | Type | Description |
16249
16278
  | --- | --- | --- |
16250
- |enabled|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Performance threshold is enabled (<code>true</code>) or disabled (<code>false</code>). |
16251
- |thresholds|Array&lt;<a href="#syntheticmonitorperformancethresholddto">SyntheticMonitorPerformanceThresholdDto</a>&gt;|The list of performance threshold rules. |
16279
+ |enabled<sup>*required</sup>|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Performance threshold is enabled (<code>true</code>) or disabled (<code>false</code>). |
16280
+ |thresholds|Array&lt;<a href="#syntheticmonitorperformancethresholddto" target="_blank" rel="noopener noreferrer">SyntheticMonitorPerformanceThresholdDto</a>&gt;|The list of performance threshold rules. |
16252
16281
 
16253
16282
  ### SyntheticMonitorSummaryDto
16254
16283
 
@@ -16261,21 +16290,6 @@ Basic monitor data.
16261
16290
  |name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the monitor. |
16262
16291
  |type<sup>*required</sup>|"BROWSER" &#124; "HTTP" &#124; "THIRD_PARTY" &#124; "MULTI_PROTOCOL"| |
16263
16292
 
16264
- ### SyntheticMultiProtocolMonitorConstraintDto
16265
-
16266
- The network availability monitor constraint.
16267
-
16268
- | Name | Type | Description |
16269
- | --- | --- | --- |
16270
- |properties<sup>*required</sup>|<a href="#syntheticmultiprotocolmonitorconstraintdtoproperties" target="_blank" rel="noopener noreferrer">SyntheticMultiProtocolMonitorConstraintDtoProperties</a>|The properties of the constraint. |
16271
- |type<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Constraint type. |
16272
-
16273
- ### SyntheticMultiProtocolMonitorConstraintDtoProperties
16274
-
16275
- The properties of the constraint.
16276
-
16277
- **type**: Record&lt;string, string | undefined&gt;
16278
-
16279
16293
  ### SyntheticMultiProtocolMonitorDto
16280
16294
 
16281
16295
  Network Availability monitor.
@@ -16291,9 +16305,9 @@ Network Availability monitor.
16291
16305
  |name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the monitor. |
16292
16306
  |performanceThresholds|<a href="#syntheticmonitorperformancethresholdsdto">SyntheticMonitorPerformanceThresholdsDto</a>|Performance thresholds configuration. |
16293
16307
  |steps<sup>*required</sup>|Array&lt;<a href="#syntheticmultiprotocolmonitorstepdto" target="_blank" rel="noopener noreferrer">SyntheticMultiProtocolMonitorStepDto</a>&gt;|The steps of the monitor. |
16294
- |syntheticMonitorOutageHandlingSettings|<a href="#syntheticmonitoroutagehandlingsettingsdto">SyntheticMonitorOutageHandlingSettingsDto</a>|Outage handling configuration. |
16308
+ |syntheticMonitorOutageHandlingSettings<sup>*required</sup>|<a href="#syntheticmonitoroutagehandlingsettingsdto">SyntheticMonitorOutageHandlingSettingsDto</a>|Outage handling configuration. |
16295
16309
  |tags|Array&lt;<a href="#synthetictagwithsourcedto" target="_blank" rel="noopener noreferrer">SyntheticTagWithSourceDto</a>&gt;|<p>A set of tags assigned to the monitor.</p> <p>You can specify only the value of the tag here and the <code>CONTEXTLESS</code> context and source 'USER' will be added automatically. But preferred option is usage of SyntheticTagWithSourceDto model.</p> |
16296
- |type<sup>*required</sup>|"BROWSER" &#124; "HTTP" &#124; "THIRD_PARTY" &#124; "MULTI_PROTOCOL"| |
16310
+ |type<sup>*required</sup>|"BROWSER" &#124; "HTTP" &#124; "MULTI_PROTOCOL"|Monitor type. |
16297
16311
 
16298
16312
  ### SyntheticMultiProtocolMonitorStepDto
16299
16313
 
@@ -16301,7 +16315,7 @@ The step of a network availability monitor.
16301
16315
 
16302
16316
  | Name | Type | Description |
16303
16317
  | --- | --- | --- |
16304
- |constraints<sup>*required</sup>|Array&lt;<a href="#syntheticmultiprotocolmonitorconstraintdto">SyntheticMultiProtocolMonitorConstraintDto</a>&gt;|The list of constraints which apply to all requests in the step. |
16318
+ |constraints<sup>*required</sup>|Array&lt;<a href="#syntheticmonitorconstraintdto">SyntheticMonitorConstraintDto</a>&gt;|The list of constraints which apply to all requests in the step. |
16305
16319
  |name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Step name. |
16306
16320
  |properties<sup>*required</sup>|<a href="#syntheticmultiprotocolmonitorstepdtoproperties" target="_blank" rel="noopener noreferrer">SyntheticMultiProtocolMonitorStepDtoProperties</a>|The properties which apply to all requests in the step. |
16307
16321
  |requestConfigurations<sup>*required</sup>|Array&lt;<a href="#syntheticmultiprotocolrequestconfigurationdto">SyntheticMultiProtocolRequestConfigurationDto</a>&gt;|Request configurations. |
@@ -16317,7 +16331,7 @@ The properties which apply to all requests in the step.
16317
16331
 
16318
16332
  ### SyntheticMultiProtocolMonitorUpdateDto
16319
16333
 
16320
- Network availability monitor.
16334
+ Network Availability monitor.
16321
16335
 
16322
16336
  | Name | Type | Description |
16323
16337
  | --- | --- | --- |
@@ -16338,7 +16352,7 @@ The configuration of a network availability monitor request.
16338
16352
 
16339
16353
  | Name | Type | Description |
16340
16354
  | --- | --- | --- |
16341
- |constraints<sup>*required</sup>|Array&lt;<a href="#syntheticmultiprotocolmonitorconstraintdto" target="_blank" rel="noopener noreferrer">SyntheticMultiProtocolMonitorConstraintDto</a>&gt;|Request constraints. |
16355
+ |constraints<sup>*required</sup>|Array&lt;<a href="#syntheticmonitorconstraintdto" target="_blank" rel="noopener noreferrer">SyntheticMonitorConstraintDto</a>&gt;|Request constraints. |
16342
16356
 
16343
16357
  ### SyntheticOnDemandBatchStatus
16344
16358
 
@@ -20392,13 +20406,13 @@ Aggregation type
20392
20406
 
20393
20407
  <div class="padding-left--md">
20394
20408
 
20395
-
20409
+ Monitor type.
20396
20410
 
20397
20411
  #### Enum keys
20398
20412
 
20399
20413
  <div class="padding-left--md">
20400
20414
 
20401
- `Browser` | `Http` | `MultiProtocol` | `ThirdParty`
20415
+ `Browser` | `Http` | `MultiProtocol`
20402
20416
 
20403
20417
  </div>
20404
20418
 
package/cjs/index.js CHANGED
@@ -13321,10 +13321,21 @@ var LogsClient = class {
13321
13321
  *
13322
13322
  * 2. On the environment details page, in the **Cluster overload prevention settings** section, select the **Refresh cluster limit**.
13323
13323
  *
13324
- * **High-cardinality attributes:**
13324
+ * <br />**High-cardinality attributes:**
13325
13325
  *
13326
13326
  * Unique log data attributes (high-cardinality attributes) such as `span_id` and `trace_id` generate unnecessarily excessive facet lists that may impact log viewer performance. Because of this, they aren't listed in log viewer facets. You can still use them in a log viewer advanced search query.
13327
13327
  *
13328
+ * <br />**Error handling:**
13329
+ *
13330
+ * The following HTTP status codes are considered retryable:
13331
+ *
13332
+ * * 429 Too Many Requests
13333
+ * * 502 Bad Gateway
13334
+ * * 503 Service Unavailable
13335
+ * * 504 Gateway Timeout
13336
+ *
13337
+ * It is recommended to use an exponential backoff strategy for retrying requests.
13338
+ *
13328
13339
  * @returns {Promise<SuccessEnvelope | void>} Only a part of input events were ingested due to event invalidity. For details, check the response body.
13329
13340
  *
13330
13341
  * @example <caption>Code example</caption>
@@ -13359,7 +13370,7 @@ var LogsClient = class {
13359
13370
  * ],
13360
13371
  * });
13361
13372
  *
13362
- * @throws {ErrorEnvelopeError} Failed. The input is invalid. | Failed. This is due either to the status of your licensing agreement or because you've exhausted your [DPS license](https://www.dynatrace.com/support/help/shortlink/dynatrace-platform-subscription). | Failed. The requested resource doesn't exist. This may happen when no ActiveGate is available with the Log Analytics Collector module enabled. | Failed. Request payload size is too big. This may happen when the payload byte size exceeds the limit or when the ingested payload is a JSON array with the size exceeding the limit. | Failed. Too Many Requests. This may happen when ActiveGate is unable to process more requests at the moment or when log ingest is disabled. | Failed. The server either does not recognize the request method, or it lacks the ability to fulfil the request. In Log Monitoring Classic, this may happen when indexed log storage is not enabled. | Failed. The server is currently unable to handle the request. This may happen when ActiveGate is overloaded. | Client side error. | Server side error.
13373
+ * @throws {ErrorEnvelopeError} Failed. The input is invalid. | Failed. This is due either to the status of your licensing agreement or because you've exhausted your [DPS license](https://www.dynatrace.com/support/help/shortlink/dynatrace-platform-subscription). | Failed. The requested resource doesn't exist. This may happen when no ActiveGate is available with the Log Analytics Collector module enabled. | Failed. Request payload size is too big. This may happen when the payload byte size exceeds the limit or when the ingested payload is a JSON array with the size exceeding the limit. | Failed. Too Many Requests. This may happen when ActiveGate is unable to process more requests at the moment or when log ingest is disabled. Retryable with exponential backoff strategy. | Failed. The server either does not recognize the request method, or it lacks the ability to fulfil the request. In Log Monitoring Classic, this may happen when indexed log storage is not enabled. | Failed. The server is currently unable to handle the request. This may happen when ActiveGate is overloaded. Retryable with exponential backoff strategy. | Client side error. | Server side error.
13363
13374
  * @throws {InvalidResponseError}
13364
13375
  * @throws {ApiClientError}
13365
13376
  * @throws {ClientRequestError}
@@ -13560,7 +13571,7 @@ var LogsClient = class {
13560
13571
  errorBody,
13561
13572
  getErrorMessage(
13562
13573
  errorBody,
13563
- "Failed. Too Many Requests. This may happen when ActiveGate is unable to process more requests at the moment or when log ingest is disabled."
13574
+ "Failed. Too Many Requests. This may happen when ActiveGate is unable to process more requests at the moment or when log ingest is disabled. Retryable with exponential backoff strategy."
13564
13575
  ),
13565
13576
  e
13566
13577
  );
@@ -13616,7 +13627,7 @@ var LogsClient = class {
13616
13627
  errorBody,
13617
13628
  getErrorMessage(
13618
13629
  errorBody,
13619
- "Failed. The server is currently unable to handle the request. This may happen when ActiveGate is overloaded."
13630
+ "Failed. The server is currently unable to handle the request. This may happen when ActiveGate is overloaded. Retryable with exponential backoff strategy."
13620
13631
  ),
13621
13632
  e
13622
13633
  );
@@ -28324,7 +28335,7 @@ var SyntheticNetworkAvailabilityMonitorsClient = class {
28324
28335
  /**
28325
28336
  * Gets all synthetic monitors. Currently network availability monitors only. | maturity=EARLY_ADOPTER
28326
28337
  *
28327
- * **Required scope:** environment-api:synthetic-monitors:read<br/>**Required permission:** environment:roles:viewer
28338
+ * **Required scope:** environment-api:synthetic-monitors:read<br/>**Required permission:** environment:roles:manage-settings
28328
28339
  *
28329
28340
  * @returns {Promise<SyntheticMonitorListDto>} Success
28330
28341
  *
@@ -28455,7 +28466,7 @@ var SyntheticNetworkAvailabilityMonitorsClient = class {
28455
28466
  /**
28456
28467
  * Creates a synthetic monitor definition. Currently network availability monitors only. | maturity=EARLY_ADOPTER
28457
28468
  *
28458
- * **Required scope:** environment-api:synthetic-monitors:write<br/>**Required permission:** environment:roles:viewer
28469
+ * **Required scope:** environment-api:synthetic-monitors:write<br/>**Required permission:** environment:roles:manage-settings
28459
28470
  *
28460
28471
  * @returns {Promise<MonitorEntityIdDto>} Success
28461
28472
  *
@@ -28591,7 +28602,7 @@ var SyntheticNetworkAvailabilityMonitorsClient = class {
28591
28602
  /**
28592
28603
  * Gets a synthetic monitor definition for the given monitor ID. Currently network availability monitors only. | maturity=EARLY_ADOPTER
28593
28604
  *
28594
- * **Required scope:** environment-api:synthetic-monitors:read<br/>**Required permission:** environment:roles:viewer
28605
+ * **Required scope:** environment-api:synthetic-monitors:read<br/>**Required permission:** environment:roles:manage-settings
28595
28606
  *
28596
28607
  * @returns {Promise<SyntheticMultiProtocolMonitorDto>} Success
28597
28608
  *
@@ -28720,7 +28731,7 @@ var SyntheticNetworkAvailabilityMonitorsClient = class {
28720
28731
  /**
28721
28732
  * Updates a synthetic monitor definition for the given monitor ID. Currently network availability monitors only. | maturity=EARLY_ADOPTER
28722
28733
  *
28723
- * **Required scope:** environment-api:synthetic-monitors:write<br/>**Required permission:** environment:roles:viewer
28734
+ * **Required scope:** environment-api:synthetic-monitors:write<br/>**Required permission:** environment:roles:manage-settings
28724
28735
  *
28725
28736
  * @example <caption>Code example</caption>
28726
28737
  * import { syntheticNetworkAvailabilityMonitorsClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -28841,7 +28852,7 @@ var SyntheticNetworkAvailabilityMonitorsClient = class {
28841
28852
  /**
28842
28853
  * Deletes a synthetic monitor definition for the given monitor ID. Currently network availability monitors only. | maturity=EARLY_ADOPTER
28843
28854
  *
28844
- * **Required scope:** environment-api:synthetic-monitors:write<br/>**Required permission:** environment:roles:viewer
28855
+ * **Required scope:** environment-api:synthetic-monitors:write<br/>**Required permission:** environment:roles:manage-settings
28845
28856
  *
28846
28857
  * @example <caption>Code example</caption>
28847
28858
  * import { syntheticNetworkAvailabilityMonitorsClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -32093,10 +32104,9 @@ var SyntheticMonitorSummaryDtoType = /* @__PURE__ */ ((SyntheticMonitorSummaryDt
32093
32104
 
32094
32105
  // packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-dto-type.ts
32095
32106
  var SyntheticMultiProtocolMonitorDtoType = /* @__PURE__ */ ((SyntheticMultiProtocolMonitorDtoType2) => {
32107
+ SyntheticMultiProtocolMonitorDtoType2["MultiProtocol"] = "MULTI_PROTOCOL";
32096
32108
  SyntheticMultiProtocolMonitorDtoType2["Browser"] = "BROWSER";
32097
32109
  SyntheticMultiProtocolMonitorDtoType2["Http"] = "HTTP";
32098
- SyntheticMultiProtocolMonitorDtoType2["MultiProtocol"] = "MULTI_PROTOCOL";
32099
- SyntheticMultiProtocolMonitorDtoType2["ThirdParty"] = "THIRD_PARTY";
32100
32110
  return SyntheticMultiProtocolMonitorDtoType2;
32101
32111
  })(SyntheticMultiProtocolMonitorDtoType || {});
32102
32112
 
package/esm/index.js CHANGED
@@ -13153,10 +13153,21 @@ var LogsClient = class {
13153
13153
  *
13154
13154
  * 2. On the environment details page, in the **Cluster overload prevention settings** section, select the **Refresh cluster limit**.
13155
13155
  *
13156
- * **High-cardinality attributes:**
13156
+ * <br />**High-cardinality attributes:**
13157
13157
  *
13158
13158
  * Unique log data attributes (high-cardinality attributes) such as `span_id` and `trace_id` generate unnecessarily excessive facet lists that may impact log viewer performance. Because of this, they aren't listed in log viewer facets. You can still use them in a log viewer advanced search query.
13159
13159
  *
13160
+ * <br />**Error handling:**
13161
+ *
13162
+ * The following HTTP status codes are considered retryable:
13163
+ *
13164
+ * * 429 Too Many Requests
13165
+ * * 502 Bad Gateway
13166
+ * * 503 Service Unavailable
13167
+ * * 504 Gateway Timeout
13168
+ *
13169
+ * It is recommended to use an exponential backoff strategy for retrying requests.
13170
+ *
13160
13171
  * @returns {Promise<SuccessEnvelope | void>} Only a part of input events were ingested due to event invalidity. For details, check the response body.
13161
13172
  *
13162
13173
  * @example <caption>Code example</caption>
@@ -13191,7 +13202,7 @@ var LogsClient = class {
13191
13202
  * ],
13192
13203
  * });
13193
13204
  *
13194
- * @throws {ErrorEnvelopeError} Failed. The input is invalid. | Failed. This is due either to the status of your licensing agreement or because you've exhausted your [DPS license](https://www.dynatrace.com/support/help/shortlink/dynatrace-platform-subscription). | Failed. The requested resource doesn't exist. This may happen when no ActiveGate is available with the Log Analytics Collector module enabled. | Failed. Request payload size is too big. This may happen when the payload byte size exceeds the limit or when the ingested payload is a JSON array with the size exceeding the limit. | Failed. Too Many Requests. This may happen when ActiveGate is unable to process more requests at the moment or when log ingest is disabled. | Failed. The server either does not recognize the request method, or it lacks the ability to fulfil the request. In Log Monitoring Classic, this may happen when indexed log storage is not enabled. | Failed. The server is currently unable to handle the request. This may happen when ActiveGate is overloaded. | Client side error. | Server side error.
13205
+ * @throws {ErrorEnvelopeError} Failed. The input is invalid. | Failed. This is due either to the status of your licensing agreement or because you've exhausted your [DPS license](https://www.dynatrace.com/support/help/shortlink/dynatrace-platform-subscription). | Failed. The requested resource doesn't exist. This may happen when no ActiveGate is available with the Log Analytics Collector module enabled. | Failed. Request payload size is too big. This may happen when the payload byte size exceeds the limit or when the ingested payload is a JSON array with the size exceeding the limit. | Failed. Too Many Requests. This may happen when ActiveGate is unable to process more requests at the moment or when log ingest is disabled. Retryable with exponential backoff strategy. | Failed. The server either does not recognize the request method, or it lacks the ability to fulfil the request. In Log Monitoring Classic, this may happen when indexed log storage is not enabled. | Failed. The server is currently unable to handle the request. This may happen when ActiveGate is overloaded. Retryable with exponential backoff strategy. | Client side error. | Server side error.
13195
13206
  * @throws {InvalidResponseError}
13196
13207
  * @throws {ApiClientError}
13197
13208
  * @throws {ClientRequestError}
@@ -13392,7 +13403,7 @@ var LogsClient = class {
13392
13403
  errorBody,
13393
13404
  getErrorMessage(
13394
13405
  errorBody,
13395
- "Failed. Too Many Requests. This may happen when ActiveGate is unable to process more requests at the moment or when log ingest is disabled."
13406
+ "Failed. Too Many Requests. This may happen when ActiveGate is unable to process more requests at the moment or when log ingest is disabled. Retryable with exponential backoff strategy."
13396
13407
  ),
13397
13408
  e
13398
13409
  );
@@ -13448,7 +13459,7 @@ var LogsClient = class {
13448
13459
  errorBody,
13449
13460
  getErrorMessage(
13450
13461
  errorBody,
13451
- "Failed. The server is currently unable to handle the request. This may happen when ActiveGate is overloaded."
13462
+ "Failed. The server is currently unable to handle the request. This may happen when ActiveGate is overloaded. Retryable with exponential backoff strategy."
13452
13463
  ),
13453
13464
  e
13454
13465
  );
@@ -28305,7 +28316,7 @@ var SyntheticNetworkAvailabilityMonitorsClient = class {
28305
28316
  /**
28306
28317
  * Gets all synthetic monitors. Currently network availability monitors only. | maturity=EARLY_ADOPTER
28307
28318
  *
28308
- * **Required scope:** environment-api:synthetic-monitors:read<br/>**Required permission:** environment:roles:viewer
28319
+ * **Required scope:** environment-api:synthetic-monitors:read<br/>**Required permission:** environment:roles:manage-settings
28309
28320
  *
28310
28321
  * @returns {Promise<SyntheticMonitorListDto>} Success
28311
28322
  *
@@ -28436,7 +28447,7 @@ var SyntheticNetworkAvailabilityMonitorsClient = class {
28436
28447
  /**
28437
28448
  * Creates a synthetic monitor definition. Currently network availability monitors only. | maturity=EARLY_ADOPTER
28438
28449
  *
28439
- * **Required scope:** environment-api:synthetic-monitors:write<br/>**Required permission:** environment:roles:viewer
28450
+ * **Required scope:** environment-api:synthetic-monitors:write<br/>**Required permission:** environment:roles:manage-settings
28440
28451
  *
28441
28452
  * @returns {Promise<MonitorEntityIdDto>} Success
28442
28453
  *
@@ -28572,7 +28583,7 @@ var SyntheticNetworkAvailabilityMonitorsClient = class {
28572
28583
  /**
28573
28584
  * Gets a synthetic monitor definition for the given monitor ID. Currently network availability monitors only. | maturity=EARLY_ADOPTER
28574
28585
  *
28575
- * **Required scope:** environment-api:synthetic-monitors:read<br/>**Required permission:** environment:roles:viewer
28586
+ * **Required scope:** environment-api:synthetic-monitors:read<br/>**Required permission:** environment:roles:manage-settings
28576
28587
  *
28577
28588
  * @returns {Promise<SyntheticMultiProtocolMonitorDto>} Success
28578
28589
  *
@@ -28701,7 +28712,7 @@ var SyntheticNetworkAvailabilityMonitorsClient = class {
28701
28712
  /**
28702
28713
  * Updates a synthetic monitor definition for the given monitor ID. Currently network availability monitors only. | maturity=EARLY_ADOPTER
28703
28714
  *
28704
- * **Required scope:** environment-api:synthetic-monitors:write<br/>**Required permission:** environment:roles:viewer
28715
+ * **Required scope:** environment-api:synthetic-monitors:write<br/>**Required permission:** environment:roles:manage-settings
28705
28716
  *
28706
28717
  * @example <caption>Code example</caption>
28707
28718
  * import { syntheticNetworkAvailabilityMonitorsClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -28822,7 +28833,7 @@ var SyntheticNetworkAvailabilityMonitorsClient = class {
28822
28833
  /**
28823
28834
  * Deletes a synthetic monitor definition for the given monitor ID. Currently network availability monitors only. | maturity=EARLY_ADOPTER
28824
28835
  *
28825
- * **Required scope:** environment-api:synthetic-monitors:write<br/>**Required permission:** environment:roles:viewer
28836
+ * **Required scope:** environment-api:synthetic-monitors:write<br/>**Required permission:** environment:roles:manage-settings
28826
28837
  *
28827
28838
  * @example <caption>Code example</caption>
28828
28839
  * import { syntheticNetworkAvailabilityMonitorsClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -32092,10 +32103,9 @@ var SyntheticMonitorSummaryDtoType = /* @__PURE__ */ ((SyntheticMonitorSummaryDt
32092
32103
 
32093
32104
  // packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-dto-type.ts
32094
32105
  var SyntheticMultiProtocolMonitorDtoType = /* @__PURE__ */ ((SyntheticMultiProtocolMonitorDtoType2) => {
32106
+ SyntheticMultiProtocolMonitorDtoType2["MultiProtocol"] = "MULTI_PROTOCOL";
32095
32107
  SyntheticMultiProtocolMonitorDtoType2["Browser"] = "BROWSER";
32096
32108
  SyntheticMultiProtocolMonitorDtoType2["Http"] = "HTTP";
32097
- SyntheticMultiProtocolMonitorDtoType2["MultiProtocol"] = "MULTI_PROTOCOL";
32098
- SyntheticMultiProtocolMonitorDtoType2["ThirdParty"] = "THIRD_PARTY";
32099
32109
  return SyntheticMultiProtocolMonitorDtoType2;
32100
32110
  })(SyntheticMultiProtocolMonitorDtoType || {});
32101
32111
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@dynatrace-sdk/client-classic-environment-v2",
3
- "version": "3.6.7",
3
+ "version": "3.6.8",
4
4
  "description": "Client for the Dynatrace Environment API v2",
5
5
  "license": "Apache-2.0",
6
6
  "dependencies": {
@@ -244,10 +244,21 @@ export declare class LogsClient {
244
244
  *
245
245
  * 2. On the environment details page, in the **Cluster overload prevention settings** section, select the **Refresh cluster limit**.
246
246
  *
247
- * **High-cardinality attributes:**
247
+ * <br />**High-cardinality attributes:**
248
248
  *
249
249
  * Unique log data attributes (high-cardinality attributes) such as `span_id` and `trace_id` generate unnecessarily excessive facet lists that may impact log viewer performance. Because of this, they aren't listed in log viewer facets. You can still use them in a log viewer advanced search query.
250
250
  *
251
+ * <br />**Error handling:**
252
+ *
253
+ * The following HTTP status codes are considered retryable:
254
+ *
255
+ * * 429 Too Many Requests
256
+ * * 502 Bad Gateway
257
+ * * 503 Service Unavailable
258
+ * * 504 Gateway Timeout
259
+ *
260
+ * It is recommended to use an exponential backoff strategy for retrying requests.
261
+ *
251
262
  * @returns {Promise<SuccessEnvelope | void>} Only a part of input events were ingested due to event invalidity. For details, check the response body.
252
263
  *
253
264
  * @example <caption>Code example</caption>
@@ -282,7 +293,7 @@ export declare class LogsClient {
282
293
  * ],
283
294
  * });
284
295
  *
285
- * @throws {ErrorEnvelopeError} Failed. The input is invalid. | Failed. This is due either to the status of your licensing agreement or because you've exhausted your [DPS license](https://www.dynatrace.com/support/help/shortlink/dynatrace-platform-subscription). | Failed. The requested resource doesn't exist. This may happen when no ActiveGate is available with the Log Analytics Collector module enabled. | Failed. Request payload size is too big. This may happen when the payload byte size exceeds the limit or when the ingested payload is a JSON array with the size exceeding the limit. | Failed. Too Many Requests. This may happen when ActiveGate is unable to process more requests at the moment or when log ingest is disabled. | Failed. The server either does not recognize the request method, or it lacks the ability to fulfil the request. In Log Monitoring Classic, this may happen when indexed log storage is not enabled. | Failed. The server is currently unable to handle the request. This may happen when ActiveGate is overloaded. | Client side error. | Server side error.
296
+ * @throws {ErrorEnvelopeError} Failed. The input is invalid. | Failed. This is due either to the status of your licensing agreement or because you've exhausted your [DPS license](https://www.dynatrace.com/support/help/shortlink/dynatrace-platform-subscription). | Failed. The requested resource doesn't exist. This may happen when no ActiveGate is available with the Log Analytics Collector module enabled. | Failed. Request payload size is too big. This may happen when the payload byte size exceeds the limit or when the ingested payload is a JSON array with the size exceeding the limit. | Failed. Too Many Requests. This may happen when ActiveGate is unable to process more requests at the moment or when log ingest is disabled. Retryable with exponential backoff strategy. | Failed. The server either does not recognize the request method, or it lacks the ability to fulfil the request. In Log Monitoring Classic, this may happen when indexed log storage is not enabled. | Failed. The server is currently unable to handle the request. This may happen when ActiveGate is overloaded. Retryable with exponential backoff strategy. | Client side error. | Server side error.
286
297
  * @throws {InvalidResponseError}
287
298
  * @throws {ApiClientError}
288
299
  * @throws {ClientRequestError}
@@ -17,7 +17,7 @@ export declare class SyntheticNetworkAvailabilityMonitorsClient {
17
17
  /**
18
18
  * Gets all synthetic monitors. Currently network availability monitors only. | maturity=EARLY_ADOPTER
19
19
  *
20
- * **Required scope:** environment-api:synthetic-monitors:read<br/>**Required permission:** environment:roles:viewer
20
+ * **Required scope:** environment-api:synthetic-monitors:read<br/>**Required permission:** environment:roles:manage-settings
21
21
  *
22
22
  * @returns {Promise<SyntheticMonitorListDto>} Success
23
23
  *
@@ -52,7 +52,7 @@ export declare class SyntheticNetworkAvailabilityMonitorsClient {
52
52
  /**
53
53
  * Creates a synthetic monitor definition. Currently network availability monitors only. | maturity=EARLY_ADOPTER
54
54
  *
55
- * **Required scope:** environment-api:synthetic-monitors:write<br/>**Required permission:** environment:roles:viewer
55
+ * **Required scope:** environment-api:synthetic-monitors:write<br/>**Required permission:** environment:roles:manage-settings
56
56
  *
57
57
  * @returns {Promise<MonitorEntityIdDto>} Success
58
58
  *
@@ -76,7 +76,7 @@ export declare class SyntheticNetworkAvailabilityMonitorsClient {
76
76
  /**
77
77
  * Gets a synthetic monitor definition for the given monitor ID. Currently network availability monitors only. | maturity=EARLY_ADOPTER
78
78
  *
79
- * **Required scope:** environment-api:synthetic-monitors:read<br/>**Required permission:** environment:roles:viewer
79
+ * **Required scope:** environment-api:synthetic-monitors:read<br/>**Required permission:** environment:roles:manage-settings
80
80
  *
81
81
  * @returns {Promise<SyntheticMultiProtocolMonitorDto>} Success
82
82
  *
@@ -100,7 +100,7 @@ export declare class SyntheticNetworkAvailabilityMonitorsClient {
100
100
  /**
101
101
  * Updates a synthetic monitor definition for the given monitor ID. Currently network availability monitors only. | maturity=EARLY_ADOPTER
102
102
  *
103
- * **Required scope:** environment-api:synthetic-monitors:write<br/>**Required permission:** environment:roles:viewer
103
+ * **Required scope:** environment-api:synthetic-monitors:write<br/>**Required permission:** environment:roles:manage-settings
104
104
  *
105
105
  * @example <caption>Code example</caption>
106
106
  * import { syntheticNetworkAvailabilityMonitorsClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -123,7 +123,7 @@ export declare class SyntheticNetworkAvailabilityMonitorsClient {
123
123
  /**
124
124
  * Deletes a synthetic monitor definition for the given monitor ID. Currently network availability monitors only. | maturity=EARLY_ADOPTER
125
125
  *
126
- * **Required scope:** environment-api:synthetic-monitors:write<br/>**Required permission:** environment:roles:viewer
126
+ * **Required scope:** environment-api:synthetic-monitors:write<br/>**Required permission:** environment:roles:manage-settings
127
127
  *
128
128
  * @example <caption>Code example</caption>
129
129
  * import { syntheticNetworkAvailabilityMonitorsClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -10,6 +10,10 @@ export interface Constraint {
10
10
  * The ID of a custom validator.
11
11
  */
12
12
  customValidatorId?: string;
13
+ /**
14
+ * Whether to disallow usage of dangerous regexes
15
+ */
16
+ disallowDangerousRegex?: boolean;
13
17
  /**
14
18
  * The maximum allowed length of string values.
15
19
  */
@@ -517,6 +517,8 @@ export * from './synthetic-location-type';
517
517
  export * from './synthetic-location-update';
518
518
  export * from './synthetic-location-update-type';
519
519
  export * from './synthetic-locations';
520
+ export * from './synthetic-monitor-constraint-dto';
521
+ export * from './synthetic-monitor-constraint-dto-properties';
520
522
  export * from './synthetic-monitor-list-dto';
521
523
  export * from './synthetic-monitor-outage-handling-settings-dto';
522
524
  export * from './synthetic-monitor-performance-threshold-dto';
@@ -524,8 +526,6 @@ export * from './synthetic-monitor-performance-threshold-dto-aggregation';
524
526
  export * from './synthetic-monitor-performance-thresholds-dto';
525
527
  export * from './synthetic-monitor-summary-dto';
526
528
  export * from './synthetic-monitor-summary-dto-type';
527
- export * from './synthetic-multi-protocol-monitor-constraint-dto';
528
- export * from './synthetic-multi-protocol-monitor-constraint-dto-properties';
529
529
  export * from './synthetic-multi-protocol-monitor-dto';
530
530
  export * from './synthetic-multi-protocol-monitor-dto-type';
531
531
  export * from './synthetic-multi-protocol-monitor-step-dto';
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * The properties of the constraint.
3
3
  */
4
- export interface SyntheticMultiProtocolMonitorConstraintDtoProperties {
4
+ export interface SyntheticMonitorConstraintDtoProperties {
5
5
  [propName: string]: string | undefined;
6
6
  }
@@ -0,0 +1,14 @@
1
+ import { SyntheticMonitorConstraintDtoProperties } from './synthetic-monitor-constraint-dto-properties';
2
+ /**
3
+ * Synthetic monitor constraint.
4
+ */
5
+ export interface SyntheticMonitorConstraintDto {
6
+ /**
7
+ * The properties of the constraint.
8
+ */
9
+ properties: SyntheticMonitorConstraintDtoProperties;
10
+ /**
11
+ * Constraint type.
12
+ */
13
+ type: string;
14
+ }
@@ -5,11 +5,11 @@ export interface SyntheticMonitorOutageHandlingSettingsDto {
5
5
  /**
6
6
  * Number of consecutive failures for all locations.
7
7
  */
8
- globalConsecutiveOutageCountThreshold?: number;
8
+ globalConsecutiveOutageCountThreshold: number;
9
9
  /**
10
10
  * Generate a problem and send an alert when the monitor is unavailable at all configured locations.
11
11
  */
12
- globalOutages?: boolean;
12
+ globalOutages: boolean;
13
13
  /**
14
14
  * Number of consecutive failures.
15
15
  */
@@ -21,5 +21,5 @@ export interface SyntheticMonitorOutageHandlingSettingsDto {
21
21
  /**
22
22
  * Generate a problem and send an alert when the monitor is unavailable for one or more consecutive runs at any location.
23
23
  */
24
- localOutages?: boolean;
24
+ localOutages: boolean;
25
25
  }
@@ -17,11 +17,11 @@ export interface SyntheticMonitorPerformanceThresholdDto {
17
17
  /**
18
18
  * Specify the step's index to which a threshold applies.
19
19
  */
20
- stepIndex?: number;
20
+ stepIndex: number;
21
21
  /**
22
22
  * Notify if monitor request takes longer than *X* milliseconds to execute.
23
23
  */
24
- threshold?: number;
24
+ threshold: number;
25
25
  /**
26
26
  * Number of violating request executions in analyzed sliding window
27
27
  */
@@ -6,7 +6,7 @@ export interface SyntheticMonitorPerformanceThresholdsDto {
6
6
  /**
7
7
  * Performance threshold is enabled (`true`) or disabled (`false`).
8
8
  */
9
- enabled?: boolean;
9
+ enabled: boolean;
10
10
  /**
11
11
  * The list of performance threshold rules.
12
12
  */
@@ -1,9 +1,10 @@
1
1
  /**
2
+ * Monitor type.
3
+ *
2
4
  * @deprecated Use literal values.
3
5
  */
4
6
  export declare enum SyntheticMultiProtocolMonitorDtoType {
5
- Browser = "BROWSER",
6
- Http = "HTTP",
7
7
  MultiProtocol = "MULTI_PROTOCOL",
8
- ThirdParty = "THIRD_PARTY"
8
+ Browser = "BROWSER",
9
+ Http = "HTTP"
9
10
  }
@@ -45,12 +45,15 @@ export interface SyntheticMultiProtocolMonitorDto {
45
45
  /**
46
46
  * Outage handling configuration.
47
47
  */
48
- syntheticMonitorOutageHandlingSettings?: SyntheticMonitorOutageHandlingSettingsDto;
48
+ syntheticMonitorOutageHandlingSettings: SyntheticMonitorOutageHandlingSettingsDto;
49
49
  /**
50
50
  * A set of tags assigned to the monitor.
51
51
  *
52
52
  * You can specify only the value of the tag here and the `CONTEXTLESS` context and source 'USER' will be added automatically. But preferred option is usage of SyntheticTagWithSourceDto model.
53
53
  */
54
54
  tags?: SyntheticTagWithSourceDto[];
55
- type: 'BROWSER' | 'HTTP' | 'MULTI_PROTOCOL' | 'THIRD_PARTY';
55
+ /**
56
+ * Monitor type.
57
+ */
58
+ type: 'MULTI_PROTOCOL' | 'BROWSER' | 'HTTP';
56
59
  }
@@ -1,4 +1,4 @@
1
- import { SyntheticMultiProtocolMonitorConstraintDto } from './synthetic-multi-protocol-monitor-constraint-dto';
1
+ import { SyntheticMonitorConstraintDto } from './synthetic-monitor-constraint-dto';
2
2
  import { SyntheticMultiProtocolMonitorStepDtoProperties } from './synthetic-multi-protocol-monitor-step-dto-properties';
3
3
  import { SyntheticMultiProtocolRequestConfigurationDto } from './synthetic-multi-protocol-request-configuration-dto';
4
4
  /**
@@ -8,7 +8,7 @@ export interface SyntheticMultiProtocolMonitorStepDto {
8
8
  /**
9
9
  * The list of constraints which apply to all requests in the step.
10
10
  */
11
- constraints: SyntheticMultiProtocolMonitorConstraintDto[];
11
+ constraints: SyntheticMonitorConstraintDto[];
12
12
  /**
13
13
  * Step name.
14
14
  */
@@ -3,7 +3,7 @@ import { SyntheticMonitorPerformanceThresholdsDto } from './synthetic-monitor-pe
3
3
  import { SyntheticMultiProtocolMonitorStepDto } from './synthetic-multi-protocol-monitor-step-dto';
4
4
  import { SyntheticTagWithSourceDto } from './synthetic-tag-with-source-dto';
5
5
  /**
6
- * Network availability monitor.
6
+ * Network Availability monitor.
7
7
  */
8
8
  export interface SyntheticMultiProtocolMonitorUpdateDto {
9
9
  /**
@@ -1,4 +1,4 @@
1
- import { SyntheticMultiProtocolMonitorConstraintDto } from './synthetic-multi-protocol-monitor-constraint-dto';
1
+ import { SyntheticMonitorConstraintDto } from './synthetic-monitor-constraint-dto';
2
2
  /**
3
3
  * The configuration of a network availability monitor request.
4
4
  */
@@ -6,5 +6,5 @@ export interface SyntheticMultiProtocolRequestConfigurationDto {
6
6
  /**
7
7
  * Request constraints.
8
8
  */
9
- constraints: SyntheticMultiProtocolMonitorConstraintDto[];
9
+ constraints: SyntheticMonitorConstraintDto[];
10
10
  }
@@ -1,14 +0,0 @@
1
- import { SyntheticMultiProtocolMonitorConstraintDtoProperties } from './synthetic-multi-protocol-monitor-constraint-dto-properties';
2
- /**
3
- * The network availability monitor constraint.
4
- */
5
- export interface SyntheticMultiProtocolMonitorConstraintDto {
6
- /**
7
- * The properties of the constraint.
8
- */
9
- properties: SyntheticMultiProtocolMonitorConstraintDtoProperties;
10
- /**
11
- * Constraint type.
12
- */
13
- type: string;
14
- }