@maxim_mazurok/gapi.client.workloadmanager-v1 0.2.20260217 → 0.2.20260602

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 (3) hide show
  1. package/index.d.ts +137 -137
  2. package/package.json +1 -1
  3. package/readme.md +17 -0
package/index.d.ts CHANGED
@@ -9,7 +9,7 @@
9
9
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
10
10
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
11
11
  // Generated from: https://workloadmanager.googleapis.com/$discovery/rest?version=v1
12
- // Revision: 20260217
12
+ // Revision: 20260602
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -29,32 +29,32 @@ declare namespace gapi.client {
29
29
 
30
30
  namespace workloadmanager {
31
31
  interface ActiveDirectory {
32
- /** Optional. DNS IP address */
32
+ /** Optional. DNS IP address. */
33
33
  dnsAddress?: string;
34
- /** Optional. human readable form of a domain such as “google.com”. */
34
+ /** Optional. Human readable form of a domain such as “google.com”. */
35
35
  domain?: string;
36
- /** Optional. domain username */
36
+ /** Optional. Domain username. */
37
37
  domainUsername?: string;
38
- /** Required. secret_manager_secret */
38
+ /** Required. Secret Manager secret. */
39
39
  secretManagerSecret?: string;
40
- /** Required. active directory type */
40
+ /** Required. Active Directory type. */
41
41
  type?:
42
42
  | 'ACTIVE_DIRECTORY_TYPE_UNSPECIFIED'
43
43
  | 'GCP_MANAGED'
44
44
  | 'SELF_MANAGED';
45
45
  }
46
46
  interface Actuation {
47
- /** Output only. [Output only] Actuation output */
47
+ /** Output only. Actuation output. */
48
48
  actuationOutput?: ActuationOutput;
49
- /** Output only. [Output only] Deployment output */
49
+ /** Output only. Deployment output. */
50
50
  deploymentOutput?: DeploymentOutput[];
51
- /** Output only. [Output only] End time stamp */
51
+ /** Output only. End time stamp. */
52
52
  endTime?: string;
53
- /** The name of actuation resource. The format is projects/{project}/locations/{location}/deployments/{deployment}/actuations/{actuation} */
53
+ /** The name of the actuation resource. The format is projects/{project}/locations/{location}/deployments/{deployment}/actuations/{actuation}. */
54
54
  name?: string;
55
- /** Output only. [Output only] Start time stamp */
55
+ /** Output only. Start time stamp. */
56
56
  startTime?: string;
57
- /** Output only. [Output only] Actuation state */
57
+ /** Output only. Actuation state. */
58
58
  state?:
59
59
  | 'STATE_UNSPECIFIED'
60
60
  | 'INFRA_CREATING'
@@ -65,13 +65,13 @@ declare namespace gapi.client {
65
65
  | 'TIMEOUT';
66
66
  }
67
67
  interface ActuationOutput {
68
- /** A link to gcs file that store build logs */
68
+ /** A link to the Cloud Storage file that stores build logs. */
69
69
  actuateLogs?: string;
70
- /** Output only. error message return from ansible. */
70
+ /** Output only. Error message returned from Ansible. */
71
71
  ansibleError?: string;
72
- /** Output only. failed task name return from ansible. */
72
+ /** Output only. Failed task name returned from Ansible. */
73
73
  ansibleFailedTask?: string[];
74
- /** reference to Blueprint Controller deployment and revision resource */
74
+ /** Reference to the Blueprint Controller deployment and revision resource. */
75
75
  blueprintId?: string;
76
76
  /** Cloud Build instance UUID associated with this revision, without any suffix or prefix */
77
77
  cloudbuildId?: string;
@@ -90,13 +90,13 @@ declare namespace gapi.client {
90
90
  | 'TERRAFORM_DELETION_FAILED'
91
91
  | 'RESOURCE_IN_USE_IN_TERRAFORM_DELETION'
92
92
  | 'ANSIBLE_START_FAILED';
93
- /** A link to actuation cloud build log. */
93
+ /** A link to the actuation Cloud Build log. */
94
94
  errorLogs?: string;
95
- /** Output only. whether the error message is user facing. If true, the error message will be shown in the UI. */
95
+ /** Output only. Whether the error message is user facing. If true, the error message will be shown in the UI. */
96
96
  hasUserFacingErrorMsg?: boolean;
97
- /** Output only. error message return from terraform. */
97
+ /** Output only. Error message returned from Terraform. */
98
98
  terraformError?: string;
99
- /** reference to terraform template used */
99
+ /** Reference to the Terraform template used. */
100
100
  terraformTemplate?: string;
101
101
  }
102
102
  interface AgentCommand {
@@ -212,37 +212,37 @@ declare namespace gapi.client {
212
212
  unspecifiedStateMessage?: string;
213
213
  }
214
214
  interface AppDetails {
215
- /** Optional. instance id for app */
215
+ /** Optional. Instance ID for app. */
216
216
  appInstanceId?: string;
217
- /** Application service account - let custoemrs bring their own SA for application */
217
+ /** Application service account. Let customers bring their own service account for the application. */
218
218
  appServiceAccount?: string;
219
- /** Optional. Customized vm names */
219
+ /** Optional. Customized VM names. */
220
220
  appVmNames?: string[];
221
- /** Required. image for ascs server */
221
+ /** Required. Image for the ASCS server. */
222
222
  ascsImage?: string;
223
- /** Optional. instance id for ascs */
223
+ /** Optional. Instance ID for ASCS. */
224
224
  ascsInstanceId?: string;
225
- /** Required. ascs_machine_type */
225
+ /** Required. ASCS machine type. */
226
226
  ascsMachineType?: string;
227
- /** ASCS service account - let custoemrs bring their own SA for ASCS */
227
+ /** ASCS service account. Let customers bring their own service account for ASCS. */
228
228
  ascsServiceAccount?: string;
229
- /** Optional. ASCS vm name */
229
+ /** Optional. ASCS VM name. */
230
230
  ascsVm?: string;
231
- /** Optional. instance id for ers */
231
+ /** Optional. Instance ID for ERS. */
232
232
  ersInstanceId?: string;
233
- /** Optional. ERS vm name */
233
+ /** Optional. ERS VM name. */
234
234
  ersVm?: string;
235
- /** Required. image for app server and ascs server */
235
+ /** Required. Image for the app server and ASCS server. */
236
236
  image?: string;
237
- /** Required. machine type */
237
+ /** Required. Machine type. */
238
238
  machineType?: string;
239
- /** Required. secret_manager_secret */
239
+ /** Required. Secret Manager secret. */
240
240
  secretManagerSecret?: string;
241
- /** Optional. Storage location */
241
+ /** Optional. Storage location. */
242
242
  sharedStorage?: string;
243
243
  /** Required. The SAP SID is a three-digit server-specific unique identification code. */
244
244
  sid?: string;
245
- /** Required. vms_multiplier */
245
+ /** Required. VMs multiplier. */
246
246
  vmsMultiplier?: number;
247
247
  }
248
248
  interface BackupProperties {
@@ -309,45 +309,45 @@ declare namespace gapi.client {
309
309
  subComponentsHealth?: ComponentHealth[];
310
310
  }
311
311
  interface Database {
312
- /** Required. disk_type */
312
+ /** Required. Disk type. */
313
313
  diskType?: string;
314
- /** Optional. only useful for Linux High Availability setup */
314
+ /** Optional. Only useful for Linux High Availability setup. */
315
315
  floatingIpAddress?: string;
316
- /** Required. machine type */
316
+ /** Required. Machine type. */
317
317
  machineType?: string;
318
- /** Optional. the name of a secondary-sole-tenant node/node group */
318
+ /** Optional. The name of a secondary-sole-tenant node/node group. */
319
319
  secondarySoleTenantNode?: string;
320
- /** Optional. the type of a secondary-sole-tenant node/node group e.g. compute.googleapis.com/node-name */
320
+ /** Optional. The type of a secondary-sole-tenant node/node group. E.g., compute.googleapis.com/node-name. */
321
321
  secondarySoleTenantNodeType?: string;
322
- /** Required. secret_manager_secret */
322
+ /** Required. Secret Manager secret. */
323
323
  secretManagerSecret?: string;
324
- /** Required. whether simultaneous multithreading is enabled or not */
324
+ /** Required. Whether simultaneous multithreading is enabled or not. */
325
325
  smt?: boolean;
326
- /** Optional. the name of a primary sole-tenant node/node group */
326
+ /** Optional. The name of a primary sole-tenant node/node group. */
327
327
  soleTenantNode?: string;
328
- /** Optional. the type of a primary sole-tenant node/node group e.g. compute.googleapis.com/node-name */
328
+ /** Optional. The type of a primary sole-tenant node/node group. E.g., compute.googleapis.com/node-name. */
329
329
  soleTenantNodeType?: string;
330
- /** Required. whether to have TempDB on local SSD */
330
+ /** Required. Whether to have TempDB on local SSD. */
331
331
  tempdbOnSsd?: boolean;
332
- /** Required. SHARED or SOLE_TENANT */
332
+ /** Required. SHARED or SOLE_TENANT. */
333
333
  tenancyModel?: 'TENANCY_MODEL_UNSPECIFIED' | 'SHARED' | 'SOLE_TENANT';
334
334
  }
335
335
  interface DatabaseDetails {
336
- /** Database service account - let custoemrs bring their own SA for database */
336
+ /** Database service account. Let customers bring their own SA for the database. */
337
337
  databaseServiceAccount?: string;
338
- /** Required. disk_type */
338
+ /** Required. Disk type. */
339
339
  diskType?: string;
340
- /** Required. image for database server */
340
+ /** Required. Image for the database server. */
341
341
  image?: string;
342
- /** Optional. instance id */
342
+ /** Optional. Instance ID. */
343
343
  instanceId?: string;
344
- /** Required. machine type */
344
+ /** Required. Machine type. */
345
345
  machineType?: string;
346
- /** Optional. primary db vm name */
346
+ /** Optional. Primary DB VM name. */
347
347
  primaryDbVm?: string;
348
- /** Optional. secondary db vm name */
348
+ /** Optional. Secondary DB VM name. */
349
349
  secondaryDbVm?: string;
350
- /** Required. secret_manager_secret */
350
+ /** Required. Secret Manager secret. */
351
351
  secretManagerSecret?: string;
352
352
  /** Required. The SID is a three-digit server-specific unique identification code. */
353
353
  sid?: string;
@@ -366,17 +366,17 @@ declare namespace gapi.client {
366
366
  | 'ASE';
367
367
  }
368
368
  interface Deployment {
369
- /** Output only. [Output only] Create time stamp */
369
+ /** Output only. Create time stamp. */
370
370
  createTime?: string;
371
- /** Description of the Deployment */
371
+ /** Description of the deployment. */
372
372
  description?: string;
373
- /** The name of deployment resource. The format will be 'projects/{project_id}/locations/{location_id}/deployments/{deployment_id}' */
373
+ /** The name of the deployment resource. The format is 'projects/{project_id}/locations/{location_id}/deployments/{deployment_id}'. */
374
374
  name?: string;
375
- /** SAP system workload input */
375
+ /** SAP system workload input. */
376
376
  sapSystemS4Config?: SapSystemS4Config;
377
- /** User-specified Service Account (SA) credentials to be used for cloud build Format: `projects/{projectID}/serviceAccounts/{serviceAccount}` The default Cloud Build SA will be used initially if this field is not set during deployment creation */
377
+ /** User-specified Service Account (SA) credentials to be used for Cloud Build. Format: `projects/{projectID}/serviceAccounts/{serviceAccount}` The default Cloud Build SA will be used initially if this field is not set during deployment creation. */
378
378
  serviceAccount?: string;
379
- /** MS SQL workload input */
379
+ /** MS SQL workload input. */
380
380
  sqlServerWorkload?: SqlServerWorkload;
381
381
  /** Output only. Current state of the deployment. */
382
382
  state?:
@@ -388,11 +388,11 @@ declare namespace gapi.client {
388
388
  | 'FAILED';
389
389
  /** Optional. terraform_variables represents all the Terraform variables for the deployment workload. The key is the name of the Terraform variable, and the value is the TerraformVariable. For example: { "project_id": { "input_value": { "string_value": "my-project-id" } }, "zone": { "input_value": { "string_value": "us-central1-a" } } } */
390
390
  terraformVariables?: {[P in string]: TerraformVariable};
391
- /** Output only. [Output only] Update time stamp */
391
+ /** Output only. Update time stamp. */
392
392
  updateTime?: string;
393
393
  /** Optional. The user-specified Cloud Build worker pool resource in which the Cloud Build job will execute. Format: `projects/{project}/locations/{location}/workerPools/{workerPoolId}`. If this field is unspecified, the default Cloud Build worker pool will be used. */
394
394
  workerPool?: string;
395
- /** Optional. Workload type of the deployment */
395
+ /** Optional. Workload type of the deployment. */
396
396
  workloadType?:
397
397
  | 'WORKLOAD_TYPE_UNSPECIFIED'
398
398
  | 'SAP_S4'
@@ -400,9 +400,9 @@ declare namespace gapi.client {
400
400
  | 'ORACLE';
401
401
  }
402
402
  interface DeploymentOutput {
403
- /** name of the resource */
403
+ /** Name of the resource. */
404
404
  name?: string;
405
- /** type of the resource */
405
+ /** Type of the resource. */
406
406
  type?: string;
407
407
  }
408
408
  interface Empty {}
@@ -561,7 +561,7 @@ declare namespace gapi.client {
561
561
  upcomingMaintenanceEvent?: UpcomingMaintenanceEvent;
562
562
  }
563
563
  interface ListActuationsResponse {
564
- /** The list of Actuation */
564
+ /** The list of actuations. */
565
565
  actuations?: Actuation[];
566
566
  /** A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. */
567
567
  nextPageToken?: string;
@@ -569,7 +569,7 @@ declare namespace gapi.client {
569
569
  unreachable?: string[];
570
570
  }
571
571
  interface ListDeploymentsResponse {
572
- /** The list of Deployment */
572
+ /** The list of deployments. */
573
573
  deployments?: Deployment[];
574
574
  /** A token identifying a page of results the server should return. */
575
575
  nextPageToken?: string;
@@ -643,31 +643,31 @@ declare namespace gapi.client {
643
643
  name?: string;
644
644
  }
645
645
  interface LocationDetails {
646
- /** Optional. create firewall, if true, create firewall for the deployment. This field provides an option to not always create firewall for the deployment. */
646
+ /** Optional. Create firewall. If true, creates a firewall for the deployment. This field provides an option to not always create a firewall for the deployment. */
647
647
  createCommsFirewall?: boolean;
648
- /** Optional. network tags */
648
+ /** Optional. Network tags. */
649
649
  customTags?: string[];
650
- /** Optional. when user skip DNS configuration from UI, deployment_dns_enabled=false otherwise deployment_dns_enabled=true */
650
+ /** Optional. When the user skips DNS configuration in the UI, `deployment_dns_enabled` is false; otherwise `deployment_dns_enabled` is true. */
651
651
  deploymentDnsEnabled?: boolean;
652
- /** Optional. dns zone name */
652
+ /** Optional. DNS zone name. */
653
653
  dnsZone?: string;
654
- /** Optional. dns_zone_name_suffix */
654
+ /** Optional. DNS zone name suffix. */
655
655
  dnsZoneNameSuffix?: string;
656
656
  internetAccess?:
657
657
  | 'INTERNETACCESS_UNSPECIFIED'
658
658
  | 'ALLOW_EXTERNAL_IP'
659
659
  | 'CONFIGURE_NAT';
660
- /** Optional. network project */
660
+ /** Optional. Network project. */
661
661
  networkProject?: string;
662
- /** Required. region_name */
662
+ /** Required. Region name. */
663
663
  regionName?: string;
664
- /** Required. subnet_name */
664
+ /** Required. Subnet name. */
665
665
  subnetName?: string;
666
- /** Required. vpc_name */
666
+ /** Required. VPC name. */
667
667
  vpcName?: string;
668
- /** Required. zone1_name */
668
+ /** Required. Zone 1 name. */
669
669
  zone1Name?: string;
670
- /** Optional. zone2_name */
670
+ /** Optional. Zone 2 name. */
671
671
  zone2Name?: string;
672
672
  }
673
673
  interface Notice {
@@ -709,17 +709,17 @@ declare namespace gapi.client {
709
709
  verb?: string;
710
710
  }
711
711
  interface Pacemaker {
712
- /** Required. bucket location for node certificates */
712
+ /** Required. Bucket location for node certificates. */
713
713
  bucketNameNodeCertificates?: string;
714
- /** Required. pacemaker cluster name */
714
+ /** Required. Pacemaker cluster name. */
715
715
  pacemakerCluster?: string;
716
- /** Required. pacemaker cluster secret name */
716
+ /** Required. Pacemaker cluster secret name. */
717
717
  pacemakerClusterSecret?: string;
718
- /** Required. pacemaker cluster username */
718
+ /** Required. Pacemaker cluster username. */
719
719
  pacemakerClusterUsername?: string;
720
- /** Required. sql pacemaker secret name */
720
+ /** Required. SQL Pacemaker secret name. */
721
721
  sqlPacemakerSecret?: string;
722
- /** Required. sql pacemaker username */
722
+ /** Required. SQL Pacemaker username. */
723
723
  sqlPacemakerUsername?: string;
724
724
  }
725
725
  interface Product {
@@ -1053,39 +1053,39 @@ declare namespace gapi.client {
1053
1053
  }
1054
1054
  interface SapSystemS4Config {
1055
1055
  allowStoppingForUpdate?: boolean;
1056
- /** Ansible runner service account - let custoemrs bring their own SA for Ansible runner */
1056
+ /** Ansible runner service account. Let customers bring their own service account for the Ansible runner. */
1057
1057
  ansibleRunnerServiceAccount?: string;
1058
- /** instance details */
1058
+ /** Instance details. */
1059
1059
  app?: AppDetails;
1060
- /** database details */
1060
+ /** Database details. */
1061
1061
  database?: DatabaseDetails;
1062
- /** Required. two model non-HA and HA supported */
1062
+ /** Required. Supports non-HA and HA models. */
1063
1063
  deploymentModel?:
1064
1064
  | 'DEPLOYMENT_MODEL_UNSPECIFIED'
1065
1065
  | 'DISTRIBUTED'
1066
1066
  | 'DISTRIBUTED_HA';
1067
- /** Required. deployment environment */
1067
+ /** Required. Deployment environment. */
1068
1068
  environmentType?:
1069
1069
  | 'ENVIRONMENT_TYPE_UNSPECIFIED'
1070
1070
  | 'NON_PRODUCTION'
1071
1071
  | 'PRODUCTION';
1072
- /** the project that infrastructure deployed, current only support the same project where the deployment resource exist. */
1072
+ /** The project that infrastructure is deployed in. Currently only supports the same project where the deployment resource exists. */
1073
1073
  gcpProjectId?: string;
1074
- /** database details */
1074
+ /** Database details. */
1075
1075
  location?: LocationDetails;
1076
- /** Required. media_bucket_name */
1076
+ /** Required. Media bucket name. */
1077
1077
  mediaBucketName?: string;
1078
- /** Optional. sap_boot_disk_image */
1078
+ /** Optional. SAP boot disk image. */
1079
1079
  sapBootDiskImage?: string;
1080
- /** Required. support scale up and scale out */
1080
+ /** Required. Supports scale up and scale out. */
1081
1081
  scalingMethod?: 'SCALE_METHOD_UNSPECIFIED' | 'SCALE_UP' | 'SCALE_OUT';
1082
- /** Required. sap hana version */
1082
+ /** Required. SAP HANA version. */
1083
1083
  version?:
1084
1084
  | 'VERSION_UNSPECIFIED'
1085
1085
  | 'S4_HANA_2021'
1086
1086
  | 'S4_HANA_2022'
1087
1087
  | 'S4_HANA_2023';
1088
- /** vm_prefix */
1088
+ /** VM prefix. */
1089
1089
  vmPrefix?: string;
1090
1090
  }
1091
1091
  interface SapValidation {
@@ -1158,26 +1158,26 @@ declare namespace gapi.client {
1158
1158
  timeoutSeconds?: number;
1159
1159
  }
1160
1160
  interface SqlLocationDetails {
1161
- /** Optional. create a new DNS Zone when the field is empty, Only show for `Using an existing DNS` List of existing DNS Zones tf variable name: existing_dns_zone_name */
1161
+ /** Optional. Create a new DNS zone when the field is empty. Only shown for `Using an existing DNS`. List of existing DNS zones. Terraform variable name: existing_dns_zone_name. */
1162
1162
  dnsZone?: string;
1163
- /** Required. the project that infrastructure deployed, currently only supports the same project where the deployment resource exists. */
1163
+ /** Required. The project that infrastructure is deployed in. Currently only supports the same project where the deployment resource exists. */
1164
1164
  gcpProjectId?: string;
1165
- /** Required. Internet Access */
1165
+ /** Required. Internet Access. */
1166
1166
  internetAccess?:
1167
1167
  | 'INTERNET_ACCESS_UNSPECIFIED'
1168
1168
  | 'ALLOW_EXTERNAL_IP'
1169
1169
  | 'CONFIGURE_NAT';
1170
- /** Required. network name */
1170
+ /** Required. Network name. */
1171
1171
  network?: string;
1172
- /** Required. primary zone */
1172
+ /** Required. Primary zone. */
1173
1173
  primaryZone?: string;
1174
- /** Required. region name */
1174
+ /** Required. Region name. */
1175
1175
  region?: string;
1176
- /** Optional. secondary zone can't be same as primary_zone and is only for High Availability deployment mode */
1176
+ /** Optional. Secondary zone cannot be the same as primary_zone and is only for High Availability deployment mode. */
1177
1177
  secondaryZone?: string;
1178
- /** Required. subnetwork name */
1178
+ /** Required. Subnetwork name. */
1179
1179
  subnetwork?: string;
1180
- /** Optional. teriary zone can't be same as primary_zone and secondary zone, and it is only for High Availability deployment mode */
1180
+ /** Optional. Tertiary zone cannot be the same as primary_zone and secondary_zone, and it is only for High Availability deployment mode. */
1181
1181
  tertiaryZone?: string;
1182
1182
  }
1183
1183
  interface SqlserverValidation {
@@ -1214,69 +1214,69 @@ declare namespace gapi.client {
1214
1214
  | 'DB_BACKUP_POLICY';
1215
1215
  }
1216
1216
  interface SqlServerWorkload {
1217
- /** Required. active directory details */
1217
+ /** Required. Active Directory details. */
1218
1218
  activeDirectory?: ActiveDirectory;
1219
- /** Compute engine service account - let customers bring their own SA for Compute engine */
1219
+ /** Compute Engine service account. Let customers bring their own service account for Compute Engine. */
1220
1220
  computeEngineServiceAccount?: string;
1221
- /** Required. database details */
1221
+ /** Required. Database details. */
1222
1222
  database?: Database;
1223
- /** Required. HIGH_AVAILABILITY or SINGLE_INSTANCE */
1223
+ /** Required. HIGH_AVAILABILITY or SINGLE_INSTANCE. */
1224
1224
  deploymentModel?:
1225
1225
  | 'DEPLOYMENT_MODEL_UNSPECIFIED'
1226
1226
  | 'HIGH_AVAILABILITY'
1227
1227
  | 'SINGLE_INSTANCE';
1228
- /** Required. deployment environment */
1228
+ /** Required. Deployment environment. */
1229
1229
  environmentType?:
1230
1230
  | 'ENVIRONMENT_TYPE_UNSPECIFIED'
1231
1231
  | 'NON_PRODUCTION'
1232
1232
  | 'PRODUCTION';
1233
- /** Optional. SHARED_DISK or S2D */
1233
+ /** Optional. SHARED_DISK or S2D. */
1234
1234
  fciType?: 'FCI_TYPE_UNSPECIFIED' | 'SHARED_DISK' | 'S2D';
1235
- /** Optional. AOAG or FCI, it is only needed for High Availability deployment mode */
1235
+ /** Optional. AOAG or FCI. It is only needed for the High Availability deployment mode. */
1236
1236
  haType?: 'HA_TYPE_UNSPECIFIED' | 'AOAG' | 'FCI';
1237
- /** Required. SQL licensing type */
1237
+ /** Required. SQL licensing type. */
1238
1238
  isSqlPayg?: boolean;
1239
- /** Required. location details */
1239
+ /** Required. Location details. */
1240
1240
  location?: SqlLocationDetails;
1241
- /** Required. name of the media storing SQL server installation files */
1241
+ /** Required. Name of the media storing SQL server installation files. */
1242
1242
  mediaBucket?: string;
1243
- /** Required. type of the operating system the SQL server is going to run on top of */
1243
+ /** Required. The type of the operating system the SQL server is going to run on top of. */
1244
1244
  operatingSystemType?:
1245
1245
  | 'OPERATING_SYSTEM_TYPE_UNSPECIFIED'
1246
1246
  | 'WINDOWS'
1247
1247
  | 'UBUNTU'
1248
1248
  | 'RED_HAT_ENTERPRISE_LINUX'
1249
1249
  | 'SUSE';
1250
- /** Required. the image of the operating system */
1250
+ /** Required. The image of the operating system. */
1251
1251
  osImage?: string;
1252
- /** Optional. OS image type, it's used to create boot disks for VM instances When either Windows licensing type or SQL licensing type is BYOL, this option is disabled and default to custom image */
1252
+ /** Optional. OS image type. It's used to create boot disks for VM instances. When either Windows licensing type or SQL licensing type is BYOL, this option is disabled and defaults to a custom image. */
1253
1253
  osImageType?:
1254
1254
  | 'OS_IMAGE_TYPE_UNSPECIFIED'
1255
1255
  | 'PUBLIC_IMAGE'
1256
1256
  | 'CUSTOM_IMAGE';
1257
- /** Optional. pacemaker configuration, only applicable for Linux HA deployments */
1257
+ /** Optional. Pacemaker configuration, only applicable for Linux HA deployments. */
1258
1258
  pacemaker?: Pacemaker;
1259
- /** Optional. SQL Server Edition type, only applicable when Operating System is Linux */
1259
+ /** Optional. SQL Server Edition type, only applicable when the operating system is Linux. */
1260
1260
  sqlServerEdition?:
1261
1261
  | 'SQL_SERVER_EDITION_TYPE_UNSPECIFIED'
1262
1262
  | 'SQL_SERVER_EDITION_TYPE_DEVELOPER'
1263
1263
  | 'SQL_SERVER_EDITION_TYPE_ENTERPRISE'
1264
1264
  | 'SQL_SERVER_EDITION_TYPE_STANDARD'
1265
1265
  | 'SQL_SERVER_EDITION_TYPE_WEB';
1266
- /** Optional. 2017 or 2019 or 2022 */
1266
+ /** Optional. 2017, 2019, or 2022. */
1267
1267
  sqlServerVersion?:
1268
1268
  | 'SQL_SERVER_VERSION_TYPE_UNSPECIFIED'
1269
1269
  | 'SQL_SERVER_VERSION_TYPE_2017'
1270
1270
  | 'SQL_SERVER_VERSION_TYPE_2019'
1271
1271
  | 'SQL_SERVER_VERSION_TYPE_2022';
1272
- /** Required. should be unique in the project */
1272
+ /** Required. Should be unique in the project. */
1273
1273
  vmPrefix?: string;
1274
1274
  }
1275
1275
  interface Status {
1276
1276
  /** The status code, which should be an enum value of google.rpc.Code. */
1277
1277
  code?: number;
1278
1278
  /** A list of messages that carry the error details. There is a common set of message types for APIs to use. */
1279
- details?: Array<{[P in string]: any}>;
1279
+ details?: {[P in string]: any}[];
1280
1280
  /** A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */
1281
1281
  message?: string;
1282
1282
  }
@@ -1377,7 +1377,7 @@ declare namespace gapi.client {
1377
1377
  key?: string;
1378
1378
  /** OAuth 2.0 token for the current user. */
1379
1379
  oauth_token?: string;
1380
- /** Required. The resource name of the Actuation location using the form: 'projects/{project_id}/locations/{location}/deployments/{deployment}' */
1380
+ /** Required. The resource name of the Actuation location using the form: 'projects/{project_id}/locations/{location}/deployments/{deployment}'. */
1381
1381
  parent: string;
1382
1382
  /** Returns response with indentations and line breaks. */
1383
1383
  prettyPrint?: boolean;
@@ -1408,7 +1408,7 @@ declare namespace gapi.client {
1408
1408
  key?: string;
1409
1409
  /** OAuth 2.0 token for the current user. */
1410
1410
  oauth_token?: string;
1411
- /** Required. The resource name of the Actuation location using the form: 'projects/{project_id}/locations/{location}/deployments/{deployment}' */
1411
+ /** Required. The resource name of the Actuation location using the form: 'projects/{project_id}/locations/{location}/deployments/{deployment}'. */
1412
1412
  parent: string;
1413
1413
  /** Returns response with indentations and line breaks. */
1414
1414
  prettyPrint?: boolean;
@@ -1423,7 +1423,7 @@ declare namespace gapi.client {
1423
1423
  },
1424
1424
  body: Actuation,
1425
1425
  ): Request<Operation>;
1426
- /** Deletes a single Actuation */
1426
+ /** Deletes a single Actuation. */
1427
1427
  delete(request?: {
1428
1428
  /** V1 error format. */
1429
1429
  '$.xgafv'?: '1' | '2';
@@ -1437,7 +1437,7 @@ declare namespace gapi.client {
1437
1437
  fields?: string;
1438
1438
  /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1439
1439
  key?: string;
1440
- /** Required. The name of the book to delete. project/{project_id}/locations/{location_id}/deployments/{deployment_id}/actuations/{actuation_id} */
1440
+ /** Required. The name of the actuation to delete. projects/{project}/locations/{location}/deployments/{deployment}/actuations/{actuation}. */
1441
1441
  name: string;
1442
1442
  /** OAuth 2.0 token for the current user. */
1443
1443
  oauth_token?: string;
@@ -1464,7 +1464,7 @@ declare namespace gapi.client {
1464
1464
  fields?: string;
1465
1465
  /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1466
1466
  key?: string;
1467
- /** Required. Name of the resource */
1467
+ /** Required. Name of the resource. */
1468
1468
  name: string;
1469
1469
  /** OAuth 2.0 token for the current user. */
1470
1470
  oauth_token?: string;
@@ -1489,7 +1489,7 @@ declare namespace gapi.client {
1489
1489
  callback?: string;
1490
1490
  /** Selector specifying which fields to include in a partial response. */
1491
1491
  fields?: string;
1492
- /** Optional. Filtering results */
1492
+ /** Optional. Filtering results. */
1493
1493
  filter?: string;
1494
1494
  /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1495
1495
  key?: string;
@@ -1501,7 +1501,7 @@ declare namespace gapi.client {
1501
1501
  pageSize?: number;
1502
1502
  /** Optional. A token identifying a page of results the server should return. */
1503
1503
  pageToken?: string;
1504
- /** Required. The resource prefix of the Actuation using the form: 'projects/{project_id}/locations/{location}/deployments/{deployment}' */
1504
+ /** Required. The resource prefix of the Actuation using the form: 'projects/{project_id}/locations/{location}/deployments/{deployment}'. */
1505
1505
  parent: string;
1506
1506
  /** Returns response with indentations and line breaks. */
1507
1507
  prettyPrint?: boolean;
@@ -1524,7 +1524,7 @@ declare namespace gapi.client {
1524
1524
  alt?: 'json' | 'media' | 'proto';
1525
1525
  /** JSONP */
1526
1526
  callback?: string;
1527
- /** Required. Id of the deployment */
1527
+ /** Required. ID of the deployment. */
1528
1528
  deploymentId?: string;
1529
1529
  /** Selector specifying which fields to include in a partial response. */
1530
1530
  fields?: string;
@@ -1557,7 +1557,7 @@ declare namespace gapi.client {
1557
1557
  alt?: 'json' | 'media' | 'proto';
1558
1558
  /** JSONP */
1559
1559
  callback?: string;
1560
- /** Required. Id of the deployment */
1560
+ /** Required. ID of the deployment. */
1561
1561
  deploymentId?: string;
1562
1562
  /** Selector specifying which fields to include in a partial response. */
1563
1563
  fields?: string;
@@ -1592,11 +1592,11 @@ declare namespace gapi.client {
1592
1592
  callback?: string;
1593
1593
  /** Selector specifying which fields to include in a partial response. */
1594
1594
  fields?: string;
1595
- /** Optional. If set to true, any actuation will also be deleted. Followed the best practice from https://aip.dev/135#cascading-delete */
1595
+ /** Optional. If set to true, any actuation will also be deleted. Follows the best practice from https://aip.dev/135#cascading-delete. */
1596
1596
  force?: boolean;
1597
1597
  /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1598
1598
  key?: string;
1599
- /** Required. Name of the resource */
1599
+ /** Required. Name of the resource. */
1600
1600
  name: string;
1601
1601
  /** OAuth 2.0 token for the current user. */
1602
1602
  oauth_token?: string;
@@ -1623,7 +1623,7 @@ declare namespace gapi.client {
1623
1623
  fields?: string;
1624
1624
  /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1625
1625
  key?: string;
1626
- /** Required. Name of the resource. The format will be 'projects/{project_id}/locations/{location_id}/deployments/{deployment_id}' */
1626
+ /** Required. Name of the resource. The format is 'projects/{project_id}/locations/{location_id}/deployments/{deployment_id}'. */
1627
1627
  name: string;
1628
1628
  /** OAuth 2.0 token for the current user. */
1629
1629
  oauth_token?: string;
@@ -1648,7 +1648,7 @@ declare namespace gapi.client {
1648
1648
  callback?: string;
1649
1649
  /** Selector specifying which fields to include in a partial response. */
1650
1650
  fields?: string;
1651
- /** Optional. Filter resource follow https://google.aip.dev/160 */
1651
+ /** Optional. Filter resource following https://google.aip.dev/160. */
1652
1652
  filter?: string;
1653
1653
  /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1654
1654
  key?: string;
@@ -2529,7 +2529,7 @@ declare namespace gapi.client {
2529
2529
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2530
2530
  uploadType?: string;
2531
2531
  }): Request<Location>;
2532
- /** Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project. */
2532
+ /** Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version. */
2533
2533
  list(request?: {
2534
2534
  /** V1 error format. */
2535
2535
  '$.xgafv'?: '1' | '2';
@@ -2539,7 +2539,7 @@ declare namespace gapi.client {
2539
2539
  alt?: 'json' | 'media' | 'proto';
2540
2540
  /** JSONP */
2541
2541
  callback?: string;
2542
- /** Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */
2542
+ /** Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. */
2543
2543
  extraLocationTypes?: string | string[];
2544
2544
  /** Selector specifying which fields to include in a partial response. */
2545
2545
  fields?: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.workloadmanager-v1",
3
- "version": "0.2.20260217",
3
+ "version": "0.2.20260602",
4
4
  "description": "TypeScript typings for Workload Manager API v1",
5
5
  "repository": {
6
6
  "type": "git",
package/readme.md CHANGED
@@ -11,6 +11,23 @@ Install typings for Workload Manager API:
11
11
  npm install @types/gapi.client.workloadmanager-v1 --save-dev
12
12
  ```
13
13
 
14
+ ## TypeScript 6.0+
15
+
16
+ TypeScript 6.0 changed `types` to default to `[]`. You must now explicitly list type packages in `tsconfig.json`:
17
+
18
+ ```json
19
+ {
20
+ "compilerOptions": {
21
+ "types": [
22
+ "gapi",
23
+ "gapi.auth2",
24
+ "gapi.client",
25
+ "gapi.client.workloadmanager-v1"
26
+ ]
27
+ }
28
+ }
29
+ ```
30
+
14
31
  ## Usage
15
32
 
16
33
  You need to initialize Google API client in your code: