@dynatrace-sdk/client-classic-environment-v2 7.0.0 → 8.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/types/index.d.ts CHANGED
@@ -502,6 +502,8 @@ export declare class AccessTokensApiTokensClient {
502
502
  * If no prefix is set, + is used.
503
503
  *
504
504
  * If not set, tokens are sorted by creation date with newest first.
505
+ *
506
+ * @defaultValue -creationDate
505
507
  */ sort?: string;
506
508
  abortSignal?: AbortSignal_2;
507
509
  }): Promise<ApiTokenList>;
@@ -775,6 +777,35 @@ export declare class AccessTokensTenantTokensClient {
775
777
  startRotation(config?: {
776
778
  abortSignal?: AbortSignal_2;
777
779
  } | AbortSignal_2): Promise<TenantTokenConfig>;
780
+ /**
781
+ * Gets tenant token rotation status
782
+ *
783
+ * **One of the following scopes is required:**
784
+ * + environment-api:tenant-token-rotation:write
785
+ * + fleet-management:tenant-token:rotate
786
+ *
787
+ * <br/>**One of the following permissions is required:**
788
+ * + environment:roles:manage-settings
789
+ * + fleet-management:tenant-token:rotate
790
+ *
791
+ * <br/><br/>To learn how to rotate tokens, see [Token rotation](https://dt-url.net/1543sf6) in Dynatrace Documentation.
792
+ *
793
+ * @returns {Promise<TenantTokenRotationStatus>} Success. Returns rotation status.
794
+ *
795
+ * @example <caption>Code example</caption>
796
+ * import { accessTokensTenantTokensClient } from "@dynatrace-sdk/client-classic-environment-v2";
797
+ *
798
+ * const data =
799
+ * await accessTokensTenantTokensClient.getRotationStatus();
800
+ *
801
+ * @throws {ErrorEnvelopeError} Failed. Tenant token configuration is unavailable. | Client side error. | Server side error.
802
+ * @throws {InvalidResponseError}
803
+ * @throws {ApiClientError}
804
+ * @throws {ClientRequestError}
805
+ */
806
+ getRotationStatus(config?: {
807
+ abortSignal?: AbortSignal_2;
808
+ } | AbortSignal_2): Promise<TenantTokenRotationStatus>;
778
809
  }
779
810
 
780
811
  export declare const accessTokensTenantTokensClient: AccessTokensTenantTokensClient;
@@ -793,6 +824,8 @@ export declare interface ActiveGate {
793
824
  autoUpdateSettings?: ActiveGateAutoUpdateConfig;
794
825
  /**
795
826
  * The current status of auto-updates of the ActiveGate.
827
+ *
828
+ * @exampleValue OUTDATED
796
829
  */
797
830
  autoUpdateStatus?: 'INCOMPATIBLE' | 'OUTDATED' | 'SCHEDULED' | 'SUPPRESSED' | 'UNKNOWN' | 'UP2DATE' | 'UPDATE_IN_PROGRESS' | 'UPDATE_PENDING' | 'UPDATE_PROBLEM';
798
831
  /**
@@ -813,14 +846,20 @@ export declare interface ActiveGate {
813
846
  fipsMode?: boolean;
814
847
  /**
815
848
  * The group of the ActiveGate.
849
+ *
850
+ * @exampleValue default
816
851
  */
817
852
  group?: string;
818
853
  /**
819
854
  * The name of the host the ActiveGate is running on.
855
+ *
856
+ * @exampleValue exampleHostname
820
857
  */
821
858
  hostname?: string;
822
859
  /**
823
860
  * The ID of the ActiveGate.
861
+ *
862
+ * @exampleValue 0x3efdd091
824
863
  */
825
864
  id?: string;
826
865
  /**
@@ -829,6 +868,8 @@ export declare interface ActiveGate {
829
868
  loadBalancerAddresses?: string[];
830
869
  /**
831
870
  * The ID of the main environment for a multi-environment ActiveGate.
871
+ *
872
+ * @exampleValue d1bf4a7e-666b-43af-9f45-718g98372e2f
832
873
  */
833
874
  mainEnvironment?: string;
834
875
  /**
@@ -841,32 +882,46 @@ export declare interface ActiveGate {
841
882
  networkAddresses?: string[];
842
883
  /**
843
884
  * The network zone of the ActiveGate.
885
+ *
886
+ * @exampleValue exampleNetworkZone
844
887
  */
845
888
  networkZone?: string;
846
889
  /**
847
890
  * The timestamp since when the ActiveGate is offline.
848
891
  *
849
892
  * The `null` value means the ActiveGate is online.
893
+ *
894
+ * @exampleValue 1582031917814
850
895
  */
851
896
  offlineSince?: number;
852
897
  /**
853
898
  * The OS architecture that the ActiveGate is running on.
899
+ *
900
+ * @exampleValue X86
854
901
  */
855
902
  osArchitecture?: 'S390' | 'X86' | 'ARM' | 'PPCLE';
856
903
  /**
857
904
  * The OS bitness that the ActiveGate is running on.
905
+ *
906
+ * @exampleValue 64
858
907
  */
859
908
  osBitness?: '64';
860
909
  /**
861
910
  * The OS type that the ActiveGate is running on.
911
+ *
912
+ * @exampleValue WINDOWS
862
913
  */
863
914
  osType?: 'LINUX' | 'WINDOWS';
864
915
  /**
865
916
  * The type of the ActiveGate.
917
+ *
918
+ * @exampleValue ENVIRONMENT
866
919
  */
867
920
  type?: 'CLUSTER' | 'ENVIRONMENT' | 'ENVIRONMENT_MULTI';
868
921
  /**
869
922
  * The current version of the ActiveGate in the `<major>.<minor>.<revision>.<timestamp>` format.
923
+ *
924
+ * @exampleValue 1.185.0.20200201-120000
870
925
  */
871
926
  version?: string;
872
927
  }
@@ -879,18 +934,24 @@ export declare interface ActiveGateAutoUpdateConfig {
879
934
  * The actual state of the ActiveGate auto-update.
880
935
  *
881
936
  * Applicable only if the **setting** parameter is set to `INHERITED`. In that case, the value is taken from the parent setting. Otherwise, it's just a duplicate of the **setting** value.
937
+ *
938
+ * @exampleValue ENABLED
882
939
  */
883
940
  effectiveSetting?: 'ENABLED' | 'DISABLED';
884
941
  /**
885
942
  * The state of the environment ActiveGate auto-update: enabled, disabled, or inherited.
886
943
  *
887
944
  * If set to `INHERITED`, the setting is inherited from the global environment ActiveGate auto-update configuration.
945
+ *
946
+ * @exampleValue INHERITED
888
947
  */
889
948
  setting: 'DISABLED' | 'ENABLED' | 'INHERITED';
890
949
  /**
891
950
  * The target version of the ActiveGate.
892
951
  *
893
952
  * Specify the version in the `<major>.<minor>` format (for example `1.342`) or `latest`, `previous`, or `older`.
953
+ *
954
+ * @exampleValue latest
894
955
  */
895
956
  targetVersion?: string;
896
957
  /**
@@ -947,6 +1008,8 @@ export declare enum ActiveGateAutoUpdateStatus {
947
1008
  export declare interface ActiveGateConnectedHosts {
948
1009
  /**
949
1010
  * The number of hosts currently connected to the ActiveGate
1011
+ *
1012
+ * @exampleValue 150
950
1013
  */
951
1014
  number?: number;
952
1015
  }
@@ -971,6 +1034,8 @@ export declare interface ActiveGateGlobalAutoUpdateConfig {
971
1034
  * Supports relative versions `latest`, `previous` and `older` as well as specific version in `<major>.<minor>` format (for example `1.261`).
972
1035
  *
973
1036
  * Only applicable when the **setting** parameter is set to `ENABLED`.
1037
+ *
1038
+ * @exampleValue latest
974
1039
  */
975
1040
  targetVersion?: string;
976
1041
  /**
@@ -997,6 +1062,8 @@ export declare enum ActiveGateGlobalAutoUpdateConfigGlobalSetting {
997
1062
  export declare interface ActiveGateGroup {
998
1063
  /**
999
1064
  * Name of ActiveGate group
1065
+ *
1066
+ * @exampleValue default
1000
1067
  */
1001
1068
  name?: string;
1002
1069
  }
@@ -1081,6 +1148,8 @@ export declare interface ActiveGateModule {
1081
1148
  misconfigured?: boolean;
1082
1149
  /**
1083
1150
  * The type of ActiveGate module.
1151
+ *
1152
+ * @exampleValue KUBERNETES
1084
1153
  */
1085
1154
  type?: 'AWS' | 'AZURE' | 'BEACON_FORWARDER' | 'CLOUD_FOUNDRY' | 'DB_INSIGHT' | 'DEBUGGING' | 'EXTENSIONS_V1' | 'EXTENSIONS_V2' | 'KUBERNETES' | 'LOGS' | 'MEMORY_DUMPS' | 'METRIC_API' | 'ONE_AGENT_ROUTING' | 'OTLP_INGEST' | 'REST_API' | 'SYNTHETIC' | 'VMWARE' | 'Z_OS';
1086
1155
  /**
@@ -1177,6 +1246,10 @@ export declare class ActiveGatesActiveGateGroupsClient {
1177
1246
  * + environment:roles:manage-settings
1178
1247
  * + fleet-management:activegates:read
1179
1248
  *
1249
+ * <br/><br/>Deprecated since version 1.343. Use DQL Smartscape nodes to query ActiveGate data instead. See https://dt-url.net/mf03894
1250
+ *
1251
+ * @deprecated
1252
+ *
1180
1253
  * @returns {Promise<ActiveGateGroups>} Success
1181
1254
  *
1182
1255
  * @example <caption>Code example</caption>
@@ -1591,14 +1664,22 @@ export declare class ActiveGatesAutoUpdateJobsClient {
1591
1664
  * Specify the comparison operator here.
1592
1665
  */ startVersionCompareType?: 'EQUAL' | 'GREATER' | 'GREATER_EQUAL' | 'LOWER' | 'LOWER_EQUAL';
1593
1666
  /** Filters the resulting set of update-jobs by the initial version (required format `<major>.<minor>.<revision>`). */ startVersion?: string;
1594
- /** Filters the resulting set of update-jobs by the update type. */ updateType?: 'ACTIVE_GATE' | 'REMOTE_PLUGIN_AGENT' | 'SYNTHETIC' | 'Z_REMOTE';
1667
+ /**
1668
+ * Filters the resulting set of update-jobs by the update type.
1669
+ *
1670
+ * @exampleValue ACTIVE_GATE
1671
+ */ updateType?: 'ACTIVE_GATE' | 'REMOTE_PLUGIN_AGENT' | 'SYNTHETIC' | 'Z_REMOTE';
1595
1672
  /**
1596
1673
  * Filters the resulting set of update jobs by the specified target version.
1597
1674
  *
1598
1675
  * Specify the comparison operator here.
1599
1676
  */ targetVersionCompareType?: 'EQUAL' | 'GREATER' | 'GREATER_EQUAL' | 'LOWER' | 'LOWER_EQUAL';
1600
1677
  /** Filters the resulting set of update-jobs by the target version (required format `<major>.<minor>.<revision>`). */ targetVersion?: string;
1601
- /** If `true`, filters the resulting set of update jobs to the most recent update of each type. */ lastUpdates?: boolean;
1678
+ /**
1679
+ * If `true`, filters the resulting set of update jobs to the most recent update of each type.
1680
+ *
1681
+ * @defaultValue false
1682
+ */ lastUpdates?: boolean;
1602
1683
  abortSignal?: AbortSignal_2;
1603
1684
  }): Promise<UpdateJobsAll>;
1604
1685
  /**
@@ -1675,14 +1756,22 @@ export declare class ActiveGatesAutoUpdateJobsClient {
1675
1756
  * Specify the comparison operator here.
1676
1757
  */ startVersionCompareType?: 'EQUAL' | 'GREATER' | 'GREATER_EQUAL' | 'LOWER' | 'LOWER_EQUAL';
1677
1758
  /** Filters the resulting set of update-jobs by the initial version (required format `<major>.<minor>.<revision>`). */ startVersion?: string;
1678
- /** Filters the resulting set of update-jobs by the update type. */ updateType?: 'ACTIVE_GATE' | 'REMOTE_PLUGIN_AGENT' | 'SYNTHETIC' | 'Z_REMOTE';
1759
+ /**
1760
+ * Filters the resulting set of update-jobs by the update type.
1761
+ *
1762
+ * @exampleValue ACTIVE_GATE
1763
+ */ updateType?: 'ACTIVE_GATE' | 'REMOTE_PLUGIN_AGENT' | 'SYNTHETIC' | 'Z_REMOTE';
1679
1764
  /**
1680
1765
  * Filters the resulting set of update jobs by the specified target version.
1681
1766
  *
1682
1767
  * Specify the comparison operator here.
1683
1768
  */ targetVersionCompareType?: 'EQUAL' | 'GREATER' | 'GREATER_EQUAL' | 'LOWER' | 'LOWER_EQUAL';
1684
1769
  /** Filters the resulting set of update-jobs by the target version (required format `<major>.<minor>.<revision>`). */ targetVersion?: string;
1685
- /** If `true`, filters the resulting set of update jobs to the most recent update of each type. */ lastUpdates?: boolean;
1770
+ /**
1771
+ * If `true`, filters the resulting set of update jobs to the most recent update of each type.
1772
+ *
1773
+ * @defaultValue false
1774
+ */ lastUpdates?: boolean;
1686
1775
  abortSignal?: AbortSignal_2;
1687
1776
  }): Promise<UpdateJobList>;
1688
1777
  /**
@@ -1839,7 +1928,9 @@ export declare class ActiveGatesClient {
1839
1928
  * + environment:roles:manage-settings
1840
1929
  * + fleet-management:activegates:read
1841
1930
  *
1842
- * <br/><br/>The response includes all ActiveGates that are currently connected to the environment or have been connected during last 2 hours.
1931
+ * <br/><br/>The response includes all ActiveGates that are currently connected to the environment or have been connected during last 2 hours. Deprecated since version 1.343. Use DQL Smartscape nodes to query ActiveGate data instead. See https://dt-url.net/mf03894
1932
+ *
1933
+ * @deprecated
1843
1934
  *
1844
1935
  * @returns {Promise<ActiveGateList>} Success
1845
1936
  *
@@ -1914,6 +2005,10 @@ export declare class ActiveGatesClient {
1914
2005
  * + environment:roles:manage-settings
1915
2006
  * + fleet-management:activegates:read
1916
2007
  *
2008
+ * <br/><br/>Deprecated since version 1.343. Use DQL Smartscape nodes to query ActiveGate data instead. See https://dt-url.net/mf03894
2009
+ *
2010
+ * @deprecated
2011
+ *
1917
2012
  * @returns {Promise<ActiveGate>} Success
1918
2013
  *
1919
2014
  * @example <caption>Code example</caption>
@@ -2173,32 +2268,46 @@ export declare interface ActiveGateToken {
2173
2268
  activeGateType: 'ENVIRONMENT' | 'CLUSTER';
2174
2269
  /**
2175
2270
  * The token creation date in ISO 8601 format (`yyyy-MM-dd'T'HH:mm:ss.SSS'Z'`).
2271
+ *
2272
+ * @exampleValue 2020-11-22T08:15:30.144Z
2176
2273
  */
2177
2274
  creationDate: string;
2178
2275
  /**
2179
2276
  * The token expiration date in ISO 8601 format (`yyyy-MM-dd'T'HH:mm:ss.SSS'Z'`).
2180
2277
  *
2181
2278
  * If not set, the token never expires.
2279
+ *
2280
+ * @exampleValue 2020-11-24T08:15:30.144Z
2182
2281
  */
2183
2282
  expirationDate?: string;
2184
2283
  /**
2185
2284
  * The ActiveGate token identifier, consisting of [prefix and public part](https://dt-url.net/rn00tjg) of the token.
2285
+ *
2286
+ * @exampleValue dt0g02.4KWZO5EF
2186
2287
  */
2187
2288
  id: string;
2188
2289
  /**
2189
2290
  * The token last used date in ISO 8601 format (`yyyy-MM-dd'T'HH:mm:ss.SSS'Z'`).
2291
+ *
2292
+ * @exampleValue 2020-11-23T08:15:30.144Z
2190
2293
  */
2191
2294
  lastUsedDate?: string;
2192
2295
  /**
2193
2296
  * The name of the token.
2297
+ *
2298
+ * @exampleValue myToken
2194
2299
  */
2195
2300
  name: string;
2196
2301
  /**
2197
2302
  * The owner of the token.
2303
+ *
2304
+ * @exampleValue john.smith
2198
2305
  */
2199
2306
  owner: string;
2200
2307
  /**
2201
2308
  * The token is a seed token (`true`) or an individual token (`false`).
2309
+ *
2310
+ * @exampleValue false
2202
2311
  */
2203
2312
  seedToken?: boolean;
2204
2313
  }
@@ -2240,16 +2349,22 @@ export declare interface ActiveGateTokenCreate {
2240
2349
  * If not set, the token never expires.
2241
2350
  *
2242
2351
  * Ensure that it is not set in the past and does not exceed `2 years` from the moment of creation."
2352
+ *
2353
+ * @exampleValue now+6M
2243
2354
  */
2244
2355
  expirationDate?: string;
2245
2356
  /**
2246
2357
  * The name of the token.
2358
+ *
2359
+ * @exampleValue myToken
2247
2360
  */
2248
2361
  name: string;
2249
2362
  /**
2250
2363
  * The token is a seed token (`true`) or an individual token (`false`).
2251
2364
  *
2252
2365
  * We recommend the individual token option (false).
2366
+ *
2367
+ * @exampleValue false
2253
2368
  */
2254
2369
  seedToken?: boolean;
2255
2370
  }
@@ -2270,14 +2385,20 @@ export declare enum ActiveGateTokenCreateActiveGateType {
2270
2385
  export declare interface ActiveGateTokenCreated {
2271
2386
  /**
2272
2387
  * The token expiration date in ISO 8601 format (`yyyy-MM-dd'T'HH:mm:ss.SSS'Z'`).
2388
+ *
2389
+ * @exampleValue 2020-11-24T08:15:30.144Z
2273
2390
  */
2274
2391
  expirationDate?: string;
2275
2392
  /**
2276
2393
  * The ActiveGate token identifier, consisting of [prefix and public part](https://dt-url.net/rn00tjg) of the token.
2394
+ *
2395
+ * @exampleValue dt0g02.4KWZO5EF
2277
2396
  */
2278
2397
  id: string;
2279
2398
  /**
2280
2399
  * The secret of the token.
2400
+ *
2401
+ * @exampleValue dt0g02.4KWZO5EF.XT47R5DRADJIZUFOX4UDNOKTSUSABGLN7XSMJG7UXHRXKNY4WLORH4OF4T75MG7E
2281
2402
  */
2282
2403
  token: string;
2283
2404
  }
@@ -2312,6 +2433,8 @@ export declare interface ActiveGateTokenInfoDto {
2312
2433
  environmentId?: string;
2313
2434
  /**
2314
2435
  * The ActiveGate token identifier, consisting of [prefix and public part](https://dt-url.net/rn00tjg) of the token.
2436
+ *
2437
+ * @exampleValue dt0g02.4KWZO5EF
2315
2438
  */
2316
2439
  id?: string;
2317
2440
  /**
@@ -2346,6 +2469,8 @@ export declare interface ActiveGateTokenList {
2346
2469
  * The cursor for the next page of results. Has the value of `null` on the last page.
2347
2470
  *
2348
2471
  * Use it in the **nextPageKey** query parameter to obtain subsequent pages of the result.
2472
+ *
2473
+ * @exampleValue AQAAABQBAAAABQ==
2349
2474
  */
2350
2475
  nextPageKey?: string;
2351
2476
  /**
@@ -2483,6 +2608,8 @@ export declare interface AffectedEntity {
2483
2608
  export declare interface AgentConnectionToken {
2484
2609
  /**
2485
2610
  * The agent connection token
2611
+ *
2612
+ * @exampleValue dt0a01.1.40f...bd9
2486
2613
  */
2487
2614
  token?: string;
2488
2615
  }
@@ -2553,48 +2680,70 @@ export declare interface ApiToken {
2553
2680
  *
2554
2681
  * * A `dashboardId` property for dashboard sharing tokens.
2555
2682
  * * A `reportId` property for report sharing tokens
2683
+ *
2684
+ * @exampleValue {"dashboardId":"82402bab-7370-4359-924d-88ed13c8919a"}
2556
2685
  */
2557
2686
  additionalMetadata?: ApiTokenAdditionalMetadata;
2558
2687
  /**
2559
2688
  * Token creation date in ISO 8601 format (`yyyy-MM-dd'T'HH:mm:ss.SSS'Z'`)
2689
+ *
2690
+ * @exampleValue 2020-11-05T08:15:30.144Z
2560
2691
  */
2561
2692
  creationDate?: string;
2562
2693
  /**
2563
2694
  * The token is enabled (`true`) or disabled (`false`).
2695
+ *
2696
+ * @exampleValue true
2564
2697
  */
2565
2698
  enabled?: boolean;
2566
2699
  /**
2567
2700
  * Token expiration date in ISO 8601 format (`yyyy-MM-dd'T'HH:mm:ss.SSS'Z'`).
2568
2701
  *
2569
2702
  * If not set, the token never expires.
2703
+ *
2704
+ * @exampleValue 2020-11-12T08:15:30.144Z
2570
2705
  */
2571
2706
  expirationDate?: string;
2572
2707
  /**
2573
2708
  * The ID of the token, consisting of prefix and public part of the token.
2709
+ *
2710
+ * @exampleValue dt0c01.ST2EY72KQINMH574WMNVI7YN
2574
2711
  */
2575
2712
  id?: string;
2576
2713
  /**
2577
2714
  * Token last used date in ISO 8601 format (`yyyy-MM-dd'T'HH:mm:ss.SSS'Z'`)
2715
+ *
2716
+ * @exampleValue 2020-11-12T08:15:30.144Z
2578
2717
  */
2579
2718
  lastUsedDate?: string;
2580
2719
  /**
2581
2720
  * Token last used IP address.
2721
+ *
2722
+ * @exampleValue 34.197.2.44
2582
2723
  */
2583
2724
  lastUsedIpAddress?: string;
2584
2725
  /**
2585
2726
  * Token last modified date in ISO 8601 format (`yyyy-MM-dd'T'HH:mm:ss.SSS'Z'`). Updating scopes or name counts as modification, enabling or disabling a token does not.
2727
+ *
2728
+ * @exampleValue 2020-11-12T08:15:30.144Z
2586
2729
  */
2587
2730
  modifiedDate?: string;
2588
2731
  /**
2589
2732
  * The name of the token.
2733
+ *
2734
+ * @exampleValue myToken
2590
2735
  */
2591
2736
  name?: string;
2592
2737
  /**
2593
2738
  * The owner of the token.
2739
+ *
2740
+ * @exampleValue john.smith
2594
2741
  */
2595
2742
  owner?: string;
2596
2743
  /**
2597
2744
  * The token is a [personal access token](https://dt-url.net/wm03sop) (`true`) or an API token (`false`).
2745
+ *
2746
+ * @exampleValue true
2598
2747
  */
2599
2748
  personalAccessToken?: boolean;
2600
2749
  /**
@@ -2634,16 +2783,22 @@ export declare interface ApiTokenCreate {
2634
2783
  * * `y`: years
2635
2784
  *
2636
2785
  * If not set, the token never expires. Ensure that the expiration date is not set in the past.
2786
+ *
2787
+ * @exampleValue now+14d
2637
2788
  */
2638
2789
  expirationDate?: string;
2639
2790
  /**
2640
2791
  * The name of the token.
2792
+ *
2793
+ * @exampleValue tokenName
2641
2794
  */
2642
2795
  name: string;
2643
2796
  /**
2644
2797
  * The token is a personal access token (`true`) or an API token (`false`).
2645
2798
  *
2646
2799
  * Personal access tokens are tied to the permissions of their owner.
2800
+ *
2801
+ * @exampleValue false
2647
2802
  */
2648
2803
  personalAccessToken?: boolean;
2649
2804
  /**
@@ -2750,14 +2905,20 @@ export declare interface ApiTokenCreate {
2750
2905
  export declare interface ApiTokenCreated {
2751
2906
  /**
2752
2907
  * The token expiration date in ISO 8601 format (`yyyy-MM-dd'T'HH:mm:ss.SSS'Z'`).
2908
+ *
2909
+ * @exampleValue 2020-11-12T08:15:30.144Z
2753
2910
  */
2754
2911
  expirationDate?: string;
2755
2912
  /**
2756
2913
  * The ID of the token, consisting of prefix and public part of the token.
2914
+ *
2915
+ * @exampleValue dt0c01.ST2EY72KQINMH574WMNVI7YN
2757
2916
  */
2758
2917
  id?: string;
2759
2918
  /**
2760
2919
  * The secret of the token.
2920
+ *
2921
+ * @exampleValue dt0c01.ST2EY72KQINMH574WMNVI7YN.G3DFPBEJYMODIDAEX454M7YWBUVEFOWKPRVMWFASS64NFH52PX6BNDVFFM572RZM
2761
2922
  */
2762
2923
  token?: string;
2763
2924
  }
@@ -2871,6 +3032,8 @@ export declare interface ApiTokenList {
2871
3032
  * The cursor for the next page of results. Has the value of `null` on the last page.
2872
3033
  *
2873
3034
  * Use it in the **nextPageKey** query parameter to obtain subsequent pages of the result.
3035
+ *
3036
+ * @exampleValue AQAAABQBAAAABQ==
2874
3037
  */
2875
3038
  nextPageKey?: string;
2876
3039
  /**
@@ -2989,6 +3152,8 @@ export declare enum ApiTokenScopesItem {
2989
3152
  export declare interface ApiTokenSecret {
2990
3153
  /**
2991
3154
  * The API token.
3155
+ *
3156
+ * @exampleValue dt0c01.ST2EY72KQINMH574WMNVI7YN.G3DFPBEJYMODIDAEX454M7YWBUVEFOWKPRVMWFASS64NFH52PX6BNDVFFM572RZM
2992
3157
  */
2993
3158
  token: string;
2994
3159
  }
@@ -2999,10 +3164,14 @@ export declare interface ApiTokenSecret {
2999
3164
  export declare interface ApiTokenUpdate {
3000
3165
  /**
3001
3166
  * The token is enabled (`true`) or disabled (`false`)
3167
+ *
3168
+ * @exampleValue true
3002
3169
  */
3003
3170
  enabled?: boolean;
3004
3171
  /**
3005
3172
  * The name of the token.
3173
+ *
3174
+ * @exampleValue myToken
3006
3175
  */
3007
3176
  name?: string;
3008
3177
  /**
@@ -3231,7 +3400,7 @@ export declare interface AssessmentAccuracyDetails {
3231
3400
  /**
3232
3401
  * The reasons for a reduced assessment accuracy.
3233
3402
  */
3234
- reducedReasons?: Array<'LIMITED_AGENT_SUPPORT' | 'LIMITED_BY_CONFIGURATION'>;
3403
+ reducedReasons?: Array<'LIMITED_AGENT_SUPPORT' | 'LIMITED_BY_CONFIGURATION' | 'LIMITED_BY_SERVICE_DETECTION_V2'>;
3235
3404
  }
3236
3405
 
3237
3406
  /**
@@ -3241,7 +3410,8 @@ export declare interface AssessmentAccuracyDetails {
3241
3410
  */
3242
3411
  export declare enum AssessmentAccuracyDetailsReducedReasonsItem {
3243
3412
  LimitedAgentSupport = "LIMITED_AGENT_SUPPORT",
3244
- LimitedByConfiguration = "LIMITED_BY_CONFIGURATION"
3413
+ LimitedByConfiguration = "LIMITED_BY_CONFIGURATION",
3414
+ LimitedByServiceDetectionV2 = "LIMITED_BY_SERVICE_DETECTION_V2"
3245
3415
  }
3246
3416
 
3247
3417
  /**
@@ -3492,6 +3662,8 @@ export declare interface AttackList {
3492
3662
  * The cursor for the next page of results. Has the value of `null` on the last page.
3493
3663
  *
3494
3664
  * Use it in the **nextPageKey** query parameter to obtain subsequent pages of the result.
3665
+ *
3666
+ * @exampleValue AQAAABQBAAAABQ==
3495
3667
  */
3496
3668
  nextPageKey?: string;
3497
3669
  /**
@@ -3798,6 +3970,8 @@ export declare interface AuditLog {
3798
3970
  * The cursor for the next page of results. Has the value of `null` on the last page.
3799
3971
  *
3800
3972
  * Use it in the **nextPageKey** query parameter to obtain subsequent pages of the result.
3973
+ *
3974
+ * @exampleValue AQAAABQBAAAABQ==
3801
3975
  */
3802
3976
  nextPageKey?: string;
3803
3977
  /**
@@ -3836,6 +4010,8 @@ export declare interface AuditLogEntry {
3836
4010
  'dt.settings.schema_id'?: string;
3837
4011
  /**
3838
4012
  * The persistence scope for entries of category `CONFIG`, e.g. an ME identifier.
4013
+ *
4014
+ * @exampleValue environment
3839
4015
  */
3840
4016
  'dt.settings.scope_id'?: string;
3841
4017
  /**
@@ -4077,6 +4253,8 @@ export declare class AuditLogsClient {
4077
4253
  * * `-timestamp`: Newest first.
4078
4254
  *
4079
4255
  * If not set, the newest first sorting is applied.
4256
+ *
4257
+ * @defaultValue -timestamp
4080
4258
  */ sort?: string;
4081
4259
  abortSignal?: AbortSignal_2;
4082
4260
  }): Promise<AuditLog>;
@@ -4801,6 +4979,8 @@ export declare interface CommentsList {
4801
4979
  * The cursor for the next page of results. Has the value of `null` on the last page.
4802
4980
  *
4803
4981
  * Use it in the **nextPageKey** query parameter to obtain subsequent pages of the result.
4982
+ *
4983
+ * @exampleValue AQAAABQBAAAABQ==
4804
4984
  */
4805
4985
  nextPageKey?: string;
4806
4986
  /**
@@ -4819,6 +4999,8 @@ export declare interface CommentsList {
4819
4999
  export declare interface ComplexConstraint {
4820
5000
  /**
4821
5001
  * Defines if modification of any property triggers secret resubmission check.
5002
+ *
5003
+ * @exampleValue false
4822
5004
  */
4823
5005
  checkAllProperties?: boolean;
4824
5006
  /**
@@ -4827,14 +5009,20 @@ export declare interface ComplexConstraint {
4827
5009
  customMessage?: string;
4828
5010
  /**
4829
5011
  * The ID of a custom validator.
5012
+ *
5013
+ * @exampleValue my-min-max
4830
5014
  */
4831
5015
  customValidatorId?: string;
4832
5016
  /**
4833
5017
  * The maximum number of properties that can be set.
5018
+ *
5019
+ * @exampleValue 2
4834
5020
  */
4835
5021
  maximumPropertyCount?: number;
4836
5022
  /**
4837
5023
  * The minimum number of properties that must be set.
5024
+ *
5025
+ * @exampleValue 1
4838
5026
  */
4839
5027
  minimumPropertyCount?: number;
4840
5028
  /**
@@ -4843,10 +5031,14 @@ export declare interface ComplexConstraint {
4843
5031
  properties?: string[];
4844
5032
  /**
4845
5033
  * Whether to skip validation on a change made from the UI.
5034
+ *
5035
+ * @exampleValue false
4846
5036
  */
4847
5037
  skipAsyncValidation?: boolean;
4848
5038
  /**
4849
5039
  * The maximum time in seconds the custom validator is allowed to run.
5040
+ *
5041
+ * @exampleValue 5
4850
5042
  */
4851
5043
  timeout?: number;
4852
5044
  /**
@@ -4877,14 +5069,20 @@ export declare enum ComplexConstraintType {
4877
5069
  export declare interface ConfigurationMetadata {
4878
5070
  /**
4879
5071
  * Dynatrace version.
5072
+ *
5073
+ * @exampleValue 1.192.1
4880
5074
  */
4881
5075
  clusterVersion?: string;
4882
5076
  /**
4883
5077
  * A sorted list of the version numbers of the configuration.
5078
+ *
5079
+ * @exampleValue [4,2]
4884
5080
  */
4885
5081
  configurationVersions?: number[];
4886
5082
  /**
4887
5083
  * A sorted list of version numbers of the configuration.
5084
+ *
5085
+ * @exampleValue ["1.0.4","1.23"]
4888
5086
  */
4889
5087
  currentConfigurationVersions?: string[];
4890
5088
  }
@@ -4895,50 +5093,74 @@ export declare interface ConfigurationMetadata {
4895
5093
  export declare interface Constraint {
4896
5094
  /**
4897
5095
  * A custom message for invalid values.
5096
+ *
5097
+ * @exampleValue customConstraintMessage
4898
5098
  */
4899
5099
  customMessage?: string;
4900
5100
  /**
4901
5101
  * The ID of a custom validator.
5102
+ *
5103
+ * @exampleValue my-min-max
4902
5104
  */
4903
5105
  customValidatorId?: string;
4904
5106
  /**
4905
5107
  * Whether to disallow usage of dangerous regexes
5108
+ *
5109
+ * @exampleValue true
4906
5110
  */
4907
5111
  disallowDangerousRegex?: boolean;
4908
5112
  /**
4909
5113
  * The maximum allowed length of string values.
5114
+ *
5115
+ * @exampleValue 20
4910
5116
  */
4911
5117
  maxLength?: number;
4912
5118
  /**
4913
5119
  * The maximum allowed value.
5120
+ *
5121
+ * @exampleValue 200
4914
5122
  */
4915
5123
  maximum?: number;
4916
5124
  /**
4917
5125
  * The minimum required length of string values.
5126
+ *
5127
+ * @exampleValue 7
4918
5128
  */
4919
5129
  minLength?: number;
4920
5130
  /**
4921
5131
  * The minimum allowed value.
5132
+ *
5133
+ * @exampleValue 3
4922
5134
  */
4923
5135
  minimum?: number;
4924
5136
  /**
4925
5137
  * The regular expression pattern for valid string values.
5138
+ *
5139
+ * @exampleValue ^([a-z]|[0-9]|\-|\_|\+|\.)+\@([a-z]|[0-9]|-){2,}\.([a-z]|[0-9]|-){2,}(\.[a-z]{2,})?$
4926
5140
  */
4927
5141
  pattern?: string;
4928
5142
  /**
4929
5143
  * Whether to skip validation on a change made from the UI.
5144
+ *
5145
+ * @exampleValue false
4930
5146
  */
4931
5147
  skipAsyncValidation?: boolean;
4932
5148
  /**
4933
5149
  * The maximum time in seconds the custom validator is allowed to run.
5150
+ *
5151
+ * @exampleValue 5
4934
5152
  */
4935
5153
  timeout?: number;
4936
5154
  /**
4937
5155
  * The type of the constraint.
5156
+ *
5157
+ * @exampleValue UNKNOWN
4938
5158
  */
4939
5159
  type: 'CUSTOM_VALIDATOR_REF' | 'LENGTH' | 'NOT_BLANK' | 'NOT_EMPTY' | 'NO_WHITESPACE' | 'PATTERN' | 'RANGE' | 'REGEX' | 'TRIMMED' | 'UNIQUE' | 'UNKNOWN';
4940
5160
  /**
4941
5161
  * A list of properties for which the combination of values must be unique.
5162
+ *
5163
+ * @exampleValue ["my-prop-1","my-prop-2"]
4942
5164
  */
4943
5165
  uniqueProperties?: string[];
4944
5166
  }
@@ -4993,7 +5215,7 @@ export declare interface ContainerImageComponent {
4993
5215
  /**
4994
5216
  * Container image component type.
4995
5217
  */
4996
- type?: 'activegate' | 'codemodules' | 'database-datasource-executor' | 'dynatrace-sql-extension-executor' | 'eec' | 'logmodule' | 'oneagent';
5218
+ type?: 'activegate' | 'codemodules' | 'database-datasource-executor' | 'sql-extension-executor' | 'dynatrace-sql-extension-executor' | 'eec' | 'logmodule' | 'oneagent';
4997
5219
  }
4998
5220
 
4999
5221
  /**
@@ -5005,6 +5227,7 @@ export declare enum ContainerImageComponentType {
5005
5227
  Activegate = "activegate",
5006
5228
  Codemodules = "codemodules",
5007
5229
  DatabaseDatasourceExecutor = "database-datasource-executor",
5230
+ SqlExtensionExecutor = "sql-extension-executor",
5008
5231
  DynatraceSqlExtensionExecutor = "dynatrace-sql-extension-executor",
5009
5232
  Eec = "eec",
5010
5233
  Logmodule = "logmodule",
@@ -5867,6 +6090,8 @@ export declare interface DavisSecurityAdviceList {
5867
6090
  * The cursor for the next page of results. Has the value of `null` on the last page.
5868
6091
  *
5869
6092
  * Use it in the **nextPageKey** query parameter to obtain subsequent pages of the result.
6093
+ *
6094
+ * @exampleValue AQAAABQBAAAABQ==
5870
6095
  */
5871
6096
  nextPageKey?: string;
5872
6097
  /**
@@ -6004,11 +6229,15 @@ export declare interface DeletionConstraint {
6004
6229
  customMessage?: string;
6005
6230
  /**
6006
6231
  * The ID of a custom validator.
6232
+ *
6233
+ * @exampleValue my-min-max
6007
6234
  */
6008
6235
  customValidatorId?: string;
6009
6236
  schemaIds?: string[];
6010
6237
  /**
6011
6238
  * The maximum time in seconds the custom validator is allowed to run.
6239
+ *
6240
+ * @exampleValue 5
6012
6241
  */
6013
6242
  timeout?: number;
6014
6243
  /**
@@ -6065,6 +6294,9 @@ export declare interface EffectivePermission {
6065
6294
  */
6066
6295
  context?: PermissionContext;
6067
6296
  granted: 'condition' | 'false' | 'true';
6297
+ /**
6298
+ * @exampleValue settings:objects:write
6299
+ */
6068
6300
  permission: string;
6069
6301
  }
6070
6302
 
@@ -6083,6 +6315,8 @@ export declare enum EffectivePermissionGranted {
6083
6315
  export declare interface EffectiveSettingsValue {
6084
6316
  /**
6085
6317
  * The user (identified by a user ID or a public token ID) who performed that most recent modification.
6318
+ *
6319
+ * @exampleValue john.doe@example.com
6086
6320
  */
6087
6321
  author?: string;
6088
6322
  /**
@@ -6099,14 +6333,20 @@ export declare interface EffectiveSettingsValue {
6099
6333
  modified?: number;
6100
6334
  /**
6101
6335
  * The origin of the settings value.
6336
+ *
6337
+ * @exampleValue HOST-D3A3C5A146830A79
6102
6338
  */
6103
6339
  origin?: string;
6104
6340
  /**
6105
6341
  * The schema on which the object is based.
6342
+ *
6343
+ * @exampleValue builtin:container.built-in-monitoring-rule
6106
6344
  */
6107
6345
  schemaId?: string;
6108
6346
  /**
6109
6347
  * The version of the schema on which the object is based.
6348
+ *
6349
+ * @exampleValue 1.0.0
6110
6350
  */
6111
6351
  schemaVersion?: string;
6112
6352
  /**
@@ -6123,6 +6363,8 @@ export declare interface EffectiveSettingsValue {
6123
6363
  * It defines the actual values of settings' parameters.
6124
6364
  *
6125
6365
  * The actual content depends on the object's schema.
6366
+ *
6367
+ * @exampleValue {"autoMonitoring":true}
6126
6368
  */
6127
6369
  value?: AnyValue;
6128
6370
  }
@@ -6139,6 +6381,8 @@ export declare interface EffectiveSettingsValuesList {
6139
6381
  * The cursor for the next page of results. Has the value of `null` on the last page.
6140
6382
  *
6141
6383
  * Use it in the **nextPageKey** query parameter to obtain subsequent pages of the result.
6384
+ *
6385
+ * @exampleValue AQAAABQBAAAABQ==
6142
6386
  */
6143
6387
  nextPageKey?: string;
6144
6388
  /**
@@ -6237,6 +6481,8 @@ export declare interface EntitiesList {
6237
6481
  * The cursor for the next page of results. Has the value of `null` on the last page.
6238
6482
  *
6239
6483
  * Use it in the **nextPageKey** query parameter to obtain subsequent pages of the result.
6484
+ *
6485
+ * @exampleValue AQAAABQBAAAABQ==
6240
6486
  */
6241
6487
  nextPageKey?: string;
6242
6488
  /**
@@ -6442,6 +6688,8 @@ export declare interface EntityTypeList {
6442
6688
  * The cursor for the next page of results. Has the value of `null` on the last page.
6443
6689
  *
6444
6690
  * Use it in the **nextPageKey** query parameter to obtain subsequent pages of the result.
6691
+ *
6692
+ * @exampleValue AQAAABQBAAAABQ==
6445
6693
  */
6446
6694
  nextPageKey?: string;
6447
6695
  /**
@@ -6464,14 +6712,20 @@ export declare interface EntityTypeList {
6464
6712
  export declare interface EntityTypePropertyDto {
6465
6713
  /**
6466
6714
  * The display-name of the property.
6715
+ *
6716
+ * @exampleValue cpu cores
6467
6717
  */
6468
6718
  displayName?: string;
6469
6719
  /**
6470
6720
  * The ID of the property.
6721
+ *
6722
+ * @exampleValue cpuCores
6471
6723
  */
6472
6724
  id?: string;
6473
6725
  /**
6474
6726
  * The type of the property.
6727
+ *
6728
+ * @exampleValue Number
6475
6729
  */
6476
6730
  type?: string;
6477
6731
  }
@@ -6595,18 +6849,26 @@ export declare enum EntryPointUsageSegmentSourceType {
6595
6849
  export declare interface EnumType {
6596
6850
  /**
6597
6851
  * A short description of the property.
6852
+ *
6853
+ * @exampleValue typeDescription
6598
6854
  */
6599
6855
  description: string;
6600
6856
  /**
6601
6857
  * The display name of the property.
6858
+ *
6859
+ * @exampleValue typeDisplayName
6602
6860
  */
6603
6861
  displayName?: string;
6604
6862
  /**
6605
6863
  * An extended description and/or links to documentation.
6864
+ *
6865
+ * @exampleValue typeDocumentation
6606
6866
  */
6607
6867
  documentation: string;
6608
6868
  /**
6609
6869
  * An existing Java enum class that holds the allowed values of the enum.
6870
+ *
6871
+ * @exampleValue enumClass
6610
6872
  */
6611
6873
  enumClass?: string;
6612
6874
  /**
@@ -6615,6 +6877,8 @@ export declare interface EnumType {
6615
6877
  items: EnumValue[];
6616
6878
  /**
6617
6879
  * The type of the property.
6880
+ *
6881
+ * @exampleValue enum
6618
6882
  */
6619
6883
  type: 'enum';
6620
6884
  }
@@ -6634,22 +6898,32 @@ export declare enum EnumTypeType {
6634
6898
  export declare interface EnumValue {
6635
6899
  /**
6636
6900
  * A short description of the value.
6901
+ *
6902
+ * @exampleValue exampleDescription
6637
6903
  */
6638
6904
  description?: string;
6639
6905
  /**
6640
6906
  * The display name of the value.
6907
+ *
6908
+ * @exampleValue exampleDisplayName
6641
6909
  */
6642
6910
  displayName: string;
6643
6911
  /**
6644
6912
  * The name of the value in an existing Java enum class.
6913
+ *
6914
+ * @exampleValue exampleJavaEnumValue
6645
6915
  */
6646
6916
  enumInstance?: string;
6647
6917
  /**
6648
6918
  * The icon of the value.
6919
+ *
6920
+ * @exampleValue checkmark
6649
6921
  */
6650
6922
  icon?: string;
6651
6923
  /**
6652
6924
  * The allowed value of the enum.
6925
+ *
6926
+ * @exampleValue exampleValue
6653
6927
  */
6654
6928
  value: AnyValue;
6655
6929
  }
@@ -6688,12 +6962,16 @@ export declare class ErrorEnvelopeError extends ClientRequestError<ErrorEnvelope
6688
6962
  declare interface Event_2 {
6689
6963
  /**
6690
6964
  * The correlation ID of the event.
6965
+ *
6966
+ * @exampleValue 933613657e1c8fcf
6691
6967
  */
6692
6968
  correlationId?: string;
6693
6969
  /**
6694
6970
  * The timestamp when the event was closed, in UTC milliseconds.
6695
6971
  *
6696
6972
  * Has the value of `null` if the event is still active.
6973
+ *
6974
+ * @exampleValue 1564039524182
6697
6975
  */
6698
6976
  endTime?: number;
6699
6977
  /**
@@ -6706,10 +6984,14 @@ declare interface Event_2 {
6706
6984
  entityTags?: METag[];
6707
6985
  /**
6708
6986
  * The ID of the event.
6987
+ *
6988
+ * @exampleValue 4293884258445543163_1564039524182
6709
6989
  */
6710
6990
  eventId?: string;
6711
6991
  /**
6712
6992
  * The type of the event.
6993
+ *
6994
+ * @exampleValue LOW_DISK_SPACE
6713
6995
  */
6714
6996
  eventType?: string;
6715
6997
  /**
@@ -6728,10 +7010,14 @@ declare interface Event_2 {
6728
7010
  properties?: EventProperty[];
6729
7011
  /**
6730
7012
  * The timestamp when the event was raised, in UTC milliseconds.
7013
+ *
7014
+ * @exampleValue 1564039524182
6731
7015
  */
6732
7016
  startTime?: number;
6733
7017
  /**
6734
7018
  * The status of the event.
7019
+ *
7020
+ * @exampleValue OPEN
6735
7021
  */
6736
7022
  status?: 'CLOSED' | 'OPEN';
6737
7023
  /**
@@ -6750,6 +7036,8 @@ declare interface Event_2 {
6750
7036
  suppressProblem?: boolean;
6751
7037
  /**
6752
7038
  * The title of the event.
7039
+ *
7040
+ * @exampleValue High CPU load on host X
6753
7041
  */
6754
7042
  title?: string;
6755
7043
  /**
@@ -6938,6 +7226,8 @@ export declare interface EventList {
6938
7226
  * The cursor for the next page of results. Has the value of `null` on the last page.
6939
7227
  *
6940
7228
  * Use it in the **nextPageKey** query parameter to obtain subsequent pages of the result.
7229
+ *
7230
+ * @exampleValue AQAAABQBAAAABQ==
6941
7231
  */
6942
7232
  nextPageKey?: string;
6943
7233
  /**
@@ -6966,6 +7256,8 @@ export declare interface EventPropertiesList {
6966
7256
  * The cursor for the next page of results. Has the value of `null` on the last page.
6967
7257
  *
6968
7258
  * Use it in the **nextPageKey** query parameter to obtain subsequent pages of the result.
7259
+ *
7260
+ * @exampleValue AQAAABQBAAAABQ==
6969
7261
  */
6970
7262
  nextPageKey?: string;
6971
7263
  /**
@@ -7002,6 +7294,8 @@ export declare interface EventPropertyDetails {
7002
7294
  description?: string;
7003
7295
  /**
7004
7296
  * The display name of the event property.
7297
+ *
7298
+ * @exampleValue Custom description
7005
7299
  */
7006
7300
  displayName?: string;
7007
7301
  /**
@@ -7011,6 +7305,8 @@ export declare interface EventPropertyDetails {
7011
7305
  filterable?: boolean;
7012
7306
  /**
7013
7307
  * The key of the event property.
7308
+ *
7309
+ * @exampleValue dt.event.description
7014
7310
  */
7015
7311
  key?: string;
7016
7312
  /**
@@ -7372,14 +7668,20 @@ export declare interface EventType {
7372
7668
  description?: string;
7373
7669
  /**
7374
7670
  * The display name of the event type.
7671
+ *
7672
+ * @exampleValue High CPU
7375
7673
  */
7376
7674
  displayName?: string;
7377
7675
  /**
7378
7676
  * The severity level associated with the event type.
7677
+ *
7678
+ * @exampleValue PERFORMANCE
7379
7679
  */
7380
7680
  severityLevel?: 'AVAILABILITY' | 'CUSTOM_ALERT' | 'ERROR' | 'INFO' | 'MONITORING_UNAVAILABLE' | 'PERFORMANCE' | 'RESOURCE_CONTENTION';
7381
7681
  /**
7382
7682
  * The event type.
7683
+ *
7684
+ * @exampleValue OSI_HIGH_CPU
7383
7685
  */
7384
7686
  type?: string;
7385
7687
  }
@@ -7396,6 +7698,8 @@ export declare interface EventTypeList {
7396
7698
  * The cursor for the next page of results. Has the value of `null` on the last page.
7397
7699
  *
7398
7700
  * Use it in the **nextPageKey** query parameter to obtain subsequent pages of the result.
7701
+ *
7702
+ * @exampleValue AQAAABQBAAAABQ==
7399
7703
  */
7400
7704
  nextPageKey?: string;
7401
7705
  /**
@@ -7683,6 +7987,8 @@ export declare interface ExportedLogRecordList {
7683
7987
  * The cursor for the next page of results. Has the value of `null` on the last page.
7684
7988
  *
7685
7989
  * Use it in the **nextPageKey** query parameter to obtain subsequent pages of the result.
7990
+ *
7991
+ * @exampleValue AQAAABQBAAAABQ==
7686
7992
  */
7687
7993
  nextPageKey?: string;
7688
7994
  /**
@@ -7742,6 +8048,8 @@ export declare interface Extension {
7742
8048
  variables: string[];
7743
8049
  /**
7744
8050
  * Extension version
8051
+ *
8052
+ * @exampleValue 1.2.3
7745
8053
  */
7746
8054
  version: string;
7747
8055
  }
@@ -7764,6 +8072,8 @@ export declare interface ExtensionAssetsDto {
7764
8072
  status: string;
7765
8073
  /**
7766
8074
  * Version of the active extension environment configuration.
8075
+ *
8076
+ * @exampleValue 1.2.3
7767
8077
  */
7768
8078
  version: string;
7769
8079
  }
@@ -7771,6 +8081,8 @@ export declare interface ExtensionAssetsDto {
7771
8081
  export declare interface ExtensionEnvironmentConfigurationVersion {
7772
8082
  /**
7773
8083
  * Extension version
8084
+ *
8085
+ * @exampleValue 1.2.3
7774
8086
  */
7775
8087
  version: string;
7776
8088
  }
@@ -7788,6 +8100,8 @@ export declare interface ExtensionFeatureSetsDetails {
7788
8100
  export declare interface ExtensionInfo {
7789
8101
  /**
7790
8102
  * Active version in the environment (null if none is active)
8103
+ *
8104
+ * @exampleValue 1.2.3
7791
8105
  */
7792
8106
  activeVersion?: string | null;
7793
8107
  /**
@@ -7800,6 +8114,8 @@ export declare interface ExtensionInfo {
7800
8114
  keywords: string[];
7801
8115
  /**
7802
8116
  * Highest installed version
8117
+ *
8118
+ * @exampleValue 1.2.3
7803
8119
  */
7804
8120
  version: string;
7805
8121
  }
@@ -7813,6 +8129,8 @@ export declare interface ExtensionInfoList {
7813
8129
  * The cursor for the next page of results. Has the value of `null` on the last page.
7814
8130
  *
7815
8131
  * Use it in the **nextPageKey** query parameter to obtain subsequent pages of the result.
8132
+ *
8133
+ * @exampleValue AQAAABQBAAAABQ==
7816
8134
  */
7817
8135
  nextPageKey?: string;
7818
8136
  /**
@@ -7834,6 +8152,8 @@ export declare interface ExtensionList {
7834
8152
  * The cursor for the next page of results. Has the value of `null` on the last page.
7835
8153
  *
7836
8154
  * Use it in the **nextPageKey** query parameter to obtain subsequent pages of the result.
8155
+ *
8156
+ * @exampleValue AQAAABQBAAAABQ==
7837
8157
  */
7838
8158
  nextPageKey?: string;
7839
8159
  /**
@@ -7870,6 +8190,8 @@ export declare interface ExtensionMonitoringConfigurationsList {
7870
8190
  * The cursor for the next page of results. Has the value of `null` on the last page.
7871
8191
  *
7872
8192
  * Use it in the **nextPageKey** query parameter to obtain subsequent pages of the result.
8193
+ *
8194
+ * @exampleValue AQAAABQBAAAABQ==
7873
8195
  */
7874
8196
  nextPageKey?: string;
7875
8197
  /**
@@ -7970,7 +8292,11 @@ export declare class Extensions_2_0Client {
7970
8292
  */
7971
8293
  uploadExtension(config: {
7972
8294
  body: Blob;
7973
- /** Only run validation but do not persist the extension even if validation was successful. */ validateOnly?: boolean;
8295
+ /**
8296
+ * Only run validation but do not persist the extension even if validation was successful.
8297
+ *
8298
+ * @defaultValue false
8299
+ */ validateOnly?: boolean;
7974
8300
  abortSignal?: AbortSignal_2;
7975
8301
  }): Promise<ExtensionUploadResponseDto>;
7976
8302
  /**
@@ -8793,6 +9119,8 @@ export declare class Extensions_2_0Client {
8793
9119
  * * `-timestamp`: Newest first.
8794
9120
  *
8795
9121
  * If not set, the newest first sorting is applied.
9122
+ *
9123
+ * @defaultValue -timestamp
8796
9124
  */ sort?: string;
8797
9125
  abortSignal?: AbortSignal_2;
8798
9126
  }): Promise<AuditLog>;
@@ -9064,6 +9392,8 @@ export declare interface ExtensionUploadResponseDto {
9064
9392
  variables: string[];
9065
9393
  /**
9066
9394
  * Extension version
9395
+ *
9396
+ * @exampleValue 1.2.3
9067
9397
  */
9068
9398
  version: string;
9069
9399
  }
@@ -9408,6 +9738,8 @@ export declare class FleetManagementContainerImagesClient {
9408
9738
  * + environment:roles:agent-install
9409
9739
  * + fleet-management:container-images:read
9410
9740
  *
9741
+ * <br/><br/>Returns container image references for Dynatrace components from the specified registry. Returned image versions are resolved based on the configured target versions: dynatrace-activegate, dynatrace-eec, dynatrace-sql-extension-executor, and dynatrace-database-datasource-executor image versions are resolved from the ActiveGate target version; dynatrace-oneagent, dynatrace-codemodules, and dynatrace-logmodule image versions are resolved from the OneAgent target version. If no target version is configured for a component, the latest available image is returned.
9742
+ *
9411
9743
  * @returns {Promise<ContainerImageData>} Container images data returned
9412
9744
  *
9413
9745
  * @example <caption>Code example</caption>
@@ -9973,10 +10305,14 @@ export declare interface HashicorpCertificateConfig extends ExternalVaultConfig
9973
10305
  export declare interface HistoryModificationInfo {
9974
10306
  /**
9975
10307
  * The unique identifier of the user who performed the most recent modification.
10308
+ *
10309
+ * @exampleValue fab17b7a-2eb2-4c95-b818-743d94be2c30
9976
10310
  */
9977
10311
  lastModifiedBy?: string;
9978
10312
  /**
9979
10313
  * Reason for system change
10314
+ *
10315
+ * @exampleValue default settings creation
9980
10316
  */
9981
10317
  lastModifiedReason?: string;
9982
10318
  /**
@@ -10027,6 +10363,8 @@ export declare interface Identity {
10027
10363
  id?: string;
10028
10364
  /**
10029
10365
  * The type of the identity.
10366
+ *
10367
+ * @exampleValue user
10030
10368
  */
10031
10369
  type: 'all-users' | 'group' | 'user';
10032
10370
  }
@@ -10144,6 +10482,8 @@ export declare interface InteractionStepDto extends SyntheticBrowserMonitorStepD
10144
10482
  button: 'MOUSE_LEFT' | 'MOUSE_MIDDLE' | 'MOUSE_RIGHT';
10145
10483
  /**
10146
10484
  * Target of Browser Monitor step.
10485
+ *
10486
+ * @exampleValue {"locators":[{"type":"CSS","value":"<img>[id='logoIcon']"},{"type":"CSS","value":"<a>[id='externalSite']"}],"window":"ruxitWin[0]"}
10147
10487
  */
10148
10488
  target?: TargetDto;
10149
10489
  /**
@@ -10152,6 +10492,8 @@ export declare interface InteractionStepDto extends SyntheticBrowserMonitorStepD
10152
10492
  validationRules?: ValidationRuleDto[];
10153
10493
  /**
10154
10494
  * Wait condition for Browser Monitor step.
10495
+ *
10496
+ * @exampleValue {"type":"NETWORK"}
10155
10497
  */
10156
10498
  waitCondition?: BaseWaitConditionDto;
10157
10499
  }
@@ -10213,14 +10555,20 @@ export declare interface Item {
10213
10555
  datasource?: DatasourceDefinition;
10214
10556
  /**
10215
10557
  * A short description of the item.
10558
+ *
10559
+ * @exampleValue itemDescription
10216
10560
  */
10217
10561
  description?: string;
10218
10562
  /**
10219
10563
  * The display name of the item.
10564
+ *
10565
+ * @exampleValue itemDisplayName
10220
10566
  */
10221
10567
  displayName?: string;
10222
10568
  /**
10223
10569
  * An extended description and/or links to documentation.
10570
+ *
10571
+ * @exampleValue propertyDocumentation
10224
10572
  */
10225
10573
  documentation?: string;
10226
10574
  /**
@@ -10229,10 +10577,14 @@ export declare interface Item {
10229
10577
  metadata?: ItemMetadata;
10230
10578
  /**
10231
10579
  * The type referenced by the item's value.
10580
+ *
10581
+ * @exampleValue itemReferencedType
10232
10582
  */
10233
10583
  referencedType?: string;
10234
10584
  /**
10235
10585
  * The subtype of the item's value.
10586
+ *
10587
+ * @exampleValue itemSubType
10236
10588
  */
10237
10589
  subType?: string;
10238
10590
  /**
@@ -10371,6 +10723,8 @@ export declare interface JavaScriptMappingFileListDto {
10371
10723
  * The cursor for the next page of results. Has the value of `null` on the last page.
10372
10724
  *
10373
10725
  * Use it in the **nextPageKey** query parameter to obtain subsequent pages of the result.
10726
+ *
10727
+ * @exampleValue AQAAABQBAAAABQ==
10374
10728
  */
10375
10729
  nextPageKey?: string;
10376
10730
  /**
@@ -10661,10 +11015,14 @@ export declare interface JavaScriptStepDto extends SyntheticBrowserMonitorStepDt
10661
11015
  javaScript: string;
10662
11016
  /**
10663
11017
  * Target of Browser Monitor step.
11018
+ *
11019
+ * @exampleValue {"locators":[{"type":"CSS","value":"<img>[id='logoIcon']"},{"type":"CSS","value":"<a>[id='externalSite']"}],"window":"ruxitWin[0]"}
10664
11020
  */
10665
11021
  target?: TargetDto;
10666
11022
  /**
10667
11023
  * Wait condition for Browser Monitor step.
11024
+ *
11025
+ * @exampleValue {"type":"NETWORK"}
10668
11026
  */
10669
11027
  waitCondition?: BaseWaitConditionDto;
10670
11028
  }
@@ -10764,6 +11122,8 @@ export declare interface KeyStrokesStepDto extends SyntheticBrowserMonitorStepDt
10764
11122
  simulateReturnKey?: boolean;
10765
11123
  /**
10766
11124
  * Target of Browser Monitor step.
11125
+ *
11126
+ * @exampleValue {"locators":[{"type":"CSS","value":"<img>[id='logoIcon']"},{"type":"CSS","value":"<a>[id='externalSite']"}],"window":"ruxitWin[0]"}
10767
11127
  */
10768
11128
  target?: TargetDto;
10769
11129
  /**
@@ -10772,6 +11132,8 @@ export declare interface KeyStrokesStepDto extends SyntheticBrowserMonitorStepDt
10772
11132
  validationRules?: ValidationRuleDto[];
10773
11133
  /**
10774
11134
  * Wait condition for Browser Monitor step.
11135
+ *
11136
+ * @exampleValue {"type":"NETWORK"}
10775
11137
  */
10776
11138
  waitCondition?: BaseWaitConditionDto;
10777
11139
  }
@@ -11201,6 +11563,10 @@ export declare class LogsClient {
11201
11563
  * The minimum length of a slot is 1 ms.
11202
11564
  *
11203
11565
  * If not set, 1 is used.
11566
+ *
11567
+ * @defaultValue 1
11568
+ *
11569
+ * @minimum 1
11204
11570
  */ timeBuckets?: number;
11205
11571
  /**
11206
11572
  * The maximum number of values in each group.
@@ -11208,6 +11574,10 @@ export declare class LogsClient {
11208
11574
  * You can get up to 100 values per group.
11209
11575
  *
11210
11576
  * If not set, 10 is used.
11577
+ *
11578
+ * @defaultValue 10
11579
+ *
11580
+ * @minimum 1
11211
11581
  */ maxGroupValues?: number;
11212
11582
  /**
11213
11583
  * The groupings to be included in the response.
@@ -11293,7 +11663,13 @@ export declare class LogsClient {
11293
11663
  *
11294
11664
  * When the **nextPageKey** is set to obtain subsequent pages, you must omit all other query parameters.
11295
11665
  */ nextPageKey?: string;
11296
- /** The number of results per result page. */ pageSize?: number;
11666
+ /**
11667
+ * The number of results per result page.
11668
+ *
11669
+ * @defaultValue 1000
11670
+ *
11671
+ * @minimum 1
11672
+ */ pageSize?: number;
11297
11673
  /**
11298
11674
  * The log search query.
11299
11675
  *
@@ -11307,6 +11683,8 @@ export declare class LogsClient {
11307
11683
  * Currently, ordering is available only for the timestamp (+timestamp for the oldest records first, or -timestamp for the newest records first).
11308
11684
  *
11309
11685
  * When millisecond resolution provided by the timestamp is not enough, log records are sorted based on the order in which they appear in the log source (remote process writing to REST API endpoint or remote process from which logs are collected).
11686
+ *
11687
+ * @defaultValue -timestamp
11310
11688
  */ sort?: string;
11311
11689
  abortSignal?: AbortSignal_2;
11312
11690
  }): Promise<ExportedLogRecordList>;
@@ -11469,6 +11847,10 @@ export declare class LogsClient {
11469
11847
  * The maximal allowed limit is 1000.
11470
11848
  *
11471
11849
  * If not set, 1000 is used.
11850
+ *
11851
+ * @defaultValue 1000
11852
+ *
11853
+ * @minimum 1
11472
11854
  */ limit?: number;
11473
11855
  /**
11474
11856
  * The log search query.
@@ -11483,6 +11865,8 @@ export declare class LogsClient {
11483
11865
  * Currently, ordering is available only for the timestamp (+timestamp for the oldest records first, or -timestamp for the newest records first).
11484
11866
  *
11485
11867
  * When millisecond resolution provided by the timestamp is not enough, log records are sorted based on the order in which they appear in the log source (remote process writing to REST API endpoint or remote process from which logs are collected).
11868
+ *
11869
+ * @defaultValue -timestamp
11486
11870
  */ sort?: string;
11487
11871
  /**
11488
11872
  * The cursor for the next slice of results. You can find it in the **nextSliceKey** field of the previous response.
@@ -12206,7 +12590,11 @@ export declare class MetricsClient {
12206
12590
  *
12207
12591
  * You can select a full set of related metrics by using a trailing asterisk (`*`) wildcard. For example, `airflow_*` selects all custom airflow metrics, `*` selects all custom metrics.
12208
12592
  */ metricSelector: string;
12209
- /** The number of days since the metric was last used. Must be between `30` and `1825` (5 years). */ minUnusedDays: number;
12593
+ /**
12594
+ * The number of days since the metric was last used. Must be between `30` and `1825` (5 years).
12595
+ *
12596
+ * @minimum 30
12597
+ */ minUnusedDays: number;
12210
12598
  abortSignal?: AbortSignal_2;
12211
12599
  }): Promise<void>;
12212
12600
  /**
@@ -12676,6 +13064,8 @@ export declare interface MinimalExtension {
12676
13064
  extensionName: string;
12677
13065
  /**
12678
13066
  * Extension version
13067
+ *
13068
+ * @exampleValue 1.2.3
12679
13069
  */
12680
13070
  version: string;
12681
13071
  }
@@ -13164,7 +13554,7 @@ export declare class MonitoredEntitiesClient {
13164
13554
  * const data =
13165
13555
  * await monitoredEntitiesClient.setSecurityContext({
13166
13556
  * entitySelector: "...",
13167
- * body: {},
13557
+ * body: { securityContext: ["..."] },
13168
13558
  * });
13169
13559
  *
13170
13560
  * @throws {ErrorEnvelopeError} Client side error. | Server side error.
@@ -14034,6 +14424,8 @@ export declare interface MonitoredStates {
14034
14424
  * The cursor for the next page of results. Has the value of `null` on the last page.
14035
14425
  *
14036
14426
  * Use it in the **nextPageKey** query parameter to obtain subsequent pages of the result.
14427
+ *
14428
+ * @exampleValue AQAAABQBAAAABQ==
14037
14429
  */
14038
14430
  nextPageKey?: string;
14039
14431
  /**
@@ -14073,6 +14465,8 @@ export declare interface MonitorExecutionResults {
14073
14465
  export declare interface MonitoringConfigurationDto {
14074
14466
  /**
14075
14467
  * The scope this monitoring configuration will be defined for
14468
+ *
14469
+ * @exampleValue HOST-D3A3C5A146830A79
14076
14470
  */
14077
14471
  scope: string;
14078
14472
  /**
@@ -14088,6 +14482,8 @@ export declare interface MonitoringConfigurationResponse {
14088
14482
  code: number;
14089
14483
  /**
14090
14484
  * The identifier of the new configuration
14485
+ *
14486
+ * @exampleValue 331e416f-9ab7-4694-8408-816026820645
14091
14487
  */
14092
14488
  objectId: string;
14093
14489
  }
@@ -14300,10 +14696,14 @@ export declare enum MuteStateReason {
14300
14696
  export declare interface NavigateStepDto extends SyntheticBrowserMonitorStepDto {
14301
14697
  /**
14302
14698
  * Authentication dto for Browser Monitor step.
14699
+ *
14700
+ * @exampleValue {"type":"HTTP_AUTHENTICATION"}
14303
14701
  */
14304
14702
  authentication?: AuthenticationDto;
14305
14703
  /**
14306
14704
  * Target of Browser Monitor step.
14705
+ *
14706
+ * @exampleValue {"locators":[{"type":"CSS","value":"<img>[id='logoIcon']"},{"type":"CSS","value":"<a>[id='externalSite']"}],"window":"ruxitWin[0]"}
14307
14707
  */
14308
14708
  target?: TargetDto;
14309
14709
  /**
@@ -14316,6 +14716,8 @@ export declare interface NavigateStepDto extends SyntheticBrowserMonitorStepDto
14316
14716
  validationRules?: ValidationRuleDto[];
14317
14717
  /**
14318
14718
  * Wait condition for Browser Monitor step.
14719
+ *
14720
+ * @exampleValue {"type":"NETWORK"}
14319
14721
  */
14320
14722
  waitCondition?: BaseWaitConditionDto;
14321
14723
  }
@@ -14863,6 +15265,8 @@ export declare interface ObjectsList {
14863
15265
  * The cursor for the next page of results. Has the value of `null` on the last page.
14864
15266
  *
14865
15267
  * Use it in the **nextPageKey** query parameter to obtain subsequent pages of the result.
15268
+ *
15269
+ * @exampleValue AQAAABQBAAAABQ==
14866
15270
  */
14867
15271
  nextPageKey?: string;
14868
15272
  /**
@@ -15019,10 +15423,14 @@ export declare const oneAgentRemoteConfigurationManagementClient: OneAgentRemote
15019
15423
  export declare interface PermissionContext {
15020
15424
  /**
15021
15425
  * Settings schema id for conditional permission
15426
+ *
15427
+ * @exampleValue service:schema
15022
15428
  */
15023
15429
  schemaId: string;
15024
15430
  /**
15025
15431
  * Settings scope for conditional permission
15432
+ *
15433
+ * @exampleValue environment
15026
15434
  */
15027
15435
  scope: string;
15028
15436
  }
@@ -15070,18 +15478,24 @@ export declare interface Precondition {
15070
15478
  * The expected value of the property.
15071
15479
  *
15072
15480
  * Only applicable to properties of the `EQUALS` type.
15481
+ *
15482
+ * @exampleValue expectedValue
15073
15483
  */
15074
15484
  expectedValue?: AnyValue;
15075
15485
  /**
15076
15486
  * A list of valid values of the property.
15077
15487
  *
15078
15488
  * Only applicable to properties of the `IN` type.
15489
+ *
15490
+ * @exampleValue expectedValues
15079
15491
  */
15080
15492
  expectedValues?: AnyValue[];
15081
15493
  /**
15082
15494
  * The Regular expression which is matched against the property.
15083
15495
  *
15084
15496
  * Only applicable to properties of the `REGEX_MATCH` type.
15497
+ *
15498
+ * @exampleValue example Regex
15085
15499
  */
15086
15500
  pattern?: string;
15087
15501
  /**
@@ -15096,10 +15510,14 @@ export declare interface Precondition {
15096
15510
  preconditions?: Precondition[];
15097
15511
  /**
15098
15512
  * The property to be evaluated.
15513
+ *
15514
+ * @exampleValue propertyToEvaluate
15099
15515
  */
15100
15516
  property?: string;
15101
15517
  /**
15102
15518
  * The type of the precondition.
15519
+ *
15520
+ * @exampleValue NULL
15103
15521
  */
15104
15522
  type: 'AND' | 'EQUALS' | 'IN' | 'NOT' | 'NULL' | 'OR' | 'REGEX_MATCH';
15105
15523
  }
@@ -15192,12 +15610,26 @@ export declare interface PrivateSyntheticLocation {
15192
15610
  latitude: number;
15193
15611
  /**
15194
15612
  * Alert if location or node outage lasts longer than *X* minutes. \n\n Only applicable when `availabilityLocationOutage` or `availabilityNodeOutage` is set to `true`. Supported only for private Synthetic locations.
15613
+ *
15614
+ * @minimum 1
15195
15615
  */
15196
15616
  locationNodeOutageDelayInMinutes?: number;
15197
15617
  /**
15198
15618
  * The longitude of the location in `DDD.dddd` format.
15199
15619
  */
15200
15620
  longitude: number;
15621
+ /**
15622
+ * Containerized location property. The maximum number of ActiveGates deployed for the location (required for a Kubernetes location).
15623
+ *
15624
+ * @minimum 1
15625
+ */
15626
+ maxActiveGateCount?: number;
15627
+ /**
15628
+ * Containerized location property. The minimum number of ActiveGates deployed for the location (required for a Kubernetes location).
15629
+ *
15630
+ * @minimum 1
15631
+ */
15632
+ minActiveGateCount?: number;
15201
15633
  /**
15202
15634
  * Containerized location property. Boolean value describes if icmp monitors will be executed on this location:
15203
15635
  *
@@ -15213,6 +15645,15 @@ export declare interface PrivateSyntheticLocation {
15213
15645
  * A mapping id to name of the nodes belonging to the location.
15214
15646
  */
15215
15647
  nodeNames?: PrivateSyntheticLocationNodeNames;
15648
+ /**
15649
+ * Containerized location property. The size of a containerized node deployed for the location (required for a Kubernetes location). Accepted values:
15650
+ *
15651
+ * * `XS`: extra small
15652
+ * * `S`: small
15653
+ * * `M`: medium
15654
+ * The node size `L` is not supported in containerized locations.
15655
+ */
15656
+ nodeSize?: 'M' | 'S' | 'UNSUPPORTED' | 'XS';
15216
15657
  /**
15217
15658
  * A list of synthetic nodes belonging to the location.
15218
15659
  *
@@ -15285,6 +15726,23 @@ export declare interface PrivateSyntheticLocationNodeNames {
15285
15726
  [propName: string]: string | undefined;
15286
15727
  }
15287
15728
 
15729
+ /**
15730
+ * Containerized location property. The size of a containerized node deployed for the location (required for a Kubernetes location). Accepted values:
15731
+ *
15732
+ * * `XS`: extra small
15733
+ * * `S`: small
15734
+ * * `M`: medium
15735
+ * The node size `L` is not supported in containerized locations.
15736
+ *
15737
+ * @deprecated Use literal values.
15738
+ */
15739
+ export declare enum PrivateSyntheticLocationNodeSize {
15740
+ M = "M",
15741
+ S = "S",
15742
+ Unsupported = "UNSUPPORTED",
15743
+ Xs = "XS"
15744
+ }
15745
+
15288
15746
  /**
15289
15747
  * The status of the location:
15290
15748
  *
@@ -15450,6 +15908,8 @@ export declare interface Problems {
15450
15908
  * The cursor for the next page of results. Has the value of `null` on the last page.
15451
15909
  *
15452
15910
  * Use it in the **nextPageKey** query parameter to obtain subsequent pages of the result.
15911
+ *
15912
+ * @exampleValue AQAAABQBAAAABQ==
15453
15913
  */
15454
15914
  nextPageKey?: string;
15455
15915
  /**
@@ -15903,22 +16363,32 @@ declare interface PropertyDefinition_2 {
15903
16363
  * The default value to be used when no value is provided.
15904
16364
  *
15905
16365
  * If a non-singleton has the value of `null`, it means an empty collection.
16366
+ *
16367
+ * @exampleValue propertyDefaultValue
15906
16368
  */
15907
16369
  default?: AnyValue;
15908
16370
  /**
15909
16371
  * A short description of the property.
16372
+ *
16373
+ * @exampleValue propertyDescription
15910
16374
  */
15911
16375
  description?: string;
15912
16376
  /**
15913
16377
  * The display name of the property.
16378
+ *
16379
+ * @exampleValue propertyDisplayName
15914
16380
  */
15915
16381
  displayName?: string;
15916
16382
  /**
15917
16383
  * An extended description and/or links to documentation.
16384
+ *
16385
+ * @exampleValue propertyDocumentation
15918
16386
  */
15919
16387
  documentation?: string;
15920
16388
  /**
15921
16389
  * Defines if value is allowed to be modified when secret properties are not
16390
+ *
16391
+ * @exampleValue true
15922
16392
  */
15923
16393
  forceSecretResubmission?: boolean;
15924
16394
  /**
@@ -15941,14 +16411,20 @@ declare interface PropertyDefinition_2 {
15941
16411
  migrationPattern?: string;
15942
16412
  /**
15943
16413
  * The minimum number of **objects** in a collection property.
16414
+ *
16415
+ * @exampleValue 1
15944
16416
  */
15945
16417
  minObjects?: number;
15946
16418
  /**
15947
16419
  * Modification policy of the property.
16420
+ *
16421
+ * @exampleValue ALWAYS
15948
16422
  */
15949
16423
  modificationPolicy?: 'ALWAYS' | 'DEFAULT' | 'NEVER';
15950
16424
  /**
15951
16425
  * The value can (`true`) or can't (`false`) be `null`.
16426
+ *
16427
+ * @exampleValue true
15952
16428
  */
15953
16429
  nullable: boolean;
15954
16430
  /**
@@ -15957,10 +16433,14 @@ declare interface PropertyDefinition_2 {
15957
16433
  precondition?: Precondition;
15958
16434
  /**
15959
16435
  * The type referenced by the property value
16436
+ *
16437
+ * @exampleValue propertyReferencedType
15960
16438
  */
15961
16439
  referencedType?: string;
15962
16440
  /**
15963
16441
  * The subtype of the property's value.
16442
+ *
16443
+ * @exampleValue propertySubType
15964
16444
  */
15965
16445
  subType?: string;
15966
16446
  /**
@@ -16135,6 +16615,8 @@ export declare interface ReactNativeMappingFileListDto {
16135
16615
  * The cursor for the next page of results. Has the value of `null` on the last page.
16136
16616
  *
16137
16617
  * Use it in the **nextPageKey** query parameter to obtain subsequent pages of the result.
16618
+ *
16619
+ * @exampleValue AQAAABQBAAAABQ==
16138
16620
  */
16139
16621
  nextPageKey?: string;
16140
16622
  /**
@@ -16175,6 +16657,8 @@ export declare interface ReactNativeMappingFileMetadataUpdateDto {
16175
16657
  export declare interface RefPointer {
16176
16658
  /**
16177
16659
  * Pointer to a JSON object this object should be logically replaced with.
16660
+ *
16661
+ * @exampleValue refPointerToAnotherJsonObject
16178
16662
  */
16179
16663
  $ref: string;
16180
16664
  }
@@ -16330,58 +16814,92 @@ export declare enum RelatedServiceExposure {
16330
16814
  export declare interface Release {
16331
16815
  /**
16332
16816
  * The entity has one or more problems
16817
+ *
16818
+ * @exampleValue true
16333
16819
  */
16334
16820
  affectedByProblems?: boolean;
16335
16821
  /**
16336
16822
  * The entity has one or more security vulnerabilities
16823
+ *
16824
+ * @exampleValue true
16337
16825
  */
16338
16826
  affectedBySecurityVulnerabilities?: boolean;
16339
16827
  /**
16340
16828
  * The instances entityIds included in this release
16829
+ *
16830
+ * @exampleValue ["PROCESS_GROUP_INSTANCE-49D94B90FB71C45B","PROCESS_GROUP_INSTANCE-7EA049157C82D1A5"]
16341
16831
  */
16342
16832
  instances?: ReleaseInstance[];
16343
16833
  /**
16344
16834
  * The entity name
16835
+ *
16836
+ * @exampleValue cluster
16345
16837
  */
16346
16838
  name?: string;
16347
16839
  /**
16348
16840
  * The number of problems of the entity
16841
+ *
16842
+ * @exampleValue 4
16843
+ *
16844
+ * @minimum 0
16349
16845
  */
16350
16846
  problemCount?: number;
16351
16847
  /**
16352
16848
  * The product name
16849
+ *
16850
+ * @exampleValue Sockshop
16353
16851
  */
16354
16852
  product?: string;
16355
16853
  /**
16356
16854
  * The entity id of correlating release.
16855
+ *
16856
+ * @exampleValue PROCESS_GROUP-DFDBAC9CBF104253
16357
16857
  */
16358
16858
  releaseEntityId?: string;
16359
16859
  /**
16360
16860
  * The related PGI is still running/monitored
16861
+ *
16862
+ * @exampleValue true
16361
16863
  */
16362
16864
  running?: boolean;
16363
16865
  /**
16364
16866
  * The number of security vulnerabilities of the entity
16867
+ *
16868
+ * @exampleValue 4
16869
+ *
16870
+ * @minimum 0
16365
16871
  */
16366
16872
  securityVulnerabilitiesCount?: number;
16367
16873
  /**
16368
16874
  * Indicates that the security vulnerabilities feature is enabled
16875
+ *
16876
+ * @exampleValue true
16369
16877
  */
16370
16878
  securityVulnerabilitiesEnabled?: boolean;
16371
16879
  /**
16372
16880
  * The software technologies of the release
16881
+ *
16882
+ * @exampleValue [{"edition":"OpenJDK","technology":"JAVA","verbatimType":"Java","version":"1.8.0_242"}]
16373
16883
  */
16374
16884
  softwareTechs?: SoftwareTechs[];
16375
16885
  /**
16376
16886
  * The stage name
16887
+ *
16888
+ * @exampleValue staging
16377
16889
  */
16378
16890
  stage?: string;
16379
16891
  /**
16380
16892
  * The count of bytes per second of the entity
16893
+ *
16894
+ * @exampleValue 923234
16895
+ *
16896
+ * @minimum 0
16381
16897
  */
16382
16898
  throughput?: number;
16383
16899
  /**
16384
16900
  * The identified release version
16901
+ *
16902
+ * @exampleValue 1.195.34.12341232423-012342
16385
16903
  */
16386
16904
  version?: string;
16387
16905
  }
@@ -16393,18 +16911,26 @@ export declare interface Release {
16393
16911
  export declare interface ReleaseInstance {
16394
16912
  /**
16395
16913
  * The build version
16914
+ *
16915
+ * @exampleValue 223005
16396
16916
  */
16397
16917
  buildVersion?: string;
16398
16918
  /**
16399
16919
  * The entity id of the instance.
16920
+ *
16921
+ * @exampleValue PROCESS_GROUP_INSTANCE-DFDBAC9CBF104253
16400
16922
  */
16401
16923
  entityId?: string;
16402
16924
  /**
16403
16925
  * List of event Ids of open problems
16926
+ *
16927
+ * @exampleValue ["573177299181554914_1616573184015V2"]
16404
16928
  */
16405
16929
  problems?: string[];
16406
16930
  /**
16407
16931
  * List of Security vulnerabilities Ids
16932
+ *
16933
+ * @exampleValue ["SNYK-JAVA-COMFASTERXMLJACKSONCORE-1234567"]
16408
16934
  */
16409
16935
  securityVulnerabilities?: string[];
16410
16936
  }
@@ -16417,6 +16943,8 @@ export declare interface Releases {
16417
16943
  * The cursor for the next page of results. Has the value of `null` on the last page.
16418
16944
  *
16419
16945
  * Use it in the **nextPageKey** query parameter to obtain subsequent pages of the result.
16946
+ *
16947
+ * @exampleValue AQAAABQBAAAABQ==
16420
16948
  */
16421
16949
  nextPageKey?: string;
16422
16950
  /**
@@ -16518,7 +17046,11 @@ export declare class ReleasesClient {
16518
17046
  *
16519
17047
  * If not set, 100 is used.
16520
17048
  */ pageSize?: number;
16521
- /** Get your Releases (`false`) or a set of demo Releases (`true`). */ demo?: boolean;
17049
+ /**
17050
+ * Get your Releases (`false`) or a set of demo Releases (`true`).
17051
+ *
17052
+ * @defaultValue false
17053
+ */ demo?: boolean;
16522
17054
  /**
16523
17055
  * Defines the scope of the query. Only Releases matching the provided criteria are included in the response.
16524
17056
  *
@@ -16549,6 +17081,8 @@ export declare class ReleasesClient {
16549
17081
  * * 'traffic': Traffic
16550
17082
  *
16551
17083
  * If not set, the ascending order sorting for name is applied.
17084
+ *
17085
+ * @defaultValue name
16552
17086
  */ sort?: string;
16553
17087
  abortSignal?: AbortSignal_2;
16554
17088
  }): Promise<Releases>;
@@ -16806,6 +17340,8 @@ export declare interface RemediationItemMuteStateChange {
16806
17340
  muted: boolean;
16807
17341
  /**
16808
17342
  * The reason for the mute state change.
17343
+ *
17344
+ * @exampleValue IGNORE
16809
17345
  */
16810
17346
  reason: 'AFFECTED' | 'CONFIGURATION_NOT_AFFECTED' | 'FALSE_POSITIVE' | 'IGNORE' | 'INITIAL_STATE' | 'OTHER' | 'VULNERABLE_CODE_NOT_IN_USE';
16811
17347
  }
@@ -17121,10 +17657,14 @@ export declare interface RemediationProgressVulnerableComponent {
17121
17657
  export declare interface RemoteConfigurationManagementEntityValidationError {
17122
17658
  /**
17123
17659
  * The ID of the entity for which validation failed.
17660
+ *
17661
+ * @exampleValue entityId
17124
17662
  */
17125
17663
  entity?: string;
17126
17664
  /**
17127
17665
  * The reason of entity validation failure.
17666
+ *
17667
+ * @exampleValue ["RUNNING_IN_CONTAINER"]
17128
17668
  */
17129
17669
  reasons?: Array<'CLOUD_NATIVE_NOT_SUPPORTED' | 'NOT_ALLOWED_WITH_CLUSTER_ACTIVE_GATE' | 'NOT_CONNECTED' | 'RUNNING_IN_CONTAINER' | 'STANDALONE_NOT_SUPPORTED' | 'VERSION_NOT_SUPPORTED'>;
17130
17670
  }
@@ -17147,10 +17687,14 @@ export declare enum RemoteConfigurationManagementEntityValidationErrorReasonsIte
17147
17687
  export declare interface RemoteConfigurationManagementJob {
17148
17688
  /**
17149
17689
  * Date (in ISO 8601 format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z') when the remote configuration management job was finished. This field is present only for finished jobs.
17690
+ *
17691
+ * @exampleValue 2020-11-05T08:15:30.144Z
17150
17692
  */
17151
17693
  endTime?: string;
17152
17694
  /**
17153
17695
  * Type of entities modified by remote configuration management.
17696
+ *
17697
+ * @exampleValue ACTIVE_GATE or ONE_AGENT
17154
17698
  */
17155
17699
  entityType?: 'ACTIVE_GATE' | 'ONE_AGENT';
17156
17700
  /**
@@ -17159,10 +17703,14 @@ export declare interface RemoteConfigurationManagementJob {
17159
17703
  failedEntities?: RemoteIdentityOperationFailedEntityDto[];
17160
17704
  /**
17161
17705
  * The ID of the remote configuration management job.
17706
+ *
17707
+ * @exampleValue 7974003406714390819
17162
17708
  */
17163
17709
  id?: string;
17164
17710
  /**
17165
17711
  * A list of in-progress remote configuration management jobs.
17712
+ *
17713
+ * @exampleValue ["HOST-D454A967666E7970"]
17166
17714
  */
17167
17715
  inProgressEntities?: string[];
17168
17716
  /**
@@ -17171,18 +17719,26 @@ export declare interface RemoteConfigurationManagementJob {
17171
17719
  operations?: RemoteConfigurationManagementOperation[];
17172
17720
  /**
17173
17721
  * Number of entities that were already processed at the time the response was created.
17722
+ *
17723
+ * @exampleValue 1
17174
17724
  */
17175
17725
  processedEntitiesCount?: number;
17176
17726
  /**
17177
17727
  * Date (in ISO 8601 format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z') when the remote configuration management job was started.
17728
+ *
17729
+ * @exampleValue 2020-11-05T08:15:30.144Z
17178
17730
  */
17179
17731
  startTime?: string;
17180
17732
  /**
17181
17733
  * Date (in ISO 8601 format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z') when the running remote configuration management job will time-out. This field is present only for running jobs.
17734
+ *
17735
+ * @exampleValue 2020-11-05T08:15:30.144Z
17182
17736
  */
17183
17737
  timeoutTime?: string;
17184
17738
  /**
17185
17739
  * Total number of entities to process.
17740
+ *
17741
+ * @exampleValue 1
17186
17742
  */
17187
17743
  totalEntitiesCount?: number;
17188
17744
  }
@@ -17213,22 +17769,32 @@ export declare interface RemoteConfigurationManagementJobList {
17213
17769
  export declare interface RemoteConfigurationManagementJobPreview {
17214
17770
  /**
17215
17771
  * The number of entities that are currently configured as defined by remote configuration management operation.
17772
+ *
17773
+ * @exampleValue 1
17216
17774
  */
17217
17775
  alreadyConfiguredEntitiesCount?: number;
17218
17776
  /**
17219
17777
  * The attribute which is affected by the operation.
17778
+ *
17779
+ * @exampleValue networkZone
17220
17780
  */
17221
17781
  attribute?: 'group' | 'hostGroup' | 'hostProperty' | 'hostTag' | 'networkZone';
17222
17782
  /**
17223
17783
  * The operation performed on given attribute.
17784
+ *
17785
+ * @exampleValue set
17224
17786
  */
17225
17787
  operation?: 'clear' | 'set';
17226
17788
  /**
17227
17789
  * The number of entities that will be configured as defined by remote configuration management after it is completed.
17790
+ *
17791
+ * @exampleValue 2
17228
17792
  */
17229
17793
  targetEntitiesCount?: number;
17230
17794
  /**
17231
17795
  * The value which should be assigned to given attribute.
17796
+ *
17797
+ * @exampleValue exampleNetworkZoneName
17232
17798
  */
17233
17799
  value?: string;
17234
17800
  }
@@ -17262,18 +17828,26 @@ export declare enum RemoteConfigurationManagementJobPreviewOperation {
17262
17828
  export declare interface RemoteConfigurationManagementJobSummary {
17263
17829
  /**
17264
17830
  * Date (in ISO 8601 format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z') when the remote configuration management job was finished. This field is present only for finished jobs.
17831
+ *
17832
+ * @exampleValue 2020-11-05T08:15:30.144Z
17265
17833
  */
17266
17834
  endTime?: string;
17267
17835
  /**
17268
17836
  * Type of entities modified by remote configuration management.
17837
+ *
17838
+ * @exampleValue ACTIVE_GATE or ONE_AGENT
17269
17839
  */
17270
17840
  entityType?: 'ACTIVE_GATE' | 'ONE_AGENT';
17271
17841
  /**
17272
17842
  * The ID of the remote configuration management job.
17843
+ *
17844
+ * @exampleValue 7974003406714390819
17273
17845
  */
17274
17846
  id?: string;
17275
17847
  /**
17276
17848
  * Date (in ISO 8601 format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z') when the remote configuration management job was started.
17849
+ *
17850
+ * @exampleValue 2020-11-05T08:15:30.144Z
17277
17851
  */
17278
17852
  startTime?: string;
17279
17853
  }
@@ -17294,14 +17868,20 @@ export declare enum RemoteConfigurationManagementJobSummaryEntityType {
17294
17868
  export declare interface RemoteConfigurationManagementOperation {
17295
17869
  /**
17296
17870
  * The attribute which is affected by the operation.
17871
+ *
17872
+ * @exampleValue networkZone
17297
17873
  */
17298
17874
  attribute: 'group' | 'hostGroup' | 'hostProperty' | 'hostTag' | 'networkZone';
17299
17875
  /**
17300
17876
  * The operation performed on given attribute.
17877
+ *
17878
+ * @exampleValue set
17301
17879
  */
17302
17880
  operation: 'clear' | 'set';
17303
17881
  /**
17304
17882
  * The value which should be assigned to given attribute.
17883
+ *
17884
+ * @exampleValue exampleNetworkZoneName
17305
17885
  */
17306
17886
  value?: string;
17307
17887
  }
@@ -17312,6 +17892,8 @@ export declare interface RemoteConfigurationManagementOperation {
17312
17892
  export declare interface RemoteConfigurationManagementOperationActiveGateRequest {
17313
17893
  /**
17314
17894
  * A list of entities IDs for which remote configuration management is to be executed.
17895
+ *
17896
+ * @exampleValue ["0x2b7c0b02","0x4928065d"]
17315
17897
  */
17316
17898
  entities: string[];
17317
17899
  /**
@@ -17339,6 +17921,8 @@ export declare enum RemoteConfigurationManagementOperationAttribute {
17339
17921
  export declare interface RemoteConfigurationManagementOperationOneAgentRequest {
17340
17922
  /**
17341
17923
  * A list of entities IDs for which remote configuration management is to be executed.
17924
+ *
17925
+ * @exampleValue ["HOST-D454A967666E7970","HOST-811760CFF2A5E872"]
17342
17926
  */
17343
17927
  entities: string[];
17344
17928
  /**
@@ -17363,18 +17947,26 @@ export declare enum RemoteConfigurationManagementOperationOperation {
17363
17947
  export declare interface RemoteConfigurationManagementOperationValidationError {
17364
17948
  /**
17365
17949
  * The attribute which is affected by the operation.
17950
+ *
17951
+ * @exampleValue networkZone
17366
17952
  */
17367
17953
  attribute?: 'group' | 'hostGroup' | 'hostProperty' | 'hostTag' | 'networkZone';
17368
17954
  /**
17369
17955
  * The operation performed on given attribute.
17956
+ *
17957
+ * @exampleValue set
17370
17958
  */
17371
17959
  operation?: 'clear' | 'set';
17372
17960
  /**
17373
17961
  * The reason of validation failure.
17962
+ *
17963
+ * @exampleValue Value must not start with a period
17374
17964
  */
17375
17965
  reason?: string;
17376
17966
  /**
17377
17967
  * The value which should be assigned to given attribute.
17968
+ *
17969
+ * @exampleValue .exampleInvalidNetworkZoneName
17378
17970
  */
17379
17971
  value?: string;
17380
17972
  }
@@ -17436,14 +18028,20 @@ export declare class RemoteConfigurationManagementValidationResultError extends
17436
18028
  export declare interface RemoteIdentityOperationFailedEntityDto {
17437
18029
  /**
17438
18030
  * Entity ID for which remote configuration management request was failed
18031
+ *
18032
+ * @exampleValue HOST-D454A967666E7970
17439
18033
  */
17440
18034
  entityId?: string;
17441
18035
  /**
17442
18036
  * Communication settings changing failure error description
18037
+ *
18038
+ * @exampleValue Failed to access new tenant: f47ac10b-58cc-4372-a567-0e02b2c3d479
17443
18039
  */
17444
18040
  failureMessage?: string;
17445
18041
  /**
17446
18042
  * Reason of communication settings changing failure.
18043
+ *
18044
+ * @exampleValue CONNECTION_FAILURE
17447
18045
  */
17448
18046
  failureReason?: 'CONNECTION_FAILURE' | 'TIMEOUT';
17449
18047
  }
@@ -17630,6 +18228,8 @@ export declare interface RevisionDiff {
17630
18228
  export declare interface RevisionDiffPage {
17631
18229
  /**
17632
18230
  * The 'to' time in ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z') from the original request.
18231
+ *
18232
+ * @exampleValue 2024-06-24T01:02:03Z
17633
18233
  */
17634
18234
  endTime: string;
17635
18235
  /**
@@ -17640,6 +18240,8 @@ export declare interface RevisionDiffPage {
17640
18240
  * The cursor for the next page of results. Has the value of `null` on the last page.
17641
18241
  *
17642
18242
  * Use it in the **nextPageKey** query parameter to obtain subsequent pages of the result.
18243
+ *
18244
+ * @exampleValue AQAAABQBAAAABQ==
17643
18245
  */
17644
18246
  nextPageKey?: string;
17645
18247
  /**
@@ -17648,6 +18250,8 @@ export declare interface RevisionDiffPage {
17648
18250
  pageSize: number;
17649
18251
  /**
17650
18252
  * The 'from' time in ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z') from the original request.
18253
+ *
18254
+ * @exampleValue 2024-06-10T01:02:03Z
17651
18255
  */
17652
18256
  startTime: string;
17653
18257
  }
@@ -18271,6 +18875,8 @@ export declare const rumManualInsertionTagsClient: RumManualInsertionTagsClient;
18271
18875
  export declare interface SchemaConstraintRestDto {
18272
18876
  /**
18273
18877
  * The maximum allowed size in bytes for the sum over all persisted values for the schema
18878
+ *
18879
+ * @exampleValue 500000
18274
18880
  */
18275
18881
  byteLimit?: number;
18276
18882
  /**
@@ -18279,6 +18885,8 @@ export declare interface SchemaConstraintRestDto {
18279
18885
  customMessage?: string;
18280
18886
  /**
18281
18887
  * The ID of a custom validator.
18888
+ *
18889
+ * @exampleValue my-min-max
18282
18890
  */
18283
18891
  customValidatorId?: string;
18284
18892
  /**
@@ -18287,6 +18895,8 @@ export declare interface SchemaConstraintRestDto {
18287
18895
  flattenCollections?: boolean;
18288
18896
  /**
18289
18897
  * Whether to skip validation on a change made from the UI.
18898
+ *
18899
+ * @exampleValue false
18290
18900
  */
18291
18901
  skipAsyncValidation?: boolean;
18292
18902
  /**
@@ -18295,6 +18905,8 @@ export declare interface SchemaConstraintRestDto {
18295
18905
  type: 'BYTE_SIZE_LIMIT' | 'CUSTOM_VALIDATOR_REF' | 'MULTI_SCOPE_CUSTOM_VALIDATOR_REF' | 'MULTI_SCOPE_UNIQUE' | 'UNIQUE' | 'UNKNOWN';
18296
18906
  /**
18297
18907
  * The list of properties for which the combination of values needs to be unique
18908
+ *
18909
+ * @exampleValue ["my-prop-1","my-prop-2"]
18298
18910
  */
18299
18911
  uniqueProperties?: string[];
18300
18912
  }
@@ -18316,6 +18928,8 @@ export declare enum SchemaConstraintRestDtoType {
18316
18928
  export declare interface SchemaDefinitionRestDto {
18317
18929
  /**
18318
18930
  * A list of scopes where the schema can be used.
18931
+ *
18932
+ * @exampleValue ["host","application"]
18319
18933
  */
18320
18934
  allowedScopes: string[];
18321
18935
  /**
@@ -18328,10 +18942,14 @@ export declare interface SchemaDefinitionRestDto {
18328
18942
  deletionConstraints?: DeletionConstraint[];
18329
18943
  /**
18330
18944
  * A short description of the schema.
18945
+ *
18946
+ * @exampleValue Dynatrace disables monitoring of containers that do not run any applications
18331
18947
  */
18332
18948
  description: string;
18333
18949
  /**
18334
18950
  * The display name of the schema.
18951
+ *
18952
+ * @exampleValue Built-in container monitoring rules
18335
18953
  */
18336
18954
  displayName: string;
18337
18955
  /**
@@ -18340,6 +18958,8 @@ export declare interface SchemaDefinitionRestDto {
18340
18958
  documentation?: string;
18341
18959
  /**
18342
18960
  * The version of the data format.
18961
+ *
18962
+ * @exampleValue 1
18343
18963
  */
18344
18964
  dynatrace: string;
18345
18965
  /**
@@ -18348,6 +18968,8 @@ export declare interface SchemaDefinitionRestDto {
18348
18968
  enums: SchemaDefinitionRestDtoEnums;
18349
18969
  /**
18350
18970
  * Name of the key property in this schema.
18971
+ *
18972
+ * @exampleValue keyProperty
18351
18973
  */
18352
18974
  keyProperty?: string;
18353
18975
  /**
@@ -18358,12 +18980,16 @@ export declare interface SchemaDefinitionRestDto {
18358
18980
  * - GENERAL_AVAILABILITY: Features marked "general availability" are the most stable. While the schemas will still evolve over time, care will be taken to only do so in a backward-compatible manner.
18359
18981
  *
18360
18982
  * In any case, automations should make use of the `schemaVersion` field when writing settings objects.
18983
+ *
18984
+ * @exampleValue GENERAL_AVAILABILITY
18361
18985
  */
18362
18986
  maturity?: 'EARLY_ADOPTER' | 'GENERAL_AVAILABILITY' | 'PREVIEW';
18363
18987
  /**
18364
18988
  * The maximum amount of objects per scope.
18365
18989
  *
18366
18990
  * Only applicable when **multiObject** is set to `true`.
18991
+ *
18992
+ * @exampleValue 10
18367
18993
  */
18368
18994
  maxObjects: number;
18369
18995
  /**
@@ -18390,10 +19016,14 @@ export declare interface SchemaDefinitionRestDto {
18390
19016
  schemaConstraints?: SchemaConstraintRestDto[];
18391
19017
  /**
18392
19018
  * Names of the groups, which the schema belongs to.
19019
+ *
19020
+ * @exampleValue ["group:some.1","group:some.2"]
18393
19021
  */
18394
19022
  schemaGroups?: string[];
18395
19023
  /**
18396
19024
  * The ID of the schema.
19025
+ *
19026
+ * @exampleValue builtin:container.built-in-monitoring-rule
18397
19027
  */
18398
19028
  schemaId: string;
18399
19029
  /**
@@ -18412,6 +19042,8 @@ export declare interface SchemaDefinitionRestDto {
18412
19042
  uiCustomization?: UiCustomization;
18413
19043
  /**
18414
19044
  * The version of the schema.
19045
+ *
19046
+ * @exampleValue 1.4.2
18415
19047
  */
18416
19048
  version: string;
18417
19049
  }
@@ -18487,6 +19119,8 @@ export declare interface SchemaList {
18487
19119
  items: SchemaStub[];
18488
19120
  /**
18489
19121
  * The number of schemas in the list.
19122
+ *
19123
+ * @exampleValue 1
18490
19124
  */
18491
19125
  totalCount: number;
18492
19126
  }
@@ -18504,10 +19138,14 @@ export declare interface SchemasList {
18504
19138
  export declare interface SchemaStub {
18505
19139
  /**
18506
19140
  * The name of the schema.
19141
+ *
19142
+ * @exampleValue Built-in container monitoring rules
18507
19143
  */
18508
19144
  displayName?: string;
18509
19145
  /**
18510
19146
  * The most recent version of the schema.
19147
+ *
19148
+ * @exampleValue 1.4.2
18511
19149
  */
18512
19150
  latestSchemaVersion?: string;
18513
19151
  /**
@@ -18518,22 +19156,32 @@ export declare interface SchemaStub {
18518
19156
  * - GENERAL_AVAILABILITY: Features marked "general availability" are the most stable. While the schemas will still evolve over time, care will be taken to only do so in a backward-compatible manner.
18519
19157
  *
18520
19158
  * In any case, automations should make use of the `schemaVersion` field when writing settings objects.
19159
+ *
19160
+ * @exampleValue GENERAL_AVAILABILITY
18521
19161
  */
18522
19162
  maturity?: 'EARLY_ADOPTER' | 'GENERAL_AVAILABILITY' | 'PREVIEW';
18523
19163
  /**
18524
19164
  * Multi-object flag. `True` if the schema is a multi-object schema
19165
+ *
19166
+ * @exampleValue true
18525
19167
  */
18526
19168
  multiObject?: boolean;
18527
19169
  /**
18528
19170
  * Ordered flag. `True` if the schema is an ordered multi-object schema.
19171
+ *
19172
+ * @exampleValue false
18529
19173
  */
18530
19174
  ordered?: boolean;
18531
19175
  /**
18532
19176
  * Owner based access control flag. `True` if the schema has owner based access control enabled.
19177
+ *
19178
+ * @exampleValue true
18533
19179
  */
18534
19180
  ownerBasedAccessControl?: boolean;
18535
19181
  /**
18536
19182
  * The ID of the schema.
19183
+ *
19184
+ * @exampleValue builtin:container.built-in-monitoring-rule
18537
19185
  */
18538
19186
  schemaId?: string;
18539
19187
  }
@@ -18567,14 +19215,20 @@ export declare interface SchemaType {
18567
19215
  constraints?: ComplexConstraint[];
18568
19216
  /**
18569
19217
  * A short description of the property.
19218
+ *
19219
+ * @exampleValue typeDescription
18570
19220
  */
18571
19221
  description: string;
18572
19222
  /**
18573
19223
  * The display name of the property.
19224
+ *
19225
+ * @exampleValue typeDisplayName
18574
19226
  */
18575
19227
  displayName?: string;
18576
19228
  /**
18577
19229
  * An extended description and/or links to documentation.
19230
+ *
19231
+ * @exampleValue typeDocumentation
18578
19232
  */
18579
19233
  documentation: string;
18580
19234
  /**
@@ -18583,22 +19237,32 @@ export declare interface SchemaType {
18583
19237
  properties: SchemaTypeProperties;
18584
19238
  /**
18585
19239
  * The pattern for the summary search(for example, "Alert after *X* minutes.") of the configuration in the UI.
19240
+ *
19241
+ * @exampleValue searchPatternOfType
18586
19242
  */
18587
19243
  searchPattern?: string;
18588
19244
  /**
18589
19245
  * The pattern for the summary (for example, "Alert after *X* minutes.") of the configuration in the UI.
19246
+ *
19247
+ * @exampleValue summaryPatternOfType
18590
19248
  */
18591
19249
  summaryPattern: string;
18592
19250
  /**
18593
19251
  * Type of the reference type.
19252
+ *
19253
+ * @exampleValue object
18594
19254
  */
18595
19255
  type: 'object';
18596
19256
  /**
18597
19257
  * The version of the type.
19258
+ *
19259
+ * @exampleValue 0
18598
19260
  */
18599
19261
  version: string;
18600
19262
  /**
18601
19263
  * A short description of the version.
19264
+ *
19265
+ * @exampleValue Added new property
18602
19266
  */
18603
19267
  versionInfo?: string;
18604
19268
  }
@@ -18647,7 +19311,7 @@ export declare interface SecurityContextDtoImpl {
18647
19311
  /**
18648
19312
  * The security context, that will be set for matching entities. If there exists a management zone with this name, it will be set for all matching entities, overriding all automatic management zone rules.
18649
19313
  */
18650
- securityContext?: string[];
19314
+ securityContext: string[];
18651
19315
  }
18652
19316
 
18653
19317
  /**
@@ -19008,6 +19672,8 @@ export declare interface SecurityProblemEventsList {
19008
19672
  * The cursor for the next page of results. Has the value of `null` on the last page.
19009
19673
  *
19010
19674
  * Use it in the **nextPageKey** query parameter to obtain subsequent pages of the result.
19675
+ *
19676
+ * @exampleValue AQAAABQBAAAABQ==
19011
19677
  */
19012
19678
  nextPageKey?: string;
19013
19679
  /**
@@ -19028,6 +19694,8 @@ export declare interface SecurityProblemList {
19028
19694
  * The cursor for the next page of results. Has the value of `null` on the last page.
19029
19695
  *
19030
19696
  * Use it in the **nextPageKey** query parameter to obtain subsequent pages of the result.
19697
+ *
19698
+ * @exampleValue AQAAABQBAAAABQ==
19031
19699
  */
19032
19700
  nextPageKey?: string;
19033
19701
  /**
@@ -19926,6 +20594,8 @@ export declare enum SecurityProblemVulnerabilityType {
19926
20594
  export declare interface SelectionDto {
19927
20595
  /**
19928
20596
  * Selection index.
20597
+ *
20598
+ * @minimum 0
19929
20599
  */
19930
20600
  index: number;
19931
20601
  /**
@@ -19944,6 +20614,8 @@ export declare interface SelectOptionStepDto extends SyntheticBrowserMonitorStep
19944
20614
  selections: SelectionDto[];
19945
20615
  /**
19946
20616
  * Target of Browser Monitor step.
20617
+ *
20618
+ * @exampleValue {"locators":[{"type":"CSS","value":"<img>[id='logoIcon']"},{"type":"CSS","value":"<a>[id='externalSite']"}],"window":"ruxitWin[0]"}
19947
20619
  */
19948
20620
  target?: TargetDto;
19949
20621
  /**
@@ -19952,6 +20624,8 @@ export declare interface SelectOptionStepDto extends SyntheticBrowserMonitorStep
19952
20624
  validationRules?: ValidationRuleDto[];
19953
20625
  /**
19954
20626
  * Wait condition for Browser Monitor step.
20627
+ *
20628
+ * @exampleValue {"type":"NETWORK"}
19955
20629
  */
19956
20630
  waitCondition?: BaseWaitConditionDto;
19957
20631
  }
@@ -20079,6 +20753,8 @@ export declare class ServiceLevelObjectivesClient {
20079
20753
  * * `-name`: Names in descending order.
20080
20754
  *
20081
20755
  * If not set, the ascending order is used.
20756
+ *
20757
+ * @defaultValue name
20082
20758
  */ sort?: string;
20083
20759
  /**
20084
20760
  * The timeframe to calculate the SLO values:
@@ -20088,10 +20764,18 @@ export declare class ServiceLevelObjectivesClient {
20088
20764
  *
20089
20765
  * If not set, the `CURRENT` value is used.
20090
20766
  */ timeFrame?: 'CURRENT' | 'GTF';
20091
- /** Get your SLOs (`false`) or a set of demo SLOs (`true`). */ demo?: boolean;
20767
+ /**
20768
+ * Get your SLOs (`false`) or a set of demo SLOs (`true`).
20769
+ *
20770
+ * @defaultValue false
20771
+ */ demo?: boolean;
20092
20772
  /** Get your SLOs without them being evaluated (`false`) or with evaluations (`true`) with maximum `pageSize` of 25. */ evaluate?: 'true' | 'false';
20093
20773
  /** Get your enabled SLOs (`true`), disabled ones (`false`) or both enabled and disabled ones (`all`). */ enabledSlos?: 'true' | 'false' | 'all';
20094
- /** Get your global SLOs (`true`) regardless of the selected filter or filter them out (`false`). */ showGlobalSlos?: boolean;
20774
+ /**
20775
+ * Get your global SLOs (`true`) regardless of the selected filter or filter them out (`false`).
20776
+ *
20777
+ * @defaultValue true
20778
+ */ showGlobalSlos?: boolean;
20095
20779
  abortSignal?: AbortSignal_2;
20096
20780
  }): Promise<SLOs>;
20097
20781
  /**
@@ -20381,6 +21065,8 @@ export declare const settingsManagementZonesClient: SettingsManagementZonesClien
20381
21065
  export declare interface SettingsObject {
20382
21066
  /**
20383
21067
  * The user (identified by a user ID or a public token ID) who performed that most recent modification.
21068
+ *
21069
+ * @exampleValue john.doe@example.com
20384
21070
  */
20385
21071
  author?: string;
20386
21072
  /**
@@ -20389,6 +21075,8 @@ export declare interface SettingsObject {
20389
21075
  created?: number;
20390
21076
  /**
20391
21077
  * The unique identifier of the user who created the settings object.
21078
+ *
21079
+ * @exampleValue fab17b7a-2eb2-4c95-b818-743d94be2c30
20392
21080
  */
20393
21081
  createdBy?: string;
20394
21082
  /**
@@ -20407,10 +21095,14 @@ export declare interface SettingsObject {
20407
21095
  modified?: number;
20408
21096
  /**
20409
21097
  * The unique identifier of the user who performed the most recent modification.
21098
+ *
21099
+ * @exampleValue fab17b7a-2eb2-4c95-b818-743d94be2c30
20410
21100
  */
20411
21101
  modifiedBy?: string;
20412
21102
  /**
20413
21103
  * The ID of the settings object.
21104
+ *
21105
+ * @exampleValue Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=
20414
21106
  */
20415
21107
  objectId?: string;
20416
21108
  /**
@@ -20423,14 +21115,20 @@ export declare interface SettingsObject {
20423
21115
  resourceContext?: ResourceContext;
20424
21116
  /**
20425
21117
  * The schema on which the object is based.
21118
+ *
21119
+ * @exampleValue builtin:container.built-in-monitoring-rule
20426
21120
  */
20427
21121
  schemaId?: string;
20428
21122
  /**
20429
21123
  * The version of the schema on which the object is based.
21124
+ *
21125
+ * @exampleValue 1.0.0
20430
21126
  */
20431
21127
  schemaVersion?: string;
20432
21128
  /**
20433
21129
  * The scope that the object targets. For more details, please see [Dynatrace Documentation](https://dt-url.net/ky03459).
21130
+ *
21131
+ * @exampleValue HOST-D3A3C5A146830A79
20434
21132
  */
20435
21133
  scope?: string;
20436
21134
  /**
@@ -20447,6 +21145,8 @@ export declare interface SettingsObject {
20447
21145
  * It is generated upon retrieval (GET requests). If set on update (PUT request) or deletion, the update/deletion will be allowed only if there wasn't any change between the retrieval and the update.
20448
21146
  *
20449
21147
  * If omitted on update/deletion, the operation overrides the current value or deletes it without any checks.
21148
+ *
21149
+ * @exampleValue Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=
20450
21150
  */
20451
21151
  updateToken?: string;
20452
21152
  /**
@@ -20455,6 +21155,8 @@ export declare interface SettingsObject {
20455
21155
  * It defines the actual values of settings' parameters.
20456
21156
  *
20457
21157
  * The actual content depends on the object's schema.
21158
+ *
21159
+ * @exampleValue {"autoMonitoring":true}
20458
21160
  */
20459
21161
  value?: AnyValue;
20460
21162
  }
@@ -20465,6 +21167,8 @@ export declare interface SettingsObject {
20465
21167
  export declare interface SettingsObjectByObjectIdResponse {
20466
21168
  /**
20467
21169
  * The user (identified by a user ID or a public token ID) who performed that most recent modification.
21170
+ *
21171
+ * @exampleValue john.doe@example.com
20468
21172
  */
20469
21173
  author?: string;
20470
21174
  /**
@@ -20473,6 +21177,8 @@ export declare interface SettingsObjectByObjectIdResponse {
20473
21177
  created?: number;
20474
21178
  /**
20475
21179
  * The unique identifier of the user who created the settings object.
21180
+ *
21181
+ * @exampleValue fab17b7a-2eb2-4c95-b818-743d94be2c30
20476
21182
  */
20477
21183
  createdBy?: string;
20478
21184
  /**
@@ -20485,10 +21191,14 @@ export declare interface SettingsObjectByObjectIdResponse {
20485
21191
  modified?: number;
20486
21192
  /**
20487
21193
  * The unique identifier of the user who performed the most recent modification.
21194
+ *
21195
+ * @exampleValue fab17b7a-2eb2-4c95-b818-743d94be2c30
20488
21196
  */
20489
21197
  modifiedBy?: string;
20490
21198
  /**
20491
21199
  * The ID of the settings object.
21200
+ *
21201
+ * @exampleValue Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=
20492
21202
  */
20493
21203
  objectId?: string;
20494
21204
  /**
@@ -20501,14 +21211,20 @@ export declare interface SettingsObjectByObjectIdResponse {
20501
21211
  resourceContext?: ResourceContext;
20502
21212
  /**
20503
21213
  * The schema on which the object is based.
21214
+ *
21215
+ * @exampleValue builtin:container.built-in-monitoring-rule
20504
21216
  */
20505
21217
  schemaId?: string;
20506
21218
  /**
20507
21219
  * The version of the schema on which the object is based.
21220
+ *
21221
+ * @exampleValue 1.0.0
20508
21222
  */
20509
21223
  schemaVersion?: string;
20510
21224
  /**
20511
21225
  * The scope that the object targets. For more details, please see [Dynatrace Documentation](https://dt-url.net/ky03459).
21226
+ *
21227
+ * @exampleValue HOST-D3A3C5A146830A79
20512
21228
  */
20513
21229
  scope?: string;
20514
21230
  /**
@@ -20525,6 +21241,8 @@ export declare interface SettingsObjectByObjectIdResponse {
20525
21241
  * It is generated upon retrieval (GET requests). If set on update (PUT request) or deletion, the update/deletion will be allowed only if there wasn't any change between the retrieval and the update.
20526
21242
  *
20527
21243
  * If omitted on update/deletion, the operation overrides the current value or deletes it without any checks.
21244
+ *
21245
+ * @exampleValue Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=
20528
21246
  */
20529
21247
  updateToken?: string;
20530
21248
  /**
@@ -20533,6 +21251,8 @@ export declare interface SettingsObjectByObjectIdResponse {
20533
21251
  * It defines the actual values of settings' parameters.
20534
21252
  *
20535
21253
  * The actual content depends on the object's schema.
21254
+ *
21255
+ * @exampleValue {"autoMonitoring":true}
20536
21256
  */
20537
21257
  value?: AnyValue;
20538
21258
  }
@@ -20553,24 +21273,34 @@ export declare interface SettingsObjectCreate {
20553
21273
  * If set to an empty string, the new object will be placed in the first position.
20554
21274
  *
20555
21275
  * Only applicable for objects based on schemas with ordered objects (schema's `ordered` parameter is set to `true`).
21276
+ *
21277
+ * @exampleValue Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=
20556
21278
  */
20557
21279
  insertAfter?: string;
20558
21280
  /**
20559
21281
  * The ID of the settings object that should be replaced.
20560
21282
  *
20561
21283
  * Only applicable if an external identifier is provided.
21284
+ *
21285
+ * @exampleValue Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=
20562
21286
  */
20563
21287
  objectId?: string;
20564
21288
  /**
20565
21289
  * The schema on which the object is based.
21290
+ *
21291
+ * @exampleValue builtin:container.built-in-monitoring-rule
20566
21292
  */
20567
21293
  schemaId: string;
20568
21294
  /**
20569
21295
  * The version of the schema on which the object is based.
21296
+ *
21297
+ * @exampleValue 1.0.0
20570
21298
  */
20571
21299
  schemaVersion?: string;
20572
21300
  /**
20573
21301
  * The scope that the object targets. For more details, please see [Dynatrace Documentation](https://dt-url.net/ky03459).
21302
+ *
21303
+ * @exampleValue HOST-D3A3C5A146830A79
20574
21304
  */
20575
21305
  scope: string;
20576
21306
  /**
@@ -20579,6 +21309,8 @@ export declare interface SettingsObjectCreate {
20579
21309
  * It defines the actual values of settings' parameters.
20580
21310
  *
20581
21311
  * The actual content depends on the object's schema.
21312
+ *
21313
+ * @exampleValue {"autoMonitoring":true}
20582
21314
  */
20583
21315
  value: AnyValue;
20584
21316
  }
@@ -20598,10 +21330,14 @@ export declare interface SettingsObjectResponse {
20598
21330
  * It defines the actual values of settings' parameters.
20599
21331
  *
20600
21332
  * The actual content depends on the object's schema.
21333
+ *
21334
+ * @exampleValue {"autoMonitoring":true}
20601
21335
  */
20602
21336
  invalidValue?: AnyValue;
20603
21337
  /**
20604
21338
  * For a successful request, the ID of the created or modified settings object.
21339
+ *
21340
+ * @exampleValue Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=
20605
21341
  */
20606
21342
  objectId?: string;
20607
21343
  }
@@ -20715,6 +21451,8 @@ export declare class SettingsObjectsClient {
20715
21451
  * Specify the required top-level fields, separated by commas (for example, `origin,value`).
20716
21452
  *
20717
21453
  * Supported fields: `summary`, `searchSummary`, `created`, `modified`, `createdBy`, `modifiedBy`, `author`, `origin`, `schemaId`, `schemaVersion`, `value`, `externalId`.
21454
+ *
21455
+ * @defaultValue origin,value
20718
21456
  */ fields?: string;
20719
21457
  /**
20720
21458
  * The cursor for the next page of results. You can find it in the **nextPageKey** field of the previous response.
@@ -20730,7 +21468,11 @@ export declare class SettingsObjectsClient {
20730
21468
  *
20731
21469
  * If not set, 100 is used.
20732
21470
  */ pageSize?: number;
20733
- /** If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects */ adminAccess?: boolean;
21471
+ /**
21472
+ * If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects
21473
+ *
21474
+ * @defaultValue false
21475
+ */ adminAccess?: boolean;
20734
21476
  abortSignal?: AbortSignal_2;
20735
21477
  }): Promise<EffectiveSettingsValuesList>;
20736
21478
  /**
@@ -20793,7 +21535,11 @@ export declare class SettingsObjectsClient {
20793
21535
  *
20794
21536
  * If not set, 100 is used.
20795
21537
  */ pageSize?: number;
20796
- /** If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects */ adminAccess?: boolean;
21538
+ /**
21539
+ * If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects
21540
+ *
21541
+ * @defaultValue false
21542
+ */ adminAccess?: boolean;
20797
21543
  abortSignal?: AbortSignal_2;
20798
21544
  }): Promise<RevisionDiffPage>;
20799
21545
  /**
@@ -20854,6 +21600,8 @@ export declare class SettingsObjectsClient {
20854
21600
  * Specify the required top-level fields, separated by commas (for example, `objectId,value`).
20855
21601
  *
20856
21602
  * Supported fields: `objectId`, `summary`, `searchSummary`, `created`, `modified`, `createdBy`, `modifiedBy`, `author`, `updateToken`, `scope`, `modificationInfo` (deprecated), `resourceContext`, `owner`, `schemaId`, `schemaVersion`, `value`, `externalId`.
21603
+ *
21604
+ * @defaultValue objectId,value
20857
21605
  */ fields?: string;
20858
21606
  /**
20859
21607
  * The filter parameter, as explained [here](https://dt-url.net/platform-services-filtering).
@@ -20897,7 +21645,11 @@ export declare class SettingsObjectsClient {
20897
21645
  *
20898
21646
  * If not set, 100 is used.
20899
21647
  */ pageSize?: number;
20900
- /** If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects */ adminAccess?: boolean;
21648
+ /**
21649
+ * If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects
21650
+ *
21651
+ * @defaultValue false
21652
+ */ adminAccess?: boolean;
20901
21653
  abortSignal?: AbortSignal_2;
20902
21654
  }): Promise<ObjectsList>;
20903
21655
  /**
@@ -20934,8 +21686,16 @@ export declare class SettingsObjectsClient {
20934
21686
  */
20935
21687
  postSettingsObjects(config: {
20936
21688
  body: SettingsObjectCreate[];
20937
- /** If `true`, the request runs only validation of the submitted settings objects, without saving them. */ validateOnly?: boolean;
20938
- /** If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects */ adminAccess?: boolean;
21689
+ /**
21690
+ * If `true`, the request runs only validation of the submitted settings objects, without saving them.
21691
+ *
21692
+ * @defaultValue false
21693
+ */ validateOnly?: boolean;
21694
+ /**
21695
+ * If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects
21696
+ *
21697
+ * @defaultValue false
21698
+ */ adminAccess?: boolean;
20939
21699
  abortSignal?: AbortSignal_2;
20940
21700
  }): Promise<SettingsObjectResponse[]>;
20941
21701
  /**
@@ -20962,7 +21722,11 @@ export declare class SettingsObjectsClient {
20962
21722
  */
20963
21723
  getSettingsObjectByObjectId(config: {
20964
21724
  /** The ID of the required settings object. */ objectId: string;
20965
- /** If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects */ adminAccess?: boolean;
21725
+ /**
21726
+ * If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects
21727
+ *
21728
+ * @defaultValue false
21729
+ */ adminAccess?: boolean;
20966
21730
  abortSignal?: AbortSignal_2;
20967
21731
  }): Promise<SettingsObjectByObjectIdResponse>;
20968
21732
  /**
@@ -20996,8 +21760,16 @@ export declare class SettingsObjectsClient {
20996
21760
  putSettingsObjectByObjectId(config: {
20997
21761
  body: SettingsObjectUpdate;
20998
21762
  /** The ID of the required settings object. */ objectId: string;
20999
- /** If `true`, the request runs only validation of the submitted settings object, without saving it. */ validateOnly?: boolean;
21000
- /** If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects */ adminAccess?: boolean;
21763
+ /**
21764
+ * If `true`, the request runs only validation of the submitted settings object, without saving it.
21765
+ *
21766
+ * @defaultValue false
21767
+ */ validateOnly?: boolean;
21768
+ /**
21769
+ * If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects
21770
+ *
21771
+ * @defaultValue false
21772
+ */ adminAccess?: boolean;
21001
21773
  abortSignal?: AbortSignal_2;
21002
21774
  }): Promise<SettingsObjectResponse>;
21003
21775
  /**
@@ -21030,7 +21802,11 @@ export declare class SettingsObjectsClient {
21030
21802
  *
21031
21803
  * If omitted on update/deletion, the operation overrides the current value or deletes it without any checks.
21032
21804
  */ updateToken?: string;
21033
- /** If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects */ adminAccess?: boolean;
21805
+ /**
21806
+ * If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects
21807
+ *
21808
+ * @defaultValue false
21809
+ */ adminAccess?: boolean;
21034
21810
  abortSignal?: AbortSignal_2;
21035
21811
  }): Promise<void>;
21036
21812
  /**
@@ -21054,7 +21830,11 @@ export declare class SettingsObjectsClient {
21054
21830
  */
21055
21831
  getPermissions(config: {
21056
21832
  /** The ID of the required settings object. */ objectId: string;
21057
- /** If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects */ adminAccess?: boolean;
21833
+ /**
21834
+ * If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects
21835
+ *
21836
+ * @defaultValue false
21837
+ */ adminAccess?: boolean;
21058
21838
  abortSignal?: AbortSignal_2;
21059
21839
  }): Promise<AccessorPermissionsList>;
21060
21840
  /**
@@ -21080,7 +21860,11 @@ export declare class SettingsObjectsClient {
21080
21860
  addPermission(config: {
21081
21861
  body: AccessorPermissions;
21082
21862
  /** The ID of the required settings object. */ objectId: string;
21083
- /** If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects */ adminAccess?: boolean;
21863
+ /**
21864
+ * If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects
21865
+ *
21866
+ * @defaultValue false
21867
+ */ adminAccess?: boolean;
21084
21868
  abortSignal?: AbortSignal_2;
21085
21869
  }): Promise<AccessorPermissions>;
21086
21870
  /**
@@ -21105,7 +21889,11 @@ export declare class SettingsObjectsClient {
21105
21889
  */
21106
21890
  getPermissionAllUsers(config: {
21107
21891
  /** The ID of the required settings object. */ objectId: string;
21108
- /** If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects */ adminAccess?: boolean;
21892
+ /**
21893
+ * If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects
21894
+ *
21895
+ * @defaultValue false
21896
+ */ adminAccess?: boolean;
21109
21897
  abortSignal?: AbortSignal_2;
21110
21898
  }): Promise<AccessorPermissions>;
21111
21899
  /**
@@ -21130,7 +21918,11 @@ export declare class SettingsObjectsClient {
21130
21918
  updatePermissionAllUsers(config: {
21131
21919
  body: UpdatePermissionsRequest;
21132
21920
  /** The ID of the required settings object. */ objectId: string;
21133
- /** If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects */ adminAccess?: boolean;
21921
+ /**
21922
+ * If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects
21923
+ *
21924
+ * @defaultValue false
21925
+ */ adminAccess?: boolean;
21134
21926
  abortSignal?: AbortSignal_2;
21135
21927
  }): Promise<void>;
21136
21928
  /**
@@ -21153,7 +21945,11 @@ export declare class SettingsObjectsClient {
21153
21945
  */
21154
21946
  removePermissionAllUsers(config: {
21155
21947
  /** The ID of the required settings object. */ objectId: string;
21156
- /** If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects */ adminAccess?: boolean;
21948
+ /**
21949
+ * If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects
21950
+ *
21951
+ * @defaultValue false
21952
+ */ adminAccess?: boolean;
21157
21953
  abortSignal?: AbortSignal_2;
21158
21954
  }): Promise<void>;
21159
21955
  /**
@@ -21181,7 +21977,11 @@ export declare class SettingsObjectsClient {
21181
21977
  /** The ID of the required settings object. */ objectId: string;
21182
21978
  /** The type of the accessor. */ accessorType: 'group' | 'user';
21183
21979
  /** The user uuid or group uuid of the accessor, depending on the type. */ accessorId: string;
21184
- /** If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects */ adminAccess?: boolean;
21980
+ /**
21981
+ * If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects
21982
+ *
21983
+ * @defaultValue false
21984
+ */ adminAccess?: boolean;
21185
21985
  abortSignal?: AbortSignal_2;
21186
21986
  }): Promise<AccessorPermissions>;
21187
21987
  /**
@@ -21209,7 +22009,11 @@ export declare class SettingsObjectsClient {
21209
22009
  /** The ID of the required settings object. */ objectId: string;
21210
22010
  /** The type of the accessor. */ accessorType: 'group' | 'user';
21211
22011
  /** The user uuid or group uuid of the accessor, depending on the type. */ accessorId: string;
21212
- /** If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects */ adminAccess?: boolean;
22012
+ /**
22013
+ * If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects
22014
+ *
22015
+ * @defaultValue false
22016
+ */ adminAccess?: boolean;
21213
22017
  abortSignal?: AbortSignal_2;
21214
22018
  }): Promise<void>;
21215
22019
  /**
@@ -21235,7 +22039,11 @@ export declare class SettingsObjectsClient {
21235
22039
  /** The ID of the required settings object. */ objectId: string;
21236
22040
  /** The type of the accessor. */ accessorType: 'group' | 'user';
21237
22041
  /** The user uuid or group uuid of the accessor, depending on the type. */ accessorId: string;
21238
- /** If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects */ adminAccess?: boolean;
22042
+ /**
22043
+ * If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects
22044
+ *
22045
+ * @defaultValue false
22046
+ */ adminAccess?: boolean;
21239
22047
  abortSignal?: AbortSignal_2;
21240
22048
  }): Promise<void>;
21241
22049
  /**
@@ -21259,7 +22067,11 @@ export declare class SettingsObjectsClient {
21259
22067
  transferOwnership(config: {
21260
22068
  body: TransferOwnershipRequest;
21261
22069
  /** The ID of the required settings object. */ objectId: string;
21262
- /** If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects */ adminAccess?: boolean;
22070
+ /**
22071
+ * If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects
22072
+ *
22073
+ * @defaultValue false
22074
+ */ adminAccess?: boolean;
21263
22075
  abortSignal?: AbortSignal_2;
21264
22076
  }): Promise<void>;
21265
22077
  }
@@ -21280,6 +22092,8 @@ export declare interface SettingsObjectUpdate {
21280
22092
  * If set to an empty string, the updated object will be placed in the first position.
21281
22093
  *
21282
22094
  * Only applicable for objects based on schemas with ordered objects (schema's **ordered** parameter is set to `true`).
22095
+ *
22096
+ * @exampleValue Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=
21283
22097
  */
21284
22098
  insertAfter?: string;
21285
22099
  /**
@@ -21292,10 +22106,14 @@ export declare interface SettingsObjectUpdate {
21292
22106
  * If set to an empty string, the updated object will be placed in the last position.
21293
22107
  *
21294
22108
  * Only applicable for objects based on schemas with ordered objects (schema's **ordered** parameter is set to `true`).
22109
+ *
22110
+ * @exampleValue Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=
21295
22111
  */
21296
22112
  insertBefore?: string;
21297
22113
  /**
21298
22114
  * The version of the schema on which the object is based.
22115
+ *
22116
+ * @exampleValue 1.0.0
21299
22117
  */
21300
22118
  schemaVersion?: string;
21301
22119
  /**
@@ -21304,6 +22122,8 @@ export declare interface SettingsObjectUpdate {
21304
22122
  * It is generated upon retrieval (GET requests). If set on update (PUT request) or deletion, the update/deletion will be allowed only if there wasn't any change between the retrieval and the update.
21305
22123
  *
21306
22124
  * If omitted on update/deletion, the operation overrides the current value or deletes it without any checks.
22125
+ *
22126
+ * @exampleValue Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=
21307
22127
  */
21308
22128
  updateToken?: string;
21309
22129
  /**
@@ -21312,6 +22132,8 @@ export declare interface SettingsObjectUpdate {
21312
22132
  * It defines the actual values of settings' parameters.
21313
22133
  *
21314
22134
  * The actual content depends on the object's schema.
22135
+ *
22136
+ * @exampleValue {"autoMonitoring":true}
21315
22137
  */
21316
22138
  value: AnyValue;
21317
22139
  }
@@ -21356,6 +22178,8 @@ export declare class SettingsSchemasClient {
21356
22178
  * Specify the required top-level fields, separated by commas (for example, `schemaId,displayName`).
21357
22179
  *
21358
22180
  * Supported fields: `schemaId`, `displayName`, `maturity`, `latestSchemaVersion`, `multiObject`, `ordered`, `ownerBasedAccessControl`.
22181
+ *
22182
+ * @defaultValue schemaId,displayName,latestSchemaVersion
21359
22183
  */ fields?: string;
21360
22184
  abortSignal?: AbortSignal_2;
21361
22185
  }): Promise<SchemaList>;
@@ -21404,6 +22228,8 @@ export declare interface SinglePermissionRequest {
21404
22228
  context?: PermissionContext;
21405
22229
  /**
21406
22230
  * Permission to be probed
22231
+ *
22232
+ * @exampleValue settings:objects:write
21407
22233
  */
21408
22234
  permission: string;
21409
22235
  }
@@ -21414,26 +22240,36 @@ export declare interface SinglePermissionRequest {
21414
22240
  export declare interface SLO {
21415
22241
  /**
21416
22242
  * The key for the SLO's error budget burn rate func metric.
22243
+ *
22244
+ * @exampleValue func:slo.errorBudgetBurnRate.payment_service_availability
21417
22245
  */
21418
22246
  burnRateMetricKey: string;
21419
22247
  /**
21420
22248
  * The denominator value used to evaluate the SLO when **useRateMetric** is set to `false`.
21421
22249
  *
22250
+ * @exampleValue 90
22251
+ *
21422
22252
  * @deprecated
21423
22253
  */
21424
22254
  denominatorValue?: number;
21425
22255
  /**
21426
22256
  * A short description of the SLO.
22257
+ *
22258
+ * @exampleValue Rate of successful payments per week
21427
22259
  */
21428
22260
  description?: string;
21429
22261
  /**
21430
22262
  * The SLO is enabled (`true`) or disabled (`false`).
22263
+ *
22264
+ * @exampleValue true
21431
22265
  */
21432
22266
  enabled: boolean;
21433
22267
  /**
21434
22268
  * The error of the SLO calculation.
21435
22269
  *
21436
22270
  * If the value differs from `NONE`, there is something wrong with the SLO calculation.
22271
+ *
22272
+ * @exampleValue NONE
21437
22273
  */
21438
22274
  error: string;
21439
22275
  /**
@@ -21445,6 +22281,8 @@ export declare interface SLO {
21445
22281
  *
21446
22282
  * * If there is an error with the SLO calculation; in that case check the value of the **error** property.
21447
22283
  * * If the evaluate parameter has not been set to `true`; in that case the **error** property will contain no error.
22284
+ *
22285
+ * @exampleValue 1.25
21448
22286
  */
21449
22287
  errorBudget: number;
21450
22288
  /**
@@ -21453,6 +22291,8 @@ export declare interface SLO {
21453
22291
  errorBudgetBurnRate: SloBurnRate;
21454
22292
  /**
21455
22293
  * The key for the SLO's error budget func metric.
22294
+ *
22295
+ * @exampleValue func:slo.errorBudget.payment_service_availability
21456
22296
  */
21457
22297
  errorBudgetMetricKey: string;
21458
22298
  /**
@@ -21460,18 +22300,26 @@ export declare interface SLO {
21460
22300
  *
21461
22301
  * * If there is an error with the SLO calculation; in that case check the value of the **error** property.
21462
22302
  * * If the evaluate parameter has not been set to `true`; in that case the **error** property will contain no error.
22303
+ *
22304
+ * @exampleValue 96.25
21463
22305
  */
21464
22306
  evaluatedPercentage: number;
21465
22307
  /**
21466
22308
  * The evaluation type of the SLO.
22309
+ *
22310
+ * @exampleValue AGGREGATE
21467
22311
  */
21468
22312
  evaluationType: 'AGGREGATE';
21469
22313
  /**
21470
22314
  * The entity filter for the SLO evaluation. The total length of the entitySelector string in SLOs is limited to 1,000 characters. Use the [syntax of entity selector](https://dt-url.net/entityselector).
22315
+ *
22316
+ * @exampleValue type("SERVICE")
21471
22317
  */
21472
22318
  filter: string;
21473
22319
  /**
21474
22320
  * The ID of the SLO
22321
+ *
22322
+ * @exampleValue 123e4567-e89b-42d3-a456-556642440000
21475
22323
  */
21476
22324
  id: string;
21477
22325
  /**
@@ -21479,19 +22327,27 @@ export declare interface SLO {
21479
22327
  *
21480
22328
  * Required when the **useRateMetric** is set to `false`.
21481
22329
  *
22330
+ * @exampleValue builtin:service.requestCount.server
22331
+ *
21482
22332
  * @deprecated
21483
22333
  */
21484
22334
  metricDenominator?: string;
21485
22335
  /**
21486
22336
  * The percentage-based metric expression for the calculation of the SLO.
22337
+ *
22338
+ * @exampleValue (100)*(builtin:service.errors.server.successCount:splitBy())/(builtin:service.requestCount.server:splitBy())
21487
22339
  */
21488
22340
  metricExpression: string;
21489
22341
  /**
21490
22342
  * The key for the SLO's status func metric.
22343
+ *
22344
+ * @exampleValue func:slo.payment_service_availability
21491
22345
  */
21492
22346
  metricKey: string;
21493
22347
  /**
21494
22348
  * The name that is used to create SLO func metrics keys. Once created, metric name cannot be changed.
22349
+ *
22350
+ * @exampleValue payment_service_availability
21495
22351
  */
21496
22352
  metricName: string;
21497
22353
  /**
@@ -21499,6 +22355,8 @@ export declare interface SLO {
21499
22355
  *
21500
22356
  * Required when the **useRateMetric** is set to `false`.
21501
22357
  *
22358
+ * @exampleValue builtin:service.errors.server.successCount
22359
+ *
21502
22360
  * @deprecated
21503
22361
  */
21504
22362
  metricNumerator?: string;
@@ -21507,26 +22365,36 @@ export declare interface SLO {
21507
22365
  *
21508
22366
  * Required when the **useRateMetric** is set to `true`.
21509
22367
  *
22368
+ * @exampleValue builtin:service.successes.server.rate
22369
+ *
21510
22370
  * @deprecated
21511
22371
  */
21512
22372
  metricRate?: string;
21513
22373
  /**
21514
22374
  * The name of the SLO.
22375
+ *
22376
+ * @exampleValue Payment service availability
21515
22377
  */
21516
22378
  name: string;
21517
22379
  /**
21518
22380
  * The key for the SLO's normalized error budget func metric.
22381
+ *
22382
+ * @exampleValue func:slo.normalizedErrorBudget.payment_service_availability
21519
22383
  */
21520
22384
  normalizedErrorBudgetMetricKey: string;
21521
22385
  /**
21522
22386
  * The numerator value used to evaluate the SLO when **useRateMetric** is set to `false`.
21523
22387
  *
22388
+ * @exampleValue 80
22389
+ *
21524
22390
  * @deprecated
21525
22391
  */
21526
22392
  numeratorValue?: number;
21527
22393
  /**
21528
22394
  * The entity filter for fetching the number of problems related to an SLO. Auto-generated in case no filter has been added to the SLO.
21529
22395
  *
22396
+ * @exampleValue [type("SERVICE")]
22397
+ *
21530
22398
  * @deprecated
21531
22399
  */
21532
22400
  problemFilters?: string[];
@@ -21544,14 +22412,20 @@ export declare interface SLO {
21544
22412
  relatedTotalProblems?: number;
21545
22413
  /**
21546
22414
  * The status of the calculated SLO.
22415
+ *
22416
+ * @exampleValue WARNING
21547
22417
  */
21548
22418
  status: 'FAILURE' | 'SUCCESS' | 'WARNING';
21549
22419
  /**
21550
22420
  * The target value of the SLO.
22421
+ *
22422
+ * @exampleValue 95
21551
22423
  */
21552
22424
  target: number;
21553
22425
  /**
21554
22426
  * The timeframe for the SLO evaluation. Use the syntax of the global timeframe selector.
22427
+ *
22428
+ * @exampleValue -1d
21555
22429
  */
21556
22430
  timeframe: string;
21557
22431
  /**
@@ -21562,6 +22436,8 @@ export declare interface SLO {
21562
22436
  *
21563
22437
  * For a list of available metrics, see [Built-in metric page](https://dt-url.net/be03kow) or try the [GET metrics](https://dt-url.net/8e43kxf) API call.
21564
22438
  *
22439
+ * @exampleValue true
22440
+ *
21565
22441
  * @deprecated
21566
22442
  */
21567
22443
  useRateMetric?: boolean;
@@ -21569,6 +22445,8 @@ export declare interface SLO {
21569
22445
  * The warning value of the SLO.
21570
22446
  *
21571
22447
  * At warning state the SLO is still fulfilled but is getting close to failure.
22448
+ *
22449
+ * @exampleValue 97.5
21572
22450
  */
21573
22451
  warning: number;
21574
22452
  }
@@ -21581,28 +22459,40 @@ export declare interface SloBurnRate {
21581
22459
  * The calculated burn rate type.
21582
22460
  *
21583
22461
  * Has a value of 'FAST', 'SLOW' or 'NONE'.
22462
+ *
22463
+ * @exampleValue SLOW
21584
22464
  */
21585
22465
  burnRateType?: 'FAST' | 'NONE' | 'SLOW';
21586
22466
  /**
21587
22467
  * The burn rate of the SLO, calculated for the last hour.
22468
+ *
22469
+ * @exampleValue 1.25
21588
22470
  */
21589
22471
  burnRateValue?: number;
21590
22472
  /**
21591
22473
  * The error budget burn rate calculation is enabled (`true`) or disabled (`false`).
21592
22474
  *
21593
22475
  * In case of `false`, no calculated values will be present here.
22476
+ *
22477
+ * @exampleValue true
21594
22478
  */
21595
22479
  burnRateVisualizationEnabled: boolean;
21596
22480
  /**
21597
22481
  * The estimated time left to consume the error budget in hours.
22482
+ *
22483
+ * @exampleValue 24
21598
22484
  */
21599
22485
  estimatedTimeToConsumeErrorBudget?: number;
21600
22486
  /**
21601
22487
  * The threshold between a slow and a fast burn rate.
22488
+ *
22489
+ * @exampleValue 1.5
21602
22490
  */
21603
22491
  fastBurnThreshold?: number;
21604
22492
  /**
21605
22493
  * The calculated value of the SLO for the timeframe chosen for the burn rate calculation.
22494
+ *
22495
+ * @exampleValue 95
21606
22496
  */
21607
22497
  sloValue?: number;
21608
22498
  }
@@ -21630,10 +22520,14 @@ export declare interface SloBurnRateConfig {
21630
22520
  * In case of `false`, no calculated values will be present here.
21631
22521
  *
21632
22522
  * If not defined, the error budget burn rate calculation is disabled by default.
22523
+ *
22524
+ * @exampleValue true
21633
22525
  */
21634
22526
  burnRateVisualizationEnabled?: boolean;
21635
22527
  /**
21636
22528
  * The threshold between a slow and a fast burn rate.
22529
+ *
22530
+ * @exampleValue 1.5
21637
22531
  */
21638
22532
  fastBurnThreshold?: number;
21639
22533
  }
@@ -21641,12 +22535,16 @@ export declare interface SloBurnRateConfig {
21641
22535
  export declare interface SloConfigItemDtoImpl {
21642
22536
  /**
21643
22537
  * The description of the SLO.
22538
+ *
22539
+ * @exampleValue Rate of successful payments per week
21644
22540
  */
21645
22541
  description?: string;
21646
22542
  /**
21647
22543
  * The SLO is enabled (`true`) or disabled (`false`).
21648
22544
  *
21649
22545
  * If not defined, the SLO is disabled by default.
22546
+ *
22547
+ * @exampleValue true
21650
22548
  */
21651
22549
  enabled?: boolean;
21652
22550
  /**
@@ -21655,10 +22553,14 @@ export declare interface SloConfigItemDtoImpl {
21655
22553
  errorBudgetBurnRate?: SloBurnRateConfig;
21656
22554
  /**
21657
22555
  * The evaluation type of the SLO.
22556
+ *
22557
+ * @exampleValue AGGREGATE
21658
22558
  */
21659
22559
  evaluationType: 'AGGREGATE';
21660
22560
  /**
21661
22561
  * The entity filter for the SLO evaluation. The total length of the entitySelector string in SLOs is limited to 1,000 characters. Use the [syntax of entity selector](https://dt-url.net/entityselector).
22562
+ *
22563
+ * @exampleValue type("SERVICE")
21662
22564
  */
21663
22565
  filter?: string;
21664
22566
  /**
@@ -21666,15 +22568,21 @@ export declare interface SloConfigItemDtoImpl {
21666
22568
  *
21667
22569
  * Required when the **useRateMetric** is set to `false`.
21668
22570
  *
22571
+ * @exampleValue builtin:service.requestCount.server
22572
+ *
21669
22573
  * @deprecated
21670
22574
  */
21671
22575
  metricDenominator?: string;
21672
22576
  /**
21673
22577
  * The percentage-based metric expression for the calculation of the SLO.
22578
+ *
22579
+ * @exampleValue (100)*(builtin:service.errors.server.successCount:splitBy())/(builtin:service.requestCount.server:splitBy())
21674
22580
  */
21675
22581
  metricExpression?: string;
21676
22582
  /**
21677
22583
  * The name that is used to create SLO func metrics keys. Once created, metric name cannot be changed.
22584
+ *
22585
+ * @exampleValue payment_service_availability
21678
22586
  */
21679
22587
  metricName?: string;
21680
22588
  /**
@@ -21682,6 +22590,8 @@ export declare interface SloConfigItemDtoImpl {
21682
22590
  *
21683
22591
  * Required when the **useRateMetric** is set to `false`.
21684
22592
  *
22593
+ * @exampleValue builtin:service.errors.server.successCount
22594
+ *
21685
22595
  * @deprecated
21686
22596
  */
21687
22597
  metricNumerator?: string;
@@ -21690,19 +22600,27 @@ export declare interface SloConfigItemDtoImpl {
21690
22600
  *
21691
22601
  * Required when the **useRateMetric** is set to `true`.
21692
22602
  *
22603
+ * @exampleValue builtin:service.successes.server.rate
22604
+ *
21693
22605
  * @deprecated
21694
22606
  */
21695
22607
  metricRate?: string;
21696
22608
  /**
21697
22609
  * The name of the SLO.
22610
+ *
22611
+ * @exampleValue Payment service availability
21698
22612
  */
21699
22613
  name: string;
21700
22614
  /**
21701
22615
  * The target value of the SLO.
22616
+ *
22617
+ * @exampleValue 95
21702
22618
  */
21703
22619
  target: number;
21704
22620
  /**
21705
22621
  * The timeframe for the SLO evaluation. Use the syntax of the global timeframe selector.
22622
+ *
22623
+ * @exampleValue -1d
21706
22624
  */
21707
22625
  timeframe: string;
21708
22626
  /**
@@ -21713,6 +22631,8 @@ export declare interface SloConfigItemDtoImpl {
21713
22631
  *
21714
22632
  * For a list of available metrics, see [Built-in metric page](https://dt-url.net/be03kow) or try the [GET metrics](https://dt-url.net/8e43kxf) API call.
21715
22633
  *
22634
+ * @exampleValue true
22635
+ *
21716
22636
  * @deprecated
21717
22637
  */
21718
22638
  useRateMetric?: boolean | null;
@@ -21720,6 +22640,8 @@ export declare interface SloConfigItemDtoImpl {
21720
22640
  * The warning value of the SLO.
21721
22641
  *
21722
22642
  * At warning state the SLO is still fulfilled but is getting close to failure.
22643
+ *
22644
+ * @exampleValue 97.5
21723
22645
  */
21724
22646
  warning: number;
21725
22647
  }
@@ -21750,6 +22672,8 @@ export declare interface SLOs {
21750
22672
  * The cursor for the next page of results. Has the value of `null` on the last page.
21751
22673
  *
21752
22674
  * Use it in the **nextPageKey** query parameter to obtain subsequent pages of the result.
22675
+ *
22676
+ * @exampleValue AQAAABQBAAAABQ==
21753
22677
  */
21754
22678
  nextPageKey?: string;
21755
22679
  /**
@@ -21813,18 +22737,26 @@ export declare interface SNMPV3Credentials extends Credentials {
21813
22737
  export declare interface SoftwareTechs {
21814
22738
  /**
21815
22739
  * The edition of the technology.
22740
+ *
22741
+ * @exampleValue OpenJDK
21816
22742
  */
21817
22743
  edition?: string;
21818
22744
  /**
21819
22745
  * The type of the technology.
22746
+ *
22747
+ * @exampleValue JAVA
21820
22748
  */
21821
22749
  technology?: string;
21822
22750
  /**
21823
22751
  * The verbatim type of the technology.
22752
+ *
22753
+ * @exampleValue Java
21824
22754
  */
21825
22755
  verbatimType?: string;
21826
22756
  /**
21827
22757
  * The version of the technology.
22758
+ *
22759
+ * @exampleValue 11.0.10
21828
22760
  */
21829
22761
  version?: string;
21830
22762
  }
@@ -21950,6 +22882,8 @@ export declare interface SyntheticBrowserMonitorRequest {
21950
22882
  description?: string;
21951
22883
  /**
21952
22884
  * If true, the monitor is enabled.
22885
+ *
22886
+ * @defaultValue true
21953
22887
  */
21954
22888
  enabled?: boolean;
21955
22889
  /**
@@ -21986,6 +22920,8 @@ export declare interface SyntheticBrowserMonitorRequest {
21986
22920
  steps: SyntheticBrowserMonitorStepDto[];
21987
22921
  /**
21988
22922
  * Outage handling configuration.
22923
+ *
22924
+ * @exampleValue {"globalConsecutiveOutageCountThreshold":"1","globalOutages":"true","localConsecutiveOutageCountThreshold":"3","localLocationOutageCountThreshold":"3","localOutages":"true"}
21989
22925
  */
21990
22926
  syntheticMonitorOutageHandlingSettings?: SyntheticMonitorOutageHandlingSettingsDto;
21991
22927
  /**
@@ -22073,6 +23009,8 @@ export declare interface SyntheticBrowserMonitorResponse {
22073
23009
  steps: SyntheticBrowserMonitorStepDto[];
22074
23010
  /**
22075
23011
  * Outage handling configuration.
23012
+ *
23013
+ * @exampleValue {"globalConsecutiveOutageCountThreshold":"1","globalOutages":"true","localConsecutiveOutageCountThreshold":"3","localLocationOutageCountThreshold":"3","localOutages":"true"}
22076
23014
  */
22077
23015
  syntheticMonitorOutageHandlingSettings: SyntheticMonitorOutageHandlingSettingsDto;
22078
23016
  /**
@@ -22153,10 +23091,14 @@ export declare enum SyntheticBrowserMonitorStepDtoType {
22153
23091
  export declare interface SyntheticConfigDto {
22154
23092
  /**
22155
23093
  * bmMonitorTimeout - browser monitor execution timeout (ms)
23094
+ *
23095
+ * @minimum 60000
22156
23096
  */
22157
23097
  bmMonitorTimeout: number;
22158
23098
  /**
22159
23099
  * bmStepTimeout - browser monitor single step execution timeout (ms)
23100
+ *
23101
+ * @minimum 10000
22160
23102
  */
22161
23103
  bmStepTimeout: number;
22162
23104
  }
@@ -22200,6 +23142,8 @@ export declare enum SyntheticHttpAuthenticationDtoType {
22200
23142
  export declare interface SyntheticHttpConfigurationDto {
22201
23143
  /**
22202
23144
  * If true accept any certificate flag.
23145
+ *
23146
+ * @defaultValue true
22203
23147
  */
22204
23148
  acceptAnyCertificate?: boolean;
22205
23149
  /**
@@ -22208,10 +23152,14 @@ export declare interface SyntheticHttpConfigurationDto {
22208
23152
  clientCertificateId?: string;
22209
23153
  /**
22210
23154
  * If true the step's data aren't stored and displayed.
23155
+ *
23156
+ * @defaultValue false
22211
23157
  */
22212
23158
  doNotPersistSensitiveData?: boolean;
22213
23159
  /**
22214
23160
  * If true follow redirects.
23161
+ *
23162
+ * @defaultValue false
22215
23163
  */
22216
23164
  followRedirects?: boolean;
22217
23165
  /**
@@ -22328,6 +23276,8 @@ export declare interface SyntheticHttpMonitorRequest {
22328
23276
  description?: string;
22329
23277
  /**
22330
23278
  * If true, the monitor is enabled.
23279
+ *
23280
+ * @defaultValue true
22331
23281
  */
22332
23282
  enabled?: boolean;
22333
23283
  /**
@@ -22360,6 +23310,8 @@ export declare interface SyntheticHttpMonitorRequest {
22360
23310
  steps: SyntheticHttpMonitorStepDto[];
22361
23311
  /**
22362
23312
  * Outage handling configuration.
23313
+ *
23314
+ * @exampleValue {"globalConsecutiveOutageCountThreshold":"1","globalOutages":"true","localConsecutiveOutageCountThreshold":"3","localLocationOutageCountThreshold":"3","localOutages":"true"}
22363
23315
  */
22364
23316
  syntheticMonitorOutageHandlingSettings?: SyntheticMonitorOutageHandlingSettingsDto;
22365
23317
  /**
@@ -22447,6 +23399,8 @@ export declare interface SyntheticHttpMonitorResponse {
22447
23399
  steps: SyntheticHttpMonitorStepDto[];
22448
23400
  /**
22449
23401
  * Outage handling configuration.
23402
+ *
23403
+ * @exampleValue {"globalConsecutiveOutageCountThreshold":"1","globalOutages":"true","localConsecutiveOutageCountThreshold":"3","localLocationOutageCountThreshold":"3","localOutages":"true"}
22450
23404
  */
22451
23405
  syntheticMonitorOutageHandlingSettings: SyntheticMonitorOutageHandlingSettingsDto;
22452
23406
  /**
@@ -23123,6 +24077,8 @@ export declare interface SyntheticMonitorConstraintDto {
23123
24077
  properties: SyntheticMonitorConstraintDtoProperties;
23124
24078
  /**
23125
24079
  * Constraint type. Allowed values depend on monitor type and step/request context. HTTP monitor step constraints: HTTP_STATUSES, HTTP_RESPONSE_PATTERN, HTTP_RESPONSE_REGEX. Network availability monitor(MULTI_PROTOCOL) step constraints: SUCCESS_RATE_PERCENT. Network availability monitor(MULTI_PROTOCOL) request configuration constraints are request-type specific, for example ICMP_SUCCESS_RATE_PERCENT (ICMP) and DNS_STATUS_CODE (DNS).
24080
+ *
24081
+ * @exampleValue ICMP_SUCCESS_RATE_PERCENT
23126
24082
  */
23127
24083
  type: string;
23128
24084
  }
@@ -23218,22 +24174,32 @@ export declare enum SyntheticMonitorOutageHandlingSettingsDtoOrigin {
23218
24174
  export declare interface SyntheticMonitorPerformanceThresholdDto {
23219
24175
  /**
23220
24176
  * Aggregation type
24177
+ *
24178
+ * @defaultValue AVG
23221
24179
  */
23222
24180
  aggregation?: 'AVG' | 'MAX' | 'MIN';
23223
24181
  /**
23224
24182
  * Number of most recent non-violating request executions that closes the problem.
24183
+ *
24184
+ * @minimum 1
23225
24185
  */
23226
24186
  dealertingSamples?: number;
23227
24187
  /**
23228
24188
  * Number of request executions in analyzed sliding window (sliding window size).
24189
+ *
24190
+ * @minimum 1
23229
24191
  */
23230
24192
  samples?: number;
23231
24193
  /**
23232
24194
  * Specify the step's index to which a threshold applies. If threshold is monitor-level, no index is needed.
24195
+ *
24196
+ * @minimum 0
23233
24197
  */
23234
24198
  stepIndex?: number;
23235
24199
  /**
23236
24200
  * Notify if monitor request takes longer than *X* time units to execute. For network availability monitors the time unit is milliseconds, for browser and HTTP monitors - seconds.
24201
+ *
24202
+ * @minimum 0
23237
24203
  */
23238
24204
  threshold: number;
23239
24205
  /**
@@ -23242,6 +24208,8 @@ export declare interface SyntheticMonitorPerformanceThresholdDto {
23242
24208
  type?: 'STEP' | 'MONITOR';
23243
24209
  /**
23244
24210
  * Number of violating request executions in analyzed sliding window.
24211
+ *
24212
+ * @minimum 1
23245
24213
  */
23246
24214
  violatingSamples?: number;
23247
24215
  }
@@ -23306,7 +24274,7 @@ export declare interface SyntheticMonitorSummaryDto {
23306
24274
  /**
23307
24275
  * The entity id of the monitor.
23308
24276
  */
23309
- entityId?: string;
24277
+ entityId: string;
23310
24278
  /**
23311
24279
  * The name of the monitor.
23312
24280
  */
@@ -23314,7 +24282,7 @@ export declare interface SyntheticMonitorSummaryDto {
23314
24282
  /**
23315
24283
  * The type of the monitor.
23316
24284
  */
23317
- type?: 'MULTI_PROTOCOL' | 'BROWSER' | 'HTTP';
24285
+ type: 'MULTI_PROTOCOL' | 'BROWSER' | 'HTTP';
23318
24286
  }
23319
24287
 
23320
24288
  /**
@@ -23338,6 +24306,8 @@ export declare interface SyntheticMultiProtocolMonitorRequest {
23338
24306
  description?: string;
23339
24307
  /**
23340
24308
  * If true, the monitor is enabled.
24309
+ *
24310
+ * @defaultValue true
23341
24311
  */
23342
24312
  enabled?: boolean;
23343
24313
  /**
@@ -23366,6 +24336,8 @@ export declare interface SyntheticMultiProtocolMonitorRequest {
23366
24336
  steps: SyntheticMultiProtocolMonitorStepDto[];
23367
24337
  /**
23368
24338
  * Outage handling configuration.
24339
+ *
24340
+ * @exampleValue {"globalConsecutiveOutageCountThreshold":"1","globalOutages":"true","localConsecutiveOutageCountThreshold":"3","localLocationOutageCountThreshold":"3","localOutages":"true"}
23369
24341
  */
23370
24342
  syntheticMonitorOutageHandlingSettings?: SyntheticMonitorOutageHandlingSettingsDto;
23371
24343
  /**
@@ -23437,6 +24409,8 @@ export declare interface SyntheticMultiProtocolMonitorResponse {
23437
24409
  steps: SyntheticMultiProtocolMonitorStepDto[];
23438
24410
  /**
23439
24411
  * Outage handling configuration.
24412
+ *
24413
+ * @exampleValue {"globalConsecutiveOutageCountThreshold":"1","globalOutages":"true","localConsecutiveOutageCountThreshold":"3","localLocationOutageCountThreshold":"3","localOutages":"true"}
23440
24414
  */
23441
24415
  syntheticMonitorOutageHandlingSettings: SyntheticMonitorOutageHandlingSettingsDto;
23442
24416
  /**
@@ -23564,7 +24538,7 @@ export declare class SyntheticNetworkAvailabilityMonitorsClient {
23564
24538
  * * Management zone ID: `managementZoneId(1, 2)`.
23565
24539
  * * Synthetic Location ME ID: `location(SYNTHETIC_LOCATION-123)`.
23566
24540
  * * Monitored host ME ID: `monitoredEntity(HOST-123)`.
23567
- * * Monitor tags: `tag([context]key:value,key:value,key)`. Tags in `[context]key:value`, `key:value`, and `key` formats are detected and parsed automatically. If a key-only tag has a colon (`:`) in it, you must escape the colon with a backslash(`\`). Otherwise, the tag will be parsed as a `key:value tag`. All tag values are case-sensitive.
24541
+ * * Monitor tags: `tag([context]key:value,key:value,key)`. Tags in `[context]key:value`, `key:value`, and `key` formats are detected and parsed automatically. If a key-only tag has a colon (`:`) in it, you must escape the colon with a backslash(`\`). Otherwise, the tag will be parsed as a `key:value tag`. All tag values are case-sensitive. Values listed within a single `tag(...)` are combined with **OR**. To require multiple tags (**AND**), specify several `tag(...)` selectors. For example, `tag(tag-a),tag(tag-b)` matches only monitors that have **both** tags, while `tag(tag-a,tag-b)` matches monitors that have **either**.
23568
24542
  * * Monitor enablement: `enabled(true)`.
23569
24543
  *
23570
24544
  * To set several criteria, separate them with a comma (`,`).
@@ -23844,10 +24818,14 @@ export declare enum SyntheticOnDemandExecutionProcessingMode {
23844
24818
  export declare interface SyntheticOnDemandExecutionRequest {
23845
24819
  /**
23846
24820
  * If true, the execution will fail in case of performance issue.
24821
+ *
24822
+ * @defaultValue true
23847
24823
  */
23848
24824
  failOnPerformanceIssue?: boolean;
23849
24825
  /**
23850
24826
  * Applies to HTTP monitors only. If true, the execution will fail in case of an SSL certificate expiration warning or if the certificate is missing.
24827
+ *
24828
+ * @defaultValue true
23851
24829
  */
23852
24830
  failOnSslWarning?: boolean;
23853
24831
  /**
@@ -23864,14 +24842,20 @@ export declare interface SyntheticOnDemandExecutionRequest {
23864
24842
  monitors?: SyntheticOnDemandExecutionRequestMonitor[];
23865
24843
  /**
23866
24844
  * The execution's processing mode
24845
+ *
24846
+ * @defaultValue STANDARD
23867
24847
  */
23868
24848
  processingMode?: 'STANDARD' | 'DISABLE_PROBLEM_DETECTION' | 'EXECUTIONS_DETAILS_ONLY';
23869
24849
  /**
23870
24850
  * If true, no executions will be scheduled if a problem occurs.
24851
+ *
24852
+ * @defaultValue false
23871
24853
  */
23872
24854
  stopOnProblem?: boolean;
23873
24855
  /**
23874
24856
  * If true, the screenshots will be taken during the execution of a browser monitor.
24857
+ *
24858
+ * @defaultValue false
23875
24859
  */
23876
24860
  takeScreenshotsOnSuccess?: boolean;
23877
24861
  }
@@ -23915,6 +24899,8 @@ export declare interface SyntheticOnDemandExecutionRequestMonitor {
23915
24899
  customizedScript?: SyntheticOnDemandExecutionRequestMonitorCustomizedScript;
23916
24900
  /**
23917
24901
  * The number of times the monitor is to be executed per location; if not set, the monitor will be executed once.
24902
+ *
24903
+ * @defaultValue 1
23918
24904
  */
23919
24905
  executionCount?: number;
23920
24906
  /**
@@ -23927,6 +24913,8 @@ export declare interface SyntheticOnDemandExecutionRequestMonitor {
23927
24913
  monitorId: string;
23928
24914
  /**
23929
24915
  * Execution repeat mode. If not set, the mode is SEQUENTIAL.
24916
+ *
24917
+ * @defaultValue SEQUENTIAL
23930
24918
  */
23931
24919
  repeatMode?: 'SEQUENTIAL' | 'PARALLEL';
23932
24920
  }
@@ -24438,6 +25426,8 @@ export declare interface SyntheticPrivateLocationUpdate extends SyntheticLocatio
24438
25426
  latitude: number;
24439
25427
  /**
24440
25428
  * Alert if location or node outage lasts longer than *X* minutes. \n\n Only applicable when `availabilityLocationOutage` or `availabilityNodeOutage` is set to `true`. Supported only for private Synthetic locations.
25429
+ *
25430
+ * @minimum 1
24441
25431
  */
24442
25432
  locationNodeOutageDelayInMinutes?: number;
24443
25433
  /**
@@ -24446,10 +25436,14 @@ export declare interface SyntheticPrivateLocationUpdate extends SyntheticLocatio
24446
25436
  longitude: number;
24447
25437
  /**
24448
25438
  * Containerized location property. The maximum number of ActiveGates deployed for the location (required for a Kubernetes location).
25439
+ *
25440
+ * @minimum 1
24449
25441
  */
24450
25442
  maxActiveGateCount?: number;
24451
25443
  /**
24452
25444
  * Containerized location property. The minimum number of ActiveGates deployed for the location (required for a Kubernetes location).
25445
+ *
25446
+ * @minimum 1
24453
25447
  */
24454
25448
  minActiveGateCount?: number;
24455
25449
  /**
@@ -24608,12 +25602,34 @@ export declare interface TenantTokenConfig {
24608
25602
  old?: TenantToken;
24609
25603
  }
24610
25604
 
25605
+ /**
25606
+ * Status of tenant token rotation.
25607
+ */
25608
+ export declare interface TenantTokenRotationStatus {
25609
+ /**
25610
+ * Rotation status. ACTIVE when a secondary token exists, otherwise INACTIVE.
25611
+ */
25612
+ status?: 'ACTIVE' | 'INACTIVE';
25613
+ }
25614
+
25615
+ /**
25616
+ * Rotation status. ACTIVE when a secondary token exists, otherwise INACTIVE.
25617
+ *
25618
+ * @deprecated Use literal values.
25619
+ */
25620
+ export declare enum TenantTokenRotationStatusStatus {
25621
+ Active = "ACTIVE",
25622
+ Inactive = "INACTIVE"
25623
+ }
25624
+
24611
25625
  /**
24612
25626
  * Test device of a Browser Monitor.
24613
25627
  */
24614
25628
  export declare interface TestDeviceDto {
24615
25629
  /**
24616
25630
  * Device height in px.
25631
+ *
25632
+ * @minimum 0
24617
25633
  */
24618
25634
  height: number;
24619
25635
  /**
@@ -24630,6 +25646,8 @@ export declare interface TestDeviceDto {
24630
25646
  touchEnabled?: boolean;
24631
25647
  /**
24632
25648
  * Device width in px.
25649
+ *
25650
+ * @minimum 0
24633
25651
  */
24634
25652
  width: number;
24635
25653
  }
@@ -24654,6 +25672,8 @@ export declare interface TimeoutSettingsDto {
24654
25672
  export declare interface TimeWaitConditionDto extends BaseWaitConditionDto {
24655
25673
  /**
24656
25674
  * Wait time in milliseconds.
25675
+ *
25676
+ * @minimum 0
24657
25677
  */
24658
25678
  milliseconds: number;
24659
25679
  }
@@ -24664,6 +25684,8 @@ export declare interface TimeWaitConditionDto extends BaseWaitConditionDto {
24664
25684
  export declare interface TokenCredentials extends Credentials {
24665
25685
  /**
24666
25686
  * Information for synchronization credentials with external vault
25687
+ *
25688
+ * @exampleValue {"description":"Sample credentials for demo purposes.","externalVault":{"passwordSecretName":"password","pathToCredentials":"kv/credentials","roleId":"00e4858c-ec33-bc99-4e7e-34de6967de6c","secretId":"CREDENTIALS_VAULT-XXXXXXXXXXXXXXXX","sourceAuthMethod":"HASHICORP_VAULT_APPROLE","usernameSecretName":"username","vaultNamespace":"admin","vaultUrl":"https://vault-cluster.vault.fb17d2fc-be92-4230-afa2-91dbfda3cbad.aws.hashicorp.cloud:8200"},"id":"CREDENTIALS_VAULT-C43F2C2E6395AD23","name":"Sample username-password credentials synchronized with Hashicorp vault","owner":"user@domain.com","ownerAccessOnly":true,"scope":"SYNTHETIC","type":"USERNAME_PASSWORD"}
24667
25689
  */
24668
25690
  externalVault?: ExternalVault;
24669
25691
  /**
@@ -24938,18 +25960,26 @@ export declare interface UiTabGroupCustomization {
24938
25960
  export declare interface UiTableColumnCustomization {
24939
25961
  /**
24940
25962
  * The ui specific builtin column-implementation for this column.
25963
+ *
25964
+ * @exampleValue summary
24941
25965
  */
24942
25966
  builtinColumnRef?: string;
24943
25967
  /**
24944
25968
  * The referenced column from the 'tableColumns' property of the schema for this column.
25969
+ *
25970
+ * @exampleValue myCustomColumn
24945
25971
  */
24946
25972
  columnRef?: string;
24947
25973
  /**
24948
25974
  * The display name for this column.
25975
+ *
25976
+ * @exampleValue Color
24949
25977
  */
24950
25978
  displayName?: string;
24951
25979
  /**
24952
25980
  * The id for this column used for filtering. Required for conflicting or pathed columns - otherwise the ref is used.
25981
+ *
25982
+ * @exampleValue color
24953
25983
  */
24954
25984
  id?: string;
24955
25985
  /**
@@ -24958,14 +25988,20 @@ export declare interface UiTableColumnCustomization {
24958
25988
  items?: UiTableColumnItemCustomization[];
24959
25989
  /**
24960
25990
  * The referenced property for this column.
25991
+ *
25992
+ * @exampleValue apiColor
24961
25993
  */
24962
25994
  propertyRef?: string;
24963
25995
  /**
24964
25996
  * The ui specific type for this column.
25997
+ *
25998
+ * @exampleValue cell-color-picker
24965
25999
  */
24966
26000
  type?: string;
24967
26001
  /**
24968
26002
  * The width this column should take up on the table.
26003
+ *
26004
+ * @exampleValue 10%
24969
26005
  */
24970
26006
  width?: string;
24971
26007
  }
@@ -24976,14 +26012,20 @@ export declare interface UiTableColumnCustomization {
24976
26012
  export declare interface UiTableColumnItemCustomization {
24977
26013
  /**
24978
26014
  * The display name of this item.
26015
+ *
26016
+ * @exampleValue Active
24979
26017
  */
24980
26018
  displayName?: string;
24981
26019
  /**
24982
26020
  * The icon of this item.
26021
+ *
26022
+ * @exampleValue CRITICAL
24983
26023
  */
24984
26024
  icon?: string;
24985
26025
  /**
24986
26026
  * The value of this item.
26027
+ *
26028
+ * @exampleValue ACTIVE
24987
26029
  */
24988
26030
  value: string;
24989
26031
  }
@@ -25090,14 +26132,20 @@ export declare enum UpdateJavaScriptMappingFileMetadataPathFileType {
25090
26132
  export declare interface UpdateJob {
25091
26133
  /**
25092
26134
  * The type of the ActiveGate.
26135
+ *
26136
+ * @exampleValue ENVIRONMENT
25093
26137
  */
25094
26138
  agType?: 'CLUSTER' | 'ENVIRONMENT' | 'ENVIRONMENT_MULTI';
25095
26139
  /**
25096
26140
  * The job can (`true`) or can't (`false`) be cancelled at the moment.
26141
+ *
26142
+ * @exampleValue false
25097
26143
  */
25098
26144
  cancelable?: boolean;
25099
26145
  /**
25100
26146
  * The duration of the update, in milliseconds.
26147
+ *
26148
+ * @exampleValue 3608000
25101
26149
  */
25102
26150
  duration?: number;
25103
26151
  /**
@@ -25110,14 +26158,20 @@ export declare interface UpdateJob {
25110
26158
  error?: string;
25111
26159
  /**
25112
26160
  * The ID of the update job.
26161
+ *
26162
+ * @exampleValue -3524498778810258605
25113
26163
  */
25114
26164
  jobId?: string;
25115
26165
  /**
25116
26166
  * The status of the update job.
26167
+ *
26168
+ * @exampleValue SUCCEED
25117
26169
  */
25118
26170
  jobState?: 'FAILED' | 'IN_PROGRESS' | 'PENDING' | 'ROLLBACK' | 'SCHEDULED' | 'SKIPPED' | 'SUCCEED';
25119
26171
  /**
25120
26172
  * The initial version of the ActiveGate.
26173
+ *
26174
+ * @exampleValue 1.185.0.20200201-120000
25121
26175
  */
25122
26176
  startVersion?: string;
25123
26177
  /**
@@ -25126,20 +26180,28 @@ export declare interface UpdateJob {
25126
26180
  * Specify the version in the `<major>.<minor>.<revision>.<timestamp>` format.
25127
26181
  *
25128
26182
  * To update to the latest available version, use the `latest` value.
26183
+ *
26184
+ * @exampleValue 1.190.0.20200301-130000
25129
26185
  */
25130
26186
  targetVersion: string;
25131
26187
  /**
25132
26188
  * The timestamp of the update job completion.
25133
26189
  *
25134
26190
  * The `null` value means the job is still running.
26191
+ *
26192
+ * @exampleValue 1582031917814
25135
26193
  */
25136
26194
  timestamp?: number;
25137
26195
  /**
25138
26196
  * The method of updating the ActiveGate or its component.
26197
+ *
26198
+ * @exampleValue AUTOMATIC
25139
26199
  */
25140
26200
  updateMethod?: 'AUTOMATIC' | 'MANUAL_INSTALLATION' | 'ON_DEMAND';
25141
26201
  /**
25142
26202
  * The component to be updated.
26203
+ *
26204
+ * @exampleValue ACTIVE_GATE
25143
26205
  */
25144
26206
  updateType?: 'ACTIVE_GATE' | 'REMOTE_PLUGIN_AGENT' | 'SYNTHETIC' | 'Z_REMOTE';
25145
26207
  }
@@ -25176,6 +26238,8 @@ export declare enum UpdateJobJobState {
25176
26238
  export declare interface UpdateJobList {
25177
26239
  /**
25178
26240
  * The ID of the ActiveGate.
26241
+ *
26242
+ * @exampleValue 0x3efdd092
25179
26243
  */
25180
26244
  agId?: string;
25181
26245
  /**
@@ -25251,10 +26315,14 @@ export declare enum UpdatePermissionsRequestPermissionsItem {
25251
26315
  export declare interface UpdateWindow {
25252
26316
  /**
25253
26317
  * Identifier of maintenance window
26318
+ *
26319
+ * @exampleValue vu9U3hXa3q0AAAABADdkeW5hdHJhY2Uuc2V0dGluZ3MuZGVwbG95bWVudC5tYW5h
25254
26320
  */
25255
26321
  id: string;
25256
26322
  /**
25257
26323
  * The name of maintenance window
26324
+ *
26325
+ * @exampleValue Daily maintenance window
25258
26326
  */
25259
26327
  name?: string;
25260
26328
  }
@@ -25307,6 +26375,8 @@ export declare enum UploadJavaScriptMappingFilePathFileType {
25307
26375
  export declare interface UserPasswordCredentials extends Credentials {
25308
26376
  /**
25309
26377
  * Information for synchronization credentials with external vault
26378
+ *
26379
+ * @exampleValue {"description":"Sample credentials for demo purposes.","externalVault":{"passwordSecretName":"password","pathToCredentials":"kv/credentials","roleId":"00e4858c-ec33-bc99-4e7e-34de6967de6c","secretId":"CREDENTIALS_VAULT-XXXXXXXXXXXXXXXX","sourceAuthMethod":"HASHICORP_VAULT_APPROLE","usernameSecretName":"username","vaultNamespace":"admin","vaultUrl":"https://vault-cluster.vault.fb17d2fc-be92-4230-afa2-91dbfda3cbad.aws.hashicorp.cloud:8200"},"id":"CREDENTIALS_VAULT-C43F2C2E6395AD23","name":"Sample username-password credentials synchronized with Hashicorp vault","owner":"user@domain.com","ownerAccessOnly":true,"scope":"SYNTHETIC","type":"USERNAME_PASSWORD"}
25310
26380
  */
25311
26381
  externalVault?: ExternalVault;
25312
26382
  /**
@@ -25348,6 +26418,8 @@ export declare interface ValidationRuleDto {
25348
26418
  regex?: boolean;
25349
26419
  /**
25350
26420
  * Target of Browser Monitor step.
26421
+ *
26422
+ * @exampleValue {"locators":[{"type":"CSS","value":"<img>[id='logoIcon']"},{"type":"CSS","value":"<a>[id='externalSite']"}],"window":"ruxitWin[0]"}
25351
26423
  */
25352
26424
  target?: TargetDto;
25353
26425
  /**
@@ -25373,10 +26445,14 @@ export declare enum ValidationRuleDtoType {
25373
26445
  export declare interface ValidationWaitConditionDto extends BaseWaitConditionDto {
25374
26446
  /**
25375
26447
  * Validation timeout in milliseconds.
26448
+ *
26449
+ * @minimum 0
25376
26450
  */
25377
26451
  timeoutInMilliseconds: number;
25378
26452
  /**
25379
26453
  * Validation rule of Browser Monitor step.
26454
+ *
26455
+ * @exampleValue {"failIfFound":false,"matchingPattern":"some text to match","regex":false,"target":{"locators":[{"type":"CSS","value":"<img>[id='logoIcon']"},{"type":"CSS","value":"<a>[id='externalSite']"}],"window":"ruxitWin[0]"},"type":"TEXT_MATCH"}
25380
26456
  */
25381
26457
  validationRule: ValidationRuleDto;
25382
26458
  }