@maxim_mazurok/gapi.client.workstations-v1beta 0.0.20230327 → 0.0.20230412

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 +42 -30
  2. package/package.json +1 -1
  3. package/tests.ts +13 -3
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://workstations.googleapis.com/$discovery/rest?version=v1beta
12
- // Revision: 20230327
12
+ // Revision: 20230412
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -74,7 +74,7 @@ declare namespace gapi.client {
74
74
  command?: string[];
75
75
  /** Environment variables passed to the container. */
76
76
  env?: { [P in string]: string };
77
- /** Docker image defining the container. This image must be accessible by the config's service account. */
77
+ /** Docker image defining the container. This image must be accessible by the service account specified in the workstation configuration. */
78
78
  image?: string;
79
79
  /** If set, overrides the USER specified in the image with the given uid. */
80
80
  runAsUser?: number;
@@ -82,11 +82,11 @@ declare namespace gapi.client {
82
82
  workingDir?: string;
83
83
  }
84
84
  interface CustomerEncryptionKey {
85
- /** The name of the Google Cloud KMS encryption key. For example, `projects/PROJECT_ID/locations/REGION/keyRings/KEY_RING/cryptoKeys/KEY_NAME`. */
85
+ /** Immutable. The name of the Google Cloud KMS encryption key. For example, `projects/PROJECT_ID/locations/REGION/keyRings/KEY_RING/cryptoKeys/KEY_NAME`. */
86
86
  kmsKey?: string;
87
87
  /**
88
- * The service account to use with the specified KMS key. We recommend that you use a separate service account and follow KMS best practices. For more information, see [Separation of
89
- * duties](https://cloud.google.com/kms/docs/separation-of-duties) and `gcloud kms keys add-iam-policy-binding`
88
+ * Immutable. The service account to use with the specified KMS key. We recommend that you use a separate service account and follow KMS best practices. For more information, see
89
+ * [Separation of duties](https://cloud.google.com/kms/docs/separation-of-duties) and `gcloud kms keys add-iam-policy-binding`
90
90
  * [`--member`](https://cloud.google.com/sdk/gcloud/reference/kms/keys/add-iam-policy-binding#--member).
91
91
  */
92
92
  kmsKeyServiceAccount?: string;
@@ -117,8 +117,8 @@ declare namespace gapi.client {
117
117
  /** Number of instances to pool for faster workstation starup. */
118
118
  poolSize?: number;
119
119
  /**
120
- * Email address of the service account that will be used on VM instances used to support this config. If not set, VMs will run with a Google-managed service account. This service
121
- * account must have permission to pull the specified container image, otherwise the image must be publicly accessible.
120
+ * Email address of the service account used on VM instances used to support this configuration. If not set, VMs run with a Google-managed service account. This service account must
121
+ * have permission to pull the specified container image; otherwise, the image must be publicly accessible.
122
122
  */
123
123
  serviceAccount?: string;
124
124
  /** A set of Compute Engine Shielded instance options. */
@@ -363,7 +363,9 @@ declare namespace gapi.client {
363
363
  deleteTime?: string;
364
364
  /** Human-readable name for this resource. */
365
365
  displayName?: string;
366
- /** Checksum computed by the server. May be sent on update and delete requests to ensure that the client has an up-to-date value before proceeding. */
366
+ /** Environment variables passed to the workstation container. */
367
+ env?: { [P in string]: string };
368
+ /** Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding. */
367
369
  etag?: string;
368
370
  /**
369
371
  * Output only. Host to which clients can send HTTPS traffic that will be received by the workstation. Authorized traffic will be received to the workstation as HTTP on port 80. To
@@ -388,6 +390,11 @@ declare namespace gapi.client {
388
390
  annotations?: { [P in string]: string };
389
391
  /** Output only. Status conditions describing the current resource state. */
390
392
  conditions?: Status[];
393
+ /**
394
+ * Output only. The private IP address of the control plane for this cluster. Workstation VMs need access to this IP address to work with the service, so make sure that your firewall
395
+ * rules allow egress from the workstation VMs to this address.
396
+ */
397
+ controlPlaneIp?: string;
391
398
  /** Output only. Time when this resource was created. */
392
399
  createTime?: string;
393
400
  /** Output only. Whether this resource is in degraded mode, in which case it may require user action to restore full functionality. Details can be found in the `conditions` field. */
@@ -396,7 +403,7 @@ declare namespace gapi.client {
396
403
  deleteTime?: string;
397
404
  /** Human-readable name for this resource. */
398
405
  displayName?: string;
399
- /** Checksum computed by the server. May be sent on update and delete requests to ensure that the client has an up-to-date value before proceeding. */
406
+ /** Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding. */
400
407
  etag?: string;
401
408
  /** Client-specified labels that are applied to the resource and that are also propagated to the underlying Compute Engine resources. */
402
409
  labels?: { [P in string]: string };
@@ -431,14 +438,19 @@ declare namespace gapi.client {
431
438
  /** Human-readable name for this resource. */
432
439
  displayName?: string;
433
440
  /**
434
- * Encrypts resources of this workstation configuration using a customer-managed encryption key. If specified, the boot disk of the Compute Engine instance and the persistent disk are
435
- * encrypted using this encryption key. If this field is not set, the disks are encrypted using a generated key. Customer-managed encryption keys do not protect disk metadata. If the
436
- * customer-managed encryption key is rotated, when the workstation instance is stopped, the system attempts to recreate the persistent disk with the new version of the key. Be sure to
437
- * keep older versions of the key until the persistent disk is recreated. Otherwise, data on the persistent disk will be lost. If the encryption key is revoked, the workstation session
438
- * will automatically be stopped within 7 hours.
441
+ * Whether to enable linux auditd logging on the workstation. When enabled, a service account must also be specified that has logging.buckets.write permission on the project. Operating
442
+ * system audit logging is distinct from [Cloud Audit Logs](https://cloud.google.com/workstations/docs/audit-logging).
443
+ */
444
+ enableAuditAgent?: boolean;
445
+ /**
446
+ * Immutable. Encrypts resources of this workstation configuration using a customer-managed encryption key. If specified, the boot disk of the Compute Engine instance and the
447
+ * persistent disk are encrypted using this encryption key. If this field is not set, the disks are encrypted using a generated key. Customer-managed encryption keys do not protect
448
+ * disk metadata. If the customer-managed encryption key is rotated, when the workstation instance is stopped, the system attempts to recreate the persistent disk with the new version
449
+ * of the key. Be sure to keep older versions of the key until the persistent disk is recreated. Otherwise, data on the persistent disk will be lost. If the encryption key is revoked,
450
+ * the workstation session will automatically be stopped within 7 hours. Immutable after the workstation configuration is created.
439
451
  */
440
452
  encryptionKey?: CustomerEncryptionKey;
441
- /** Checksum computed by the server. May be sent on update and delete requests to ensure that the client has an up-to-date value before proceeding. */
453
+ /** Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding. */
442
454
  etag?: string;
443
455
  /** Runtime host for the workstation. */
444
456
  host?: Host;
@@ -835,7 +847,7 @@ declare namespace gapi.client {
835
847
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
836
848
  uploadType?: string;
837
849
  }): Request<Policy>;
838
- /** Returns all Workstations using the specified config. */
850
+ /** Returns all Workstations using the specified workstation configuration. */
839
851
  list(request?: {
840
852
  /** V1 error format. */
841
853
  "$.xgafv"?: string;
@@ -866,7 +878,7 @@ declare namespace gapi.client {
866
878
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
867
879
  uploadType?: string;
868
880
  }): Request<ListWorkstationsResponse>;
869
- /** Returns all Workstations using the specified config on which the caller has the "workstations.workstations.use" permission. */
881
+ /** Returns all workstations using the specified workstation configuration on which the caller has the "workstations.workstations.use" permission. */
870
882
  listUsable(request?: {
871
883
  /** V1 error format. */
872
884
  "$.xgafv"?: string;
@@ -903,7 +915,7 @@ declare namespace gapi.client {
903
915
  "$.xgafv"?: string;
904
916
  /** OAuth access token. */
905
917
  access_token?: string;
906
- /** If set, and the config is not found, a new config will be created. In this situation, update_mask is ignored. */
918
+ /** If set and the workstation configuration is not found, a new workstation configuration is created. In this situation, update_mask is ignored. */
907
919
  allowMissing?: boolean;
908
920
  /** Data format for response. */
909
921
  alt?: string;
@@ -921,7 +933,7 @@ declare namespace gapi.client {
921
933
  prettyPrint?: boolean;
922
934
  /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
923
935
  quotaUser?: string;
924
- /** Required. Mask specifying which fields in the config should be updated. */
936
+ /** Required. Mask specifying which fields in the workstation configuration should be updated. */
925
937
  updateMask?: string;
926
938
  /** Upload protocol for media (e.g. "raw", "multipart"). */
927
939
  upload_protocol?: string;
@@ -937,7 +949,7 @@ declare namespace gapi.client {
937
949
  "$.xgafv"?: string;
938
950
  /** OAuth access token. */
939
951
  access_token?: string;
940
- /** If set, and the config is not found, a new config will be created. In this situation, update_mask is ignored. */
952
+ /** If set and the workstation configuration is not found, a new workstation configuration is created. In this situation, update_mask is ignored. */
941
953
  allowMissing?: boolean;
942
954
  /** Data format for response. */
943
955
  alt?: string;
@@ -955,7 +967,7 @@ declare namespace gapi.client {
955
967
  prettyPrint?: boolean;
956
968
  /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
957
969
  quotaUser?: string;
958
- /** Required. Mask specifying which fields in the config should be updated. */
970
+ /** Required. Mask specifying which fields in the workstation configuration should be updated. */
959
971
  updateMask?: string;
960
972
  /** Upload protocol for media (e.g. "raw", "multipart"). */
961
973
  upload_protocol?: string;
@@ -1172,7 +1184,7 @@ declare namespace gapi.client {
1172
1184
  uploadType?: string;
1173
1185
  /** If set, validate the request and preview the review, but do not actually apply it. */
1174
1186
  validateOnly?: boolean;
1175
- /** Required. ID to use for the config. */
1187
+ /** Required. ID to use for the workstation configuration. */
1176
1188
  workstationConfigId?: string;
1177
1189
  /** Request body */
1178
1190
  resource: WorkstationConfig;
@@ -1204,7 +1216,7 @@ declare namespace gapi.client {
1204
1216
  uploadType?: string;
1205
1217
  /** If set, validate the request and preview the review, but do not actually apply it. */
1206
1218
  validateOnly?: boolean;
1207
- /** Required. ID to use for the config. */
1219
+ /** Required. ID to use for the workstation configuration. */
1208
1220
  workstationConfigId?: string;
1209
1221
  },
1210
1222
  body: WorkstationConfig): Request<Operation>;
@@ -1218,15 +1230,15 @@ declare namespace gapi.client {
1218
1230
  alt?: string;
1219
1231
  /** JSONP */
1220
1232
  callback?: string;
1221
- /** If set, the request will be rejected if the latest version of the config on the server does not have this etag. */
1233
+ /** If set, the request is rejected if the latest version of the workstation configuration on the server does not have this etag. */
1222
1234
  etag?: string;
1223
1235
  /** Selector specifying which fields to include in a partial response. */
1224
1236
  fields?: string;
1225
- /** If set, any Workstations in the config will also be deleted. Otherwise, the request will work only if the config has no workstations. */
1237
+ /** If set, any workstations in the workstation configuration are also deleted. Otherwise, the request works only if the workstation configuration has no workstations. */
1226
1238
  force?: boolean;
1227
1239
  /** 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. */
1228
1240
  key?: string;
1229
- /** Required. Name of the config to delete. */
1241
+ /** Required. Name of the workstation configuration to delete. */
1230
1242
  name: string;
1231
1243
  /** OAuth 2.0 token for the current user. */
1232
1244
  oauth_token?: string;
@@ -1374,7 +1386,7 @@ declare namespace gapi.client {
1374
1386
  "$.xgafv"?: string;
1375
1387
  /** OAuth access token. */
1376
1388
  access_token?: string;
1377
- /** If set, and the config is not found, a new config will be created. In this situation, update_mask is ignored. */
1389
+ /** If set and the workstation configuration is not found, a new workstation configuration will be created. In this situation, update_mask is ignored. */
1378
1390
  allowMissing?: boolean;
1379
1391
  /** Data format for response. */
1380
1392
  alt?: string;
@@ -1392,7 +1404,7 @@ declare namespace gapi.client {
1392
1404
  prettyPrint?: boolean;
1393
1405
  /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1394
1406
  quotaUser?: string;
1395
- /** Required. Mask specifying which fields in the config should be updated. */
1407
+ /** Required. Mask specifying which fields in the workstation configuration should be updated. */
1396
1408
  updateMask?: string;
1397
1409
  /** Upload protocol for media (e.g. "raw", "multipart"). */
1398
1410
  upload_protocol?: string;
@@ -1408,7 +1420,7 @@ declare namespace gapi.client {
1408
1420
  "$.xgafv"?: string;
1409
1421
  /** OAuth access token. */
1410
1422
  access_token?: string;
1411
- /** If set, and the config is not found, a new config will be created. In this situation, update_mask is ignored. */
1423
+ /** If set and the workstation configuration is not found, a new workstation configuration will be created. In this situation, update_mask is ignored. */
1412
1424
  allowMissing?: boolean;
1413
1425
  /** Data format for response. */
1414
1426
  alt?: string;
@@ -1426,7 +1438,7 @@ declare namespace gapi.client {
1426
1438
  prettyPrint?: boolean;
1427
1439
  /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1428
1440
  quotaUser?: string;
1429
- /** Required. Mask specifying which fields in the config should be updated. */
1441
+ /** Required. Mask specifying which fields in the workstation configuration should be updated. */
1430
1442
  updateMask?: string;
1431
1443
  /** Upload protocol for media (e.g. "raw", "multipart"). */
1432
1444
  upload_protocol?: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.workstations-v1beta",
3
- "version": "0.0.20230327",
3
+ "version": "0.0.20230412",
4
4
  "description": "TypeScript typings for Cloud Workstations API v1beta",
5
5
  "license": "MIT",
6
6
  "author": {
package/tests.ts CHANGED
@@ -3,7 +3,7 @@
3
3
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
4
4
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
5
5
 
6
- // Revision: 20230327
6
+ // Revision: 20230412
7
7
 
8
8
  gapi.load('client', async () => {
9
9
  /** now we can use gapi.client */
@@ -77,6 +77,7 @@ gapi.load('client', async () => {
77
77
  message: "Test string",
78
78
  }
79
79
  ],
80
+ controlPlaneIp: "Test string",
80
81
  createTime: "Test string",
81
82
  degraded: true,
82
83
  deleteTime: "Test string",
@@ -138,6 +139,7 @@ gapi.load('client', async () => {
138
139
  message: "Test string",
139
140
  }
140
141
  ],
142
+ controlPlaneIp: "Test string",
141
143
  createTime: "Test string",
142
144
  degraded: true,
143
145
  deleteTime: "Test string",
@@ -199,6 +201,7 @@ gapi.load('client', async () => {
199
201
  degraded: true,
200
202
  deleteTime: "Test string",
201
203
  displayName: "Test string",
204
+ enableAuditAgent: true,
202
205
  encryptionKey: {
203
206
  kmsKey: "Test string",
204
207
  kmsKeyServiceAccount: "Test string",
@@ -313,6 +316,7 @@ gapi.load('client', async () => {
313
316
  degraded: true,
314
317
  deleteTime: "Test string",
315
318
  displayName: "Test string",
319
+ enableAuditAgent: true,
316
320
  encryptionKey: {
317
321
  kmsKey: "Test string",
318
322
  kmsKeyServiceAccount: "Test string",
@@ -420,6 +424,9 @@ gapi.load('client', async () => {
420
424
  createTime: "Test string",
421
425
  deleteTime: "Test string",
422
426
  displayName: "Test string",
427
+ env: {
428
+ A: "Test string"
429
+ },
423
430
  etag: "Test string",
424
431
  host: "Test string",
425
432
  labels: {
@@ -453,13 +460,13 @@ gapi.load('client', async () => {
453
460
  "options.requestedPolicyVersion": 42,
454
461
  resource: "Test string",
455
462
  });
456
- /** Returns all Workstations using the specified config. */
463
+ /** Returns all Workstations using the specified workstation configuration. */
457
464
  await gapi.client.workstations.projects.locations.workstationClusters.workstationConfigs.workstations.list({
458
465
  pageSize: 42,
459
466
  pageToken: "Test string",
460
467
  parent: "Test string",
461
468
  });
462
- /** Returns all Workstations using the specified config on which the caller has the "workstations.workstations.use" permission. */
469
+ /** Returns all workstations using the specified workstation configuration on which the caller has the "workstations.workstations.use" permission. */
463
470
  await gapi.client.workstations.projects.locations.workstationClusters.workstationConfigs.workstations.listUsable({
464
471
  pageSize: 42,
465
472
  pageToken: "Test string",
@@ -478,6 +485,9 @@ gapi.load('client', async () => {
478
485
  createTime: "Test string",
479
486
  deleteTime: "Test string",
480
487
  displayName: "Test string",
488
+ env: {
489
+ A: "Test string"
490
+ },
481
491
  etag: "Test string",
482
492
  host: "Test string",
483
493
  labels: {