@scaleway/sdk 2.53.0 → 2.54.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (45) hide show
  1. package/dist/api/applesilicon/v1alpha1/api.gen.cjs +21 -0
  2. package/dist/api/applesilicon/v1alpha1/api.gen.d.ts +3 -1
  3. package/dist/api/applesilicon/v1alpha1/api.gen.js +22 -1
  4. package/dist/api/applesilicon/v1alpha1/index.gen.d.ts +1 -1
  5. package/dist/api/applesilicon/v1alpha1/marshalling.gen.cjs +46 -0
  6. package/dist/api/applesilicon/v1alpha1/marshalling.gen.d.ts +4 -1
  7. package/dist/api/applesilicon/v1alpha1/marshalling.gen.js +47 -1
  8. package/dist/api/applesilicon/v1alpha1/types.gen.d.ts +31 -0
  9. package/dist/api/block/v1alpha1/api.gen.cjs +2 -1
  10. package/dist/api/block/v1alpha1/api.gen.js +2 -1
  11. package/dist/api/block/v1alpha1/types.gen.d.ts +5 -0
  12. package/dist/api/cockpit/v1/api.gen.cjs +21 -2
  13. package/dist/api/cockpit/v1/api.gen.d.ts +16 -3
  14. package/dist/api/cockpit/v1/api.gen.js +22 -3
  15. package/dist/api/cockpit/v1/index.gen.d.ts +1 -1
  16. package/dist/api/cockpit/v1/marshalling.gen.cjs +29 -1
  17. package/dist/api/cockpit/v1/marshalling.gen.d.ts +2 -1
  18. package/dist/api/cockpit/v1/marshalling.gen.js +29 -1
  19. package/dist/api/cockpit/v1/types.gen.d.ts +29 -1
  20. package/dist/api/cockpit/v1/validation-rules.gen.cjs +11 -0
  21. package/dist/api/cockpit/v1/validation-rules.gen.d.ts +11 -0
  22. package/dist/api/cockpit/v1/validation-rules.gen.js +11 -0
  23. package/dist/api/container/v1beta1/marshalling.gen.cjs +7 -3
  24. package/dist/api/container/v1beta1/marshalling.gen.js +7 -3
  25. package/dist/api/container/v1beta1/types.gen.d.ts +17 -2
  26. package/dist/api/edge_services/v1alpha1/types.gen.d.ts +4 -4
  27. package/dist/api/function/v1beta1/marshalling.gen.cjs +3 -1
  28. package/dist/api/function/v1beta1/marshalling.gen.js +3 -1
  29. package/dist/api/function/v1beta1/types.gen.d.ts +4 -0
  30. package/dist/api/ipam/v1/types.gen.d.ts +1 -1
  31. package/dist/api/jobs/v1alpha1/api.gen.cjs +29 -0
  32. package/dist/api/jobs/v1alpha1/api.gen.d.ts +29 -0
  33. package/dist/api/jobs/v1alpha1/api.gen.js +29 -0
  34. package/dist/api/jobs/v1alpha1/types.gen.d.ts +38 -6
  35. package/dist/api/k8s/v1/api.gen.cjs +1 -1
  36. package/dist/api/k8s/v1/api.gen.js +1 -1
  37. package/dist/api/k8s/v1/types.gen.d.ts +1 -1
  38. package/dist/api/mongodb/v1alpha1/api.gen.cjs +4 -16
  39. package/dist/api/mongodb/v1alpha1/api.gen.js +4 -16
  40. package/dist/api/webhosting/v1/api.gen.cjs +2 -8
  41. package/dist/api/webhosting/v1/api.gen.js +2 -8
  42. package/dist/scw/constants.cjs +1 -1
  43. package/dist/scw/constants.d.ts +2 -2
  44. package/dist/scw/constants.js +1 -1
  45. package/package.json +2 -2
@@ -35,6 +35,7 @@ const unmarshalDataSource = (data) => {
35
35
  origin: data.origin,
36
36
  projectId: data.project_id,
37
37
  region: data.region,
38
+ retentionDays: data.retention_days,
38
39
  synchronizedWithGrafana: data.synchronized_with_grafana,
39
40
  type: data.type,
40
41
  updatedAt: unmarshalDate(data.updated_at),
@@ -115,6 +116,30 @@ const unmarshalAlertManager = (data) => {
115
116
  region: data.region
116
117
  };
117
118
  };
119
+ const unmarshalGetConfigResponseRetention = (data) => {
120
+ if (!isJSONObject(data)) {
121
+ throw new TypeError(
122
+ `Unmarshalling the type 'GetConfigResponseRetention' failed as data isn't a dictionary.`
123
+ );
124
+ }
125
+ return {
126
+ defaultDays: data.default_days,
127
+ maxDays: data.max_days,
128
+ minDays: data.min_days
129
+ };
130
+ };
131
+ const unmarshalGetConfigResponse = (data) => {
132
+ if (!isJSONObject(data)) {
133
+ throw new TypeError(
134
+ `Unmarshalling the type 'GetConfigResponse' failed as data isn't a dictionary.`
135
+ );
136
+ }
137
+ return {
138
+ logsRetention: data.logs_retention ? unmarshalGetConfigResponseRetention(data.logs_retention) : void 0,
139
+ metricsRetention: data.metrics_retention ? unmarshalGetConfigResponseRetention(data.metrics_retention) : void 0,
140
+ tracesRetention: data.traces_retention ? unmarshalGetConfigResponseRetention(data.traces_retention) : void 0
141
+ };
142
+ };
118
143
  const unmarshalGrafana = (data) => {
119
144
  if (!isJSONObject(data)) {
120
145
  throw new TypeError(
@@ -288,6 +313,7 @@ const marshalRegionalApiCreateContactPointRequest = (request, defaults) => ({
288
313
  const marshalRegionalApiCreateDataSourceRequest = (request, defaults) => ({
289
314
  name: request.name,
290
315
  project_id: request.projectId ?? defaults.defaultProjectId,
316
+ retention_days: request.retentionDays,
291
317
  type: request.type
292
318
  });
293
319
  const marshalRegionalApiCreateTokenRequest = (request, defaults) => ({
@@ -320,7 +346,8 @@ const marshalRegionalApiTriggerTestAlertRequest = (request, defaults) => ({
320
346
  project_id: request.projectId ?? defaults.defaultProjectId
321
347
  });
322
348
  const marshalRegionalApiUpdateDataSourceRequest = (request, defaults) => ({
323
- name: request.name
349
+ name: request.name,
350
+ retention_days: request.retentionDays
324
351
  });
325
352
  export {
326
353
  marshalGlobalApiCreateGrafanaUserRequest,
@@ -340,6 +367,7 @@ export {
340
367
  unmarshalAlertManager,
341
368
  unmarshalContactPoint,
342
369
  unmarshalDataSource,
370
+ unmarshalGetConfigResponse,
343
371
  unmarshalGrafana,
344
372
  unmarshalGrafanaProductDashboard,
345
373
  unmarshalGrafanaUser,
@@ -1,6 +1,6 @@
1
1
  import type { Region } from '../../../bridge';
2
2
  export type DataSourceOrigin = 'unknown_origin' | 'scaleway' | 'external';
3
- export type DataSourceType = 'unknown_type' | 'metrics' | 'logs' | 'traces' | 'alerts';
3
+ export type DataSourceType = 'unknown_type' | 'metrics' | 'logs' | 'traces';
4
4
  export type GrafanaUserRole = 'unknown_role' | 'editor' | 'viewer';
5
5
  export type ListDataSourcesRequestOrderBy = 'created_at_asc' | 'created_at_desc' | 'name_asc' | 'name_desc' | 'type_asc' | 'type_desc';
6
6
  export type ListGrafanaUsersRequestOrderBy = 'login_asc' | 'login_desc';
@@ -13,6 +13,11 @@ export type UsageUnit = 'unknown_unit' | 'bytes' | 'samples';
13
13
  export interface ContactPointEmail {
14
14
  to: string;
15
15
  }
16
+ export interface GetConfigResponseRetention {
17
+ minDays: number;
18
+ maxDays: number;
19
+ defaultDays: number;
20
+ }
16
21
  /** Contact point. */
17
22
  export interface ContactPoint {
18
23
  /**
@@ -47,6 +52,8 @@ export interface DataSource {
47
52
  updatedAt?: Date;
48
53
  /** Indicates whether the data source is synchronized with Grafana. */
49
54
  synchronizedWithGrafana: boolean;
55
+ /** BETA - Duration for which the data will be retained in the data source. */
56
+ retentionDays: number;
50
57
  /** Region of the data source. */
51
58
  region: Region;
52
59
  }
@@ -149,6 +156,15 @@ export interface AlertManager {
149
156
  /** Regions where the Alert manager is enabled. */
150
157
  region: Region;
151
158
  }
159
+ /** Cockpit configuration. */
160
+ export interface GetConfigResponse {
161
+ /** Metrics retention configuration. */
162
+ metricsRetention?: GetConfigResponseRetention;
163
+ /** Logs retention configuration. */
164
+ logsRetention?: GetConfigResponseRetention;
165
+ /** Traces retention configuration. */
166
+ tracesRetention?: GetConfigResponseRetention;
167
+ }
152
168
  /** Create a Grafana user. */
153
169
  export type GlobalApiCreateGrafanaUserRequest = {
154
170
  /** ID of the Project in which to create the Grafana user. */
@@ -330,6 +346,8 @@ export type RegionalApiCreateDataSourceRequest = {
330
346
  name: string;
331
347
  /** Data source type. */
332
348
  type?: DataSourceType;
349
+ /** Default values are 30 days for metrics, 7 days for logs and traces. */
350
+ retentionDays?: number;
333
351
  };
334
352
  /** Create a token. */
335
353
  export type RegionalApiCreateTokenRequest = {
@@ -431,6 +449,14 @@ export type RegionalApiGetAlertManagerRequest = {
431
449
  /** Project ID of the requested Alert manager. */
432
450
  projectId?: string;
433
451
  };
452
+ /** Get Cockpit configuration. */
453
+ export type RegionalApiGetConfigRequest = {
454
+ /**
455
+ * Region to target. If none is passed will use default region from the
456
+ * config.
457
+ */
458
+ region?: Region;
459
+ };
434
460
  /** Retrieve a data source. */
435
461
  export type RegionalApiGetDataSourceRequest = {
436
462
  /**
@@ -561,6 +587,8 @@ export type RegionalApiUpdateDataSourceRequest = {
561
587
  dataSourceId: string;
562
588
  /** Updated name of the data source. */
563
589
  name?: string;
590
+ /** BETA - Duration for which the data will be retained in the data source. */
591
+ retentionDays?: number;
564
592
  };
565
593
  export interface UsageOverview {
566
594
  scalewayMetricsUsage?: Usage;
@@ -5,6 +5,11 @@ const RegionalApiCreateDataSourceRequest = {
5
5
  maxLength: 50,
6
6
  minLength: 3,
7
7
  pattern: /^[A-Za-z0-9-_. ]+$/
8
+ },
9
+ retentionDays: {
10
+ greaterThanOrEqual: 1,
11
+ ignoreEmpty: true,
12
+ lessThanOrEqual: 365
8
13
  }
9
14
  };
10
15
  const RegionalApiCreateTokenRequest = {
@@ -52,9 +57,15 @@ const RegionalApiListTokensRequest = {
52
57
  };
53
58
  const RegionalApiUpdateDataSourceRequest = {
54
59
  name: {
60
+ ignoreEmpty: true,
55
61
  maxLength: 50,
56
62
  minLength: 3,
57
63
  pattern: /^[A-Za-z0-9-_. ]+$/
64
+ },
65
+ retentionDays: {
66
+ greaterThanOrEqual: 1,
67
+ ignoreEmpty: true,
68
+ lessThanOrEqual: 365
58
69
  }
59
70
  };
60
71
  exports.RegionalApiCreateDataSourceRequest = RegionalApiCreateDataSourceRequest;
@@ -4,6 +4,11 @@ export declare const RegionalApiCreateDataSourceRequest: {
4
4
  minLength: number;
5
5
  pattern: RegExp;
6
6
  };
7
+ retentionDays: {
8
+ greaterThanOrEqual: number;
9
+ ignoreEmpty: boolean;
10
+ lessThanOrEqual: number;
11
+ };
7
12
  };
8
13
  export declare const RegionalApiCreateTokenRequest: {
9
14
  name: {
@@ -50,8 +55,14 @@ export declare const RegionalApiListTokensRequest: {
50
55
  };
51
56
  export declare const RegionalApiUpdateDataSourceRequest: {
52
57
  name: {
58
+ ignoreEmpty: boolean;
53
59
  maxLength: number;
54
60
  minLength: number;
55
61
  pattern: RegExp;
56
62
  };
63
+ retentionDays: {
64
+ greaterThanOrEqual: number;
65
+ ignoreEmpty: boolean;
66
+ lessThanOrEqual: number;
67
+ };
57
68
  };
@@ -3,6 +3,11 @@ const RegionalApiCreateDataSourceRequest = {
3
3
  maxLength: 50,
4
4
  minLength: 3,
5
5
  pattern: /^[A-Za-z0-9-_. ]+$/
6
+ },
7
+ retentionDays: {
8
+ greaterThanOrEqual: 1,
9
+ ignoreEmpty: true,
10
+ lessThanOrEqual: 365
6
11
  }
7
12
  };
8
13
  const RegionalApiCreateTokenRequest = {
@@ -50,9 +55,15 @@ const RegionalApiListTokensRequest = {
50
55
  };
51
56
  const RegionalApiUpdateDataSourceRequest = {
52
57
  name: {
58
+ ignoreEmpty: true,
53
59
  maxLength: 50,
54
60
  minLength: 3,
55
61
  pattern: /^[A-Za-z0-9-_. ]+$/
62
+ },
63
+ retentionDays: {
64
+ greaterThanOrEqual: 1,
65
+ ignoreEmpty: true,
66
+ lessThanOrEqual: 365
56
67
  }
57
68
  };
58
69
  export {
@@ -43,7 +43,8 @@ const unmarshalContainerScalingOption = (data) => {
43
43
  }
44
44
  return {
45
45
  concurrentRequestsThreshold: data.concurrent_requests_threshold,
46
- cpuUsageThreshold: data.cpu_usage_threshold
46
+ cpuUsageThreshold: data.cpu_usage_threshold,
47
+ memoryUsageThreshold: data.memory_usage_threshold
47
48
  };
48
49
  };
49
50
  const unmarshalSecretHashedValue = (data) => {
@@ -134,6 +135,7 @@ const unmarshalNamespace = (data) => {
134
135
  );
135
136
  }
136
137
  return {
138
+ createdAt: marshalling.unmarshalDate(data.created_at),
137
139
  description: data.description,
138
140
  environmentVariables: data.environment_variables,
139
141
  errorMessage: data.error_message,
@@ -149,7 +151,8 @@ const unmarshalNamespace = (data) => {
149
151
  unmarshalSecretHashedValue
150
152
  ),
151
153
  status: data.status,
152
- tags: data.tags
154
+ tags: data.tags,
155
+ updatedAt: marshalling.unmarshalDate(data.updated_at)
153
156
  };
154
157
  };
155
158
  const unmarshalToken = (data) => {
@@ -318,7 +321,8 @@ const marshalContainerScalingOption = (request, defaults) => ({
318
321
  param: "concurrent_requests_threshold",
319
322
  value: request.concurrentRequestsThreshold
320
323
  },
321
- { param: "cpu_usage_threshold", value: request.cpuUsageThreshold }
324
+ { param: "cpu_usage_threshold", value: request.cpuUsageThreshold },
325
+ { param: "memory_usage_threshold", value: request.memoryUsageThreshold }
322
326
  ])
323
327
  });
324
328
  const marshalSecret = (request, defaults) => ({
@@ -41,7 +41,8 @@ const unmarshalContainerScalingOption = (data) => {
41
41
  }
42
42
  return {
43
43
  concurrentRequestsThreshold: data.concurrent_requests_threshold,
44
- cpuUsageThreshold: data.cpu_usage_threshold
44
+ cpuUsageThreshold: data.cpu_usage_threshold,
45
+ memoryUsageThreshold: data.memory_usage_threshold
45
46
  };
46
47
  };
47
48
  const unmarshalSecretHashedValue = (data) => {
@@ -132,6 +133,7 @@ const unmarshalNamespace = (data) => {
132
133
  );
133
134
  }
134
135
  return {
136
+ createdAt: unmarshalDate(data.created_at),
135
137
  description: data.description,
136
138
  environmentVariables: data.environment_variables,
137
139
  errorMessage: data.error_message,
@@ -147,7 +149,8 @@ const unmarshalNamespace = (data) => {
147
149
  unmarshalSecretHashedValue
148
150
  ),
149
151
  status: data.status,
150
- tags: data.tags
152
+ tags: data.tags,
153
+ updatedAt: unmarshalDate(data.updated_at)
151
154
  };
152
155
  };
153
156
  const unmarshalToken = (data) => {
@@ -316,7 +319,8 @@ const marshalContainerScalingOption = (request, defaults) => ({
316
319
  param: "concurrent_requests_threshold",
317
320
  value: request.concurrentRequestsThreshold
318
321
  },
319
- { param: "cpu_usage_threshold", value: request.cpuUsageThreshold }
322
+ { param: "cpu_usage_threshold", value: request.cpuUsageThreshold },
323
+ { param: "memory_usage_threshold", value: request.memoryUsageThreshold }
320
324
  ])
321
325
  });
322
326
  const marshalSecret = (request, defaults) => ({
@@ -47,14 +47,19 @@ export interface ContainerHealthCheckSpec {
47
47
  export interface ContainerScalingOption {
48
48
  /**
49
49
  * One-of ('scalingRule'): at most one of 'concurrentRequestsThreshold',
50
- * 'cpuUsageThreshold' could be set.
50
+ * 'cpuUsageThreshold', 'memoryUsageThreshold' could be set.
51
51
  */
52
52
  concurrentRequestsThreshold?: number;
53
53
  /**
54
54
  * One-of ('scalingRule'): at most one of 'concurrentRequestsThreshold',
55
- * 'cpuUsageThreshold' could be set.
55
+ * 'cpuUsageThreshold', 'memoryUsageThreshold' could be set.
56
56
  */
57
57
  cpuUsageThreshold?: number;
58
+ /**
59
+ * One-of ('scalingRule'): at most one of 'concurrentRequestsThreshold',
60
+ * 'cpuUsageThreshold', 'memoryUsageThreshold' could be set.
61
+ */
62
+ memoryUsageThreshold?: number;
58
63
  }
59
64
  export interface SecretHashedValue {
60
65
  key: string;
@@ -183,6 +188,8 @@ export interface Container {
183
188
  * requests being processed per container instance.
184
189
  * - Cpu_usage_threshold: Scale depending on the CPU usage of a container
185
190
  * instance.
191
+ * - Memory_usage_threshold: Scale depending on the memory usage of a container
192
+ * instance.
186
193
  */
187
194
  scalingOption?: ContainerScalingOption;
188
195
  /** Health check configuration of the container. */
@@ -251,6 +258,10 @@ export interface Namespace {
251
258
  region: Region;
252
259
  /** [ALPHA] List of tags applied to the Serverless Container Namespace. */
253
260
  tags: string[];
261
+ /** Creation date of the namespace. */
262
+ createdAt?: Date;
263
+ /** Last update date of the namespace. */
264
+ updatedAt?: Date;
254
265
  }
255
266
  export interface Token {
256
267
  /** UUID of the token. */
@@ -377,6 +388,8 @@ export type CreateContainerRequest = {
377
388
  * requests being processed per container instance.
378
389
  * - Cpu_usage_threshold: Scale depending on the CPU usage of a container
379
390
  * instance.
391
+ * - Memory_usage_threshold: Scale depending on the memory usage of a container
392
+ * instance.
380
393
  */
381
394
  scalingOption?: ContainerScalingOption;
382
395
  /** Health check configuration of the container. */
@@ -811,6 +824,8 @@ export type UpdateContainerRequest = {
811
824
  * requests being processed per container instance.
812
825
  * - Cpu_usage_threshold: Scale depending on the CPU usage of a container
813
826
  * instance.
827
+ * - Memory_usage_threshold: Scale depending on the memory usage of a container
828
+ * instance.
814
829
  */
815
830
  scalingOption?: ContainerScalingOption;
816
831
  /** Health check configuration of the container. */
@@ -433,13 +433,13 @@ export interface GetBillingResponse {
433
433
  */
434
434
  extraPipelinesCost?: Money;
435
435
  /**
436
- * Total amount of data egressed from the cache (this month), included in the
437
- * active subscription plan.
436
+ * Total amount of data egressed from the cache in gigabytes from the
437
+ * beginning of the month, included in the active subscription plan.
438
438
  */
439
439
  currentPlanCacheUsage: number;
440
440
  /**
441
- * Total amount of data egressed from cache (this month), not included in the
442
- * active subscription plan.
441
+ * Total amount of extra data egressed from cache in gigabytes from the
442
+ * beginning of the month, not included in the active subscription plan.
443
443
  */
444
444
  extraCacheUsage: number;
445
445
  /**
@@ -89,6 +89,7 @@ const unmarshalNamespace = (data) => {
89
89
  );
90
90
  }
91
91
  return {
92
+ createdAt: marshalling.unmarshalDate(data.created_at),
92
93
  description: data.description,
93
94
  environmentVariables: data.environment_variables,
94
95
  errorMessage: data.error_message,
@@ -104,7 +105,8 @@ const unmarshalNamespace = (data) => {
104
105
  unmarshalSecretHashedValue
105
106
  ),
106
107
  status: data.status,
107
- tags: data.tags
108
+ tags: data.tags,
109
+ updatedAt: marshalling.unmarshalDate(data.updated_at)
108
110
  };
109
111
  };
110
112
  const unmarshalToken = (data) => {
@@ -87,6 +87,7 @@ const unmarshalNamespace = (data) => {
87
87
  );
88
88
  }
89
89
  return {
90
+ createdAt: unmarshalDate(data.created_at),
90
91
  description: data.description,
91
92
  environmentVariables: data.environment_variables,
92
93
  errorMessage: data.error_message,
@@ -102,7 +103,8 @@ const unmarshalNamespace = (data) => {
102
103
  unmarshalSecretHashedValue
103
104
  ),
104
105
  status: data.status,
105
- tags: data.tags
106
+ tags: data.tags,
107
+ updatedAt: unmarshalDate(data.updated_at)
106
108
  };
107
109
  };
108
110
  const unmarshalToken = (data) => {
@@ -207,6 +207,10 @@ export interface Namespace {
207
207
  region: Region;
208
208
  /** [ALPHA] List of tags applied to the Serverless Function Namespace. */
209
209
  tags: string[];
210
+ /** Creation date of the namespace. */
211
+ createdAt?: Date;
212
+ /** Last update date of the namespace. */
213
+ updatedAt?: Date;
210
214
  }
211
215
  export interface Token {
212
216
  /** UUID of the token. */
@@ -1,6 +1,6 @@
1
1
  import type { Region, Zone } from '../../../bridge';
2
2
  export type ListIPsRequestOrderBy = 'created_at_desc' | 'created_at_asc' | 'updated_at_desc' | 'updated_at_asc' | 'attached_at_desc' | 'attached_at_asc';
3
- export type ResourceType = 'unknown_type' | 'custom' | 'instance_server' | 'instance_ip' | 'instance_private_nic' | 'lb_server' | 'fip_ip' | 'vpc_gateway' | 'vpc_gateway_network' | 'k8s_node' | 'k8s_cluster' | 'rdb_instance' | 'redis_cluster' | 'baremetal_server' | 'baremetal_private_nic' | 'llm_deployment';
3
+ export type ResourceType = 'unknown_type' | 'custom' | 'instance_server' | 'instance_ip' | 'instance_private_nic' | 'lb_server' | 'fip_ip' | 'vpc_gateway' | 'vpc_gateway_network' | 'k8s_node' | 'k8s_cluster' | 'rdb_instance' | 'redis_cluster' | 'baremetal_server' | 'baremetal_private_nic' | 'llm_deployment' | 'mgdb_instance';
4
4
  export interface Resource {
5
5
  /** Type of resource the IP is attached to. */
6
6
  type: ResourceType;
@@ -114,6 +114,12 @@ class API extends api.API {
114
114
  },
115
115
  marshalling_gen.unmarshalStartJobDefinitionResponse
116
116
  );
117
+ /**
118
+ * Create a secret reference within a job definition.
119
+ *
120
+ * @param request - The request {@link CreateJobDefinitionSecretsRequest}
121
+ * @returns A Promise of CreateJobDefinitionSecretsResponse
122
+ */
117
123
  createJobDefinitionSecrets = (request) => this.client.fetch(
118
124
  {
119
125
  body: JSON.stringify(
@@ -128,6 +134,12 @@ class API extends api.API {
128
134
  },
129
135
  marshalling_gen.unmarshalCreateJobDefinitionSecretsResponse
130
136
  );
137
+ /**
138
+ * Get a secret references within a job definition.
139
+ *
140
+ * @param request - The request {@link GetJobDefinitionSecretRequest}
141
+ * @returns A Promise of Secret
142
+ */
131
143
  getJobDefinitionSecret = (request) => this.client.fetch(
132
144
  {
133
145
  method: "GET",
@@ -135,6 +147,12 @@ class API extends api.API {
135
147
  },
136
148
  marshalling_gen.unmarshalSecret
137
149
  );
150
+ /**
151
+ * List secrets references within a job definition.
152
+ *
153
+ * @param request - The request {@link ListJobDefinitionSecretsRequest}
154
+ * @returns A Promise of ListJobDefinitionSecretsResponse
155
+ */
138
156
  listJobDefinitionSecrets = (request) => this.client.fetch(
139
157
  {
140
158
  method: "GET",
@@ -142,6 +160,12 @@ class API extends api.API {
142
160
  },
143
161
  marshalling_gen.unmarshalListJobDefinitionSecretsResponse
144
162
  );
163
+ /**
164
+ * Update a secret reference within a job definition.
165
+ *
166
+ * @param request - The request {@link UpdateJobDefinitionSecretRequest}
167
+ * @returns A Promise of Secret
168
+ */
145
169
  updateJobDefinitionSecret = (request) => this.client.fetch(
146
170
  {
147
171
  body: JSON.stringify(
@@ -156,6 +180,11 @@ class API extends api.API {
156
180
  },
157
181
  marshalling_gen.unmarshalSecret
158
182
  );
183
+ /**
184
+ * Delete a secret reference within a job definition.
185
+ *
186
+ * @param request - The request {@link DeleteJobDefinitionSecretRequest}
187
+ */
159
188
  deleteJobDefinitionSecret = (request) => this.client.fetch({
160
189
  method: "DELETE",
161
190
  path: `/serverless-jobs/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/job-definitions/${marshalling.validatePathParam("jobDefinitionId", request.jobDefinitionId)}/secrets/${marshalling.validatePathParam("secretId", request.secretId)}`
@@ -56,10 +56,39 @@ export declare class API extends ParentAPI {
56
56
  * @returns A Promise of StartJobDefinitionResponse
57
57
  */
58
58
  startJobDefinition: (request: Readonly<StartJobDefinitionRequest>) => Promise<StartJobDefinitionResponse>;
59
+ /**
60
+ * Create a secret reference within a job definition.
61
+ *
62
+ * @param request - The request {@link CreateJobDefinitionSecretsRequest}
63
+ * @returns A Promise of CreateJobDefinitionSecretsResponse
64
+ */
59
65
  createJobDefinitionSecrets: (request: Readonly<CreateJobDefinitionSecretsRequest>) => Promise<CreateJobDefinitionSecretsResponse>;
66
+ /**
67
+ * Get a secret references within a job definition.
68
+ *
69
+ * @param request - The request {@link GetJobDefinitionSecretRequest}
70
+ * @returns A Promise of Secret
71
+ */
60
72
  getJobDefinitionSecret: (request: Readonly<GetJobDefinitionSecretRequest>) => Promise<Secret>;
73
+ /**
74
+ * List secrets references within a job definition.
75
+ *
76
+ * @param request - The request {@link ListJobDefinitionSecretsRequest}
77
+ * @returns A Promise of ListJobDefinitionSecretsResponse
78
+ */
61
79
  listJobDefinitionSecrets: (request: Readonly<ListJobDefinitionSecretsRequest>) => Promise<ListJobDefinitionSecretsResponse>;
80
+ /**
81
+ * Update a secret reference within a job definition.
82
+ *
83
+ * @param request - The request {@link UpdateJobDefinitionSecretRequest}
84
+ * @returns A Promise of Secret
85
+ */
62
86
  updateJobDefinitionSecret: (request: Readonly<UpdateJobDefinitionSecretRequest>) => Promise<Secret>;
87
+ /**
88
+ * Delete a secret reference within a job definition.
89
+ *
90
+ * @param request - The request {@link DeleteJobDefinitionSecretRequest}
91
+ */
63
92
  deleteJobDefinitionSecret: (request: Readonly<DeleteJobDefinitionSecretRequest>) => Promise<void>;
64
93
  /**
65
94
  * Get a job run by its unique identifier.
@@ -112,6 +112,12 @@ class API extends API$1 {
112
112
  },
113
113
  unmarshalStartJobDefinitionResponse
114
114
  );
115
+ /**
116
+ * Create a secret reference within a job definition.
117
+ *
118
+ * @param request - The request {@link CreateJobDefinitionSecretsRequest}
119
+ * @returns A Promise of CreateJobDefinitionSecretsResponse
120
+ */
115
121
  createJobDefinitionSecrets = (request) => this.client.fetch(
116
122
  {
117
123
  body: JSON.stringify(
@@ -126,6 +132,12 @@ class API extends API$1 {
126
132
  },
127
133
  unmarshalCreateJobDefinitionSecretsResponse
128
134
  );
135
+ /**
136
+ * Get a secret references within a job definition.
137
+ *
138
+ * @param request - The request {@link GetJobDefinitionSecretRequest}
139
+ * @returns A Promise of Secret
140
+ */
129
141
  getJobDefinitionSecret = (request) => this.client.fetch(
130
142
  {
131
143
  method: "GET",
@@ -133,6 +145,12 @@ class API extends API$1 {
133
145
  },
134
146
  unmarshalSecret
135
147
  );
148
+ /**
149
+ * List secrets references within a job definition.
150
+ *
151
+ * @param request - The request {@link ListJobDefinitionSecretsRequest}
152
+ * @returns A Promise of ListJobDefinitionSecretsResponse
153
+ */
136
154
  listJobDefinitionSecrets = (request) => this.client.fetch(
137
155
  {
138
156
  method: "GET",
@@ -140,6 +158,12 @@ class API extends API$1 {
140
158
  },
141
159
  unmarshalListJobDefinitionSecretsResponse
142
160
  );
161
+ /**
162
+ * Update a secret reference within a job definition.
163
+ *
164
+ * @param request - The request {@link UpdateJobDefinitionSecretRequest}
165
+ * @returns A Promise of Secret
166
+ */
143
167
  updateJobDefinitionSecret = (request) => this.client.fetch(
144
168
  {
145
169
  body: JSON.stringify(
@@ -154,6 +178,11 @@ class API extends API$1 {
154
178
  },
155
179
  unmarshalSecret
156
180
  );
181
+ /**
182
+ * Delete a secret reference within a job definition.
183
+ *
184
+ * @param request - The request {@link DeleteJobDefinitionSecretRequest}
185
+ */
157
186
  deleteJobDefinitionSecret = (request) => this.client.fetch({
158
187
  method: "DELETE",
159
188
  path: `/serverless-jobs/v1alpha1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/job-definitions/${validatePathParam("jobDefinitionId", request.jobDefinitionId)}/secrets/${validatePathParam("secretId", request.secretId)}`