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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/index.d.ts +95 -1
  2. package/package.json +1 -1
package/index.d.ts CHANGED
@@ -9,7 +9,7 @@
9
9
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
10
10
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
11
11
  // Generated from: https://composer.googleapis.com/$discovery/rest?version=v1
12
- // Revision: 20231205
12
+ // Revision: 20240123
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -48,6 +48,36 @@ declare namespace gapi.client {
48
48
  /** User-defined name that identifies the CIDR block. */
49
49
  displayName?: string;
50
50
  }
51
+ interface CloudDataLineageIntegration {
52
+ /** Optional. Whether or not Cloud Data Lineage integration is enabled. */
53
+ enabled?: boolean;
54
+ }
55
+ interface ComposerWorkload {
56
+ /** Name of a workload. */
57
+ name?: string;
58
+ /** Output only. Status of a workload. */
59
+ status?: ComposerWorkloadStatus;
60
+ /** Type of a workload. */
61
+ type?: string;
62
+ }
63
+ interface ComposerWorkloadStatus {
64
+ /** Output only. Detailed message of the status. */
65
+ detailedStatusMessage?: string;
66
+ /** Output only. Workload state. */
67
+ state?: string;
68
+ /** Output only. Text to provide more descriptive status. */
69
+ statusMessage?: string;
70
+ }
71
+ interface DagProcessorResource {
72
+ /** Optional. The number of DAG processors. If not provided or set to 0, a single DAG processor instance will be created. */
73
+ count?: number;
74
+ /** Optional. CPU request and limit for a single Airflow DAG processor replica. */
75
+ cpu?: number;
76
+ /** Optional. Memory (GB) request and limit for a single Airflow DAG processor replica. */
77
+ memoryGb?: number;
78
+ /** Optional. Storage (GB) request and limit for a single Airflow DAG processor replica. */
79
+ storageGb?: number;
80
+ }
51
81
  interface DatabaseConfig {
52
82
  /** 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
83
  machineType?: string;
@@ -56,6 +86,10 @@ declare namespace gapi.client {
56
86
  }
57
87
  interface DatabaseFailoverRequest {}
58
88
  interface DatabaseFailoverResponse {}
89
+ interface DataRetentionConfig {
90
+ /** Optional. The configuration settings for task logs retention */
91
+ taskLogsRetentionConfig?: TaskLogsRetentionConfig;
92
+ }
59
93
  interface Date {
60
94
  /** 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
95
  day?: number;
@@ -98,6 +132,8 @@ declare namespace gapi.client {
98
132
  dagGcsPrefix?: string;
99
133
  /** Optional. The configuration settings for Cloud SQL instance used internally by Apache Airflow software. */
100
134
  databaseConfig?: DatabaseConfig;
135
+ /** Optional. The configuration setting for Airflow database data retention mechanism. */
136
+ dataRetentionConfig?: DataRetentionConfig;
101
137
  /** Optional. The encryption options for the Cloud Composer environment and its dependencies. Cannot be updated. */
102
138
  encryptionConfig?: EncryptionConfig;
103
139
  /** Optional. The size of the Cloud Composer environment. This field is supported for Cloud Composer environments in versions composer-2.*.*-airflow-*.*.* and newer. */
@@ -209,6 +245,12 @@ declare namespace gapi.client {
209
245
  /** A list of operations that matches the specified filter in the request. */
210
246
  operations?: Operation[];
211
247
  }
248
+ interface ListWorkloadsResponse {
249
+ /** The page token used to query for the next page if one exists. */
250
+ nextPageToken?: string;
251
+ /** The list of environment workloads. */
252
+ workloads?: ComposerWorkload[];
253
+ }
212
254
  interface LoadSnapshotRequest {
213
255
  /** Whether or not to skip setting Airflow overrides when loading the environment's state. */
214
256
  skipAirflowOverridesSetting?: boolean;
@@ -241,6 +283,10 @@ declare namespace gapi.client {
241
283
  connectionType?: string;
242
284
  }
243
285
  interface NodeConfig {
286
+ /** Optional. The IP range in CIDR notation to use internally by Cloud Composer. IP addresses are not reserved - and the same range can be used by multiple Cloud Composer environments. In case of overlap, IPs from this range will not be accessible in the user's VPC network. Cannot be updated. If not specified, the default value of '100.64.128.0/20' is used. This field is supported for Cloud Composer environments in versions composer-3.*.*-airflow-*.*.* and newer. */
287
+ composerInternalIpv4CidrBlock?: string;
288
+ /** Optional. Network Attachment that Cloud Composer environment is connected to, which provides connectivity with a user's VPC network. Takes precedence over network and subnetwork settings. If not provided, but network and subnetwork are defined during environment, it will be provisioned. If not provided and network and subnetwork are also empty, then connectivity to user's VPC network is disabled. Network attachment must be provided in format projects/{project}/regions/{region}/networkAttachments/{networkAttachment}. This field is supported for Cloud Composer environments in versions composer-3.*.*-airflow-*.*.* and newer. */
289
+ composerNetworkAttachment?: string;
244
290
  /** 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
291
  diskSizeGb?: number;
246
292
  /** 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 */
@@ -323,6 +369,8 @@ declare namespace gapi.client {
323
369
  cloudComposerNetworkIpv4ReservedRange?: string;
324
370
  /** 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
371
  cloudSqlIpv4CidrBlock?: string;
372
+ /** Optional. If `true`, builds performed during operations that install Python packages have only private connectivity to Google services (including Artifact Registry) and VPC network (if either `NodeConfig.network` and `NodeConfig.subnetwork` fields or `NodeConfig.composer_network_attachment` field are specified). If `false`, the builds also have access to the internet. This field is supported for Cloud Composer environments in versions composer-3.*.*-airflow-*.*.* and newer. */
373
+ enablePrivateBuildsOnly?: boolean;
326
374
  /** 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
375
  enablePrivateEnvironment?: boolean;
328
376
  /** Optional. When enabled, IPs from public (non-RFC1918) ranges can be used for `IPAllocationPolicy.cluster_ipv4_cidr_block` and `IPAllocationPolicy.service_ipv4_cidr_block`. */
@@ -371,6 +419,8 @@ declare namespace gapi.client {
371
419
  interface SoftwareConfig {
372
420
  /** 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
421
  airflowConfigOverrides?: {[P in string]: string};
422
+ /** Optional. The configuration for Cloud Data Lineage integration. */
423
+ cloudDataLineageIntegration?: CloudDataLineageIntegration;
374
424
  /** 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
425
  envVariables?: {[P in string]: string};
376
426
  /** 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). */
@@ -381,6 +431,8 @@ declare namespace gapi.client {
381
431
  pythonVersion?: string;
382
432
  /** Optional. The number of schedulers for Airflow. This field is supported for Cloud Composer environments in versions composer-1.*.*-airflow-2.*.*. */
383
433
  schedulerCount?: number;
434
+ /** Optional. Whether or not the web server uses custom plugins. If unspecified, the field defaults to `PLUGINS_ENABLED`. This field is supported for Cloud Composer environments in versions composer-3.*.*-airflow-*.*.* and newer. */
435
+ webServerPluginsMode?: string;
384
436
  }
385
437
  interface Status {
386
438
  /** The status code, which should be an enum value of google.rpc.Code. */
@@ -410,6 +462,10 @@ declare namespace gapi.client {
410
462
  /** Optional. The name of the Cloud Storage bucket used by the environment. No `gs://` prefix. */
411
463
  bucket?: string;
412
464
  }
465
+ interface TaskLogsRetentionConfig {
466
+ /** Optional. The mode of storage for Airflow workers task logs. For details, see go/composer-store-task-logs-in-cloud-logging-only-design-doc */
467
+ storageMode?: string;
468
+ }
413
469
  interface TriggererResource {
414
470
  /** Optional. The number of triggerers. */
415
471
  count?: number;
@@ -447,6 +503,8 @@ declare namespace gapi.client {
447
503
  storageGb?: number;
448
504
  }
449
505
  interface WorkloadsConfig {
506
+ /** Optional. Resources used by Airflow DAG processors. This field is supported for Cloud Composer environments in versions composer-3.*.*-airflow-*.*.* and newer. */
507
+ dagProcessor?: DagProcessorResource;
450
508
  /** Optional. Resources used by Airflow schedulers. */
451
509
  scheduler?: SchedulerResource;
452
510
  /** Optional. Resources used by Airflow triggerers. */
@@ -456,6 +514,41 @@ declare namespace gapi.client {
456
514
  /** Optional. Resources used by Airflow workers. */
457
515
  worker?: WorkerResource;
458
516
  }
517
+ interface WorkloadsResource {
518
+ /** Lists workloads in a Cloud Composer environment. Workload is a unit that runs a single Composer component. This method is supported for Cloud Composer environments in versions composer-3.*.*-airflow-*.*.* and newer. */
519
+ list(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
+ /** Selector specifying which fields to include in a partial response. */
529
+ fields?: string;
530
+ /** Optional. The list filter. Currently only supports equality on the type field. The value of a field specified in the filter expression must be one ComposerWorkloadType enum option. It's possible to get multiple types using "OR" operator, e.g.: "type=SCHEDULER OR type=CELERY_WORKER". If not specified, all items are returned. */
531
+ filter?: 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
+ /** Optional. The maximum number of environments to return. */
537
+ pageSize?: number;
538
+ /** Optional. The next_page_token value returned from a previous List request, if any. */
539
+ pageToken?: string;
540
+ /** Required. The environment name to get workloads for, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" */
541
+ parent: string;
542
+ /** Returns response with indentations and line breaks. */
543
+ prettyPrint?: boolean;
544
+ /** 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. */
545
+ quotaUser?: string;
546
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
547
+ upload_protocol?: string;
548
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
549
+ uploadType?: string;
550
+ }): Request<ListWorkloadsResponse>;
551
+ }
459
552
  interface EnvironmentsResource {
460
553
  /** Create a new environment. */
461
554
  create(request: {
@@ -1037,6 +1130,7 @@ declare namespace gapi.client {
1037
1130
  },
1038
1131
  body: StopAirflowCommandRequest
1039
1132
  ): Request<StopAirflowCommandResponse>;
1133
+ workloads: WorkloadsResource;
1040
1134
  }
1041
1135
  interface ImageVersionsResource {
1042
1136
  /** List ImageVersions for provided location. */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.composer-v1",
3
- "version": "0.0.20231205",
3
+ "version": "0.0.20240123",
4
4
  "description": "TypeScript typings for Cloud Composer API v1",
5
5
  "repository": {
6
6
  "type": "git",