@maxim_mazurok/gapi.client.composer-v1 0.0.20231105 → 0.0.20231205

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/index.d.ts CHANGED
@@ -9,1874 +9,1168 @@
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://composer.googleapis.com/$discovery/rest?version=v1
12
- // Revision: 20231105
12
+ // Revision: 20231205
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
16
16
  declare namespace gapi.client {
17
- /** Load Cloud Composer API v1 */
18
- function load(urlOrObject: "https://composer.googleapis.com/$discovery/rest?version=v1"): Promise<void>;
19
- /** @deprecated Please load APIs with discovery documents. */
20
- function load(name: "composer", version: "v1"): Promise<void>;
21
- /** @deprecated Please load APIs with discovery documents. */
22
- function load(name: "composer", version: "v1", callback: () => any): void;
17
+ /** Load Cloud Composer API v1 */
18
+ function load(
19
+ urlOrObject: 'https://composer.googleapis.com/$discovery/rest?version=v1'
20
+ ): Promise<void>;
21
+ /** @deprecated Please load APIs with discovery documents. */
22
+ function load(name: 'composer', version: 'v1'): Promise<void>;
23
+ /** @deprecated Please load APIs with discovery documents. */
24
+ function load(name: 'composer', version: 'v1', callback: () => any): void;
23
25
 
24
- namespace composer {
25
- interface AllowedIpRange {
26
- /** Optional. User-provided description. It must contain at most 300 characters. */
27
- description?:
28
- string;
29
- /**
30
- * IP address or range, defined using CIDR notation, of requests that this rule applies to. Examples: `192.168.1.1` or `192.168.0.0/16` or `2001:db8::/32` or
31
- * `2001:0db8:0000:0042:0000:8a2e:0370:7334`. IP range prefixes should be properly truncated. For example, `1.2.3.4/24` should be truncated to `1.2.3.0/24`. Similarly, for IPv6,
32
- * `2001:db8::1/32` should be truncated to `2001:db8::/32`.
33
- */
34
- value?:
35
- string;
36
- }
37
- interface CheckUpgradeResponse {
38
- /** Output only. Url for a docker build log of an upgraded image. */
39
- buildLogUri?:
40
- string;
41
- /** Output only. Whether build has succeeded or failed on modules conflicts. */
42
- containsPypiModulesConflict?:
43
- string;
44
- /** Composer image for which the build was happening. */
45
- imageVersion?:
46
- string;
47
- /** Output only. Extract from a docker image build log containing information about pypi modules conflicts. */
48
- pypiConflictBuildLogExtract?:
49
- string;
50
- /** Pypi dependencies specified in the environment configuration, at the time when the build was triggered. */
51
- pypiDependencies?:
52
- { [P in string]: string };
53
- }
54
- interface CidrBlock {
55
- /** CIDR block that must be specified in CIDR notation. */
56
- cidrBlock?:
57
- string;
58
- /** User-defined name that identifies the CIDR block. */
59
- displayName?:
60
- string;
61
- }
62
- interface DatabaseConfig {
63
- /**
64
- * Optional. Cloud SQL machine type used by Airflow database. It has to be one of: db-n1-standard-2, db-n1-standard-4, db-n1-standard-8 or db-n1-standard-16. If not specified,
65
- * db-n1-standard-2 will be used. Supported for Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*.
66
- */
67
- machineType?:
68
- string;
69
- /**
70
- * Optional. The Compute Engine zone where the Airflow database is created. If zone is provided, it must be in the region selected for the environment. If zone is not provided, a zone
71
- * is automatically selected. The zone can only be set during environment creation. Supported for Cloud Composer environments in versions composer-2.*.*-airflow-*.*.*.
72
- */
73
- zone?:
74
- string;
75
- }
76
- // tslint:disable-next-line:no-empty-interface
77
- interface DatabaseFailoverRequest {
78
- }
79
- // tslint:disable-next-line:no-empty-interface
80
- interface DatabaseFailoverResponse {
81
- }
82
- interface Date {
83
- /** Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. */
84
- day?:
85
- number;
86
- /** Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. */
87
- month?:
88
- number;
89
- /** Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. */
90
- year?:
91
- number;
92
- }
93
- // tslint:disable-next-line:no-empty-interface
94
- interface Empty {
95
- }
96
- interface EncryptionConfig {
97
- /** Optional. Customer-managed Encryption Key available through Google's Key Management Service. Cannot be updated. If not specified, Google-managed key will be used. */
98
- kmsKeyName?:
99
- string;
100
- }
101
- interface Environment {
102
- /** Configuration parameters for this environment. */
103
- config?:
104
- EnvironmentConfig;
105
- /** Output only. The time at which this environment was created. */
106
- createTime?:
107
- string;
108
- /**
109
- * Optional. User-defined labels for this environment. The labels map can contain no more than 64 entries. Entries of the labels map are UTF8 strings that comply with the following
110
- * restrictions: * Keys must conform to regexp: \p{Ll}\p{Lo}{0,62} * Values must conform to regexp: [\p{Ll}\p{Lo}\p{N}_-]{0,63} * Both keys and values are additionally constrained to
111
- * be <= 128 bytes in size.
112
- */
113
- labels?:
114
- { [P in string]: string };
115
- /**
116
- * The resource name of the environment, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" EnvironmentId must start with a lowercase letter
117
- * followed by up to 63 lowercase letters, numbers, or hyphens, and cannot end with a hyphen.
118
- */
119
- name?:
120
- string;
121
- /** Output only. Reserved for future use. */
122
- satisfiesPzs?:
123
- boolean;
124
- /** The current state of the environment. */
125
- state?:
126
- string;
127
- /** Optional. Storage configuration for this environment. */
128
- storageConfig?:
129
- StorageConfig;
130
- /** Output only. The time at which this environment was last modified. */
131
- updateTime?:
132
- string;
133
- /** Output only. The UUID (Universally Unique IDentifier) associated with this environment. This value is generated when the environment is created. */
134
- uuid?:
135
- string;
136
- }
137
- interface EnvironmentConfig {
138
- /**
139
- * Output only. The 'bring your own identity' variant of the URI of the Apache Airflow Web UI hosted within this environment, to be accessed with external identities using workforce
140
- * identity federation (see [Access environments with workforce identity federation](/composer/docs/composer-2/access-environments-with-workforce-identity-federation)).
141
- */
142
- airflowByoidUri?:
143
- string;
144
- /** Output only. The URI of the Apache Airflow Web UI hosted within this environment (see [Airflow web interface](/composer/docs/how-to/accessing/airflow-web-interface)). */
145
- airflowUri?:
146
- string;
147
- /**
148
- * Output only. The Cloud Storage prefix of the DAGs for this environment. Although Cloud Storage objects reside in a flat namespace, a hierarchical file tree can be simulated using
149
- * "/"-delimited object name prefixes. DAG objects for this environment reside in a simulated directory with the given prefix.
150
- */
151
- dagGcsPrefix?:
152
- string;
153
- /** Optional. The configuration settings for Cloud SQL instance used internally by Apache Airflow software. */
154
- databaseConfig?:
155
- DatabaseConfig;
156
- /** Optional. The encryption options for the Cloud Composer environment and its dependencies. Cannot be updated. */
157
- encryptionConfig?:
158
- EncryptionConfig;
159
- /** Optional. The size of the Cloud Composer environment. This field is supported for Cloud Composer environments in versions composer-2.*.*-airflow-*.*.* and newer. */
160
- environmentSize?:
161
- string;
162
- /** Output only. The Kubernetes Engine cluster used to run this environment. */
163
- gkeCluster?:
164
- string;
165
- /**
166
- * Optional. The maintenance window is the period when Cloud Composer components may undergo maintenance. It is defined so that maintenance is not executed during peak hours or
167
- * critical time periods. The system will not be under maintenance for every occurrence of this window, but when maintenance is planned, it will be scheduled during the window. The
168
- * maintenance window period must encompass at least 12 hours per week. This may be split into multiple chunks, each with a size of at least 4 hours. If this value is omitted, the
169
- * default value for maintenance window will be applied. The default value is Saturday and Sunday 00-06 GMT.
170
- */
171
- maintenanceWindow?:
172
- MaintenanceWindow;
173
- /**
174
- * Optional. The configuration options for GKE cluster master authorized networks. By default master authorized networks feature is: - in case of private environment: enabled with no
175
- * external networks allowlisted. - in case of public environment: disabled.
176
- */
177
- masterAuthorizedNetworksConfig?:
178
- MasterAuthorizedNetworksConfig;
179
- /** The configuration used for the Kubernetes Engine cluster. */
180
- nodeConfig?:
181
- NodeConfig;
182
- /**
183
- * The number of nodes in the Kubernetes Engine cluster that will be used to run this environment. This field is supported for Cloud Composer environments in versions
184
- * composer-1.*.*-airflow-*.*.*.
185
- */
186
- nodeCount?:
187
- number;
188
- /** The configuration used for the Private IP Cloud Composer environment. */
189
- privateEnvironmentConfig?:
190
- PrivateEnvironmentConfig;
191
- /** Optional. The Recovery settings configuration of an environment. This field is supported for Cloud Composer environments in versions composer-2.*.*-airflow-*.*.* and newer. */
192
- recoveryConfig?:
193
- RecoveryConfig;
194
- /** Optional. Resilience mode of the Cloud Composer Environment. This field is supported for Cloud Composer environments in versions composer-2.2.0-airflow-*.*.* and newer. */
195
- resilienceMode?:
196
- string;
197
- /** The configuration settings for software inside the environment. */
198
- softwareConfig?:
199
- SoftwareConfig;
200
- /** Optional. The configuration settings for the Airflow web server App Engine instance. */
201
- webServerConfig?:
202
- WebServerConfig;
203
- /** Optional. The network-level access control policy for the Airflow web server. If unspecified, no network-level access restrictions will be applied. */
204
- webServerNetworkAccessControl?:
205
- WebServerNetworkAccessControl;
206
- /**
207
- * Optional. The workloads configuration settings for the GKE cluster associated with the Cloud Composer environment. The GKE cluster runs Airflow scheduler, web server and workers
208
- * workloads. This field is supported for Cloud Composer environments in versions composer-2.*.*-airflow-*.*.* and newer.
209
- */
210
- workloadsConfig?:
211
- WorkloadsConfig;
212
- }
213
- interface ExecuteAirflowCommandRequest {
214
- /** Airflow command. */
215
- command?:
216
- string;
217
- /**
218
- * Parameters for the Airflow command/subcommand as an array of arguments. It may contain positional arguments like `["my-dag-id"]`, key-value parameters like `["--foo=bar"]` or
219
- * `["--foo","bar"]`, or other flags like `["-f"]`.
220
- */
221
- parameters?:
222
- string[];
223
- /** Airflow subcommand. */
224
- subcommand?:
225
- string;
226
- }
227
- interface ExecuteAirflowCommandResponse {
228
- /** Error message. Empty if there was no error. */
229
- error?:
230
- string;
231
- /** The unique ID of the command execution for polling. */
232
- executionId?:
233
- string;
234
- /** The name of the pod where the command is executed. */
235
- pod?:
236
- string;
237
- /** The namespace of the pod where the command is executed. */
238
- podNamespace?:
239
- string;
240
- }
241
- interface ExitInfo {
242
- /** Error message. Empty if there was no error. */
243
- error?:
244
- string;
245
- /** The exit code from the command execution. */
246
- exitCode?:
247
- number;
248
- }
249
- interface FetchDatabasePropertiesResponse {
250
- /**
251
- * The availability status of the failover replica. A false status indicates that the failover replica is out of sync. The primary instance can only fail over to the failover replica
252
- * when the status is true.
253
- */
254
- isFailoverReplicaAvailable?:
255
- boolean;
256
- /** The Compute Engine zone that the instance is currently serving from. */
257
- primaryGceZone?:
258
- string;
259
- /** The Compute Engine zone that the failover instance is currently serving from for a regional Cloud SQL instance. */
260
- secondaryGceZone?:
261
- string;
262
- }
263
- interface ImageVersion {
264
- /** Whether it is impossible to create an environment with the image version. */
265
- creationDisabled?:
266
- boolean;
267
- /** The string identifier of the ImageVersion, in the form: "composer-x.y.z-airflow-a.b.c" */
268
- imageVersionId?:
269
- string;
270
- /** Whether this is the default ImageVersion used by Composer during environment creation if no input ImageVersion is specified. */
271
- isDefault?:
272
- boolean;
273
- /** The date of the version release. */
274
- releaseDate?:
275
- Date;
276
- /** supported python versions */
277
- supportedPythonVersions?:
278
- string[];
279
- /** Whether it is impossible to upgrade an environment running with the image version. */
280
- upgradeDisabled?:
281
- boolean;
282
- }
283
- // tslint:disable-next-line:interface-name
284
- interface IPAllocationPolicy {
285
- /**
286
- * Optional. The IP address range used to allocate IP addresses to pods in the GKE cluster. For Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*, this field is
287
- * applicable only when `use_ip_aliases` is true. Set to blank to have GKE choose a range with the default size. Set to /netmask (e.g. `/14`) to have GKE choose a range with a specific
288
- * netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`,
289
- * `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use.
290
- */
291
- clusterIpv4CidrBlock?:
292
- string;
293
- /**
294
- * Optional. The name of the GKE cluster's secondary range used to allocate IP addresses to pods. For Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*, this field
295
- * is applicable only when `use_ip_aliases` is true.
296
- */
297
- clusterSecondaryRangeName?:
298
- string;
299
- /**
300
- * Optional. The IP address range of the services IP addresses in this GKE cluster. For Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*, this field is applicable
301
- * only when `use_ip_aliases` is true. Set to blank to have GKE choose a range with the default size. Set to /netmask (e.g. `/14`) to have GKE choose a range with a specific netmask.
302
- * Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`,
303
- * `192.168.0.0/16`) to pick a specific range to use.
304
- */
305
- servicesIpv4CidrBlock?:
306
- string;
307
- /**
308
- * Optional. The name of the services' secondary range used to allocate IP addresses to the GKE cluster. For Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*, this
309
- * field is applicable only when `use_ip_aliases` is true.
310
- */
311
- servicesSecondaryRangeName?:
312
- string;
313
- /**
314
- * Optional. Whether or not to enable Alias IPs in the GKE cluster. If `true`, a VPC-native cluster is created. This field is only supported for Cloud Composer environments in versions
315
- * composer-1.*.*-airflow-*.*.*. Environments in newer versions always use VPC-native GKE clusters.
316
- */
317
- useIpAliases?:
318
- boolean;
319
- }
320
- interface Line {
321
- /** Text content of the log line. */
322
- content?:
323
- string;
324
- /** Number of the line. */
325
- lineNumber?:
326
- number;
327
- }
328
- interface ListEnvironmentsResponse {
329
- /** The list of environments returned by a ListEnvironmentsRequest. */
330
- environments?:
331
- Environment[];
332
- /** The page token used to query for the next page if one exists. */
333
- nextPageToken?:
334
- string;
335
- }
336
- interface ListImageVersionsResponse {
337
- /** The list of supported ImageVersions in a location. */
338
- imageVersions?:
339
- ImageVersion[];
340
- /** The page token used to query for the next page if one exists. */
341
- nextPageToken?:
342
- string;
343
- }
344
- interface ListOperationsResponse {
345
- /** The standard List next-page token. */
346
- nextPageToken?:
347
- string;
348
- /** A list of operations that matches the specified filter in the request. */
349
- operations?:
350
- Operation[];
351
- }
352
- interface LoadSnapshotRequest {
353
- /** Whether or not to skip setting Airflow overrides when loading the environment's state. */
354
- skipAirflowOverridesSetting?:
355
- boolean;
356
- /** Whether or not to skip setting environment variables when loading the environment's state. */
357
- skipEnvironmentVariablesSetting?:
358
- boolean;
359
- /** Whether or not to skip copying Cloud Storage data when loading the environment's state. */
360
- skipGcsDataCopying?:
361
- boolean;
362
- /** Whether or not to skip installing Pypi packages when loading the environment's state. */
363
- skipPypiPackagesInstallation?:
364
- boolean;
365
- /** A Cloud Storage path to a snapshot to load, e.g.: "gs://my-bucket/snapshots/project_location_environment_timestamp". */
366
- snapshotPath?:
367
- string;
368
- }
369
- // tslint:disable-next-line:no-empty-interface
370
- interface LoadSnapshotResponse {
371
- }
372
- interface MaintenanceWindow {
373
- /** Required. Maintenance window end time. It is used only to calculate the duration of the maintenance window. The value for end-time must be in the future, relative to `start_time`. */
374
- endTime?:
375
- string;
376
- /**
377
- * Required. Maintenance window recurrence. Format is a subset of [RFC-5545](https://tools.ietf.org/html/rfc5545) `RRULE`. The only allowed values for `FREQ` field are `FREQ=DAILY` and
378
- * `FREQ=WEEKLY;BYDAY=...` Example values: `FREQ=WEEKLY;BYDAY=TU,WE`, `FREQ=DAILY`.
379
- */
380
- recurrence?:
381
- string;
382
- /** Required. Start time of the first recurrence of the maintenance window. */
383
- startTime?:
384
- string;
385
- }
386
- interface MasterAuthorizedNetworksConfig {
387
- /** Up to 50 external networks that could access Kubernetes master through HTTPS. */
388
- cidrBlocks?:
389
- CidrBlock[];
390
- /** Whether or not master authorized networks feature is enabled. */
391
- enabled?:
392
- boolean;
393
- }
394
- interface NetworkingConfig {
395
- /** Optional. Indicates the user requested specifc connection type between Tenant and Customer projects. You cannot set networking connection type in public IP environment. */
396
- connectionType?:
397
- string;
398
- }
399
- interface NodeConfig {
400
- /**
401
- * Optional. The disk size in GB used for node VMs. Minimum size is 30GB. If unspecified, defaults to 100GB. Cannot be updated. This field is supported for Cloud Composer environments
402
- * in versions composer-1.*.*-airflow-*.*.*.
403
- */
404
- diskSizeGb?:
405
- number;
406
- /**
407
- * Optional. Deploys 'ip-masq-agent' daemon set in the GKE cluster and defines nonMasqueradeCIDRs equals to pod IP range so IP masquerading is used for all destination addresses,
408
- * except between pods traffic. See: https://cloud.google.com/kubernetes-engine/docs/how-to/ip-masquerade-agent
409
- */
410
- enableIpMasqAgent?:
411
- boolean;
412
- /** Optional. The configuration for controlling how IPs are allocated in the GKE cluster. */
413
- ipAllocationPolicy?:
414
- IPAllocationPolicy;
415
- /**
416
- * Optional. The Compute Engine [zone](/compute/docs/regions-zones) in which to deploy the VMs used to run the Apache Airflow software, specified as a [relative resource
417
- * name](/apis/design/resource_names#relative_resource_name). For example: "projects/{projectId}/zones/{zoneId}". This `location` must belong to the enclosing environment's project and
418
- * location. If both this field and `nodeConfig.machineType` are specified, `nodeConfig.machineType` must belong to this `location`; if both are unspecified, the service will pick a
419
- * zone in the Compute Engine region corresponding to the Cloud Composer location, and propagate that choice to both fields. If only one field (`location` or `nodeConfig.machineType`)
420
- * is specified, the location information from the specified field will be propagated to the unspecified field. This field is supported for Cloud Composer environments in versions
421
- * composer-1.*.*-airflow-*.*.*.
422
- */
423
- location?:
424
- string;
425
- /**
426
- * Optional. The Compute Engine [machine type](/compute/docs/machine-types) used for cluster instances, specified as a [relative resource
427
- * name](/apis/design/resource_names#relative_resource_name). For example: "projects/{projectId}/zones/{zoneId}/machineTypes/{machineTypeId}". The `machineType` must belong to the
428
- * enclosing environment's project and location. If both this field and `nodeConfig.location` are specified, this `machineType` must belong to the `nodeConfig.location`; if both are
429
- * unspecified, the service will pick a zone in the Compute Engine region corresponding to the Cloud Composer location, and propagate that choice to both fields. If exactly one of this
430
- * field and `nodeConfig.location` is specified, the location information from the specified field will be propagated to the unspecified field. The `machineTypeId` must not be a
431
- * [shared-core machine type](/compute/docs/machine-types#sharedcore). If this field is unspecified, the `machineTypeId` defaults to "n1-standard-1". This field is supported for Cloud
432
- * Composer environments in versions composer-1.*.*-airflow-*.*.*.
433
- */
434
- machineType?:
435
- string;
436
- /**
437
- * Optional. The Compute Engine network to be used for machine communications, specified as a [relative resource name](/apis/design/resource_names#relative_resource_name). For example:
438
- * "projects/{projectId}/global/networks/{networkId}". If unspecified, the "default" network ID in the environment's project is used. If a [Custom Subnet
439
- * Network](/vpc/docs/vpc#vpc_networks_and_subnets) is provided, `nodeConfig.subnetwork` must also be provided. For [Shared VPC](/vpc/docs/shared-vpc) subnetwork requirements, see
440
- * `nodeConfig.subnetwork`.
441
- */
442
- network?:
443
- string;
444
- /**
445
- * Optional. The set of Google API scopes to be made available on all node VMs. If `oauth_scopes` is empty, defaults to ["https://www.googleapis.com/auth/cloud-platform"]. Cannot be
446
- * updated. This field is supported for Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*.
447
- */
448
- oauthScopes?:
449
- string[];
450
- /**
451
- * Optional. The Google Cloud Platform Service Account to be used by the node VMs. If a service account is not specified, the "default" Compute Engine service account is used. Cannot
452
- * be updated.
453
- */
454
- serviceAccount?:
455
- string;
456
- /**
457
- * Optional. The Compute Engine subnetwork to be used for machine communications, specified as a [relative resource name](/apis/design/resource_names#relative_resource_name). For
458
- * example: "projects/{projectId}/regions/{regionId}/subnetworks/{subnetworkId}" If a subnetwork is provided, `nodeConfig.network` must also be provided, and the subnetwork must belong
459
- * to the enclosing environment's project and location.
460
- */
461
- subnetwork?:
462
- string;
463
- /**
464
- * Optional. The list of instance tags applied to all node VMs. Tags are used to identify valid sources or targets for network firewalls. Each tag within the list must comply with
465
- * [RFC1035](https://www.ietf.org/rfc/rfc1035.txt). Cannot be updated.
466
- */
467
- tags?:
468
- string[];
469
- }
470
- interface Operation {
471
- /** If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */
472
- done?:
473
- boolean;
474
- /** The error result of the operation in case of failure or cancellation. */
475
- error?:
476
- Status;
477
- /**
478
- * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such
479
- * metadata. Any method that returns a long-running operation should document the metadata type, if any.
480
- */
481
- metadata?:
482
- { [P in string]: any };
483
- /**
484
- * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending
485
- * with `operations/{unique_id}`.
486
- */
487
- name?:
488
- string;
489
- /**
490
- * The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original
491
- * method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original
492
- * method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
493
- */
494
- response?:
495
- { [P in string]: any };
496
- }
497
- interface OperationMetadata {
498
- /** Output only. The time the operation was submitted to the server. */
499
- createTime?:
500
- string;
501
- /** Output only. The time when the operation terminated, regardless of its success. This field is unset if the operation is still ongoing. */
502
- endTime?:
503
- string;
504
- /** Output only. The type of operation being performed. */
505
- operationType?:
506
- string;
507
- /** Output only. The resource being operated on, as a [relative resource name]( /apis/design/resource_names#relative_resource_name). */
508
- resource?:
509
- string;
510
- /** Output only. The UUID of the resource being operated on. */
511
- resourceUuid?:
512
- string;
513
- /** Output only. The current operation state. */
514
- state?:
515
- string;
516
- }
517
- interface PollAirflowCommandRequest {
518
- /** The unique ID of the command execution. */
519
- executionId?:
520
- string;
521
- /** Line number from which new logs should be fetched. */
522
- nextLineNumber?:
523
- number;
524
- /** The name of the pod where the command is executed. */
525
- pod?:
526
- string;
527
- /** The namespace of the pod where the command is executed. */
528
- podNamespace?:
529
- string;
530
- }
531
- interface PollAirflowCommandResponse {
532
- /** The result exit status of the command. */
533
- exitInfo?:
534
- ExitInfo;
535
- /** Output from the command execution. It may not contain the full output and the caller may need to poll for more lines. */
536
- output?:
537
- Line[];
538
- /** Whether the command execution has finished and there is no more output. */
539
- outputEnd?:
540
- boolean;
541
- }
542
- interface PrivateClusterConfig {
543
- /** Optional. If `true`, access to the public endpoint of the GKE cluster is denied. */
544
- enablePrivateEndpoint?:
545
- boolean;
546
- /** Optional. The CIDR block from which IPv4 range for GKE master will be reserved. If left blank, the default value of '172.16.0.0/23' is used. */
547
- masterIpv4CidrBlock?:
548
- string;
549
- /**
550
- * Output only. The IP range in CIDR notation to use for the hosted master network. This range is used for assigning internal IP addresses to the GKE cluster master or set of masters
551
- * and to the internal load balancer virtual IP. This range must not overlap with any other ranges in use within the cluster's network.
552
- */
553
- masterIpv4ReservedRange?:
554
- string;
555
- }
556
- interface PrivateEnvironmentConfig {
557
- /**
558
- * Optional. When specified, the environment will use Private Service Connect instead of VPC peerings to connect to Cloud SQL in the Tenant Project, and the PSC endpoint in the
559
- * Customer Project will use an IP address from this subnetwork.
560
- */
561
- cloudComposerConnectionSubnetwork?:
562
- string;
563
- /**
564
- * Optional. The CIDR block from which IP range for Cloud Composer Network in tenant project will be reserved. Needs to be disjoint from private_cluster_config.master_ipv4_cidr_block
565
- * and cloud_sql_ipv4_cidr_block. This field is supported for Cloud Composer environments in versions composer-2.*.*-airflow-*.*.* and newer.
566
- */
567
- cloudComposerNetworkIpv4CidrBlock?:
568
- string;
569
- /**
570
- * Output only. The IP range reserved for the tenant project's Cloud Composer network. This field is supported for Cloud Composer environments in versions composer-2.*.*-airflow-*.*.*
571
- * and newer.
572
- */
573
- cloudComposerNetworkIpv4ReservedRange?:
574
- string;
575
- /** Optional. The CIDR block from which IP range in tenant project will be reserved for Cloud SQL. Needs to be disjoint from `web_server_ipv4_cidr_block`. */
576
- cloudSqlIpv4CidrBlock?:
577
- string;
578
- /**
579
- * Optional. If `true`, a Private IP Cloud Composer environment is created. If this field is set to true, `IPAllocationPolicy.use_ip_aliases` must be set to true for Cloud Composer
580
- * environments in versions composer-1.*.*-airflow-*.*.*.
581
- */
582
- enablePrivateEnvironment?:
583
- boolean;
584
- /** Optional. When enabled, IPs from public (non-RFC1918) ranges can be used for `IPAllocationPolicy.cluster_ipv4_cidr_block` and `IPAllocationPolicy.service_ipv4_cidr_block`. */
585
- enablePrivatelyUsedPublicIps?:
586
- boolean;
587
- /** Optional. Configuration for the network connections configuration in the environment. */
588
- networkingConfig?:
589
- NetworkingConfig;
590
- /** Optional. Configuration for the private GKE cluster for a Private IP Cloud Composer environment. */
591
- privateClusterConfig?:
592
- PrivateClusterConfig;
593
- /**
594
- * Optional. The CIDR block from which IP range for web server will be reserved. Needs to be disjoint from `private_cluster_config.master_ipv4_cidr_block` and
595
- * `cloud_sql_ipv4_cidr_block`. This field is supported for Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*.
596
- */
597
- webServerIpv4CidrBlock?:
598
- string;
599
- /** Output only. The IP range reserved for the tenant project's App Engine VMs. This field is supported for Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*. */
600
- webServerIpv4ReservedRange?:
601
- string;
602
- }
603
- interface RecoveryConfig {
604
- /** Optional. The configuration for scheduled snapshot creation mechanism. */
605
- scheduledSnapshotsConfig?:
606
- ScheduledSnapshotsConfig;
607
- }
608
- interface SaveSnapshotRequest {
609
- /** Location in a Cloud Storage where the snapshot is going to be stored, e.g.: "gs://my-bucket/snapshots". */
610
- snapshotLocation?:
611
- string;
612
- }
613
- interface SaveSnapshotResponse {
614
- /**
615
- * The fully-resolved Cloud Storage path of the created snapshot, e.g.: "gs://my-bucket/snapshots/project_location_environment_timestamp". This field is populated only if the snapshot
616
- * creation was successful.
617
- */
618
- snapshotPath?:
619
- string;
620
- }
621
- interface ScheduledSnapshotsConfig {
622
- /** Optional. Whether scheduled snapshots creation is enabled. */
623
- enabled?:
624
- boolean;
625
- /** Optional. The cron expression representing the time when snapshots creation mechanism runs. This field is subject to additional validation around frequency of execution. */
626
- snapshotCreationSchedule?:
627
- string;
628
- /** Optional. The Cloud Storage location for storing automatically created snapshots. */
629
- snapshotLocation?:
630
- string;
631
- /** Optional. Time zone that sets the context to interpret snapshot_creation_schedule. */
632
- timeZone?:
633
- string;
634
- }
635
- interface SchedulerResource {
636
- /** Optional. The number of schedulers. */
637
- count?:
638
- number;
639
- /** Optional. CPU request and limit for a single Airflow scheduler replica. */
640
- cpu?:
641
- number;
642
- /** Optional. Memory (GB) request and limit for a single Airflow scheduler replica. */
643
- memoryGb?:
644
- number;
645
- /** Optional. Storage (GB) request and limit for a single Airflow scheduler replica. */
646
- storageGb?:
647
- number;
648
- }
649
- interface SoftwareConfig {
650
- /**
651
- * Optional. Apache Airflow configuration properties to override. Property keys contain the section and property names, separated by a hyphen, for example
652
- * "core-dags_are_paused_at_creation". Section names must not contain hyphens ("-"), opening square brackets ("["), or closing square brackets ("]"). The property name must not be
653
- * empty and must not contain an equals sign ("=") or semicolon (";"). Section and property names must not contain a period ("."). Apache Airflow configuration property names must be
654
- * written in [snake_case](https://en.wikipedia.org/wiki/Snake_case). Property values can contain any character, and can be written in any lower/upper case format. Certain Apache
655
- * Airflow configuration property values are [blocked](/composer/docs/concepts/airflow-configurations), and cannot be overridden.
656
- */
657
- airflowConfigOverrides?:
658
- { [P in string]: string };
659
- /**
660
- * Optional. Additional environment variables to provide to the Apache Airflow scheduler, worker, and webserver processes. Environment variable names must match the regular expression
661
- * `a-zA-Z_*`. They cannot specify Apache Airflow software configuration overrides (they cannot match the regular expression `AIRFLOW__[A-Z0-9_]+__[A-Z0-9_]+`), and they cannot match
662
- * any of the following reserved names: * `AIRFLOW_HOME` * `C_FORCE_ROOT` * `CONTAINER_NAME` * `DAGS_FOLDER` * `GCP_PROJECT` * `GCS_BUCKET` * `GKE_CLUSTER_NAME` * `SQL_DATABASE` *
663
- * `SQL_INSTANCE` * `SQL_PASSWORD` * `SQL_PROJECT` * `SQL_REGION` * `SQL_USER`
664
- */
665
- envVariables?:
666
- { [P in string]: string };
667
- /**
668
- * The version of the software running in the environment. This encapsulates both the version of Cloud Composer functionality and the version of Apache Airflow. It must match the
669
- * regular expression `composer-([0-9]+(\.[0-9]+\.[0-9]+(-preview\.[0-9]+)?)?|latest)-airflow-([0-9]+(\.[0-9]+(\.[0-9]+)?)?)`. When used as input, the server also checks if the
670
- * provided version is supported and denies the request for an unsupported version. The Cloud Composer portion of the image version is a full [semantic version](https://semver.org), or
671
- * an alias in the form of major version number or `latest`. When an alias is provided, the server replaces it with the current Cloud Composer version that satisfies the alias. The
672
- * Apache Airflow portion of the image version is a full semantic version that points to one of the supported Apache Airflow versions, or an alias in the form of only major or
673
- * major.minor versions specified. When an alias is provided, the server replaces it with the latest Apache Airflow version that satisfies the alias and is supported in the given Cloud
674
- * Composer version. In all cases, the resolved image version is stored in the same field. See also [version list](/composer/docs/concepts/versioning/composer-versions) and [versioning
675
- * overview](/composer/docs/concepts/versioning/composer-versioning-overview).
676
- */
677
- imageVersion?:
678
- string;
679
- /**
680
- * Optional. Custom Python Package Index (PyPI) packages to be installed in the environment. Keys refer to the lowercase package name such as "numpy" and values are the lowercase
681
- * extras and version specifier such as "==1.12.0", "[devel,gcp_api]", or "[devel]>=1.8.2, <1.9.2". To specify a package without pinning it to a version specifier, use the empty string
682
- * as the value.
683
- */
684
- pypiPackages?:
685
- { [P in string]: string };
686
- /**
687
- * Optional. The major version of Python used to run the Apache Airflow scheduler, worker, and webserver processes. Can be set to '2' or '3'. If not specified, the default is '3'.
688
- * Cannot be updated. This field is only supported for Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*. Environments in newer versions always use Python major
689
- * version 3.
690
- */
691
- pythonVersion?:
692
- string;
693
- /** Optional. The number of schedulers for Airflow. This field is supported for Cloud Composer environments in versions composer-1.*.*-airflow-2.*.*. */
694
- schedulerCount?:
695
- number;
696
- }
697
- interface Status {
698
- /** The status code, which should be an enum value of google.rpc.Code. */
699
- code?:
700
- number;
701
- /** A list of messages that carry the error details. There is a common set of message types for APIs to use. */
702
- details?:
703
- Array<{ [P in string]: any }>;
704
- /**
705
- * 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
706
- * client.
707
- */
708
- message?:
709
- string;
710
- }
711
- interface StopAirflowCommandRequest {
712
- /** The unique ID of the command execution. */
713
- executionId?:
714
- string;
715
- /** If true, the execution is terminated forcefully (SIGKILL). If false, the execution is stopped gracefully, giving it time for cleanup. */
716
- force?:
717
- boolean;
718
- /** The name of the pod where the command is executed. */
719
- pod?:
720
- string;
721
- /** The namespace of the pod where the command is executed. */
722
- podNamespace?:
723
- string;
724
- }
725
- interface StopAirflowCommandResponse {
726
- /** Whether the execution is still running. */
727
- isDone?:
728
- boolean;
729
- /** Output message from stopping execution request. */
730
- output?:
731
- string[];
732
- }
733
- interface StorageConfig {
734
- /** Optional. The name of the Cloud Storage bucket used by the environment. No `gs://` prefix. */
735
- bucket?:
736
- string;
737
- }
738
- interface TriggererResource {
739
- /** Optional. The number of triggerers. */
740
- count?:
741
- number;
742
- /** Optional. CPU request and limit for a single Airflow triggerer replica. */
743
- cpu?:
744
- number;
745
- /** Optional. Memory (GB) request and limit for a single Airflow triggerer replica. */
746
- memoryGb?:
747
- number;
748
- }
749
- interface WebServerConfig {
750
- /**
751
- * Optional. Machine type on which Airflow web server is running. It has to be one of: composer-n1-webserver-2, composer-n1-webserver-4 or composer-n1-webserver-8. If not specified,
752
- * composer-n1-webserver-2 will be used. Value custom is returned only in response, if Airflow web server parameters were manually changed to a non-standard values.
753
- */
754
- machineType?:
755
- string;
756
- }
757
- interface WebServerNetworkAccessControl {
758
- /** A collection of allowed IP ranges with descriptions. */
759
- allowedIpRanges?:
760
- AllowedIpRange[];
761
- }
762
- interface WebServerResource {
763
- /** Optional. CPU request and limit for Airflow web server. */
764
- cpu?:
765
- number;
766
- /** Optional. Memory (GB) request and limit for Airflow web server. */
767
- memoryGb?:
768
- number;
769
- /** Optional. Storage (GB) request and limit for Airflow web server. */
770
- storageGb?:
771
- number;
772
- }
773
- interface WorkerResource {
774
- /** Optional. CPU request and limit for a single Airflow worker replica. */
775
- cpu?:
776
- number;
777
- /** Optional. Maximum number of workers for autoscaling. */
778
- maxCount?:
779
- number;
780
- /** Optional. Memory (GB) request and limit for a single Airflow worker replica. */
781
- memoryGb?:
782
- number;
783
- /** Optional. Minimum number of workers for autoscaling. */
784
- minCount?:
785
- number;
786
- /** Optional. Storage (GB) request and limit for a single Airflow worker replica. */
787
- storageGb?:
788
- number;
789
- }
790
- interface WorkloadsConfig {
791
- /** Optional. Resources used by Airflow schedulers. */
792
- scheduler?:
793
- SchedulerResource;
794
- /** Optional. Resources used by Airflow triggerers. */
795
- triggerer?:
796
- TriggererResource;
797
- /** Optional. Resources used by Airflow web server. */
798
- webServer?:
799
- WebServerResource;
800
- /** Optional. Resources used by Airflow workers. */
801
- worker?:
802
- WorkerResource;
803
- }
804
- interface EnvironmentsResource {
805
- /** Create a new environment. */
806
- create(request: {
807
- /** V1 error format. */
808
- "$.xgafv"?:
809
- string;
810
- /** OAuth access token. */
811
- access_token?:
812
- string;
813
- /** Data format for response. */
814
- alt?:
815
- string;
816
- /** JSONP */
817
- callback?:
818
- string;
819
- /** Selector specifying which fields to include in a partial response. */
820
- fields?:
821
- string;
822
- /** 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. */
823
- key?:
824
- string;
825
- /** OAuth 2.0 token for the current user. */
826
- oauth_token?:
827
- string;
828
- /** The parent must be of the form "projects/{projectId}/locations/{locationId}". */
829
- parent:
830
- string;
831
- /** Returns response with indentations and line breaks. */
832
- prettyPrint?:
833
- boolean;
834
- /** 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. */
835
- quotaUser?:
836
- string;
837
- /** Upload protocol for media (e.g. "raw", "multipart"). */
838
- upload_protocol?:
839
- string;
840
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
841
- uploadType?:
842
- string;
843
- /** Request body */
844
- resource:
845
- Environment;
846
- }): Request<Operation>;
847
- create(request: {
848
- /** V1 error format. */
849
- "$.xgafv"?:
850
- string;
851
- /** OAuth access token. */
852
- access_token?:
853
- string;
854
- /** Data format for response. */
855
- alt?:
856
- string;
857
- /** JSONP */
858
- callback?:
859
- string;
860
- /** Selector specifying which fields to include in a partial response. */
861
- fields?:
862
- string;
863
- /** 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. */
864
- key?:
865
- string;
866
- /** OAuth 2.0 token for the current user. */
867
- oauth_token?:
868
- string;
869
- /** The parent must be of the form "projects/{projectId}/locations/{locationId}". */
870
- parent:
871
- string;
872
- /** Returns response with indentations and line breaks. */
873
- prettyPrint?:
874
- boolean;
875
- /** 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. */
876
- quotaUser?:
877
- string;
878
- /** Upload protocol for media (e.g. "raw", "multipart"). */
879
- upload_protocol?:
880
- string;
881
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
882
- uploadType?:
883
- string;
884
- },
885
- body: Environment): Request<Operation>;
886
- /** Triggers database failover (only for highly resilient environments). */
887
- databaseFailover(request: {
888
- /** V1 error format. */
889
- "$.xgafv"?:
890
- string;
891
- /** OAuth access token. */
892
- access_token?:
893
- string;
894
- /** Data format for response. */
895
- alt?:
896
- string;
897
- /** JSONP */
898
- callback?:
899
- string;
900
- /** Target environment: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" */
901
- environment:
902
- string;
903
- /** Selector specifying which fields to include in a partial response. */
904
- fields?:
905
- string;
906
- /** 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. */
907
- key?:
908
- string;
909
- /** OAuth 2.0 token for the current user. */
910
- oauth_token?:
911
- string;
912
- /** Returns response with indentations and line breaks. */
913
- prettyPrint?:
914
- boolean;
915
- /** 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. */
916
- quotaUser?:
917
- string;
918
- /** Upload protocol for media (e.g. "raw", "multipart"). */
919
- upload_protocol?:
920
- string;
921
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
922
- uploadType?:
923
- string;
924
- /** Request body */
925
- resource:
926
- DatabaseFailoverRequest;
927
- }): Request<Operation>;
928
- databaseFailover(request: {
929
- /** V1 error format. */
930
- "$.xgafv"?:
931
- string;
932
- /** OAuth access token. */
933
- access_token?:
934
- string;
935
- /** Data format for response. */
936
- alt?:
937
- string;
938
- /** JSONP */
939
- callback?:
940
- string;
941
- /** Target environment: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" */
942
- environment:
943
- string;
944
- /** Selector specifying which fields to include in a partial response. */
945
- fields?:
946
- string;
947
- /** 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. */
948
- key?:
949
- string;
950
- /** OAuth 2.0 token for the current user. */
951
- oauth_token?:
952
- string;
953
- /** Returns response with indentations and line breaks. */
954
- prettyPrint?:
955
- boolean;
956
- /** 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
- quotaUser?:
958
- string;
959
- /** Upload protocol for media (e.g. "raw", "multipart"). */
960
- upload_protocol?:
961
- string;
962
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
963
- uploadType?:
964
- string;
965
- },
966
- body: DatabaseFailoverRequest): Request<Operation>;
967
- /** Delete an environment. */
968
- delete(request?: {
969
- /** V1 error format. */
970
- "$.xgafv"?:
971
- string;
972
- /** OAuth access token. */
973
- access_token?:
974
- string;
975
- /** Data format for response. */
976
- alt?:
977
- string;
978
- /** JSONP */
979
- callback?:
980
- string;
981
- /** Selector specifying which fields to include in a partial response. */
982
- fields?:
983
- string;
984
- /** 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. */
985
- key?:
986
- string;
987
- /** The environment to delete, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" */
988
- name:
989
- string;
990
- /** OAuth 2.0 token for the current user. */
991
- oauth_token?:
992
- string;
993
- /** Returns response with indentations and line breaks. */
994
- prettyPrint?:
995
- boolean;
996
- /** 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. */
997
- quotaUser?:
998
- string;
999
- /** Upload protocol for media (e.g. "raw", "multipart"). */
1000
- upload_protocol?:
1001
- string;
1002
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1003
- uploadType?:
1004
- string;
1005
- }): Request<Operation>;
1006
- /** Executes Airflow CLI command. */
1007
- executeAirflowCommand(request: {
1008
- /** V1 error format. */
1009
- "$.xgafv"?:
1010
- string;
1011
- /** OAuth access token. */
1012
- access_token?:
1013
- string;
1014
- /** Data format for response. */
1015
- alt?:
1016
- string;
1017
- /** JSONP */
1018
- callback?:
1019
- string;
1020
- /** The resource name of the environment in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}". */
1021
- environment:
1022
- string;
1023
- /** Selector specifying which fields to include in a partial response. */
1024
- fields?:
1025
- string;
1026
- /** 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. */
1027
- key?:
1028
- string;
1029
- /** OAuth 2.0 token for the current user. */
1030
- oauth_token?:
1031
- string;
1032
- /** Returns response with indentations and line breaks. */
1033
- prettyPrint?:
1034
- boolean;
1035
- /** 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. */
1036
- quotaUser?:
1037
- string;
1038
- /** Upload protocol for media (e.g. "raw", "multipart"). */
1039
- upload_protocol?:
1040
- string;
1041
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1042
- uploadType?:
1043
- string;
1044
- /** Request body */
1045
- resource:
1046
- ExecuteAirflowCommandRequest;
1047
- }): Request<ExecuteAirflowCommandResponse>;
1048
- executeAirflowCommand(request: {
1049
- /** V1 error format. */
1050
- "$.xgafv"?:
1051
- string;
1052
- /** OAuth access token. */
1053
- access_token?:
1054
- string;
1055
- /** Data format for response. */
1056
- alt?:
1057
- string;
1058
- /** JSONP */
1059
- callback?:
1060
- string;
1061
- /** The resource name of the environment in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}". */
1062
- environment:
1063
- string;
1064
- /** Selector specifying which fields to include in a partial response. */
1065
- fields?:
1066
- string;
1067
- /** 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. */
1068
- key?:
1069
- string;
1070
- /** OAuth 2.0 token for the current user. */
1071
- oauth_token?:
1072
- string;
1073
- /** Returns response with indentations and line breaks. */
1074
- prettyPrint?:
1075
- boolean;
1076
- /** 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. */
1077
- quotaUser?:
1078
- string;
1079
- /** Upload protocol for media (e.g. "raw", "multipart"). */
1080
- upload_protocol?:
1081
- string;
1082
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1083
- uploadType?:
1084
- string;
1085
- },
1086
- body: ExecuteAirflowCommandRequest): Request<ExecuteAirflowCommandResponse>;
1087
- /** Fetches database properties. */
1088
- fetchDatabaseProperties(request?: {
1089
- /** V1 error format. */
1090
- "$.xgafv"?:
1091
- string;
1092
- /** OAuth access token. */
1093
- access_token?:
1094
- string;
1095
- /** Data format for response. */
1096
- alt?:
1097
- string;
1098
- /** JSONP */
1099
- callback?:
1100
- string;
1101
- /** Required. The resource name of the environment, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" */
1102
- environment:
1103
- string;
1104
- /** Selector specifying which fields to include in a partial response. */
1105
- fields?:
1106
- string;
1107
- /** 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. */
1108
- key?:
1109
- string;
1110
- /** OAuth 2.0 token for the current user. */
1111
- oauth_token?:
1112
- string;
1113
- /** Returns response with indentations and line breaks. */
1114
- prettyPrint?:
1115
- boolean;
1116
- /** 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. */
1117
- quotaUser?:
1118
- string;
1119
- /** Upload protocol for media (e.g. "raw", "multipart"). */
1120
- upload_protocol?:
1121
- string;
1122
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1123
- uploadType?:
1124
- string;
1125
- }): Request<FetchDatabasePropertiesResponse>;
1126
- /** Get an existing environment. */
1127
- get(request?: {
1128
- /** V1 error format. */
1129
- "$.xgafv"?:
1130
- string;
1131
- /** OAuth access token. */
1132
- access_token?:
1133
- string;
1134
- /** Data format for response. */
1135
- alt?:
1136
- string;
1137
- /** JSONP */
1138
- callback?:
1139
- string;
1140
- /** Selector specifying which fields to include in a partial response. */
1141
- fields?:
1142
- string;
1143
- /** 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. */
1144
- key?:
1145
- string;
1146
- /** The resource name of the environment to get, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" */
1147
- name:
1148
- string;
1149
- /** OAuth 2.0 token for the current user. */
1150
- oauth_token?:
1151
- string;
1152
- /** Returns response with indentations and line breaks. */
1153
- prettyPrint?:
1154
- boolean;
1155
- /** 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. */
1156
- quotaUser?:
1157
- string;
1158
- /** Upload protocol for media (e.g. "raw", "multipart"). */
1159
- upload_protocol?:
1160
- string;
1161
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1162
- uploadType?:
1163
- string;
1164
- }): Request<Environment>;
1165
- /** List environments. */
1166
- list(request?: {
1167
- /** V1 error format. */
1168
- "$.xgafv"?:
1169
- string;
1170
- /** OAuth access token. */
1171
- access_token?:
1172
- string;
1173
- /** Data format for response. */
1174
- alt?:
1175
- string;
1176
- /** JSONP */
1177
- callback?:
1178
- string;
1179
- /** Selector specifying which fields to include in a partial response. */
1180
- fields?:
1181
- string;
1182
- /** 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. */
1183
- key?:
1184
- string;
1185
- /** OAuth 2.0 token for the current user. */
1186
- oauth_token?:
1187
- string;
1188
- /** The maximum number of environments to return. */
1189
- pageSize?:
1190
- number;
1191
- /** The next_page_token value returned from a previous List request, if any. */
1192
- pageToken?:
1193
- string;
1194
- /** List environments in the given project and location, in the form: "projects/{projectId}/locations/{locationId}" */
1195
- parent:
1196
- string;
1197
- /** Returns response with indentations and line breaks. */
1198
- prettyPrint?:
1199
- boolean;
1200
- /** 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. */
1201
- quotaUser?:
1202
- string;
1203
- /** Upload protocol for media (e.g. "raw", "multipart"). */
1204
- upload_protocol?:
1205
- string;
1206
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1207
- uploadType?:
1208
- string;
1209
- }): Request<ListEnvironmentsResponse>;
1210
- /** Loads a snapshot of a Cloud Composer environment. As a result of this operation, a snapshot of environment's specified in LoadSnapshotRequest is loaded into the environment. */
1211
- loadSnapshot(request: {
1212
- /** V1 error format. */
1213
- "$.xgafv"?:
1214
- string;
1215
- /** OAuth access token. */
1216
- access_token?:
1217
- string;
1218
- /** Data format for response. */
1219
- alt?:
1220
- string;
1221
- /** JSONP */
1222
- callback?:
1223
- string;
1224
- /** The resource name of the target environment in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" */
1225
- environment:
1226
- string;
1227
- /** Selector specifying which fields to include in a partial response. */
1228
- fields?:
1229
- string;
1230
- /** 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. */
1231
- key?:
1232
- string;
1233
- /** OAuth 2.0 token for the current user. */
1234
- oauth_token?:
1235
- string;
1236
- /** Returns response with indentations and line breaks. */
1237
- prettyPrint?:
1238
- boolean;
1239
- /** 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. */
1240
- quotaUser?:
1241
- string;
1242
- /** Upload protocol for media (e.g. "raw", "multipart"). */
1243
- upload_protocol?:
1244
- string;
1245
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1246
- uploadType?:
1247
- string;
1248
- /** Request body */
1249
- resource:
1250
- LoadSnapshotRequest;
1251
- }): Request<Operation>;
1252
- loadSnapshot(request: {
1253
- /** V1 error format. */
1254
- "$.xgafv"?:
1255
- string;
1256
- /** OAuth access token. */
1257
- access_token?:
1258
- string;
1259
- /** Data format for response. */
1260
- alt?:
1261
- string;
1262
- /** JSONP */
1263
- callback?:
1264
- string;
1265
- /** The resource name of the target environment in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" */
1266
- environment:
1267
- string;
1268
- /** Selector specifying which fields to include in a partial response. */
1269
- fields?:
1270
- string;
1271
- /** 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. */
1272
- key?:
1273
- string;
1274
- /** OAuth 2.0 token for the current user. */
1275
- oauth_token?:
1276
- string;
1277
- /** Returns response with indentations and line breaks. */
1278
- prettyPrint?:
1279
- boolean;
1280
- /** 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. */
1281
- quotaUser?:
1282
- string;
1283
- /** Upload protocol for media (e.g. "raw", "multipart"). */
1284
- upload_protocol?:
1285
- string;
1286
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1287
- uploadType?:
1288
- string;
1289
- },
1290
- body: LoadSnapshotRequest): Request<Operation>;
1291
- /** Update an environment. */
1292
- patch(request: {
1293
- /** V1 error format. */
1294
- "$.xgafv"?:
1295
- string;
1296
- /** OAuth access token. */
1297
- access_token?:
1298
- string;
1299
- /** Data format for response. */
1300
- alt?:
1301
- string;
1302
- /** JSONP */
1303
- callback?:
1304
- string;
1305
- /** Selector specifying which fields to include in a partial response. */
1306
- fields?:
1307
- string;
1308
- /** 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. */
1309
- key?:
1310
- string;
1311
- /** The relative resource name of the environment to update, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" */
1312
- name:
1313
- string;
1314
- /** OAuth 2.0 token for the current user. */
1315
- oauth_token?:
1316
- string;
1317
- /** Returns response with indentations and line breaks. */
1318
- prettyPrint?:
1319
- boolean;
1320
- /** 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. */
1321
- quotaUser?:
1322
- string;
1323
- /**
1324
- * Required. A comma-separated list of paths, relative to `Environment`, of fields to update. For example, to set the version of scikit-learn to install in the environment to
1325
- * 0.19.0 and to remove an existing installation of numpy, the `updateMask` parameter would include the following two `paths` values:
1326
- * "config.softwareConfig.pypiPackages.scikit-learn" and "config.softwareConfig.pypiPackages.numpy". The included patch environment would specify the scikit-learn version as
1327
- * follows: { "config":{ "softwareConfig":{ "pypiPackages":{ "scikit-learn":"==0.19.0" } } } } Note that in the above example, any existing PyPI packages other than scikit-learn
1328
- * and numpy will be unaffected. Only one update type may be included in a single request's `updateMask`. For example, one cannot update both the PyPI packages and labels in the
1329
- * same request. However, it is possible to update multiple members of a map field simultaneously in the same request. For example, to set the labels "label1" and "label2" while
1330
- * clearing "label3" (assuming it already exists), one can provide the paths "labels.label1", "labels.label2", and "labels.label3" and populate the patch environment as follows: {
1331
- * "labels":{ "label1":"new-label1-value" "label2":"new-label2-value" } } Note that in the above example, any existing labels that are not included in the `updateMask` will be
1332
- * unaffected. It is also possible to replace an entire map field by providing the map field's path in the `updateMask`. The new value of the field will be that which is provided
1333
- * in the patch environment. For example, to delete all pre-existing user-specified PyPI packages and install botocore at version 1.7.14, the `updateMask` would contain the path
1334
- * "config.softwareConfig.pypiPackages", and the patch environment would be the following: { "config":{ "softwareConfig":{ "pypiPackages":{ "botocore":"==1.7.14" } } } } **Note:**
1335
- * Only the following fields can be updated: * `config.softwareConfig.pypiPackages` * Replace all custom custom PyPI packages. If a replacement package map is not included in
1336
- * `environment`, all custom PyPI packages are cleared. It is an error to provide both this mask and a mask specifying an individual package. *
1337
- * `config.softwareConfig.pypiPackages.`packagename * Update the custom PyPI package *packagename*, preserving other packages. To delete the package, include it in `updateMask`,
1338
- * and omit the mapping for it in `environment.config.softwareConfig.pypiPackages`. It is an error to provide both a mask of this form and the `config.softwareConfig.pypiPackages`
1339
- * mask. * `labels` * Replace all environment labels. If a replacement labels map is not included in `environment`, all labels are cleared. It is an error to provide both this mask
1340
- * and a mask specifying one or more individual labels. * `labels.`labelName * Set the label named *labelName*, while preserving other labels. To delete the label, include it in
1341
- * `updateMask` and omit its mapping in `environment.labels`. It is an error to provide both a mask of this form and the `labels` mask. * `config.nodeCount` * Horizontally scale
1342
- * the number of nodes in the environment. An integer greater than or equal to 3 must be provided in the `config.nodeCount` field. Supported for Cloud Composer environments in
1343
- * versions composer-1.*.*-airflow-*.*.*. * `config.webServerNetworkAccessControl` * Replace the environment's current `WebServerNetworkAccessControl`. *
1344
- * `config.softwareConfig.airflowConfigOverrides` * Replace all Apache Airflow config overrides. If a replacement config overrides map is not included in `environment`, all config
1345
- * overrides are cleared. It is an error to provide both this mask and a mask specifying one or more individual config overrides. *
1346
- * `config.softwareConfig.airflowConfigOverrides.`section-name * Override the Apache Airflow config property *name* in the section named *section*, preserving other properties. To
1347
- * delete the property override, include it in `updateMask` and omit its mapping in `environment.config.softwareConfig.airflowConfigOverrides`. It is an error to provide both a
1348
- * mask of this form and the `config.softwareConfig.airflowConfigOverrides` mask. * `config.softwareConfig.envVariables` * Replace all environment variables. If a replacement
1349
- * environment variable map is not included in `environment`, all custom environment variables are cleared. * `config.softwareConfig.schedulerCount` * Horizontally scale the number
1350
- * of schedulers in Airflow. A positive integer not greater than the number of nodes must be provided in the `config.softwareConfig.schedulerCount` field. Supported for Cloud
1351
- * Composer environments in versions composer-1.*.*-airflow-2.*.*. * `config.databaseConfig.machineType` * Cloud SQL machine type used by Airflow database. It has to be one of:
1352
- * db-n1-standard-2, db-n1-standard-4, db-n1-standard-8 or db-n1-standard-16. Supported for Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*. *
1353
- * `config.webServerConfig.machineType` * Machine type on which Airflow web server is running. It has to be one of: composer-n1-webserver-2, composer-n1-webserver-4 or
1354
- * composer-n1-webserver-8. Supported for Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*.
1355
- */
1356
- updateMask?:
1357
- string;
1358
- /** Upload protocol for media (e.g. "raw", "multipart"). */
1359
- upload_protocol?:
1360
- string;
1361
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1362
- uploadType?:
1363
- string;
1364
- /** Request body */
1365
- resource:
1366
- Environment;
1367
- }): Request<Operation>;
1368
- patch(request: {
1369
- /** V1 error format. */
1370
- "$.xgafv"?:
1371
- string;
1372
- /** OAuth access token. */
1373
- access_token?:
1374
- string;
1375
- /** Data format for response. */
1376
- alt?:
1377
- string;
1378
- /** JSONP */
1379
- callback?:
1380
- string;
1381
- /** Selector specifying which fields to include in a partial response. */
1382
- fields?:
1383
- string;
1384
- /** 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. */
1385
- key?:
1386
- string;
1387
- /** The relative resource name of the environment to update, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" */
1388
- name:
1389
- string;
1390
- /** OAuth 2.0 token for the current user. */
1391
- oauth_token?:
1392
- string;
1393
- /** Returns response with indentations and line breaks. */
1394
- prettyPrint?:
1395
- boolean;
1396
- /** 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. */
1397
- quotaUser?:
1398
- string;
1399
- /**
1400
- * Required. A comma-separated list of paths, relative to `Environment`, of fields to update. For example, to set the version of scikit-learn to install in the environment to
1401
- * 0.19.0 and to remove an existing installation of numpy, the `updateMask` parameter would include the following two `paths` values:
1402
- * "config.softwareConfig.pypiPackages.scikit-learn" and "config.softwareConfig.pypiPackages.numpy". The included patch environment would specify the scikit-learn version as
1403
- * follows: { "config":{ "softwareConfig":{ "pypiPackages":{ "scikit-learn":"==0.19.0" } } } } Note that in the above example, any existing PyPI packages other than scikit-learn
1404
- * and numpy will be unaffected. Only one update type may be included in a single request's `updateMask`. For example, one cannot update both the PyPI packages and labels in the
1405
- * same request. However, it is possible to update multiple members of a map field simultaneously in the same request. For example, to set the labels "label1" and "label2" while
1406
- * clearing "label3" (assuming it already exists), one can provide the paths "labels.label1", "labels.label2", and "labels.label3" and populate the patch environment as follows: {
1407
- * "labels":{ "label1":"new-label1-value" "label2":"new-label2-value" } } Note that in the above example, any existing labels that are not included in the `updateMask` will be
1408
- * unaffected. It is also possible to replace an entire map field by providing the map field's path in the `updateMask`. The new value of the field will be that which is provided
1409
- * in the patch environment. For example, to delete all pre-existing user-specified PyPI packages and install botocore at version 1.7.14, the `updateMask` would contain the path
1410
- * "config.softwareConfig.pypiPackages", and the patch environment would be the following: { "config":{ "softwareConfig":{ "pypiPackages":{ "botocore":"==1.7.14" } } } } **Note:**
1411
- * Only the following fields can be updated: * `config.softwareConfig.pypiPackages` * Replace all custom custom PyPI packages. If a replacement package map is not included in
1412
- * `environment`, all custom PyPI packages are cleared. It is an error to provide both this mask and a mask specifying an individual package. *
1413
- * `config.softwareConfig.pypiPackages.`packagename * Update the custom PyPI package *packagename*, preserving other packages. To delete the package, include it in `updateMask`,
1414
- * and omit the mapping for it in `environment.config.softwareConfig.pypiPackages`. It is an error to provide both a mask of this form and the `config.softwareConfig.pypiPackages`
1415
- * mask. * `labels` * Replace all environment labels. If a replacement labels map is not included in `environment`, all labels are cleared. It is an error to provide both this mask
1416
- * and a mask specifying one or more individual labels. * `labels.`labelName * Set the label named *labelName*, while preserving other labels. To delete the label, include it in
1417
- * `updateMask` and omit its mapping in `environment.labels`. It is an error to provide both a mask of this form and the `labels` mask. * `config.nodeCount` * Horizontally scale
1418
- * the number of nodes in the environment. An integer greater than or equal to 3 must be provided in the `config.nodeCount` field. Supported for Cloud Composer environments in
1419
- * versions composer-1.*.*-airflow-*.*.*. * `config.webServerNetworkAccessControl` * Replace the environment's current `WebServerNetworkAccessControl`. *
1420
- * `config.softwareConfig.airflowConfigOverrides` * Replace all Apache Airflow config overrides. If a replacement config overrides map is not included in `environment`, all config
1421
- * overrides are cleared. It is an error to provide both this mask and a mask specifying one or more individual config overrides. *
1422
- * `config.softwareConfig.airflowConfigOverrides.`section-name * Override the Apache Airflow config property *name* in the section named *section*, preserving other properties. To
1423
- * delete the property override, include it in `updateMask` and omit its mapping in `environment.config.softwareConfig.airflowConfigOverrides`. It is an error to provide both a
1424
- * mask of this form and the `config.softwareConfig.airflowConfigOverrides` mask. * `config.softwareConfig.envVariables` * Replace all environment variables. If a replacement
1425
- * environment variable map is not included in `environment`, all custom environment variables are cleared. * `config.softwareConfig.schedulerCount` * Horizontally scale the number
1426
- * of schedulers in Airflow. A positive integer not greater than the number of nodes must be provided in the `config.softwareConfig.schedulerCount` field. Supported for Cloud
1427
- * Composer environments in versions composer-1.*.*-airflow-2.*.*. * `config.databaseConfig.machineType` * Cloud SQL machine type used by Airflow database. It has to be one of:
1428
- * db-n1-standard-2, db-n1-standard-4, db-n1-standard-8 or db-n1-standard-16. Supported for Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*. *
1429
- * `config.webServerConfig.machineType` * Machine type on which Airflow web server is running. It has to be one of: composer-n1-webserver-2, composer-n1-webserver-4 or
1430
- * composer-n1-webserver-8. Supported for Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*.
1431
- */
1432
- updateMask?:
1433
- string;
1434
- /** Upload protocol for media (e.g. "raw", "multipart"). */
1435
- upload_protocol?:
1436
- string;
1437
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1438
- uploadType?:
1439
- string;
1440
- },
1441
- body: Environment): Request<Operation>;
1442
- /** Polls Airflow CLI command execution and fetches logs. */
1443
- pollAirflowCommand(request: {
1444
- /** V1 error format. */
1445
- "$.xgafv"?:
1446
- string;
1447
- /** OAuth access token. */
1448
- access_token?:
1449
- string;
1450
- /** Data format for response. */
1451
- alt?:
1452
- string;
1453
- /** JSONP */
1454
- callback?:
1455
- string;
1456
- /** The resource name of the environment in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" */
1457
- environment:
1458
- string;
1459
- /** Selector specifying which fields to include in a partial response. */
1460
- fields?:
1461
- string;
1462
- /** 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. */
1463
- key?:
1464
- string;
1465
- /** OAuth 2.0 token for the current user. */
1466
- oauth_token?:
1467
- string;
1468
- /** Returns response with indentations and line breaks. */
1469
- prettyPrint?:
1470
- boolean;
1471
- /** 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. */
1472
- quotaUser?:
1473
- string;
1474
- /** Upload protocol for media (e.g. "raw", "multipart"). */
1475
- upload_protocol?:
1476
- string;
1477
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1478
- uploadType?:
1479
- string;
1480
- /** Request body */
1481
- resource:
1482
- PollAirflowCommandRequest;
1483
- }): Request<PollAirflowCommandResponse>;
1484
- pollAirflowCommand(request: {
1485
- /** V1 error format. */
1486
- "$.xgafv"?:
1487
- string;
1488
- /** OAuth access token. */
1489
- access_token?:
1490
- string;
1491
- /** Data format for response. */
1492
- alt?:
1493
- string;
1494
- /** JSONP */
1495
- callback?:
1496
- string;
1497
- /** The resource name of the environment in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" */
1498
- environment:
1499
- string;
1500
- /** Selector specifying which fields to include in a partial response. */
1501
- fields?:
1502
- string;
1503
- /** 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. */
1504
- key?:
1505
- string;
1506
- /** OAuth 2.0 token for the current user. */
1507
- oauth_token?:
1508
- string;
1509
- /** Returns response with indentations and line breaks. */
1510
- prettyPrint?:
1511
- boolean;
1512
- /** 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. */
1513
- quotaUser?:
1514
- string;
1515
- /** Upload protocol for media (e.g. "raw", "multipart"). */
1516
- upload_protocol?:
1517
- string;
1518
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1519
- uploadType?:
1520
- string;
1521
- },
1522
- body: PollAirflowCommandRequest): Request<PollAirflowCommandResponse>;
1523
- /** Creates a snapshots of a Cloud Composer environment. As a result of this operation, snapshot of environment's state is stored in a location specified in the SaveSnapshotRequest. */
1524
- saveSnapshot(request: {
1525
- /** V1 error format. */
1526
- "$.xgafv"?:
1527
- string;
1528
- /** OAuth access token. */
1529
- access_token?:
1530
- string;
1531
- /** Data format for response. */
1532
- alt?:
1533
- string;
1534
- /** JSONP */
1535
- callback?:
1536
- string;
1537
- /** The resource name of the source environment in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" */
1538
- environment:
1539
- string;
1540
- /** Selector specifying which fields to include in a partial response. */
1541
- fields?:
1542
- string;
1543
- /** 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. */
1544
- key?:
1545
- string;
1546
- /** OAuth 2.0 token for the current user. */
1547
- oauth_token?:
1548
- string;
1549
- /** Returns response with indentations and line breaks. */
1550
- prettyPrint?:
1551
- boolean;
1552
- /** 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. */
1553
- quotaUser?:
1554
- string;
1555
- /** Upload protocol for media (e.g. "raw", "multipart"). */
1556
- upload_protocol?:
1557
- string;
1558
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1559
- uploadType?:
1560
- string;
1561
- /** Request body */
1562
- resource:
1563
- SaveSnapshotRequest;
1564
- }): Request<Operation>;
1565
- saveSnapshot(request: {
1566
- /** V1 error format. */
1567
- "$.xgafv"?:
1568
- string;
1569
- /** OAuth access token. */
1570
- access_token?:
1571
- string;
1572
- /** Data format for response. */
1573
- alt?:
1574
- string;
1575
- /** JSONP */
1576
- callback?:
1577
- string;
1578
- /** The resource name of the source environment in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" */
1579
- environment:
1580
- string;
1581
- /** Selector specifying which fields to include in a partial response. */
1582
- fields?:
1583
- string;
1584
- /** 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. */
1585
- key?:
1586
- string;
1587
- /** OAuth 2.0 token for the current user. */
1588
- oauth_token?:
1589
- string;
1590
- /** Returns response with indentations and line breaks. */
1591
- prettyPrint?:
1592
- boolean;
1593
- /** 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. */
1594
- quotaUser?:
1595
- string;
1596
- /** Upload protocol for media (e.g. "raw", "multipart"). */
1597
- upload_protocol?:
1598
- string;
1599
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1600
- uploadType?:
1601
- string;
1602
- },
1603
- body: SaveSnapshotRequest): Request<Operation>;
1604
- /** Stops Airflow CLI command execution. */
1605
- stopAirflowCommand(request: {
1606
- /** V1 error format. */
1607
- "$.xgafv"?:
1608
- string;
1609
- /** OAuth access token. */
1610
- access_token?:
1611
- string;
1612
- /** Data format for response. */
1613
- alt?:
1614
- string;
1615
- /** JSONP */
1616
- callback?:
1617
- string;
1618
- /** The resource name of the environment in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}". */
1619
- environment:
1620
- string;
1621
- /** Selector specifying which fields to include in a partial response. */
1622
- fields?:
1623
- string;
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
- key?:
1626
- string;
1627
- /** OAuth 2.0 token for the current user. */
1628
- oauth_token?:
1629
- string;
1630
- /** Returns response with indentations and line breaks. */
1631
- prettyPrint?:
1632
- boolean;
1633
- /** 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. */
1634
- quotaUser?:
1635
- string;
1636
- /** Upload protocol for media (e.g. "raw", "multipart"). */
1637
- upload_protocol?:
1638
- string;
1639
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1640
- uploadType?:
1641
- string;
1642
- /** Request body */
1643
- resource:
1644
- StopAirflowCommandRequest;
1645
- }): Request<StopAirflowCommandResponse>;
1646
- stopAirflowCommand(request: {
1647
- /** V1 error format. */
1648
- "$.xgafv"?:
1649
- string;
1650
- /** OAuth access token. */
1651
- access_token?:
1652
- string;
1653
- /** Data format for response. */
1654
- alt?:
1655
- string;
1656
- /** JSONP */
1657
- callback?:
1658
- string;
1659
- /** The resource name of the environment in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}". */
1660
- environment:
1661
- string;
1662
- /** Selector specifying which fields to include in a partial response. */
1663
- fields?:
1664
- string;
1665
- /** 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. */
1666
- key?:
1667
- string;
1668
- /** OAuth 2.0 token for the current user. */
1669
- oauth_token?:
1670
- string;
1671
- /** Returns response with indentations and line breaks. */
1672
- prettyPrint?:
1673
- boolean;
1674
- /** 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. */
1675
- quotaUser?:
1676
- string;
1677
- /** Upload protocol for media (e.g. "raw", "multipart"). */
1678
- upload_protocol?:
1679
- string;
1680
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1681
- uploadType?:
1682
- string;
1683
- },
1684
- body: StopAirflowCommandRequest): Request<StopAirflowCommandResponse>;
1685
- }
1686
- interface ImageVersionsResource {
1687
- /** List ImageVersions for provided location. */
1688
- list(request?: {
1689
- /** V1 error format. */
1690
- "$.xgafv"?:
1691
- string;
1692
- /** OAuth access token. */
1693
- access_token?:
1694
- string;
1695
- /** Data format for response. */
1696
- alt?:
1697
- string;
1698
- /** JSONP */
1699
- callback?:
1700
- string;
1701
- /** Selector specifying which fields to include in a partial response. */
1702
- fields?:
1703
- string;
1704
- /** Whether or not image versions from old releases should be included. */
1705
- includePastReleases?:
1706
- boolean;
1707
- /** 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. */
1708
- key?:
1709
- string;
1710
- /** OAuth 2.0 token for the current user. */
1711
- oauth_token?:
1712
- string;
1713
- /** The maximum number of image_versions to return. */
1714
- pageSize?:
1715
- number;
1716
- /** The next_page_token value returned from a previous List request, if any. */
1717
- pageToken?:
1718
- string;
1719
- /** List ImageVersions in the given project and location, in the form: "projects/{projectId}/locations/{locationId}" */
1720
- parent:
1721
- string;
1722
- /** Returns response with indentations and line breaks. */
1723
- prettyPrint?:
1724
- boolean;
1725
- /** 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. */
1726
- quotaUser?:
1727
- string;
1728
- /** Upload protocol for media (e.g. "raw", "multipart"). */
1729
- upload_protocol?:
1730
- string;
1731
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1732
- uploadType?:
1733
- string;
1734
- }): Request<ListImageVersionsResponse>;
1735
- }
1736
- interface OperationsResource {
1737
- /**
1738
- * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't
1739
- * support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
1740
- */
1741
- delete(request?: {
1742
- /** V1 error format. */
1743
- "$.xgafv"?:
1744
- string;
1745
- /** OAuth access token. */
1746
- access_token?:
1747
- string;
1748
- /** Data format for response. */
1749
- alt?:
1750
- string;
1751
- /** JSONP */
1752
- callback?:
1753
- string;
1754
- /** Selector specifying which fields to include in a partial response. */
1755
- fields?:
1756
- string;
1757
- /** 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. */
1758
- key?:
1759
- string;
1760
- /** The name of the operation resource to be deleted. */
1761
- name:
1762
- string;
1763
- /** OAuth 2.0 token for the current user. */
1764
- oauth_token?:
1765
- string;
1766
- /** Returns response with indentations and line breaks. */
1767
- prettyPrint?:
1768
- boolean;
1769
- /** 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. */
1770
- quotaUser?:
1771
- string;
1772
- /** Upload protocol for media (e.g. "raw", "multipart"). */
1773
- upload_protocol?:
1774
- string;
1775
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1776
- uploadType?:
1777
- string;
1778
- }): Request<{}>;
1779
- /** Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. */
1780
- get(request?: {
1781
- /** V1 error format. */
1782
- "$.xgafv"?:
1783
- string;
1784
- /** OAuth access token. */
1785
- access_token?:
1786
- string;
1787
- /** Data format for response. */
1788
- alt?:
1789
- string;
1790
- /** JSONP */
1791
- callback?:
1792
- string;
1793
- /** Selector specifying which fields to include in a partial response. */
1794
- fields?:
1795
- string;
1796
- /** 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. */
1797
- key?:
1798
- string;
1799
- /** The name of the operation resource. */
1800
- name:
1801
- string;
1802
- /** OAuth 2.0 token for the current user. */
1803
- oauth_token?:
1804
- string;
1805
- /** Returns response with indentations and line breaks. */
1806
- prettyPrint?:
1807
- boolean;
1808
- /** 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. */
1809
- quotaUser?:
1810
- string;
1811
- /** Upload protocol for media (e.g. "raw", "multipart"). */
1812
- upload_protocol?:
1813
- string;
1814
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1815
- uploadType?:
1816
- string;
1817
- }): Request<Operation>;
1818
- /** Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. */
1819
- list(request?: {
1820
- /** V1 error format. */
1821
- "$.xgafv"?:
1822
- string;
1823
- /** OAuth access token. */
1824
- access_token?:
1825
- string;
1826
- /** Data format for response. */
1827
- alt?:
1828
- string;
1829
- /** JSONP */
1830
- callback?:
1831
- string;
1832
- /** Selector specifying which fields to include in a partial response. */
1833
- fields?:
1834
- string;
1835
- /** The standard list filter. */
1836
- filter?:
1837
- string;
1838
- /** 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. */
1839
- key?:
1840
- string;
1841
- /** The name of the operation's parent resource. */
1842
- name:
1843
- string;
1844
- /** OAuth 2.0 token for the current user. */
1845
- oauth_token?:
1846
- string;
1847
- /** The standard list page size. */
1848
- pageSize?:
1849
- number;
1850
- /** The standard list page token. */
1851
- pageToken?:
1852
- string;
1853
- /** Returns response with indentations and line breaks. */
1854
- prettyPrint?:
1855
- boolean;
1856
- /** 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. */
1857
- quotaUser?:
1858
- string;
1859
- /** Upload protocol for media (e.g. "raw", "multipart"). */
1860
- upload_protocol?:
1861
- string;
1862
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1863
- uploadType?:
1864
- string;
1865
- }): Request<ListOperationsResponse>;
1866
- }
1867
- interface LocationsResource {
1868
- environments:
1869
- EnvironmentsResource;
1870
- imageVersions:
1871
- ImageVersionsResource;
1872
- operations:
1873
- OperationsResource;
1874
- }
1875
- interface ProjectsResource {
1876
- locations:
1877
- LocationsResource;
1878
- }
1879
-
1880
- const projects: ProjectsResource;
26
+ namespace composer {
27
+ interface AllowedIpRange {
28
+ /** Optional. User-provided description. It must contain at most 300 characters. */
29
+ description?: string;
30
+ /** IP address or range, defined using CIDR notation, of requests that this rule applies to. Examples: `192.168.1.1` or `192.168.0.0/16` or `2001:db8::/32` or `2001:0db8:0000:0042:0000:8a2e:0370:7334`. IP range prefixes should be properly truncated. For example, `1.2.3.4/24` should be truncated to `1.2.3.0/24`. Similarly, for IPv6, `2001:db8::1/32` should be truncated to `2001:db8::/32`. */
31
+ value?: string;
32
+ }
33
+ interface CheckUpgradeResponse {
34
+ /** Output only. Url for a docker build log of an upgraded image. */
35
+ buildLogUri?: string;
36
+ /** Output only. Whether build has succeeded or failed on modules conflicts. */
37
+ containsPypiModulesConflict?: string;
38
+ /** Composer image for which the build was happening. */
39
+ imageVersion?: string;
40
+ /** Output only. Extract from a docker image build log containing information about pypi modules conflicts. */
41
+ pypiConflictBuildLogExtract?: string;
42
+ /** Pypi dependencies specified in the environment configuration, at the time when the build was triggered. */
43
+ pypiDependencies?: {[P in string]: string};
44
+ }
45
+ interface CidrBlock {
46
+ /** CIDR block that must be specified in CIDR notation. */
47
+ cidrBlock?: string;
48
+ /** User-defined name that identifies the CIDR block. */
49
+ displayName?: string;
50
+ }
51
+ interface DatabaseConfig {
52
+ /** Optional. Cloud SQL machine type used by Airflow database. It has to be one of: db-n1-standard-2, db-n1-standard-4, db-n1-standard-8 or db-n1-standard-16. If not specified, db-n1-standard-2 will be used. Supported for Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*. */
53
+ machineType?: string;
54
+ /** Optional. The Compute Engine zone where the Airflow database is created. If zone is provided, it must be in the region selected for the environment. If zone is not provided, a zone is automatically selected. The zone can only be set during environment creation. Supported for Cloud Composer environments in versions composer-2.*.*-airflow-*.*.*. */
55
+ zone?: string;
56
+ }
57
+ interface DatabaseFailoverRequest {}
58
+ interface DatabaseFailoverResponse {}
59
+ interface Date {
60
+ /** Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. */
61
+ day?: number;
62
+ /** Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. */
63
+ month?: number;
64
+ /** Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. */
65
+ year?: number;
66
+ }
67
+ interface Empty {}
68
+ interface EncryptionConfig {
69
+ /** Optional. Customer-managed Encryption Key available through Google's Key Management Service. Cannot be updated. If not specified, Google-managed key will be used. */
70
+ kmsKeyName?: string;
71
+ }
72
+ interface Environment {
73
+ /** Configuration parameters for this environment. */
74
+ config?: EnvironmentConfig;
75
+ /** Output only. The time at which this environment was created. */
76
+ createTime?: string;
77
+ /** Optional. User-defined labels for this environment. The labels map can contain no more than 64 entries. Entries of the labels map are UTF8 strings that comply with the following restrictions: * Keys must conform to regexp: \p{Ll}\p{Lo}{0,62} * Values must conform to regexp: [\p{Ll}\p{Lo}\p{N}_-]{0,63} * Both keys and values are additionally constrained to be <= 128 bytes in size. */
78
+ labels?: {[P in string]: string};
79
+ /** The resource name of the environment, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" EnvironmentId must start with a lowercase letter followed by up to 63 lowercase letters, numbers, or hyphens, and cannot end with a hyphen. */
80
+ name?: string;
81
+ /** Output only. Reserved for future use. */
82
+ satisfiesPzs?: boolean;
83
+ /** The current state of the environment. */
84
+ state?: string;
85
+ /** Optional. Storage configuration for this environment. */
86
+ storageConfig?: StorageConfig;
87
+ /** Output only. The time at which this environment was last modified. */
88
+ updateTime?: string;
89
+ /** Output only. The UUID (Universally Unique IDentifier) associated with this environment. This value is generated when the environment is created. */
90
+ uuid?: string;
91
+ }
92
+ interface EnvironmentConfig {
93
+ /** Output only. The 'bring your own identity' variant of the URI of the Apache Airflow Web UI hosted within this environment, to be accessed with external identities using workforce identity federation (see [Access environments with workforce identity federation](/composer/docs/composer-2/access-environments-with-workforce-identity-federation)). */
94
+ airflowByoidUri?: string;
95
+ /** Output only. The URI of the Apache Airflow Web UI hosted within this environment (see [Airflow web interface](/composer/docs/how-to/accessing/airflow-web-interface)). */
96
+ airflowUri?: string;
97
+ /** Output only. The Cloud Storage prefix of the DAGs for this environment. Although Cloud Storage objects reside in a flat namespace, a hierarchical file tree can be simulated using "/"-delimited object name prefixes. DAG objects for this environment reside in a simulated directory with the given prefix. */
98
+ dagGcsPrefix?: string;
99
+ /** Optional. The configuration settings for Cloud SQL instance used internally by Apache Airflow software. */
100
+ databaseConfig?: DatabaseConfig;
101
+ /** Optional. The encryption options for the Cloud Composer environment and its dependencies. Cannot be updated. */
102
+ encryptionConfig?: EncryptionConfig;
103
+ /** Optional. The size of the Cloud Composer environment. This field is supported for Cloud Composer environments in versions composer-2.*.*-airflow-*.*.* and newer. */
104
+ environmentSize?: string;
105
+ /** Output only. The Kubernetes Engine cluster used to run this environment. */
106
+ gkeCluster?: string;
107
+ /** Optional. The maintenance window is the period when Cloud Composer components may undergo maintenance. It is defined so that maintenance is not executed during peak hours or critical time periods. The system will not be under maintenance for every occurrence of this window, but when maintenance is planned, it will be scheduled during the window. The maintenance window period must encompass at least 12 hours per week. This may be split into multiple chunks, each with a size of at least 4 hours. If this value is omitted, the default value for maintenance window will be applied. The default value is Saturday and Sunday 00-06 GMT. */
108
+ maintenanceWindow?: MaintenanceWindow;
109
+ /** Optional. The configuration options for GKE cluster master authorized networks. By default master authorized networks feature is: - in case of private environment: enabled with no external networks allowlisted. - in case of public environment: disabled. */
110
+ masterAuthorizedNetworksConfig?: MasterAuthorizedNetworksConfig;
111
+ /** The configuration used for the Kubernetes Engine cluster. */
112
+ nodeConfig?: NodeConfig;
113
+ /** The number of nodes in the Kubernetes Engine cluster that will be used to run this environment. This field is supported for Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*. */
114
+ nodeCount?: number;
115
+ /** The configuration used for the Private IP Cloud Composer environment. */
116
+ privateEnvironmentConfig?: PrivateEnvironmentConfig;
117
+ /** Optional. The Recovery settings configuration of an environment. This field is supported for Cloud Composer environments in versions composer-2.*.*-airflow-*.*.* and newer. */
118
+ recoveryConfig?: RecoveryConfig;
119
+ /** Optional. Resilience mode of the Cloud Composer Environment. This field is supported for Cloud Composer environments in versions composer-2.2.0-airflow-*.*.* and newer. */
120
+ resilienceMode?: string;
121
+ /** The configuration settings for software inside the environment. */
122
+ softwareConfig?: SoftwareConfig;
123
+ /** Optional. The configuration settings for the Airflow web server App Engine instance. */
124
+ webServerConfig?: WebServerConfig;
125
+ /** Optional. The network-level access control policy for the Airflow web server. If unspecified, no network-level access restrictions will be applied. */
126
+ webServerNetworkAccessControl?: WebServerNetworkAccessControl;
127
+ /** Optional. The workloads configuration settings for the GKE cluster associated with the Cloud Composer environment. The GKE cluster runs Airflow scheduler, web server and workers workloads. This field is supported for Cloud Composer environments in versions composer-2.*.*-airflow-*.*.* and newer. */
128
+ workloadsConfig?: WorkloadsConfig;
129
+ }
130
+ interface ExecuteAirflowCommandRequest {
131
+ /** Airflow command. */
132
+ command?: string;
133
+ /** Parameters for the Airflow command/subcommand as an array of arguments. It may contain positional arguments like `["my-dag-id"]`, key-value parameters like `["--foo=bar"]` or `["--foo","bar"]`, or other flags like `["-f"]`. */
134
+ parameters?: string[];
135
+ /** Airflow subcommand. */
136
+ subcommand?: string;
137
+ }
138
+ interface ExecuteAirflowCommandResponse {
139
+ /** Error message. Empty if there was no error. */
140
+ error?: string;
141
+ /** The unique ID of the command execution for polling. */
142
+ executionId?: string;
143
+ /** The name of the pod where the command is executed. */
144
+ pod?: string;
145
+ /** The namespace of the pod where the command is executed. */
146
+ podNamespace?: string;
147
+ }
148
+ interface ExitInfo {
149
+ /** Error message. Empty if there was no error. */
150
+ error?: string;
151
+ /** The exit code from the command execution. */
152
+ exitCode?: number;
153
+ }
154
+ interface FetchDatabasePropertiesResponse {
155
+ /** The availability status of the failover replica. A false status indicates that the failover replica is out of sync. The primary instance can only fail over to the failover replica when the status is true. */
156
+ isFailoverReplicaAvailable?: boolean;
157
+ /** The Compute Engine zone that the instance is currently serving from. */
158
+ primaryGceZone?: string;
159
+ /** The Compute Engine zone that the failover instance is currently serving from for a regional Cloud SQL instance. */
160
+ secondaryGceZone?: string;
161
+ }
162
+ interface ImageVersion {
163
+ /** Whether it is impossible to create an environment with the image version. */
164
+ creationDisabled?: boolean;
165
+ /** The string identifier of the ImageVersion, in the form: "composer-x.y.z-airflow-a.b.c" */
166
+ imageVersionId?: string;
167
+ /** Whether this is the default ImageVersion used by Composer during environment creation if no input ImageVersion is specified. */
168
+ isDefault?: boolean;
169
+ /** The date of the version release. */
170
+ releaseDate?: Date;
171
+ /** supported python versions */
172
+ supportedPythonVersions?: string[];
173
+ /** Whether it is impossible to upgrade an environment running with the image version. */
174
+ upgradeDisabled?: boolean;
175
+ }
176
+ interface IPAllocationPolicy {
177
+ /** Optional. The IP address range used to allocate IP addresses to pods in the GKE cluster. For Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*, this field is applicable only when `use_ip_aliases` is true. Set to blank to have GKE choose a range with the default size. Set to /netmask (e.g. `/14`) to have GKE choose a range with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. */
178
+ clusterIpv4CidrBlock?: string;
179
+ /** Optional. The name of the GKE cluster's secondary range used to allocate IP addresses to pods. For Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*, this field is applicable only when `use_ip_aliases` is true. */
180
+ clusterSecondaryRangeName?: string;
181
+ /** Optional. The IP address range of the services IP addresses in this GKE cluster. For Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*, this field is applicable only when `use_ip_aliases` is true. Set to blank to have GKE choose a range with the default size. Set to /netmask (e.g. `/14`) to have GKE choose a range with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. */
182
+ servicesIpv4CidrBlock?: string;
183
+ /** Optional. The name of the services' secondary range used to allocate IP addresses to the GKE cluster. For Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*, this field is applicable only when `use_ip_aliases` is true. */
184
+ servicesSecondaryRangeName?: string;
185
+ /** Optional. Whether or not to enable Alias IPs in the GKE cluster. If `true`, a VPC-native cluster is created. This field is only supported for Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*. Environments in newer versions always use VPC-native GKE clusters. */
186
+ useIpAliases?: boolean;
187
+ }
188
+ interface Line {
189
+ /** Text content of the log line. */
190
+ content?: string;
191
+ /** Number of the line. */
192
+ lineNumber?: number;
193
+ }
194
+ interface ListEnvironmentsResponse {
195
+ /** The list of environments returned by a ListEnvironmentsRequest. */
196
+ environments?: Environment[];
197
+ /** The page token used to query for the next page if one exists. */
198
+ nextPageToken?: string;
199
+ }
200
+ interface ListImageVersionsResponse {
201
+ /** The list of supported ImageVersions in a location. */
202
+ imageVersions?: ImageVersion[];
203
+ /** The page token used to query for the next page if one exists. */
204
+ nextPageToken?: string;
205
+ }
206
+ interface ListOperationsResponse {
207
+ /** The standard List next-page token. */
208
+ nextPageToken?: string;
209
+ /** A list of operations that matches the specified filter in the request. */
210
+ operations?: Operation[];
211
+ }
212
+ interface LoadSnapshotRequest {
213
+ /** Whether or not to skip setting Airflow overrides when loading the environment's state. */
214
+ skipAirflowOverridesSetting?: boolean;
215
+ /** Whether or not to skip setting environment variables when loading the environment's state. */
216
+ skipEnvironmentVariablesSetting?: boolean;
217
+ /** Whether or not to skip copying Cloud Storage data when loading the environment's state. */
218
+ skipGcsDataCopying?: boolean;
219
+ /** Whether or not to skip installing Pypi packages when loading the environment's state. */
220
+ skipPypiPackagesInstallation?: boolean;
221
+ /** A Cloud Storage path to a snapshot to load, e.g.: "gs://my-bucket/snapshots/project_location_environment_timestamp". */
222
+ snapshotPath?: string;
223
+ }
224
+ interface LoadSnapshotResponse {}
225
+ interface MaintenanceWindow {
226
+ /** Required. Maintenance window end time. It is used only to calculate the duration of the maintenance window. The value for end-time must be in the future, relative to `start_time`. */
227
+ endTime?: string;
228
+ /** Required. Maintenance window recurrence. Format is a subset of [RFC-5545](https://tools.ietf.org/html/rfc5545) `RRULE`. The only allowed values for `FREQ` field are `FREQ=DAILY` and `FREQ=WEEKLY;BYDAY=...` Example values: `FREQ=WEEKLY;BYDAY=TU,WE`, `FREQ=DAILY`. */
229
+ recurrence?: string;
230
+ /** Required. Start time of the first recurrence of the maintenance window. */
231
+ startTime?: string;
232
+ }
233
+ interface MasterAuthorizedNetworksConfig {
234
+ /** Up to 50 external networks that could access Kubernetes master through HTTPS. */
235
+ cidrBlocks?: CidrBlock[];
236
+ /** Whether or not master authorized networks feature is enabled. */
237
+ enabled?: boolean;
238
+ }
239
+ interface NetworkingConfig {
240
+ /** Optional. Indicates the user requested specifc connection type between Tenant and Customer projects. You cannot set networking connection type in public IP environment. */
241
+ connectionType?: string;
242
+ }
243
+ interface NodeConfig {
244
+ /** Optional. The disk size in GB used for node VMs. Minimum size is 30GB. If unspecified, defaults to 100GB. Cannot be updated. This field is supported for Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*. */
245
+ diskSizeGb?: number;
246
+ /** Optional. Deploys 'ip-masq-agent' daemon set in the GKE cluster and defines nonMasqueradeCIDRs equals to pod IP range so IP masquerading is used for all destination addresses, except between pods traffic. See: https://cloud.google.com/kubernetes-engine/docs/how-to/ip-masquerade-agent */
247
+ enableIpMasqAgent?: boolean;
248
+ /** Optional. The configuration for controlling how IPs are allocated in the GKE cluster. */
249
+ ipAllocationPolicy?: IPAllocationPolicy;
250
+ /** Optional. The Compute Engine [zone](/compute/docs/regions-zones) in which to deploy the VMs used to run the Apache Airflow software, specified as a [relative resource name](/apis/design/resource_names#relative_resource_name). For example: "projects/{projectId}/zones/{zoneId}". This `location` must belong to the enclosing environment's project and location. If both this field and `nodeConfig.machineType` are specified, `nodeConfig.machineType` must belong to this `location`; if both are unspecified, the service will pick a zone in the Compute Engine region corresponding to the Cloud Composer location, and propagate that choice to both fields. If only one field (`location` or `nodeConfig.machineType`) is specified, the location information from the specified field will be propagated to the unspecified field. This field is supported for Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*. */
251
+ location?: string;
252
+ /** Optional. The Compute Engine [machine type](/compute/docs/machine-types) used for cluster instances, specified as a [relative resource name](/apis/design/resource_names#relative_resource_name). For example: "projects/{projectId}/zones/{zoneId}/machineTypes/{machineTypeId}". The `machineType` must belong to the enclosing environment's project and location. If both this field and `nodeConfig.location` are specified, this `machineType` must belong to the `nodeConfig.location`; if both are unspecified, the service will pick a zone in the Compute Engine region corresponding to the Cloud Composer location, and propagate that choice to both fields. If exactly one of this field and `nodeConfig.location` is specified, the location information from the specified field will be propagated to the unspecified field. The `machineTypeId` must not be a [shared-core machine type](/compute/docs/machine-types#sharedcore). If this field is unspecified, the `machineTypeId` defaults to "n1-standard-1". This field is supported for Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*. */
253
+ machineType?: string;
254
+ /** Optional. The Compute Engine network to be used for machine communications, specified as a [relative resource name](/apis/design/resource_names#relative_resource_name). For example: "projects/{projectId}/global/networks/{networkId}". If unspecified, the "default" network ID in the environment's project is used. If a [Custom Subnet Network](/vpc/docs/vpc#vpc_networks_and_subnets) is provided, `nodeConfig.subnetwork` must also be provided. For [Shared VPC](/vpc/docs/shared-vpc) subnetwork requirements, see `nodeConfig.subnetwork`. */
255
+ network?: string;
256
+ /** Optional. The set of Google API scopes to be made available on all node VMs. If `oauth_scopes` is empty, defaults to ["https://www.googleapis.com/auth/cloud-platform"]. Cannot be updated. This field is supported for Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*. */
257
+ oauthScopes?: string[];
258
+ /** Optional. The Google Cloud Platform Service Account to be used by the node VMs. If a service account is not specified, the "default" Compute Engine service account is used. Cannot be updated. */
259
+ serviceAccount?: string;
260
+ /** Optional. The Compute Engine subnetwork to be used for machine communications, specified as a [relative resource name](/apis/design/resource_names#relative_resource_name). For example: "projects/{projectId}/regions/{regionId}/subnetworks/{subnetworkId}" If a subnetwork is provided, `nodeConfig.network` must also be provided, and the subnetwork must belong to the enclosing environment's project and location. */
261
+ subnetwork?: string;
262
+ /** Optional. The list of instance tags applied to all node VMs. Tags are used to identify valid sources or targets for network firewalls. Each tag within the list must comply with [RFC1035](https://www.ietf.org/rfc/rfc1035.txt). Cannot be updated. */
263
+ tags?: string[];
264
+ }
265
+ interface Operation {
266
+ /** If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */
267
+ done?: boolean;
268
+ /** The error result of the operation in case of failure or cancellation. */
269
+ error?: Status;
270
+ /** Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */
271
+ metadata?: {[P in string]: any};
272
+ /** The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */
273
+ name?: string;
274
+ /** The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */
275
+ response?: {[P in string]: any};
276
+ }
277
+ interface OperationMetadata {
278
+ /** Output only. The time the operation was submitted to the server. */
279
+ createTime?: string;
280
+ /** Output only. The time when the operation terminated, regardless of its success. This field is unset if the operation is still ongoing. */
281
+ endTime?: string;
282
+ /** Output only. The type of operation being performed. */
283
+ operationType?: string;
284
+ /** Output only. The resource being operated on, as a [relative resource name]( /apis/design/resource_names#relative_resource_name). */
285
+ resource?: string;
286
+ /** Output only. The UUID of the resource being operated on. */
287
+ resourceUuid?: string;
288
+ /** Output only. The current operation state. */
289
+ state?: string;
290
+ }
291
+ interface PollAirflowCommandRequest {
292
+ /** The unique ID of the command execution. */
293
+ executionId?: string;
294
+ /** Line number from which new logs should be fetched. */
295
+ nextLineNumber?: number;
296
+ /** The name of the pod where the command is executed. */
297
+ pod?: string;
298
+ /** The namespace of the pod where the command is executed. */
299
+ podNamespace?: string;
1881
300
  }
301
+ interface PollAirflowCommandResponse {
302
+ /** The result exit status of the command. */
303
+ exitInfo?: ExitInfo;
304
+ /** Output from the command execution. It may not contain the full output and the caller may need to poll for more lines. */
305
+ output?: Line[];
306
+ /** Whether the command execution has finished and there is no more output. */
307
+ outputEnd?: boolean;
308
+ }
309
+ interface PrivateClusterConfig {
310
+ /** Optional. If `true`, access to the public endpoint of the GKE cluster is denied. */
311
+ enablePrivateEndpoint?: boolean;
312
+ /** Optional. The CIDR block from which IPv4 range for GKE master will be reserved. If left blank, the default value of '172.16.0.0/23' is used. */
313
+ masterIpv4CidrBlock?: string;
314
+ /** Output only. The IP range in CIDR notation to use for the hosted master network. This range is used for assigning internal IP addresses to the GKE cluster master or set of masters and to the internal load balancer virtual IP. This range must not overlap with any other ranges in use within the cluster's network. */
315
+ masterIpv4ReservedRange?: string;
316
+ }
317
+ interface PrivateEnvironmentConfig {
318
+ /** Optional. When specified, the environment will use Private Service Connect instead of VPC peerings to connect to Cloud SQL in the Tenant Project, and the PSC endpoint in the Customer Project will use an IP address from this subnetwork. */
319
+ cloudComposerConnectionSubnetwork?: string;
320
+ /** Optional. The CIDR block from which IP range for Cloud Composer Network in tenant project will be reserved. Needs to be disjoint from private_cluster_config.master_ipv4_cidr_block and cloud_sql_ipv4_cidr_block. This field is supported for Cloud Composer environments in versions composer-2.*.*-airflow-*.*.* and newer. */
321
+ cloudComposerNetworkIpv4CidrBlock?: string;
322
+ /** Output only. The IP range reserved for the tenant project's Cloud Composer network. This field is supported for Cloud Composer environments in versions composer-2.*.*-airflow-*.*.* and newer. */
323
+ cloudComposerNetworkIpv4ReservedRange?: string;
324
+ /** Optional. The CIDR block from which IP range in tenant project will be reserved for Cloud SQL. Needs to be disjoint from `web_server_ipv4_cidr_block`. */
325
+ cloudSqlIpv4CidrBlock?: string;
326
+ /** Optional. If `true`, a Private IP Cloud Composer environment is created. If this field is set to true, `IPAllocationPolicy.use_ip_aliases` must be set to true for Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*. */
327
+ enablePrivateEnvironment?: boolean;
328
+ /** Optional. When enabled, IPs from public (non-RFC1918) ranges can be used for `IPAllocationPolicy.cluster_ipv4_cidr_block` and `IPAllocationPolicy.service_ipv4_cidr_block`. */
329
+ enablePrivatelyUsedPublicIps?: boolean;
330
+ /** Optional. Configuration for the network connections configuration in the environment. */
331
+ networkingConfig?: NetworkingConfig;
332
+ /** Optional. Configuration for the private GKE cluster for a Private IP Cloud Composer environment. */
333
+ privateClusterConfig?: PrivateClusterConfig;
334
+ /** Optional. The CIDR block from which IP range for web server will be reserved. Needs to be disjoint from `private_cluster_config.master_ipv4_cidr_block` and `cloud_sql_ipv4_cidr_block`. This field is supported for Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*. */
335
+ webServerIpv4CidrBlock?: string;
336
+ /** Output only. The IP range reserved for the tenant project's App Engine VMs. This field is supported for Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*. */
337
+ webServerIpv4ReservedRange?: string;
338
+ }
339
+ interface RecoveryConfig {
340
+ /** Optional. The configuration for scheduled snapshot creation mechanism. */
341
+ scheduledSnapshotsConfig?: ScheduledSnapshotsConfig;
342
+ }
343
+ interface SaveSnapshotRequest {
344
+ /** Location in a Cloud Storage where the snapshot is going to be stored, e.g.: "gs://my-bucket/snapshots". */
345
+ snapshotLocation?: string;
346
+ }
347
+ interface SaveSnapshotResponse {
348
+ /** The fully-resolved Cloud Storage path of the created snapshot, e.g.: "gs://my-bucket/snapshots/project_location_environment_timestamp". This field is populated only if the snapshot creation was successful. */
349
+ snapshotPath?: string;
350
+ }
351
+ interface ScheduledSnapshotsConfig {
352
+ /** Optional. Whether scheduled snapshots creation is enabled. */
353
+ enabled?: boolean;
354
+ /** Optional. The cron expression representing the time when snapshots creation mechanism runs. This field is subject to additional validation around frequency of execution. */
355
+ snapshotCreationSchedule?: string;
356
+ /** Optional. The Cloud Storage location for storing automatically created snapshots. */
357
+ snapshotLocation?: string;
358
+ /** Optional. Time zone that sets the context to interpret snapshot_creation_schedule. */
359
+ timeZone?: string;
360
+ }
361
+ interface SchedulerResource {
362
+ /** Optional. The number of schedulers. */
363
+ count?: number;
364
+ /** Optional. CPU request and limit for a single Airflow scheduler replica. */
365
+ cpu?: number;
366
+ /** Optional. Memory (GB) request and limit for a single Airflow scheduler replica. */
367
+ memoryGb?: number;
368
+ /** Optional. Storage (GB) request and limit for a single Airflow scheduler replica. */
369
+ storageGb?: number;
370
+ }
371
+ interface SoftwareConfig {
372
+ /** Optional. Apache Airflow configuration properties to override. Property keys contain the section and property names, separated by a hyphen, for example "core-dags_are_paused_at_creation". Section names must not contain hyphens ("-"), opening square brackets ("["), or closing square brackets ("]"). The property name must not be empty and must not contain an equals sign ("=") or semicolon (";"). Section and property names must not contain a period ("."). Apache Airflow configuration property names must be written in [snake_case](https://en.wikipedia.org/wiki/Snake_case). Property values can contain any character, and can be written in any lower/upper case format. Certain Apache Airflow configuration property values are [blocked](/composer/docs/concepts/airflow-configurations), and cannot be overridden. */
373
+ airflowConfigOverrides?: {[P in string]: string};
374
+ /** Optional. Additional environment variables to provide to the Apache Airflow scheduler, worker, and webserver processes. Environment variable names must match the regular expression `a-zA-Z_*`. They cannot specify Apache Airflow software configuration overrides (they cannot match the regular expression `AIRFLOW__[A-Z0-9_]+__[A-Z0-9_]+`), and they cannot match any of the following reserved names: * `AIRFLOW_HOME` * `C_FORCE_ROOT` * `CONTAINER_NAME` * `DAGS_FOLDER` * `GCP_PROJECT` * `GCS_BUCKET` * `GKE_CLUSTER_NAME` * `SQL_DATABASE` * `SQL_INSTANCE` * `SQL_PASSWORD` * `SQL_PROJECT` * `SQL_REGION` * `SQL_USER` */
375
+ envVariables?: {[P in string]: string};
376
+ /** The version of the software running in the environment. This encapsulates both the version of Cloud Composer functionality and the version of Apache Airflow. It must match the regular expression `composer-([0-9]+(\.[0-9]+\.[0-9]+(-preview\.[0-9]+)?)?|latest)-airflow-([0-9]+(\.[0-9]+(\.[0-9]+)?)?)`. When used as input, the server also checks if the provided version is supported and denies the request for an unsupported version. The Cloud Composer portion of the image version is a full [semantic version](https://semver.org), or an alias in the form of major version number or `latest`. When an alias is provided, the server replaces it with the current Cloud Composer version that satisfies the alias. The Apache Airflow portion of the image version is a full semantic version that points to one of the supported Apache Airflow versions, or an alias in the form of only major or major.minor versions specified. When an alias is provided, the server replaces it with the latest Apache Airflow version that satisfies the alias and is supported in the given Cloud Composer version. In all cases, the resolved image version is stored in the same field. See also [version list](/composer/docs/concepts/versioning/composer-versions) and [versioning overview](/composer/docs/concepts/versioning/composer-versioning-overview). */
377
+ imageVersion?: string;
378
+ /** Optional. Custom Python Package Index (PyPI) packages to be installed in the environment. Keys refer to the lowercase package name such as "numpy" and values are the lowercase extras and version specifier such as "==1.12.0", "[devel,gcp_api]", or "[devel]>=1.8.2, <1.9.2". To specify a package without pinning it to a version specifier, use the empty string as the value. */
379
+ pypiPackages?: {[P in string]: string};
380
+ /** Optional. The major version of Python used to run the Apache Airflow scheduler, worker, and webserver processes. Can be set to '2' or '3'. If not specified, the default is '3'. Cannot be updated. This field is only supported for Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*. Environments in newer versions always use Python major version 3. */
381
+ pythonVersion?: string;
382
+ /** Optional. The number of schedulers for Airflow. This field is supported for Cloud Composer environments in versions composer-1.*.*-airflow-2.*.*. */
383
+ schedulerCount?: number;
384
+ }
385
+ interface Status {
386
+ /** The status code, which should be an enum value of google.rpc.Code. */
387
+ code?: number;
388
+ /** A list of messages that carry the error details. There is a common set of message types for APIs to use. */
389
+ details?: Array<{[P in string]: any}>;
390
+ /** 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. */
391
+ message?: string;
392
+ }
393
+ interface StopAirflowCommandRequest {
394
+ /** The unique ID of the command execution. */
395
+ executionId?: string;
396
+ /** If true, the execution is terminated forcefully (SIGKILL). If false, the execution is stopped gracefully, giving it time for cleanup. */
397
+ force?: boolean;
398
+ /** The name of the pod where the command is executed. */
399
+ pod?: string;
400
+ /** The namespace of the pod where the command is executed. */
401
+ podNamespace?: string;
402
+ }
403
+ interface StopAirflowCommandResponse {
404
+ /** Whether the execution is still running. */
405
+ isDone?: boolean;
406
+ /** Output message from stopping execution request. */
407
+ output?: string[];
408
+ }
409
+ interface StorageConfig {
410
+ /** Optional. The name of the Cloud Storage bucket used by the environment. No `gs://` prefix. */
411
+ bucket?: string;
412
+ }
413
+ interface TriggererResource {
414
+ /** Optional. The number of triggerers. */
415
+ count?: number;
416
+ /** Optional. CPU request and limit for a single Airflow triggerer replica. */
417
+ cpu?: number;
418
+ /** Optional. Memory (GB) request and limit for a single Airflow triggerer replica. */
419
+ memoryGb?: number;
420
+ }
421
+ interface WebServerConfig {
422
+ /** Optional. Machine type on which Airflow web server is running. It has to be one of: composer-n1-webserver-2, composer-n1-webserver-4 or composer-n1-webserver-8. If not specified, composer-n1-webserver-2 will be used. Value custom is returned only in response, if Airflow web server parameters were manually changed to a non-standard values. */
423
+ machineType?: string;
424
+ }
425
+ interface WebServerNetworkAccessControl {
426
+ /** A collection of allowed IP ranges with descriptions. */
427
+ allowedIpRanges?: AllowedIpRange[];
428
+ }
429
+ interface WebServerResource {
430
+ /** Optional. CPU request and limit for Airflow web server. */
431
+ cpu?: number;
432
+ /** Optional. Memory (GB) request and limit for Airflow web server. */
433
+ memoryGb?: number;
434
+ /** Optional. Storage (GB) request and limit for Airflow web server. */
435
+ storageGb?: number;
436
+ }
437
+ interface WorkerResource {
438
+ /** Optional. CPU request and limit for a single Airflow worker replica. */
439
+ cpu?: number;
440
+ /** Optional. Maximum number of workers for autoscaling. */
441
+ maxCount?: number;
442
+ /** Optional. Memory (GB) request and limit for a single Airflow worker replica. */
443
+ memoryGb?: number;
444
+ /** Optional. Minimum number of workers for autoscaling. */
445
+ minCount?: number;
446
+ /** Optional. Storage (GB) request and limit for a single Airflow worker replica. */
447
+ storageGb?: number;
448
+ }
449
+ interface WorkloadsConfig {
450
+ /** Optional. Resources used by Airflow schedulers. */
451
+ scheduler?: SchedulerResource;
452
+ /** Optional. Resources used by Airflow triggerers. */
453
+ triggerer?: TriggererResource;
454
+ /** Optional. Resources used by Airflow web server. */
455
+ webServer?: WebServerResource;
456
+ /** Optional. Resources used by Airflow workers. */
457
+ worker?: WorkerResource;
458
+ }
459
+ interface EnvironmentsResource {
460
+ /** Create a new environment. */
461
+ create(request: {
462
+ /** V1 error format. */
463
+ '$.xgafv'?: string;
464
+ /** OAuth access token. */
465
+ access_token?: string;
466
+ /** Data format for response. */
467
+ alt?: string;
468
+ /** JSONP */
469
+ callback?: string;
470
+ /** Selector specifying which fields to include in a partial response. */
471
+ fields?: string;
472
+ /** 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. */
473
+ key?: string;
474
+ /** OAuth 2.0 token for the current user. */
475
+ oauth_token?: string;
476
+ /** The parent must be of the form "projects/{projectId}/locations/{locationId}". */
477
+ parent: string;
478
+ /** Returns response with indentations and line breaks. */
479
+ prettyPrint?: boolean;
480
+ /** 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. */
481
+ quotaUser?: string;
482
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
483
+ upload_protocol?: string;
484
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
485
+ uploadType?: string;
486
+ /** Request body */
487
+ resource: Environment;
488
+ }): Request<Operation>;
489
+ create(
490
+ request: {
491
+ /** V1 error format. */
492
+ '$.xgafv'?: string;
493
+ /** OAuth access token. */
494
+ access_token?: string;
495
+ /** Data format for response. */
496
+ alt?: string;
497
+ /** JSONP */
498
+ callback?: string;
499
+ /** Selector specifying which fields to include in a partial response. */
500
+ fields?: string;
501
+ /** 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. */
502
+ key?: string;
503
+ /** OAuth 2.0 token for the current user. */
504
+ oauth_token?: string;
505
+ /** The parent must be of the form "projects/{projectId}/locations/{locationId}". */
506
+ parent: string;
507
+ /** Returns response with indentations and line breaks. */
508
+ prettyPrint?: boolean;
509
+ /** 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. */
510
+ quotaUser?: string;
511
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
512
+ upload_protocol?: string;
513
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
514
+ uploadType?: string;
515
+ },
516
+ body: Environment
517
+ ): Request<Operation>;
518
+ /** Triggers database failover (only for highly resilient environments). */
519
+ databaseFailover(request: {
520
+ /** V1 error format. */
521
+ '$.xgafv'?: string;
522
+ /** OAuth access token. */
523
+ access_token?: string;
524
+ /** Data format for response. */
525
+ alt?: string;
526
+ /** JSONP */
527
+ callback?: string;
528
+ /** Target environment: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" */
529
+ environment: string;
530
+ /** Selector specifying which fields to include in a partial response. */
531
+ fields?: string;
532
+ /** 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. */
533
+ key?: string;
534
+ /** OAuth 2.0 token for the current user. */
535
+ oauth_token?: string;
536
+ /** Returns response with indentations and line breaks. */
537
+ prettyPrint?: boolean;
538
+ /** 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. */
539
+ quotaUser?: string;
540
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
541
+ upload_protocol?: string;
542
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
543
+ uploadType?: string;
544
+ /** Request body */
545
+ resource: DatabaseFailoverRequest;
546
+ }): Request<Operation>;
547
+ databaseFailover(
548
+ request: {
549
+ /** V1 error format. */
550
+ '$.xgafv'?: string;
551
+ /** OAuth access token. */
552
+ access_token?: string;
553
+ /** Data format for response. */
554
+ alt?: string;
555
+ /** JSONP */
556
+ callback?: string;
557
+ /** Target environment: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" */
558
+ environment: string;
559
+ /** Selector specifying which fields to include in a partial response. */
560
+ fields?: string;
561
+ /** 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. */
562
+ key?: string;
563
+ /** OAuth 2.0 token for the current user. */
564
+ oauth_token?: string;
565
+ /** Returns response with indentations and line breaks. */
566
+ prettyPrint?: boolean;
567
+ /** 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. */
568
+ quotaUser?: string;
569
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
570
+ upload_protocol?: string;
571
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
572
+ uploadType?: string;
573
+ },
574
+ body: DatabaseFailoverRequest
575
+ ): Request<Operation>;
576
+ /** Delete an environment. */
577
+ delete(request?: {
578
+ /** V1 error format. */
579
+ '$.xgafv'?: string;
580
+ /** OAuth access token. */
581
+ access_token?: string;
582
+ /** Data format for response. */
583
+ alt?: string;
584
+ /** JSONP */
585
+ callback?: string;
586
+ /** Selector specifying which fields to include in a partial response. */
587
+ fields?: string;
588
+ /** 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. */
589
+ key?: string;
590
+ /** The environment to delete, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" */
591
+ name: string;
592
+ /** OAuth 2.0 token for the current user. */
593
+ oauth_token?: string;
594
+ /** Returns response with indentations and line breaks. */
595
+ prettyPrint?: boolean;
596
+ /** 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. */
597
+ quotaUser?: string;
598
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
599
+ upload_protocol?: string;
600
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
601
+ uploadType?: string;
602
+ }): Request<Operation>;
603
+ /** Executes Airflow CLI command. */
604
+ executeAirflowCommand(request: {
605
+ /** V1 error format. */
606
+ '$.xgafv'?: string;
607
+ /** OAuth access token. */
608
+ access_token?: string;
609
+ /** Data format for response. */
610
+ alt?: string;
611
+ /** JSONP */
612
+ callback?: string;
613
+ /** The resource name of the environment in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}". */
614
+ environment: string;
615
+ /** Selector specifying which fields to include in a partial response. */
616
+ fields?: string;
617
+ /** 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. */
618
+ key?: string;
619
+ /** OAuth 2.0 token for the current user. */
620
+ oauth_token?: string;
621
+ /** Returns response with indentations and line breaks. */
622
+ prettyPrint?: boolean;
623
+ /** 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. */
624
+ quotaUser?: string;
625
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
626
+ upload_protocol?: string;
627
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
628
+ uploadType?: string;
629
+ /** Request body */
630
+ resource: ExecuteAirflowCommandRequest;
631
+ }): Request<ExecuteAirflowCommandResponse>;
632
+ executeAirflowCommand(
633
+ request: {
634
+ /** V1 error format. */
635
+ '$.xgafv'?: string;
636
+ /** OAuth access token. */
637
+ access_token?: string;
638
+ /** Data format for response. */
639
+ alt?: string;
640
+ /** JSONP */
641
+ callback?: string;
642
+ /** The resource name of the environment in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}". */
643
+ environment: string;
644
+ /** Selector specifying which fields to include in a partial response. */
645
+ fields?: string;
646
+ /** 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. */
647
+ key?: string;
648
+ /** OAuth 2.0 token for the current user. */
649
+ oauth_token?: string;
650
+ /** Returns response with indentations and line breaks. */
651
+ prettyPrint?: boolean;
652
+ /** 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. */
653
+ quotaUser?: string;
654
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
655
+ upload_protocol?: string;
656
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
657
+ uploadType?: string;
658
+ },
659
+ body: ExecuteAirflowCommandRequest
660
+ ): Request<ExecuteAirflowCommandResponse>;
661
+ /** Fetches database properties. */
662
+ fetchDatabaseProperties(request?: {
663
+ /** V1 error format. */
664
+ '$.xgafv'?: string;
665
+ /** OAuth access token. */
666
+ access_token?: string;
667
+ /** Data format for response. */
668
+ alt?: string;
669
+ /** JSONP */
670
+ callback?: string;
671
+ /** Required. The resource name of the environment, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" */
672
+ environment: string;
673
+ /** Selector specifying which fields to include in a partial response. */
674
+ fields?: string;
675
+ /** 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. */
676
+ key?: string;
677
+ /** OAuth 2.0 token for the current user. */
678
+ oauth_token?: string;
679
+ /** Returns response with indentations and line breaks. */
680
+ prettyPrint?: boolean;
681
+ /** 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. */
682
+ quotaUser?: string;
683
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
684
+ upload_protocol?: string;
685
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
686
+ uploadType?: string;
687
+ }): Request<FetchDatabasePropertiesResponse>;
688
+ /** Get an existing environment. */
689
+ get(request?: {
690
+ /** V1 error format. */
691
+ '$.xgafv'?: string;
692
+ /** OAuth access token. */
693
+ access_token?: string;
694
+ /** Data format for response. */
695
+ alt?: string;
696
+ /** JSONP */
697
+ callback?: string;
698
+ /** Selector specifying which fields to include in a partial response. */
699
+ fields?: string;
700
+ /** 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. */
701
+ key?: string;
702
+ /** The resource name of the environment to get, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" */
703
+ name: string;
704
+ /** OAuth 2.0 token for the current user. */
705
+ oauth_token?: string;
706
+ /** Returns response with indentations and line breaks. */
707
+ prettyPrint?: boolean;
708
+ /** 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. */
709
+ quotaUser?: string;
710
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
711
+ upload_protocol?: string;
712
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
713
+ uploadType?: string;
714
+ }): Request<Environment>;
715
+ /** List environments. */
716
+ list(request?: {
717
+ /** V1 error format. */
718
+ '$.xgafv'?: string;
719
+ /** OAuth access token. */
720
+ access_token?: string;
721
+ /** Data format for response. */
722
+ alt?: string;
723
+ /** JSONP */
724
+ callback?: string;
725
+ /** Selector specifying which fields to include in a partial response. */
726
+ fields?: string;
727
+ /** 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. */
728
+ key?: string;
729
+ /** OAuth 2.0 token for the current user. */
730
+ oauth_token?: string;
731
+ /** The maximum number of environments to return. */
732
+ pageSize?: number;
733
+ /** The next_page_token value returned from a previous List request, if any. */
734
+ pageToken?: string;
735
+ /** List environments in the given project and location, in the form: "projects/{projectId}/locations/{locationId}" */
736
+ parent: string;
737
+ /** Returns response with indentations and line breaks. */
738
+ prettyPrint?: boolean;
739
+ /** 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. */
740
+ quotaUser?: string;
741
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
742
+ upload_protocol?: string;
743
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
744
+ uploadType?: string;
745
+ }): Request<ListEnvironmentsResponse>;
746
+ /** Loads a snapshot of a Cloud Composer environment. As a result of this operation, a snapshot of environment's specified in LoadSnapshotRequest is loaded into the environment. */
747
+ loadSnapshot(request: {
748
+ /** V1 error format. */
749
+ '$.xgafv'?: string;
750
+ /** OAuth access token. */
751
+ access_token?: string;
752
+ /** Data format for response. */
753
+ alt?: string;
754
+ /** JSONP */
755
+ callback?: string;
756
+ /** The resource name of the target environment in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" */
757
+ environment: string;
758
+ /** Selector specifying which fields to include in a partial response. */
759
+ fields?: string;
760
+ /** 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. */
761
+ key?: string;
762
+ /** OAuth 2.0 token for the current user. */
763
+ oauth_token?: string;
764
+ /** Returns response with indentations and line breaks. */
765
+ prettyPrint?: boolean;
766
+ /** 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. */
767
+ quotaUser?: string;
768
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
769
+ upload_protocol?: string;
770
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
771
+ uploadType?: string;
772
+ /** Request body */
773
+ resource: LoadSnapshotRequest;
774
+ }): Request<Operation>;
775
+ loadSnapshot(
776
+ request: {
777
+ /** V1 error format. */
778
+ '$.xgafv'?: string;
779
+ /** OAuth access token. */
780
+ access_token?: string;
781
+ /** Data format for response. */
782
+ alt?: string;
783
+ /** JSONP */
784
+ callback?: string;
785
+ /** The resource name of the target environment in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" */
786
+ environment: string;
787
+ /** Selector specifying which fields to include in a partial response. */
788
+ fields?: string;
789
+ /** 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. */
790
+ key?: string;
791
+ /** OAuth 2.0 token for the current user. */
792
+ oauth_token?: string;
793
+ /** Returns response with indentations and line breaks. */
794
+ prettyPrint?: boolean;
795
+ /** 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. */
796
+ quotaUser?: string;
797
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
798
+ upload_protocol?: string;
799
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
800
+ uploadType?: string;
801
+ },
802
+ body: LoadSnapshotRequest
803
+ ): Request<Operation>;
804
+ /** Update an environment. */
805
+ patch(request: {
806
+ /** V1 error format. */
807
+ '$.xgafv'?: string;
808
+ /** OAuth access token. */
809
+ access_token?: string;
810
+ /** Data format for response. */
811
+ alt?: string;
812
+ /** JSONP */
813
+ callback?: string;
814
+ /** Selector specifying which fields to include in a partial response. */
815
+ fields?: string;
816
+ /** 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. */
817
+ key?: string;
818
+ /** The relative resource name of the environment to update, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" */
819
+ name: string;
820
+ /** OAuth 2.0 token for the current user. */
821
+ oauth_token?: string;
822
+ /** Returns response with indentations and line breaks. */
823
+ prettyPrint?: boolean;
824
+ /** 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. */
825
+ quotaUser?: string;
826
+ /** Required. A comma-separated list of paths, relative to `Environment`, of fields to update. For example, to set the version of scikit-learn to install in the environment to 0.19.0 and to remove an existing installation of numpy, the `updateMask` parameter would include the following two `paths` values: "config.softwareConfig.pypiPackages.scikit-learn" and "config.softwareConfig.pypiPackages.numpy". The included patch environment would specify the scikit-learn version as follows: { "config":{ "softwareConfig":{ "pypiPackages":{ "scikit-learn":"==0.19.0" } } } } Note that in the above example, any existing PyPI packages other than scikit-learn and numpy will be unaffected. Only one update type may be included in a single request's `updateMask`. For example, one cannot update both the PyPI packages and labels in the same request. However, it is possible to update multiple members of a map field simultaneously in the same request. For example, to set the labels "label1" and "label2" while clearing "label3" (assuming it already exists), one can provide the paths "labels.label1", "labels.label2", and "labels.label3" and populate the patch environment as follows: { "labels":{ "label1":"new-label1-value" "label2":"new-label2-value" } } Note that in the above example, any existing labels that are not included in the `updateMask` will be unaffected. It is also possible to replace an entire map field by providing the map field's path in the `updateMask`. The new value of the field will be that which is provided in the patch environment. For example, to delete all pre-existing user-specified PyPI packages and install botocore at version 1.7.14, the `updateMask` would contain the path "config.softwareConfig.pypiPackages", and the patch environment would be the following: { "config":{ "softwareConfig":{ "pypiPackages":{ "botocore":"==1.7.14" } } } } **Note:** Only the following fields can be updated: * `config.softwareConfig.pypiPackages` * Replace all custom custom PyPI packages. If a replacement package map is not included in `environment`, all custom PyPI packages are cleared. It is an error to provide both this mask and a mask specifying an individual package. * `config.softwareConfig.pypiPackages.`packagename * Update the custom PyPI package *packagename*, preserving other packages. To delete the package, include it in `updateMask`, and omit the mapping for it in `environment.config.softwareConfig.pypiPackages`. It is an error to provide both a mask of this form and the `config.softwareConfig.pypiPackages` mask. * `labels` * Replace all environment labels. If a replacement labels map is not included in `environment`, all labels are cleared. It is an error to provide both this mask and a mask specifying one or more individual labels. * `labels.`labelName * Set the label named *labelName*, while preserving other labels. To delete the label, include it in `updateMask` and omit its mapping in `environment.labels`. It is an error to provide both a mask of this form and the `labels` mask. * `config.nodeCount` * Horizontally scale the number of nodes in the environment. An integer greater than or equal to 3 must be provided in the `config.nodeCount` field. Supported for Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*. * `config.webServerNetworkAccessControl` * Replace the environment's current `WebServerNetworkAccessControl`. * `config.softwareConfig.airflowConfigOverrides` * Replace all Apache Airflow config overrides. If a replacement config overrides map is not included in `environment`, all config overrides are cleared. It is an error to provide both this mask and a mask specifying one or more individual config overrides. * `config.softwareConfig.airflowConfigOverrides.`section-name * Override the Apache Airflow config property *name* in the section named *section*, preserving other properties. To delete the property override, include it in `updateMask` and omit its mapping in `environment.config.softwareConfig.airflowConfigOverrides`. It is an error to provide both a mask of this form and the `config.softwareConfig.airflowConfigOverrides` mask. * `config.softwareConfig.envVariables` * Replace all environment variables. If a replacement environment variable map is not included in `environment`, all custom environment variables are cleared. * `config.softwareConfig.schedulerCount` * Horizontally scale the number of schedulers in Airflow. A positive integer not greater than the number of nodes must be provided in the `config.softwareConfig.schedulerCount` field. Supported for Cloud Composer environments in versions composer-1.*.*-airflow-2.*.*. * `config.databaseConfig.machineType` * Cloud SQL machine type used by Airflow database. It has to be one of: db-n1-standard-2, db-n1-standard-4, db-n1-standard-8 or db-n1-standard-16. Supported for Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*. * `config.webServerConfig.machineType` * Machine type on which Airflow web server is running. It has to be one of: composer-n1-webserver-2, composer-n1-webserver-4 or composer-n1-webserver-8. Supported for Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*. */
827
+ updateMask?: string;
828
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
829
+ upload_protocol?: string;
830
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
831
+ uploadType?: string;
832
+ /** Request body */
833
+ resource: Environment;
834
+ }): Request<Operation>;
835
+ patch(
836
+ request: {
837
+ /** V1 error format. */
838
+ '$.xgafv'?: string;
839
+ /** OAuth access token. */
840
+ access_token?: string;
841
+ /** Data format for response. */
842
+ alt?: string;
843
+ /** JSONP */
844
+ callback?: string;
845
+ /** Selector specifying which fields to include in a partial response. */
846
+ fields?: string;
847
+ /** 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. */
848
+ key?: string;
849
+ /** The relative resource name of the environment to update, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" */
850
+ name: string;
851
+ /** OAuth 2.0 token for the current user. */
852
+ oauth_token?: string;
853
+ /** Returns response with indentations and line breaks. */
854
+ prettyPrint?: boolean;
855
+ /** 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. */
856
+ quotaUser?: string;
857
+ /** Required. A comma-separated list of paths, relative to `Environment`, of fields to update. For example, to set the version of scikit-learn to install in the environment to 0.19.0 and to remove an existing installation of numpy, the `updateMask` parameter would include the following two `paths` values: "config.softwareConfig.pypiPackages.scikit-learn" and "config.softwareConfig.pypiPackages.numpy". The included patch environment would specify the scikit-learn version as follows: { "config":{ "softwareConfig":{ "pypiPackages":{ "scikit-learn":"==0.19.0" } } } } Note that in the above example, any existing PyPI packages other than scikit-learn and numpy will be unaffected. Only one update type may be included in a single request's `updateMask`. For example, one cannot update both the PyPI packages and labels in the same request. However, it is possible to update multiple members of a map field simultaneously in the same request. For example, to set the labels "label1" and "label2" while clearing "label3" (assuming it already exists), one can provide the paths "labels.label1", "labels.label2", and "labels.label3" and populate the patch environment as follows: { "labels":{ "label1":"new-label1-value" "label2":"new-label2-value" } } Note that in the above example, any existing labels that are not included in the `updateMask` will be unaffected. It is also possible to replace an entire map field by providing the map field's path in the `updateMask`. The new value of the field will be that which is provided in the patch environment. For example, to delete all pre-existing user-specified PyPI packages and install botocore at version 1.7.14, the `updateMask` would contain the path "config.softwareConfig.pypiPackages", and the patch environment would be the following: { "config":{ "softwareConfig":{ "pypiPackages":{ "botocore":"==1.7.14" } } } } **Note:** Only the following fields can be updated: * `config.softwareConfig.pypiPackages` * Replace all custom custom PyPI packages. If a replacement package map is not included in `environment`, all custom PyPI packages are cleared. It is an error to provide both this mask and a mask specifying an individual package. * `config.softwareConfig.pypiPackages.`packagename * Update the custom PyPI package *packagename*, preserving other packages. To delete the package, include it in `updateMask`, and omit the mapping for it in `environment.config.softwareConfig.pypiPackages`. It is an error to provide both a mask of this form and the `config.softwareConfig.pypiPackages` mask. * `labels` * Replace all environment labels. If a replacement labels map is not included in `environment`, all labels are cleared. It is an error to provide both this mask and a mask specifying one or more individual labels. * `labels.`labelName * Set the label named *labelName*, while preserving other labels. To delete the label, include it in `updateMask` and omit its mapping in `environment.labels`. It is an error to provide both a mask of this form and the `labels` mask. * `config.nodeCount` * Horizontally scale the number of nodes in the environment. An integer greater than or equal to 3 must be provided in the `config.nodeCount` field. Supported for Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*. * `config.webServerNetworkAccessControl` * Replace the environment's current `WebServerNetworkAccessControl`. * `config.softwareConfig.airflowConfigOverrides` * Replace all Apache Airflow config overrides. If a replacement config overrides map is not included in `environment`, all config overrides are cleared. It is an error to provide both this mask and a mask specifying one or more individual config overrides. * `config.softwareConfig.airflowConfigOverrides.`section-name * Override the Apache Airflow config property *name* in the section named *section*, preserving other properties. To delete the property override, include it in `updateMask` and omit its mapping in `environment.config.softwareConfig.airflowConfigOverrides`. It is an error to provide both a mask of this form and the `config.softwareConfig.airflowConfigOverrides` mask. * `config.softwareConfig.envVariables` * Replace all environment variables. If a replacement environment variable map is not included in `environment`, all custom environment variables are cleared. * `config.softwareConfig.schedulerCount` * Horizontally scale the number of schedulers in Airflow. A positive integer not greater than the number of nodes must be provided in the `config.softwareConfig.schedulerCount` field. Supported for Cloud Composer environments in versions composer-1.*.*-airflow-2.*.*. * `config.databaseConfig.machineType` * Cloud SQL machine type used by Airflow database. It has to be one of: db-n1-standard-2, db-n1-standard-4, db-n1-standard-8 or db-n1-standard-16. Supported for Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*. * `config.webServerConfig.machineType` * Machine type on which Airflow web server is running. It has to be one of: composer-n1-webserver-2, composer-n1-webserver-4 or composer-n1-webserver-8. Supported for Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*. */
858
+ updateMask?: string;
859
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
860
+ upload_protocol?: string;
861
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
862
+ uploadType?: string;
863
+ },
864
+ body: Environment
865
+ ): Request<Operation>;
866
+ /** Polls Airflow CLI command execution and fetches logs. */
867
+ pollAirflowCommand(request: {
868
+ /** V1 error format. */
869
+ '$.xgafv'?: string;
870
+ /** OAuth access token. */
871
+ access_token?: string;
872
+ /** Data format for response. */
873
+ alt?: string;
874
+ /** JSONP */
875
+ callback?: string;
876
+ /** The resource name of the environment in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" */
877
+ environment: string;
878
+ /** Selector specifying which fields to include in a partial response. */
879
+ fields?: string;
880
+ /** 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. */
881
+ key?: string;
882
+ /** OAuth 2.0 token for the current user. */
883
+ oauth_token?: string;
884
+ /** Returns response with indentations and line breaks. */
885
+ prettyPrint?: boolean;
886
+ /** 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. */
887
+ quotaUser?: string;
888
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
889
+ upload_protocol?: string;
890
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
891
+ uploadType?: string;
892
+ /** Request body */
893
+ resource: PollAirflowCommandRequest;
894
+ }): Request<PollAirflowCommandResponse>;
895
+ pollAirflowCommand(
896
+ request: {
897
+ /** V1 error format. */
898
+ '$.xgafv'?: string;
899
+ /** OAuth access token. */
900
+ access_token?: string;
901
+ /** Data format for response. */
902
+ alt?: string;
903
+ /** JSONP */
904
+ callback?: string;
905
+ /** The resource name of the environment in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" */
906
+ environment: string;
907
+ /** Selector specifying which fields to include in a partial response. */
908
+ fields?: string;
909
+ /** 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. */
910
+ key?: string;
911
+ /** OAuth 2.0 token for the current user. */
912
+ oauth_token?: string;
913
+ /** Returns response with indentations and line breaks. */
914
+ prettyPrint?: boolean;
915
+ /** 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. */
916
+ quotaUser?: string;
917
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
918
+ upload_protocol?: string;
919
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
920
+ uploadType?: string;
921
+ },
922
+ body: PollAirflowCommandRequest
923
+ ): Request<PollAirflowCommandResponse>;
924
+ /** Creates a snapshots of a Cloud Composer environment. As a result of this operation, snapshot of environment's state is stored in a location specified in the SaveSnapshotRequest. */
925
+ saveSnapshot(request: {
926
+ /** V1 error format. */
927
+ '$.xgafv'?: string;
928
+ /** OAuth access token. */
929
+ access_token?: string;
930
+ /** Data format for response. */
931
+ alt?: string;
932
+ /** JSONP */
933
+ callback?: string;
934
+ /** The resource name of the source environment in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" */
935
+ environment: string;
936
+ /** Selector specifying which fields to include in a partial response. */
937
+ fields?: string;
938
+ /** 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. */
939
+ key?: string;
940
+ /** OAuth 2.0 token for the current user. */
941
+ oauth_token?: string;
942
+ /** Returns response with indentations and line breaks. */
943
+ prettyPrint?: boolean;
944
+ /** 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. */
945
+ quotaUser?: string;
946
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
947
+ upload_protocol?: string;
948
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
949
+ uploadType?: string;
950
+ /** Request body */
951
+ resource: SaveSnapshotRequest;
952
+ }): Request<Operation>;
953
+ saveSnapshot(
954
+ request: {
955
+ /** V1 error format. */
956
+ '$.xgafv'?: string;
957
+ /** OAuth access token. */
958
+ access_token?: string;
959
+ /** Data format for response. */
960
+ alt?: string;
961
+ /** JSONP */
962
+ callback?: string;
963
+ /** The resource name of the source environment in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" */
964
+ environment: string;
965
+ /** Selector specifying which fields to include in a partial response. */
966
+ fields?: string;
967
+ /** 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. */
968
+ key?: string;
969
+ /** OAuth 2.0 token for the current user. */
970
+ oauth_token?: string;
971
+ /** Returns response with indentations and line breaks. */
972
+ prettyPrint?: boolean;
973
+ /** 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. */
974
+ quotaUser?: string;
975
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
976
+ upload_protocol?: string;
977
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
978
+ uploadType?: string;
979
+ },
980
+ body: SaveSnapshotRequest
981
+ ): Request<Operation>;
982
+ /** Stops Airflow CLI command execution. */
983
+ stopAirflowCommand(request: {
984
+ /** V1 error format. */
985
+ '$.xgafv'?: string;
986
+ /** OAuth access token. */
987
+ access_token?: string;
988
+ /** Data format for response. */
989
+ alt?: string;
990
+ /** JSONP */
991
+ callback?: string;
992
+ /** The resource name of the environment in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}". */
993
+ environment: string;
994
+ /** Selector specifying which fields to include in a partial response. */
995
+ fields?: string;
996
+ /** 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. */
997
+ key?: string;
998
+ /** OAuth 2.0 token for the current user. */
999
+ oauth_token?: string;
1000
+ /** Returns response with indentations and line breaks. */
1001
+ prettyPrint?: boolean;
1002
+ /** 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. */
1003
+ quotaUser?: string;
1004
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1005
+ upload_protocol?: string;
1006
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1007
+ uploadType?: string;
1008
+ /** Request body */
1009
+ resource: StopAirflowCommandRequest;
1010
+ }): Request<StopAirflowCommandResponse>;
1011
+ stopAirflowCommand(
1012
+ request: {
1013
+ /** V1 error format. */
1014
+ '$.xgafv'?: string;
1015
+ /** OAuth access token. */
1016
+ access_token?: string;
1017
+ /** Data format for response. */
1018
+ alt?: string;
1019
+ /** JSONP */
1020
+ callback?: string;
1021
+ /** The resource name of the environment in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}". */
1022
+ environment: string;
1023
+ /** Selector specifying which fields to include in a partial response. */
1024
+ fields?: string;
1025
+ /** 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. */
1026
+ key?: string;
1027
+ /** OAuth 2.0 token for the current user. */
1028
+ oauth_token?: string;
1029
+ /** Returns response with indentations and line breaks. */
1030
+ prettyPrint?: boolean;
1031
+ /** 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. */
1032
+ quotaUser?: string;
1033
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1034
+ upload_protocol?: string;
1035
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1036
+ uploadType?: string;
1037
+ },
1038
+ body: StopAirflowCommandRequest
1039
+ ): Request<StopAirflowCommandResponse>;
1040
+ }
1041
+ interface ImageVersionsResource {
1042
+ /** List ImageVersions for provided location. */
1043
+ list(request?: {
1044
+ /** V1 error format. */
1045
+ '$.xgafv'?: string;
1046
+ /** OAuth access token. */
1047
+ access_token?: string;
1048
+ /** Data format for response. */
1049
+ alt?: string;
1050
+ /** JSONP */
1051
+ callback?: string;
1052
+ /** Selector specifying which fields to include in a partial response. */
1053
+ fields?: string;
1054
+ /** Whether or not image versions from old releases should be included. */
1055
+ includePastReleases?: boolean;
1056
+ /** 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. */
1057
+ key?: string;
1058
+ /** OAuth 2.0 token for the current user. */
1059
+ oauth_token?: string;
1060
+ /** The maximum number of image_versions to return. */
1061
+ pageSize?: number;
1062
+ /** The next_page_token value returned from a previous List request, if any. */
1063
+ pageToken?: string;
1064
+ /** List ImageVersions in the given project and location, in the form: "projects/{projectId}/locations/{locationId}" */
1065
+ parent: string;
1066
+ /** Returns response with indentations and line breaks. */
1067
+ prettyPrint?: boolean;
1068
+ /** 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. */
1069
+ quotaUser?: string;
1070
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1071
+ upload_protocol?: string;
1072
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1073
+ uploadType?: string;
1074
+ }): Request<ListImageVersionsResponse>;
1075
+ }
1076
+ interface OperationsResource {
1077
+ /** Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. */
1078
+ delete(request?: {
1079
+ /** V1 error format. */
1080
+ '$.xgafv'?: string;
1081
+ /** OAuth access token. */
1082
+ access_token?: string;
1083
+ /** Data format for response. */
1084
+ alt?: string;
1085
+ /** JSONP */
1086
+ callback?: string;
1087
+ /** Selector specifying which fields to include in a partial response. */
1088
+ fields?: string;
1089
+ /** 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. */
1090
+ key?: string;
1091
+ /** The name of the operation resource to be deleted. */
1092
+ name: string;
1093
+ /** OAuth 2.0 token for the current user. */
1094
+ oauth_token?: string;
1095
+ /** Returns response with indentations and line breaks. */
1096
+ prettyPrint?: boolean;
1097
+ /** 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. */
1098
+ quotaUser?: string;
1099
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1100
+ upload_protocol?: string;
1101
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1102
+ uploadType?: string;
1103
+ }): Request<{}>;
1104
+ /** Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. */
1105
+ get(request?: {
1106
+ /** V1 error format. */
1107
+ '$.xgafv'?: string;
1108
+ /** OAuth access token. */
1109
+ access_token?: string;
1110
+ /** Data format for response. */
1111
+ alt?: string;
1112
+ /** JSONP */
1113
+ callback?: string;
1114
+ /** Selector specifying which fields to include in a partial response. */
1115
+ fields?: string;
1116
+ /** 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. */
1117
+ key?: string;
1118
+ /** The name of the operation resource. */
1119
+ name: string;
1120
+ /** OAuth 2.0 token for the current user. */
1121
+ oauth_token?: string;
1122
+ /** Returns response with indentations and line breaks. */
1123
+ prettyPrint?: boolean;
1124
+ /** 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. */
1125
+ quotaUser?: string;
1126
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1127
+ upload_protocol?: string;
1128
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1129
+ uploadType?: string;
1130
+ }): Request<Operation>;
1131
+ /** Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. */
1132
+ list(request?: {
1133
+ /** V1 error format. */
1134
+ '$.xgafv'?: string;
1135
+ /** OAuth access token. */
1136
+ access_token?: string;
1137
+ /** Data format for response. */
1138
+ alt?: string;
1139
+ /** JSONP */
1140
+ callback?: string;
1141
+ /** Selector specifying which fields to include in a partial response. */
1142
+ fields?: string;
1143
+ /** The standard list filter. */
1144
+ filter?: string;
1145
+ /** 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. */
1146
+ key?: string;
1147
+ /** The name of the operation's parent resource. */
1148
+ name: string;
1149
+ /** OAuth 2.0 token for the current user. */
1150
+ oauth_token?: string;
1151
+ /** The standard list page size. */
1152
+ pageSize?: number;
1153
+ /** The standard list page token. */
1154
+ pageToken?: string;
1155
+ /** Returns response with indentations and line breaks. */
1156
+ prettyPrint?: boolean;
1157
+ /** 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. */
1158
+ quotaUser?: string;
1159
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1160
+ upload_protocol?: string;
1161
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1162
+ uploadType?: string;
1163
+ }): Request<ListOperationsResponse>;
1164
+ }
1165
+ interface LocationsResource {
1166
+ environments: EnvironmentsResource;
1167
+ imageVersions: ImageVersionsResource;
1168
+ operations: OperationsResource;
1169
+ }
1170
+ interface ProjectsResource {
1171
+ locations: LocationsResource;
1172
+ }
1173
+
1174
+ const projects: ProjectsResource;
1175
+ }
1882
1176
  }