/
v1beta1.ts
1525 lines (1447 loc) · 66.6 KB
/
v1beta1.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/**
* Copyright 2019 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import {GaxiosPromise} from 'gaxios';
import {Compute, JWT, OAuth2Client, UserRefreshClient} from 'google-auth-library';
import {APIRequestContext, BodyResponseCallback, createAPIRequest, GlobalOptions, GoogleConfigurable, MethodOptions} from 'googleapis-common';
// tslint:disable: no-any
// tslint:disable: class-name
// tslint:disable: variable-name
// tslint:disable: jsdoc-format
// tslint:disable: no-namespace
export namespace composer_v1beta1 {
export interface Options extends GlobalOptions {
version: 'v1beta1';
}
let context: APIRequestContext;
interface StandardParameters {
/**
* V1 error format.
*/
'$.xgafv'?: string;
/**
* OAuth access token.
*/
access_token?: string;
/**
* Data format for response.
*/
alt?: string;
/**
* JSONP
*/
callback?: string;
/**
* Selector specifying which fields to include in a partial response.
*/
fields?: string;
/**
* 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.
*/
key?: string;
/**
* OAuth 2.0 token for the current user.
*/
oauth_token?: string;
/**
* Returns response with indentations and line breaks.
*/
prettyPrint?: boolean;
/**
* 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.
*/
quotaUser?: string;
/**
* Legacy upload protocol for media (e.g. "media", "multipart").
*/
uploadType?: string;
/**
* Upload protocol for media (e.g. "raw", "multipart").
*/
upload_protocol?: string;
}
/**
* Cloud Composer API
*
* Manages Apache Airflow environments on Google Cloud Platform.
*
* @example
* const {google} = require('googleapis');
* const composer = google.composer('v1beta1');
*
* @namespace composer
* @type {Function}
* @version v1beta1
* @variation v1beta1
* @param {object=} options Options for Composer
*/
export class Composer {
projects: Resource$Projects;
constructor(options: GlobalOptions, google?: GoogleConfigurable) {
context = {_options: options || {}, google};
this.projects = new Resource$Projects();
}
}
/**
* A generic empty message that you can re-use to avoid defining duplicated
* empty messages in your APIs. A typical example is to use it as the request
* or the response type of an API method. For instance: service Foo { rpc
* Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON
* representation for `Empty` is empty JSON object `{}`.
*/
export interface Schema$Empty {}
/**
* An environment for running orchestration tasks.
*/
export interface Schema$Environment {
/**
* Configuration parameters for this environment.
*/
config?: Schema$EnvironmentConfig;
/**
* Output only. The time at which this environment was created.
*/
createTime?: string;
/**
* 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.
*/
labels?: {[key: string]: string;};
/**
* The resource name of the environment, in the form:
* "projects/{projectId}/locations/{locationId}/environments/{environmentId}"
*/
name?: string;
/**
* The current state of the environment.
*/
state?: string;
/**
* Output only. The time at which this environment was last modified.
*/
updateTime?: string;
/**
* Output only. The UUID (Universally Unique IDentifier) associated with
* this environment. This value is generated when the environment is
* created.
*/
uuid?: string;
}
/**
* Configuration information for an environment.
*/
export interface Schema$EnvironmentConfig {
/**
* 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)).
*/
airflowUri?: string;
/**
* 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.
*/
dagGcsPrefix?: string;
/**
* Output only. The Kubernetes Engine cluster used to run this environment.
*/
gkeCluster?: string;
/**
* The configuration used for the Kubernetes Engine cluster.
*/
nodeConfig?: Schema$NodeConfig;
/**
* The number of nodes in the Kubernetes Engine cluster that will be used to
* run this environment.
*/
nodeCount?: number;
/**
* The configuration used for the private Composer environment.
*/
privateEnvironmentConfig?: Schema$PrivateEnvironmentConfig;
/**
* The configuration settings for software inside the environment.
*/
softwareConfig?: Schema$SoftwareConfig;
}
/**
* Image Version information
*/
export interface Schema$ImageVersion {
/**
* The string identifier of the ImageVersion, in the form:
* "composer-x.y.z-airflow-a.b(.c)"
*/
imageVersionId?: string;
/**
* Whether this is the default ImageVersion used by Composer during
* environment creation if no input ImageVersion is specified.
*/
isDefault?: boolean;
/**
* supported python versions
*/
supportedPythonVersions?: string[];
}
/**
* Configuration for controlling how IPs are allocated in the GKE cluster.
*/
export interface Schema$IPAllocationPolicy {
/**
* Optional. The IP address range used to allocate IP addresses to pods in
* the cluster. 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](http://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. Specify `cluster_secondary_range_name` or
* `cluster_ipv4_cidr_block` but not both.
*/
clusterIpv4CidrBlock?: string;
/**
* Optional. The name of the cluster's secondary range used to allocate
* IP addresses to pods. Specify either `cluster_secondary_range_name` or
* `cluster_ipv4_cidr_block` but not both.
*/
clusterSecondaryRangeName?: string;
/**
* Optional. The IP address range of the services IP addresses in this
* cluster. 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](http://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. Specify `services_secondary_range_name` or
* `services_ipv4_cidr_block` but not both.
*/
servicesIpv4CidrBlock?: string;
/**
* Optional. The name of the services' secondary range used to allocate
* IP addresses to the cluster. Specify either
* `services_secondary_range_name` or `services_ipv4_cidr_block` but not
* both.
*/
servicesSecondaryRangeName?: string;
/**
* Optional. Whether or not to enable Alias IPs in the GKE cluster. If true
* or if left blank, a VPC-native cluster is created.
*/
useIpAliases?: boolean;
}
/**
* The environments in a project and location.
*/
export interface Schema$ListEnvironmentsResponse {
/**
* The list of environments returned by a ListEnvironmentsRequest.
*/
environments?: Schema$Environment[];
/**
* The page token used to query for the next page if one exists.
*/
nextPageToken?: string;
}
/**
* The ImageVersions in a project and location.
*/
export interface Schema$ListImageVersionsResponse {
/**
* The list of supported ImageVersions in a location.
*/
imageVersions?: Schema$ImageVersion[];
/**
* The page token used to query for the next page if one exists.
*/
nextPageToken?: string;
}
/**
* The response message for Operations.ListOperations.
*/
export interface Schema$ListOperationsResponse {
/**
* The standard List next-page token.
*/
nextPageToken?: string;
/**
* A list of operations that matches the specified filter in the request.
*/
operations?: Schema$Operation[];
}
/**
* The configuration information for the Kubernetes Engine nodes running the
* Apache Airflow software.
*/
export interface Schema$NodeConfig {
/**
* Optional. The disk size in GB used for node VMs. Minimum size is 20GB. If
* unspecified, defaults to 100GB. Cannot be updated.
*/
diskSizeGb?: number;
/**
* Optional. The IPAllocationPolicy fields for the GKE cluster.
*/
ipAllocationPolicy?: Schema$IPAllocationPolicy;
/**
* 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.
*/
location?: string;
/**
* 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. If this field is unspecified, the
* `machineTypeId` defaults to "n1-standard-1".
*/
machineType?: string;
/**
* 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 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`.
*/
network?: string;
/**
* Optional. The set of Google API scopes to be made available on all node
* VMs. Defaults to
* ["https://www.googleapis.com/auth/cloud-platform"] and must be
* included in the list of specified scopes. Cannot be updated.
*/
oauthScopes?: string[];
/**
* 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.
*/
serviceAccount?: string;
/**
* 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 same project as the network. For
* Shared VPC, you must configure the subnetwork with secondary ranges named
* <strong>composer-pods</strong> and
* <strong>composer-services</strong> to support Alias IPs.
*/
subnetwork?: string;
/**
* 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.
*/
tags?: string[];
}
/**
* This resource represents a long-running operation that is the result of a
* network API call.
*/
export interface Schema$Operation {
/**
* 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.
*/
done?: boolean;
/**
* The error result of the operation in case of failure or cancellation.
*/
error?: Schema$Status;
/**
* 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.
*/
metadata?: {[key: string]: any;};
/**
* 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 have the format of `operations/some/unique/name`.
*/
name?: string;
/**
* The normal response of the operation in case of success. 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`.
*/
response?: {[key: string]: any;};
}
/**
* Metadata describing an operation.
*/
export interface Schema$OperationMetadata {
/**
* Output only. The time the operation was submitted to the server.
*/
createTime?: string;
/**
* Output only. The time when the operation terminated, regardless of its
* success. This field is unset if the operation is still ongoing.
*/
endTime?: string;
/**
* Output only. The type of operation being performed.
*/
operationType?: string;
/**
* Output only. The resource being operated on, as a [relative resource
* name]( /apis/design/resource_names#relative_resource_name).
*/
resource?: string;
/**
* Output only. The UUID of the resource being operated on.
*/
resourceUuid?: string;
/**
* Output only. The current operation state.
*/
state?: string;
}
/**
* Configuration options for private cluster of Composer environment.
*/
export interface Schema$PrivateClusterConfig {
/**
* Optional. If true, access to public endpoint of gke cluster will be
* denied. `IPAllocationPolicy.use_ip_aliases` must be true if this field is
* set to true. Default value is false.
*/
enablePrivateEndpoint?: boolean;
/**
* The IP range in CIDR notation to use for the hosted master network. This
* range will be used for assigning internal IP addresses to the cluster
* master or set of masters, as well as the ILB VIP (Internal Load Balance
* Virtual IP).This range must not overlap with any other ranges in use
* within the cluster's network. If left blank, default value of
* '172.16.0.0/28' will be used.
*/
masterIpv4CidrBlock?: string;
}
/**
* The configuration information for configuring a private Composer
* environment.
*/
export interface Schema$PrivateEnvironmentConfig {
/**
* Optional. If `true`, a private Composer environment is created.
*/
enablePrivateEnvironment?: boolean;
/**
* Optional. Configuration for private cluster for a private Composer
* environment.
*/
privateClusterConfig?: Schema$PrivateClusterConfig;
}
/**
* Specifies the selection and configuration of software inside the
* environment.
*/
export interface Schema$SoftwareConfig {
/**
* 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
* [blacklisted](/composer/docs/how-to/managing/setting-airflow-configurations#airflow_configuration_blacklists),
* and cannot be overridden.
*/
airflowConfigOverrides?: {[key: string]: string;};
/**
* 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`
*/
envVariables?: {[key: string]: string;};
/**
* 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]+|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 version is a [semantic
* version](https://semver.org) or `latest`. When the patch version is
* omitted, the current Cloud Composer patch version is selected. When
* `latest` is provided instead of an explicit version number, the server
* replaces `latest` with the current Cloud Composer version and stores that
* version number in the same field. The portion of the image version that
* follows <em>airflow-</em> is an official Apache Airflow
* repository [release
* name](https://github.com/apache/incubator-airflow/releases). See also
* [Version List](/composer/docs/concepts/versioning/composer-versions).
*/
imageVersion?: string;
/**
* 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.
*/
pypiPackages?: {[key: string]: string;};
/**
* 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 '2'. Cannot be
* updated.
*/
pythonVersion?: string;
}
/**
* The `Status` type defines a logical error model that is suitable for
* different programming environments, including REST APIs and RPC APIs. It is
* used by [gRPC](https://github.com/grpc). The error model is designed to be:
* - Simple to use and understand for most users - Flexible enough to meet
* unexpected needs # Overview The `Status` message contains three pieces of
* data: error code, error message, and error details. The error code should
* be an enum value of google.rpc.Code, but it may accept additional error
* codes if needed. The error message should be a developer-facing English
* message that helps developers *understand* and *resolve* the error. If a
* localized user-facing error message is needed, put the localized message in
* the error details or localize it in the client. The optional error details
* may contain arbitrary information about the error. There is a predefined
* set of error detail types in the package `google.rpc` that can be used for
* common error conditions. # Language mapping The `Status` message is the
* logical representation of the error model, but it is not necessarily the
* actual wire format. When the `Status` message is exposed in different
* client libraries and different wire protocols, it can be mapped
* differently. For example, it will likely be mapped to some exceptions in
* Java, but more likely mapped to some error codes in C. # Other uses The
* error model and the `Status` message can be used in a variety of
* environments, either with or without APIs, to provide a consistent
* developer experience across different environments. Example uses of this
* error model include: - Partial errors. If a service needs to return
* partial errors to the client, it may embed the `Status` in the normal
* response to indicate the partial errors. - Workflow errors. A typical
* workflow has multiple steps. Each step may have a `Status` message for
* error reporting. - Batch operations. If a client uses batch request and
* batch response, the `Status` message should be used directly inside
* batch response, one for each error sub-response. - Asynchronous
* operations. If an API call embeds asynchronous operation results in its
* response, the status of those operations should be represented directly
* using the `Status` message. - Logging. If some API errors are stored in
* logs, the message `Status` could be used directly after any stripping
* needed for security/privacy reasons.
*/
export interface Schema$Status {
/**
* The status code, which should be an enum value of google.rpc.Code.
*/
code?: number;
/**
* A list of messages that carry the error details. There is a common set
* of message types for APIs to use.
*/
details?: Array<{[key: string]: any;}>;
/**
* 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.
*/
message?: string;
}
export class Resource$Projects {
locations: Resource$Projects$Locations;
constructor() {
this.locations = new Resource$Projects$Locations();
}
}
export class Resource$Projects$Locations {
environments: Resource$Projects$Locations$Environments;
imageVersions: Resource$Projects$Locations$Imageversions;
operations: Resource$Projects$Locations$Operations;
constructor() {
this.environments = new Resource$Projects$Locations$Environments();
this.imageVersions = new Resource$Projects$Locations$Imageversions();
this.operations = new Resource$Projects$Locations$Operations();
}
}
export class Resource$Projects$Locations$Environments {
constructor() {}
/**
* composer.projects.locations.environments.create
* @desc Create a new environment.
* @alias composer.projects.locations.environments.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.parent The parent must be of the form "projects/{projectId}/locations/{locationId}".
* @param {().Environment} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
create(
params?: Params$Resource$Projects$Locations$Environments$Create,
options?: MethodOptions): GaxiosPromise<Schema$Operation>;
create(
params: Params$Resource$Projects$Locations$Environments$Create,
options: MethodOptions|BodyResponseCallback<Schema$Operation>,
callback: BodyResponseCallback<Schema$Operation>): void;
create(
params: Params$Resource$Projects$Locations$Environments$Create,
callback: BodyResponseCallback<Schema$Operation>): void;
create(callback: BodyResponseCallback<Schema$Operation>): void;
create(
paramsOrCallback?:
Params$Resource$Projects$Locations$Environments$Create|
BodyResponseCallback<Schema$Operation>,
optionsOrCallback?: MethodOptions|
BodyResponseCallback<Schema$Operation>,
callback?: BodyResponseCallback<Schema$Operation>):
void|GaxiosPromise<Schema$Operation> {
let params = (paramsOrCallback || {}) as
Params$Resource$Projects$Locations$Environments$Create;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$Projects$Locations$Environments$Create;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://composer.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1beta1/{+parent}/environments')
.replace(/([^:]\/)\/+/g, '$1'),
method: 'POST'
},
options),
params,
requiredParams: ['parent'],
pathParams: ['parent'],
context
};
if (callback) {
createAPIRequest<Schema$Operation>(parameters, callback);
} else {
return createAPIRequest<Schema$Operation>(parameters);
}
}
/**
* composer.projects.locations.environments.delete
* @desc Delete an environment.
* @alias composer.projects.locations.environments.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The environment to delete, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}"
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
delete(
params?: Params$Resource$Projects$Locations$Environments$Delete,
options?: MethodOptions): GaxiosPromise<Schema$Operation>;
delete(
params: Params$Resource$Projects$Locations$Environments$Delete,
options: MethodOptions|BodyResponseCallback<Schema$Operation>,
callback: BodyResponseCallback<Schema$Operation>): void;
delete(
params: Params$Resource$Projects$Locations$Environments$Delete,
callback: BodyResponseCallback<Schema$Operation>): void;
delete(callback: BodyResponseCallback<Schema$Operation>): void;
delete(
paramsOrCallback?:
Params$Resource$Projects$Locations$Environments$Delete|
BodyResponseCallback<Schema$Operation>,
optionsOrCallback?: MethodOptions|
BodyResponseCallback<Schema$Operation>,
callback?: BodyResponseCallback<Schema$Operation>):
void|GaxiosPromise<Schema$Operation> {
let params = (paramsOrCallback || {}) as
Params$Resource$Projects$Locations$Environments$Delete;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$Projects$Locations$Environments$Delete;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://composer.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'),
method: 'DELETE'
},
options),
params,
requiredParams: ['name'],
pathParams: ['name'],
context
};
if (callback) {
createAPIRequest<Schema$Operation>(parameters, callback);
} else {
return createAPIRequest<Schema$Operation>(parameters);
}
}
/**
* composer.projects.locations.environments.get
* @desc Get an existing environment.
* @alias composer.projects.locations.environments.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The resource name of the environment to get, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}"
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Projects$Locations$Environments$Get,
options?: MethodOptions): GaxiosPromise<Schema$Environment>;
get(params: Params$Resource$Projects$Locations$Environments$Get,
options: MethodOptions|BodyResponseCallback<Schema$Environment>,
callback: BodyResponseCallback<Schema$Environment>): void;
get(params: Params$Resource$Projects$Locations$Environments$Get,
callback: BodyResponseCallback<Schema$Environment>): void;
get(callback: BodyResponseCallback<Schema$Environment>): void;
get(paramsOrCallback?: Params$Resource$Projects$Locations$Environments$Get|
BodyResponseCallback<Schema$Environment>,
optionsOrCallback?: MethodOptions|
BodyResponseCallback<Schema$Environment>,
callback?: BodyResponseCallback<Schema$Environment>):
void|GaxiosPromise<Schema$Environment> {
let params = (paramsOrCallback || {}) as
Params$Resource$Projects$Locations$Environments$Get;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$Projects$Locations$Environments$Get;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://composer.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'),
method: 'GET'
},
options),
params,
requiredParams: ['name'],
pathParams: ['name'],
context
};
if (callback) {
createAPIRequest<Schema$Environment>(parameters, callback);
} else {
return createAPIRequest<Schema$Environment>(parameters);
}
}
/**
* composer.projects.locations.environments.list
* @desc List environments.
* @alias composer.projects.locations.environments.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {integer=} params.pageSize The maximum number of environments to return.
* @param {string=} params.pageToken The next_page_token value returned from a previous List request, if any.
* @param {string} params.parent List environments in the given project and location, in the form: "projects/{projectId}/locations/{locationId}"
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(
params?: Params$Resource$Projects$Locations$Environments$List,
options?: MethodOptions):
GaxiosPromise<Schema$ListEnvironmentsResponse>;
list(
params: Params$Resource$Projects$Locations$Environments$List,
options: MethodOptions|
BodyResponseCallback<Schema$ListEnvironmentsResponse>,
callback: BodyResponseCallback<Schema$ListEnvironmentsResponse>): void;
list(
params: Params$Resource$Projects$Locations$Environments$List,
callback: BodyResponseCallback<Schema$ListEnvironmentsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListEnvironmentsResponse>): void;
list(
paramsOrCallback?: Params$Resource$Projects$Locations$Environments$List|
BodyResponseCallback<Schema$ListEnvironmentsResponse>,
optionsOrCallback?: MethodOptions|
BodyResponseCallback<Schema$ListEnvironmentsResponse>,
callback?: BodyResponseCallback<Schema$ListEnvironmentsResponse>):
void|GaxiosPromise<Schema$ListEnvironmentsResponse> {
let params = (paramsOrCallback || {}) as
Params$Resource$Projects$Locations$Environments$List;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$Projects$Locations$Environments$List;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://composer.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1beta1/{+parent}/environments')
.replace(/([^:]\/)\/+/g, '$1'),
method: 'GET'
},
options),
params,
requiredParams: ['parent'],
pathParams: ['parent'],
context
};
if (callback) {
createAPIRequest<Schema$ListEnvironmentsResponse>(parameters, callback);
} else {
return createAPIRequest<Schema$ListEnvironmentsResponse>(parameters);
}
}
/**
* composer.projects.locations.environments.patch
* @desc Update an environment.
* @alias composer.projects.locations.environments.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The relative resource name of the environment to update, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}"
* @param {string=} params.updateMask 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 argparse, the `updateMask` parameter would include the following two `paths` values: "config.softwareConfig.pypiPackages.scikit-learn" and "config.softwareConfig.pypiPackages.argparse". 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 argparse 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" } } } } <strong>Note:</strong> Only the following fields can be updated: <table> <tbody> <tr> <td><strong>Mask</strong></td> <td><strong>Purpose</strong></td> </tr> <tr> <td>config.softwareConfig.pypiPackages </td> <td>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.</td> </tr> <tr> <td>config.softwareConfig.pypiPackages.<var>packagename</var></td> <td>Update the custom PyPI package <var>packagename</var>, 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.</td> </tr> <tr> <td>labels</td> <td>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.</td> </tr> <tr> <td>labels.<var>labelName</var></td> <td>Set the label named <var>labelName</var>, 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.</td> </tr> <tr> <td>config.nodeCount</td> <td>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. </td> </tr> <tr> <td>config.softwareConfig.airflowConfigOverrides</td> <td>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.</td> </tr> <tr> <td>config.softwareConfig.airflowConfigOverrides.<var>section</var>-<var>name </var></td> <td>Override the Apache Airflow config property <var>name</var> in the section named <var>section</var>, 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.</td> </tr> <tr> <td>config.softwareConfig.envVariables</td> <td>Replace all environment variables. If a replacement environment variable map is not included in `environment`, all custom environment variables are cleared. It is an error to provide both this mask and a mask specifying one or more individual environment variables.</td> </tr> <tr> <td>config.softwareConfig.imageVersion</td> <td>Upgrade the version of the environment in-place. Refer to `SoftwareConfig.image_version` for information on how to format the new image version. Additionally, the new image version cannot effect a version downgrade and must match the current image version's Composer major version and Airflow major and minor versions. Consult the <a href="/composer/docs/concepts/versioning/composer-versions">Cloud Composer Version List</a> for valid values.</td> </tr> </tbody> </table>
* @param {().Environment} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
patch(
params?: Params$Resource$Projects$Locations$Environments$Patch,
options?: MethodOptions): GaxiosPromise<Schema$Operation>;
patch(
params: Params$Resource$Projects$Locations$Environments$Patch,
options: MethodOptions|BodyResponseCallback<Schema$Operation>,
callback: BodyResponseCallback<Schema$Operation>): void;
patch(
params: Params$Resource$Projects$Locations$Environments$Patch,
callback: BodyResponseCallback<Schema$Operation>): void;
patch(callback: BodyResponseCallback<Schema$Operation>): void;
patch(
paramsOrCallback?:
Params$Resource$Projects$Locations$Environments$Patch|
BodyResponseCallback<Schema$Operation>,
optionsOrCallback?: MethodOptions|
BodyResponseCallback<Schema$Operation>,
callback?: BodyResponseCallback<Schema$Operation>):
void|GaxiosPromise<Schema$Operation> {
let params = (paramsOrCallback || {}) as
Params$Resource$Projects$Locations$Environments$Patch;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$Projects$Locations$Environments$Patch;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://composer.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'),
method: 'PATCH'
},
options),
params,
requiredParams: ['name'],
pathParams: ['name'],
context
};
if (callback) {
createAPIRequest<Schema$Operation>(parameters, callback);
} else {
return createAPIRequest<Schema$Operation>(parameters);
}
}
}
export interface Params$Resource$Projects$Locations$Environments$Create
extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient;
/**
* The parent must be of the form
* "projects/{projectId}/locations/{locationId}".
*/