@northflank/js-client 0.7.12 → 0.7.13
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/dist/cjs/api-client.d.ts +154 -32
- package/dist/cjs/api-client.js +1 -1
- package/dist/esm/api-client.d.ts +154 -32
- package/dist/esm/api-client.js +1 -1
- package/package.json +1 -1
package/dist/cjs/api-client.d.ts
CHANGED
|
@@ -900,7 +900,9 @@ declare enum MetricType {
|
|
|
900
900
|
PvcUsage = "diskUsage",
|
|
901
901
|
Requests = "requests",
|
|
902
902
|
Http4xxResponses = "http4xxResponses",
|
|
903
|
-
Http5xxResponses = "http5xxResponses"
|
|
903
|
+
Http5xxResponses = "http5xxResponses",
|
|
904
|
+
Bandwidth = "bandwidth",
|
|
905
|
+
BandwidthVolume = "bandwidthVolume"
|
|
904
906
|
}
|
|
905
907
|
type MetricUnit = 'pct' | 'vCPU' | 'mb' | 'kbps' | 'rps' | 'count';
|
|
906
908
|
type MetricValue = {
|
|
@@ -1437,7 +1439,7 @@ type ListCloudClustersResult = {
|
|
|
1437
1439
|
/** When 'provider' is 'azure', at least one system node pool is required per cluster. */
|
|
1438
1440
|
'systemPool'?: boolean;
|
|
1439
1441
|
/** Zones in which the node pool should be provisioned. */
|
|
1440
|
-
'availabilityZones'
|
|
1442
|
+
'availabilityZones': string[];
|
|
1441
1443
|
/** Set of label keys and values that can be used to determine scheduling via resource tags. */
|
|
1442
1444
|
'labels'?: any;
|
|
1443
1445
|
/** ID of existing node pool. Must be passed when modifying existing node pools. Not relevant for new node pools Example: "6aa96121-0345-43ad-bade-af36d540c222" */
|
|
@@ -1508,7 +1510,7 @@ type CreateCloudClusterResult = {
|
|
|
1508
1510
|
/** When 'provider' is 'azure', at least one system node pool is required per cluster. */
|
|
1509
1511
|
'systemPool'?: boolean;
|
|
1510
1512
|
/** Zones in which the node pool should be provisioned. */
|
|
1511
|
-
'availabilityZones'
|
|
1513
|
+
'availabilityZones': string[];
|
|
1512
1514
|
/** Set of label keys and values that can be used to determine scheduling via resource tags. */
|
|
1513
1515
|
'labels'?: any;
|
|
1514
1516
|
/** ID of existing node pool. Must be passed when modifying existing node pools. Not relevant for new node pools Example: "6aa96121-0345-43ad-bade-af36d540c222" */
|
|
@@ -1575,7 +1577,7 @@ type CreateCloudClusterData = {
|
|
|
1575
1577
|
/** When 'provider' is 'azure', at least one system node pool is required per cluster. */
|
|
1576
1578
|
'systemPool'?: boolean;
|
|
1577
1579
|
/** Zones in which the node pool should be provisioned. */
|
|
1578
|
-
'availabilityZones'
|
|
1580
|
+
'availabilityZones': string[];
|
|
1579
1581
|
/** Set of label keys and values that can be used to determine scheduling via resource tags. */
|
|
1580
1582
|
'labels'?: any;
|
|
1581
1583
|
}[];
|
|
@@ -1649,7 +1651,7 @@ type GetCloudClusterResult = {
|
|
|
1649
1651
|
/** When 'provider' is 'azure', at least one system node pool is required per cluster. */
|
|
1650
1652
|
'systemPool'?: boolean;
|
|
1651
1653
|
/** Zones in which the node pool should be provisioned. */
|
|
1652
|
-
'availabilityZones'
|
|
1654
|
+
'availabilityZones': string[];
|
|
1653
1655
|
/** Set of label keys and values that can be used to determine scheduling via resource tags. */
|
|
1654
1656
|
'labels'?: any;
|
|
1655
1657
|
/** ID of existing node pool. Must be passed when modifying existing node pools. Not relevant for new node pools Example: "6aa96121-0345-43ad-bade-af36d540c222" */
|
|
@@ -1714,7 +1716,7 @@ type UpdateCloudClusterResult = {
|
|
|
1714
1716
|
/** When 'provider' is 'azure', at least one system node pool is required per cluster. */
|
|
1715
1717
|
'systemPool'?: boolean;
|
|
1716
1718
|
/** Zones in which the node pool should be provisioned. */
|
|
1717
|
-
'availabilityZones'
|
|
1719
|
+
'availabilityZones': string[];
|
|
1718
1720
|
/** Set of label keys and values that can be used to determine scheduling via resource tags. */
|
|
1719
1721
|
'labels'?: any;
|
|
1720
1722
|
/** ID of existing node pool. Must be passed when modifying existing node pools. Not relevant for new node pools Example: "6aa96121-0345-43ad-bade-af36d540c222" */
|
|
@@ -1763,7 +1765,7 @@ type UpdateCloudClusterData = {
|
|
|
1763
1765
|
/** When 'provider' is 'azure', at least one system node pool is required per cluster. */
|
|
1764
1766
|
'systemPool'?: boolean;
|
|
1765
1767
|
/** Zones in which the node pool should be provisioned. */
|
|
1766
|
-
'availabilityZones'
|
|
1768
|
+
'availabilityZones': string[];
|
|
1767
1769
|
/** Set of label keys and values that can be used to determine scheduling via resource tags. */
|
|
1768
1770
|
'labels'?: any;
|
|
1769
1771
|
/** ID of existing node pool. Must be passed when modifying existing node pools. Not relevant for new node pools Example: "6aa96121-0345-43ad-bade-af36d540c222" */
|
|
@@ -3406,8 +3408,6 @@ type CreateNotificationResult = {
|
|
|
3406
3408
|
'trigger:infrastructure:service:container-memorySustained90'?: boolean;
|
|
3407
3409
|
'trigger:infrastructure:job:container-memorySpike90'?: boolean;
|
|
3408
3410
|
'trigger:infrastructure:job:container-memorySustained90'?: boolean;
|
|
3409
|
-
'trigger:infrastructure:addon:container-memorySpike90'?: boolean;
|
|
3410
|
-
'trigger:infrastructure:addon:container-memorySustained90'?: boolean;
|
|
3411
3411
|
'trigger:infrastructure:addon-volume:usage-75-exceeded'?: boolean;
|
|
3412
3412
|
'trigger:infrastructure:addon-volume:usage-90-exceeded'?: boolean;
|
|
3413
3413
|
'trigger:infrastructure:platform-volume:usage-75-exceeded'?: boolean;
|
|
@@ -3490,8 +3490,6 @@ type CreateNotificationData = {
|
|
|
3490
3490
|
'trigger:infrastructure:service:container-memorySustained90'?: boolean;
|
|
3491
3491
|
'trigger:infrastructure:job:container-memorySpike90'?: boolean;
|
|
3492
3492
|
'trigger:infrastructure:job:container-memorySustained90'?: boolean;
|
|
3493
|
-
'trigger:infrastructure:addon:container-memorySpike90'?: boolean;
|
|
3494
|
-
'trigger:infrastructure:addon:container-memorySustained90'?: boolean;
|
|
3495
3493
|
'trigger:infrastructure:addon-volume:usage-75-exceeded'?: boolean;
|
|
3496
3494
|
'trigger:infrastructure:addon-volume:usage-90-exceeded'?: boolean;
|
|
3497
3495
|
'trigger:infrastructure:platform-volume:usage-75-exceeded'?: boolean;
|
|
@@ -3589,8 +3587,6 @@ type GetNotificationResult = {
|
|
|
3589
3587
|
'trigger:infrastructure:service:container-memorySustained90'?: boolean;
|
|
3590
3588
|
'trigger:infrastructure:job:container-memorySpike90'?: boolean;
|
|
3591
3589
|
'trigger:infrastructure:job:container-memorySustained90'?: boolean;
|
|
3592
|
-
'trigger:infrastructure:addon:container-memorySpike90'?: boolean;
|
|
3593
|
-
'trigger:infrastructure:addon:container-memorySustained90'?: boolean;
|
|
3594
3590
|
'trigger:infrastructure:addon-volume:usage-75-exceeded'?: boolean;
|
|
3595
3591
|
'trigger:infrastructure:addon-volume:usage-90-exceeded'?: boolean;
|
|
3596
3592
|
'trigger:infrastructure:platform-volume:usage-75-exceeded'?: boolean;
|
|
@@ -3688,8 +3684,6 @@ type UpdateNotificationData = {
|
|
|
3688
3684
|
'trigger:infrastructure:service:container-memorySustained90'?: boolean;
|
|
3689
3685
|
'trigger:infrastructure:job:container-memorySpike90'?: boolean;
|
|
3690
3686
|
'trigger:infrastructure:job:container-memorySustained90'?: boolean;
|
|
3691
|
-
'trigger:infrastructure:addon:container-memorySpike90'?: boolean;
|
|
3692
|
-
'trigger:infrastructure:addon:container-memorySustained90'?: boolean;
|
|
3693
3687
|
'trigger:infrastructure:addon-volume:usage-75-exceeded'?: boolean;
|
|
3694
3688
|
'trigger:infrastructure:addon-volume:usage-90-exceeded'?: boolean;
|
|
3695
3689
|
'trigger:infrastructure:platform-volume:usage-75-exceeded'?: boolean;
|
|
@@ -4448,8 +4442,8 @@ type CreateAddonResult = {
|
|
|
4448
4442
|
'storage': number;
|
|
4449
4443
|
/** The number of addon replicas to run. Example: 1 */
|
|
4450
4444
|
'replicas': number;
|
|
4451
|
-
/**
|
|
4452
|
-
'zonalRedundancy'?:
|
|
4445
|
+
/** Defines scheduling behaviour across different zones within the same region. */
|
|
4446
|
+
'zonalRedundancy'?: 'required' | 'disabled';
|
|
4453
4447
|
};
|
|
4454
4448
|
/** Optional object containing data about an existing addon to fork. If provided, the addon will be created from that existing addon backup. */
|
|
4455
4449
|
'source'?: {
|
|
@@ -4487,7 +4481,25 @@ type CreateAddonResult = {
|
|
|
4487
4481
|
/** Custom database name. Not supported for all addon types. */
|
|
4488
4482
|
'dbName'?: string;
|
|
4489
4483
|
};
|
|
4490
|
-
'backupSchedules'?:
|
|
4484
|
+
'backupSchedules'?: {
|
|
4485
|
+
/** Schedule for the backup. */
|
|
4486
|
+
'scheduling': {
|
|
4487
|
+
/** The interval between backups. Each addon can only have one backup schedule of each interval for each backup type. Example: "weekly" */
|
|
4488
|
+
'interval': 'hourly' | 'daily' | 'weekly';
|
|
4489
|
+
/** An array of minutes when the backup should be performed. */
|
|
4490
|
+
'minute': number[];
|
|
4491
|
+
/** An array of hours in 24 hour format when the backup should be performed. At these hours, a backup will be performed at each of the minutes provided in the `minute` field. Required for `daily` and `weekly` intervals and unavailable for `hourly` intervals. */
|
|
4492
|
+
'hour'?: number[];
|
|
4493
|
+
/** An array of days of the week when the backup should be performed, where `0` represents Monday and `6` represents Sunday. On these days, a backup will be performed at each of the minutes provided in the `minute` field whenever it is an hour from the `hour` field. Required for `weekly` intervals and unavailable for `hourly` and `daily` intervals. */
|
|
4494
|
+
'day'?: number[];
|
|
4495
|
+
};
|
|
4496
|
+
/** The type of the backup to be performed. Example: "snapshot" */
|
|
4497
|
+
'backupType': 'dump' | 'snapshot';
|
|
4498
|
+
/** The compression algorithm of the backup. Only applicable for dump backups. Defaults to `gz`. Example: "gz" */
|
|
4499
|
+
'compressionType'?: 'gz' | 'zstd';
|
|
4500
|
+
/** The time the backup is retained for, in days. `hourly` backups have a maximum retention of 7 days, `daily` backups have a maximum retention of 60 days and `weekly` backups have a maximum retention of 120 days. Example: 7 */
|
|
4501
|
+
'retentionTime': number;
|
|
4502
|
+
}[];
|
|
4491
4503
|
/** Identifier for the addon. Example: "example-addon" */
|
|
4492
4504
|
'id': string;
|
|
4493
4505
|
/** Full identifier used for deployment Example: "/example-user/default-project/example-addon" */
|
|
@@ -4532,8 +4544,8 @@ type CreateAddonData = {
|
|
|
4532
4544
|
'storage': number;
|
|
4533
4545
|
/** The number of addon replicas to run. Example: 1 */
|
|
4534
4546
|
'replicas': number;
|
|
4535
|
-
/**
|
|
4536
|
-
'zonalRedundancy'?:
|
|
4547
|
+
/** Defines scheduling behaviour across different zones within the same region. */
|
|
4548
|
+
'zonalRedundancy'?: 'required' | 'disabled';
|
|
4537
4549
|
};
|
|
4538
4550
|
/** Optional object containing data about an existing addon to fork. If provided, the addon will be created from that existing addon backup. */
|
|
4539
4551
|
'source'?: {
|
|
@@ -4571,7 +4583,25 @@ type CreateAddonData = {
|
|
|
4571
4583
|
/** Custom database name. Not supported for all addon types. */
|
|
4572
4584
|
'dbName'?: string;
|
|
4573
4585
|
};
|
|
4574
|
-
'backupSchedules'?:
|
|
4586
|
+
'backupSchedules'?: {
|
|
4587
|
+
/** Schedule for the backup. */
|
|
4588
|
+
'scheduling': {
|
|
4589
|
+
/** The interval between backups. Each addon can only have one backup schedule of each interval for each backup type. Example: "weekly" */
|
|
4590
|
+
'interval': 'hourly' | 'daily' | 'weekly';
|
|
4591
|
+
/** An array of minutes when the backup should be performed. */
|
|
4592
|
+
'minute': number[];
|
|
4593
|
+
/** An array of hours in 24 hour format when the backup should be performed. At these hours, a backup will be performed at each of the minutes provided in the `minute` field. Required for `daily` and `weekly` intervals and unavailable for `hourly` intervals. */
|
|
4594
|
+
'hour'?: number[];
|
|
4595
|
+
/** An array of days of the week when the backup should be performed, where `0` represents Monday and `6` represents Sunday. On these days, a backup will be performed at each of the minutes provided in the `minute` field whenever it is an hour from the `hour` field. Required for `weekly` intervals and unavailable for `hourly` and `daily` intervals. */
|
|
4596
|
+
'day'?: number[];
|
|
4597
|
+
};
|
|
4598
|
+
/** The type of the backup to be performed. Example: "snapshot" */
|
|
4599
|
+
'backupType': 'dump' | 'snapshot';
|
|
4600
|
+
/** The compression algorithm of the backup. Only applicable for dump backups. Defaults to `gz`. Example: "gz" */
|
|
4601
|
+
'compressionType'?: 'gz' | 'zstd';
|
|
4602
|
+
/** The time the backup is retained for, in days. `hourly` backups have a maximum retention of 7 days, `daily` backups have a maximum retention of 60 days and `weekly` backups have a maximum retention of 120 days. Example: 7 */
|
|
4603
|
+
'retentionTime': number;
|
|
4604
|
+
}[];
|
|
4575
4605
|
};
|
|
4576
4606
|
/** Creates a new addon */
|
|
4577
4607
|
declare class CreateAddonEndpoint extends PostApiEndpoint<CreateAddonRequest, CreateAddonResult> {
|
|
@@ -4602,8 +4632,8 @@ type PutAddonResult = {
|
|
|
4602
4632
|
'storage': number;
|
|
4603
4633
|
/** The number of addon replicas to run. Example: 1 */
|
|
4604
4634
|
'replicas': number;
|
|
4605
|
-
/**
|
|
4606
|
-
'zonalRedundancy'?:
|
|
4635
|
+
/** Defines scheduling behaviour across different zones within the same region. */
|
|
4636
|
+
'zonalRedundancy'?: 'required' | 'disabled';
|
|
4607
4637
|
};
|
|
4608
4638
|
/** Optional object containing data about an existing addon to fork. If provided, the addon will be created from that existing addon backup. */
|
|
4609
4639
|
'source'?: {
|
|
@@ -4641,7 +4671,25 @@ type PutAddonResult = {
|
|
|
4641
4671
|
/** Custom database name. Not supported for all addon types. */
|
|
4642
4672
|
'dbName'?: string;
|
|
4643
4673
|
};
|
|
4644
|
-
'backupSchedules'?:
|
|
4674
|
+
'backupSchedules'?: {
|
|
4675
|
+
/** Schedule for the backup. */
|
|
4676
|
+
'scheduling': {
|
|
4677
|
+
/** The interval between backups. Each addon can only have one backup schedule of each interval for each backup type. Example: "weekly" */
|
|
4678
|
+
'interval': 'hourly' | 'daily' | 'weekly';
|
|
4679
|
+
/** An array of minutes when the backup should be performed. */
|
|
4680
|
+
'minute': number[];
|
|
4681
|
+
/** An array of hours in 24 hour format when the backup should be performed. At these hours, a backup will be performed at each of the minutes provided in the `minute` field. Required for `daily` and `weekly` intervals and unavailable for `hourly` intervals. */
|
|
4682
|
+
'hour'?: number[];
|
|
4683
|
+
/** An array of days of the week when the backup should be performed, where `0` represents Monday and `6` represents Sunday. On these days, a backup will be performed at each of the minutes provided in the `minute` field whenever it is an hour from the `hour` field. Required for `weekly` intervals and unavailable for `hourly` and `daily` intervals. */
|
|
4684
|
+
'day'?: number[];
|
|
4685
|
+
};
|
|
4686
|
+
/** The type of the backup to be performed. Example: "snapshot" */
|
|
4687
|
+
'backupType': 'dump' | 'snapshot';
|
|
4688
|
+
/** The compression algorithm of the backup. Only applicable for dump backups. Defaults to `gz`. Example: "gz" */
|
|
4689
|
+
'compressionType'?: 'gz' | 'zstd';
|
|
4690
|
+
/** The time the backup is retained for, in days. `hourly` backups have a maximum retention of 7 days, `daily` backups have a maximum retention of 60 days and `weekly` backups have a maximum retention of 120 days. Example: 7 */
|
|
4691
|
+
'retentionTime': number;
|
|
4692
|
+
}[];
|
|
4645
4693
|
/** Identifier for the addon. Example: "example-addon" */
|
|
4646
4694
|
'id': string;
|
|
4647
4695
|
/** Full identifier used for deployment Example: "/example-user/default-project/example-addon" */
|
|
@@ -4686,8 +4734,8 @@ type PutAddonData = {
|
|
|
4686
4734
|
'storage': number;
|
|
4687
4735
|
/** The number of addon replicas to run. Example: 1 */
|
|
4688
4736
|
'replicas': number;
|
|
4689
|
-
/**
|
|
4690
|
-
'zonalRedundancy'?:
|
|
4737
|
+
/** Defines scheduling behaviour across different zones within the same region. */
|
|
4738
|
+
'zonalRedundancy'?: 'required' | 'disabled';
|
|
4691
4739
|
};
|
|
4692
4740
|
/** Optional object containing data about an existing addon to fork. If provided, the addon will be created from that existing addon backup. */
|
|
4693
4741
|
'source'?: {
|
|
@@ -4725,7 +4773,25 @@ type PutAddonData = {
|
|
|
4725
4773
|
/** Custom database name. Not supported for all addon types. */
|
|
4726
4774
|
'dbName'?: string;
|
|
4727
4775
|
};
|
|
4728
|
-
'backupSchedules'?:
|
|
4776
|
+
'backupSchedules'?: {
|
|
4777
|
+
/** Schedule for the backup. */
|
|
4778
|
+
'scheduling': {
|
|
4779
|
+
/** The interval between backups. Each addon can only have one backup schedule of each interval for each backup type. Example: "weekly" */
|
|
4780
|
+
'interval': 'hourly' | 'daily' | 'weekly';
|
|
4781
|
+
/** An array of minutes when the backup should be performed. */
|
|
4782
|
+
'minute': number[];
|
|
4783
|
+
/** An array of hours in 24 hour format when the backup should be performed. At these hours, a backup will be performed at each of the minutes provided in the `minute` field. Required for `daily` and `weekly` intervals and unavailable for `hourly` intervals. */
|
|
4784
|
+
'hour'?: number[];
|
|
4785
|
+
/** An array of days of the week when the backup should be performed, where `0` represents Monday and `6` represents Sunday. On these days, a backup will be performed at each of the minutes provided in the `minute` field whenever it is an hour from the `hour` field. Required for `weekly` intervals and unavailable for `hourly` and `daily` intervals. */
|
|
4786
|
+
'day'?: number[];
|
|
4787
|
+
};
|
|
4788
|
+
/** The type of the backup to be performed. Example: "snapshot" */
|
|
4789
|
+
'backupType': 'dump' | 'snapshot';
|
|
4790
|
+
/** The compression algorithm of the backup. Only applicable for dump backups. Defaults to `gz`. Example: "gz" */
|
|
4791
|
+
'compressionType'?: 'gz' | 'zstd';
|
|
4792
|
+
/** The time the backup is retained for, in days. `hourly` backups have a maximum retention of 7 days, `daily` backups have a maximum retention of 60 days and `weekly` backups have a maximum retention of 120 days. Example: 7 */
|
|
4793
|
+
'retentionTime': number;
|
|
4794
|
+
}[];
|
|
4729
4795
|
};
|
|
4730
4796
|
/** Creates or updates an addon */
|
|
4731
4797
|
declare class PutAddonEndpoint extends PutApiEndpoint<PutAddonRequest, PutAddonResult> {
|
|
@@ -4838,8 +4904,8 @@ type PatchAddonResult = {
|
|
|
4838
4904
|
'storage': number;
|
|
4839
4905
|
/** The number of addon replicas to run. Example: 1 */
|
|
4840
4906
|
'replicas': number;
|
|
4841
|
-
/**
|
|
4842
|
-
'zonalRedundancy'?:
|
|
4907
|
+
/** Defines scheduling behaviour across different zones within the same region. */
|
|
4908
|
+
'zonalRedundancy'?: 'required' | 'disabled';
|
|
4843
4909
|
};
|
|
4844
4910
|
/** Optional object containing data about an existing addon to fork. If provided, the addon will be created from that existing addon backup. */
|
|
4845
4911
|
'source'?: {
|
|
@@ -4877,7 +4943,25 @@ type PatchAddonResult = {
|
|
|
4877
4943
|
/** Custom database name. Not supported for all addon types. */
|
|
4878
4944
|
'dbName'?: string;
|
|
4879
4945
|
};
|
|
4880
|
-
'backupSchedules'?:
|
|
4946
|
+
'backupSchedules'?: {
|
|
4947
|
+
/** Schedule for the backup. */
|
|
4948
|
+
'scheduling': {
|
|
4949
|
+
/** The interval between backups. Each addon can only have one backup schedule of each interval for each backup type. Example: "weekly" */
|
|
4950
|
+
'interval': 'hourly' | 'daily' | 'weekly';
|
|
4951
|
+
/** An array of minutes when the backup should be performed. */
|
|
4952
|
+
'minute': number[];
|
|
4953
|
+
/** An array of hours in 24 hour format when the backup should be performed. At these hours, a backup will be performed at each of the minutes provided in the `minute` field. Required for `daily` and `weekly` intervals and unavailable for `hourly` intervals. */
|
|
4954
|
+
'hour'?: number[];
|
|
4955
|
+
/** An array of days of the week when the backup should be performed, where `0` represents Monday and `6` represents Sunday. On these days, a backup will be performed at each of the minutes provided in the `minute` field whenever it is an hour from the `hour` field. Required for `weekly` intervals and unavailable for `hourly` and `daily` intervals. */
|
|
4956
|
+
'day'?: number[];
|
|
4957
|
+
};
|
|
4958
|
+
/** The type of the backup to be performed. Example: "snapshot" */
|
|
4959
|
+
'backupType': 'dump' | 'snapshot';
|
|
4960
|
+
/** The compression algorithm of the backup. Only applicable for dump backups. Defaults to `gz`. Example: "gz" */
|
|
4961
|
+
'compressionType'?: 'gz' | 'zstd';
|
|
4962
|
+
/** The time the backup is retained for, in days. `hourly` backups have a maximum retention of 7 days, `daily` backups have a maximum retention of 60 days and `weekly` backups have a maximum retention of 120 days. Example: 7 */
|
|
4963
|
+
'retentionTime': number;
|
|
4964
|
+
}[];
|
|
4881
4965
|
/** Identifier for the addon. Example: "example-addon" */
|
|
4882
4966
|
'id': string;
|
|
4883
4967
|
/** Full identifier used for deployment Example: "/example-user/default-project/example-addon" */
|
|
@@ -4918,6 +5002,8 @@ type PatchAddonData = {
|
|
|
4918
5002
|
'storage'?: number;
|
|
4919
5003
|
/** The number of addon replicas to run. Example: 1 */
|
|
4920
5004
|
'replicas'?: number;
|
|
5005
|
+
/** Defines scheduling behaviour across different zones within the same region. */
|
|
5006
|
+
'zonalRedundancy'?: 'required' | 'disabled';
|
|
4921
5007
|
};
|
|
4922
5008
|
/** Enables access to the addon via TLS (if supported by the addon type). */
|
|
4923
5009
|
'tlsEnabled'?: boolean;
|
|
@@ -4946,7 +5032,25 @@ type PatchAddonData = {
|
|
|
4946
5032
|
/** Custom database name. Not supported for all addon types. */
|
|
4947
5033
|
'dbName'?: string;
|
|
4948
5034
|
};
|
|
4949
|
-
'backupSchedules'?:
|
|
5035
|
+
'backupSchedules'?: {
|
|
5036
|
+
/** Schedule for the backup. */
|
|
5037
|
+
'scheduling': {
|
|
5038
|
+
/** The interval between backups. Each addon can only have one backup schedule of each interval for each backup type. Example: "weekly" */
|
|
5039
|
+
'interval': 'hourly' | 'daily' | 'weekly';
|
|
5040
|
+
/** An array of minutes when the backup should be performed. */
|
|
5041
|
+
'minute': number[];
|
|
5042
|
+
/** An array of hours in 24 hour format when the backup should be performed. At these hours, a backup will be performed at each of the minutes provided in the `minute` field. Required for `daily` and `weekly` intervals and unavailable for `hourly` intervals. */
|
|
5043
|
+
'hour'?: number[];
|
|
5044
|
+
/** An array of days of the week when the backup should be performed, where `0` represents Monday and `6` represents Sunday. On these days, a backup will be performed at each of the minutes provided in the `minute` field whenever it is an hour from the `hour` field. Required for `weekly` intervals and unavailable for `hourly` and `daily` intervals. */
|
|
5045
|
+
'day'?: number[];
|
|
5046
|
+
};
|
|
5047
|
+
/** The type of the backup to be performed. Example: "snapshot" */
|
|
5048
|
+
'backupType': 'dump' | 'snapshot';
|
|
5049
|
+
/** The compression algorithm of the backup. Only applicable for dump backups. Defaults to `gz`. Example: "gz" */
|
|
5050
|
+
'compressionType'?: 'gz' | 'zstd';
|
|
5051
|
+
/** The time the backup is retained for, in days. `hourly` backups have a maximum retention of 7 days, `daily` backups have a maximum retention of 60 days and `weekly` backups have a maximum retention of 120 days. Example: 7 */
|
|
5052
|
+
'retentionTime': number;
|
|
5053
|
+
}[];
|
|
4950
5054
|
};
|
|
4951
5055
|
/** Updates an addon */
|
|
4952
5056
|
declare class PatchAddonEndpoint extends PatchApiEndpoint<PatchAddonRequest, PatchAddonResult> {
|
|
@@ -5042,7 +5146,25 @@ type CreateAddonBackupscheduleParameters = {
|
|
|
5042
5146
|
/** ID of the addon */
|
|
5043
5147
|
'addonId': string;
|
|
5044
5148
|
};
|
|
5045
|
-
type CreateAddonBackupscheduleData =
|
|
5149
|
+
type CreateAddonBackupscheduleData = {
|
|
5150
|
+
/** Schedule for the backup. */
|
|
5151
|
+
'scheduling': {
|
|
5152
|
+
/** The interval between backups. Each addon can only have one backup schedule of each interval for each backup type. Example: "weekly" */
|
|
5153
|
+
'interval': 'hourly' | 'daily' | 'weekly';
|
|
5154
|
+
/** An array of minutes when the backup should be performed. */
|
|
5155
|
+
'minute': number[];
|
|
5156
|
+
/** An array of hours in 24 hour format when the backup should be performed. At these hours, a backup will be performed at each of the minutes provided in the `minute` field. Required for `daily` and `weekly` intervals and unavailable for `hourly` intervals. */
|
|
5157
|
+
'hour'?: number[];
|
|
5158
|
+
/** An array of days of the week when the backup should be performed, where `0` represents Monday and `6` represents Sunday. On these days, a backup will be performed at each of the minutes provided in the `minute` field whenever it is an hour from the `hour` field. Required for `weekly` intervals and unavailable for `hourly` and `daily` intervals. */
|
|
5159
|
+
'day'?: number[];
|
|
5160
|
+
};
|
|
5161
|
+
/** The type of the backup to be performed. Example: "snapshot" */
|
|
5162
|
+
'backupType': 'dump' | 'snapshot';
|
|
5163
|
+
/** The compression algorithm of the backup. Only applicable for dump backups. Defaults to `gz`. Example: "gz" */
|
|
5164
|
+
'compressionType'?: 'gz' | 'zstd';
|
|
5165
|
+
/** The time the backup is retained for, in days. `hourly` backups have a maximum retention of 7 days, `daily` backups have a maximum retention of 60 days and `weekly` backups have a maximum retention of 120 days. Example: 7 */
|
|
5166
|
+
'retentionTime': number;
|
|
5167
|
+
};
|
|
5046
5168
|
/** Create a new backup schedule for an addon. */
|
|
5047
5169
|
declare class CreateAddonBackupscheduleEndpoint extends PostApiEndpoint<CreateAddonBackupscheduleRequest, CreateAddonBackupscheduleResult> {
|
|
5048
5170
|
description: string;
|