You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: docs/dyn/composer_v1beta1.projects.locations.environments.html
+40
Original file line number
Diff line number
Diff line change
@@ -208,6 +208,8 @@ <h3>Method Details</h3>
208
208
"enabled": True or False, # Whether or not master authorized networks feature is enabled.
209
209
},
210
210
"nodeConfig": { # The configuration information for the Kubernetes Engine nodes running the Apache Airflow software. # The configuration used for the Kubernetes Engine cluster.
211
+
"composerInternalIpv4CidrBlock": "A String", # 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.
212
+
"composerNetworkAttachment": "A String", # 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.
211
213
"diskSizeGb": 42, # 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-*.*.*.
212
214
"enableIpMasqAgent": True or False, # 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
213
215
"ipAllocationPolicy": { # Configuration for controlling how IPs are allocated in the GKE cluster. # Optional. The IPAllocationPolicy fields for the GKE cluster.
@@ -236,6 +238,7 @@ <h3>Method Details</h3>
236
238
"cloudComposerNetworkIpv4CidrBlock": "A String", # 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.
237
239
"cloudComposerNetworkIpv4ReservedRange": "A String", # 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.
238
240
"cloudSqlIpv4CidrBlock": "A String", # 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
241
+
"enablePrivateBuildsOnly": True or False, # 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.
239
242
"enablePrivateEnvironment": True or False, # 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-*.*.*.
240
243
"enablePrivatelyUsedPublicIps": True or False, # Optional. When enabled, IPs from public (non-RFC1918) ranges can be used for `IPAllocationPolicy.cluster_ipv4_cidr_block` and `IPAllocationPolicy.service_ipv4_cidr_block`.
241
244
"networkingConfig": { # Configuration options for networking connections in the Composer 2 environment. # Optional. Configuration for the network connections configuration in the environment.
@@ -274,6 +277,7 @@ <h3>Method Details</h3>
274
277
},
275
278
"pythonVersion": "A 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 '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.
276
279
"schedulerCount": 42, # Optional. The number of schedulers for Airflow. This field is supported for Cloud Composer environments in versions composer-1.*.*-airflow-2.*.*.
280
+
"webServerPluginsMode": "A String", # 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.
277
281
},
278
282
"webServerConfig": { # The configuration settings for the Airflow web server App Engine instance. Supported for Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*. # Optional. The configuration settings for the Airflow web server App Engine instance. This field is supported for Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*.
279
283
"machineType": "A String", # 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.
@@ -287,6 +291,12 @@ <h3>Method Details</h3>
287
291
],
288
292
},
289
293
"workloadsConfig": { # The Kubernetes workloads configuration for GKE cluster associated with the Cloud Composer environment. Supported for Cloud Composer environments in versions composer-2.*.*-airflow-*.*.* and newer. # 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.
294
+
"dagProcessor": { # Configuration for resources used by Airflow DAG processors. # Optional. Resources used by Airflow DAG processors. This field is supported for Cloud Composer environments in versions composer-3.*.*-airflow-*.*.* and newer.
295
+
"count": 42, # Optional. The number of DAG processors. If not provided or set to 0, a single DAG processor instance will be created.
296
+
"cpu": 3.14, # Optional. CPU request and limit for a single Airflow DAG processor replica.
297
+
"memoryGb": 3.14, # Optional. Memory (GB) request and limit for a single Airflow DAG processor replica.
298
+
"storageGb": 3.14, # Optional. Storage (GB) request and limit for a single Airflow DAG processor replica.
299
+
},
290
300
"scheduler": { # Configuration for resources used by Airflow schedulers. # Optional. Resources used by Airflow schedulers.
291
301
"count": 42, # Optional. The number of schedulers.
292
302
"cpu": 3.14, # Optional. CPU request and limit for a single Airflow scheduler replica.
@@ -528,6 +538,8 @@ <h3>Method Details</h3>
528
538
"enabled": True or False, # Whether or not master authorized networks feature is enabled.
529
539
},
530
540
"nodeConfig": { # The configuration information for the Kubernetes Engine nodes running the Apache Airflow software. # The configuration used for the Kubernetes Engine cluster.
541
+
"composerInternalIpv4CidrBlock": "A String", # 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.
542
+
"composerNetworkAttachment": "A String", # 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.
531
543
"diskSizeGb": 42, # 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-*.*.*.
532
544
"enableIpMasqAgent": True or False, # 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
533
545
"ipAllocationPolicy": { # Configuration for controlling how IPs are allocated in the GKE cluster. # Optional. The IPAllocationPolicy fields for the GKE cluster.
@@ -556,6 +568,7 @@ <h3>Method Details</h3>
556
568
"cloudComposerNetworkIpv4CidrBlock": "A String", # 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.
557
569
"cloudComposerNetworkIpv4ReservedRange": "A String", # 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.
558
570
"cloudSqlIpv4CidrBlock": "A String", # 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
571
+
"enablePrivateBuildsOnly": True or False, # 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.
559
572
"enablePrivateEnvironment": True or False, # 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-*.*.*.
560
573
"enablePrivatelyUsedPublicIps": True or False, # Optional. When enabled, IPs from public (non-RFC1918) ranges can be used for `IPAllocationPolicy.cluster_ipv4_cidr_block` and `IPAllocationPolicy.service_ipv4_cidr_block`.
561
574
"networkingConfig": { # Configuration options for networking connections in the Composer 2 environment. # Optional. Configuration for the network connections configuration in the environment.
@@ -594,6 +607,7 @@ <h3>Method Details</h3>
594
607
},
595
608
"pythonVersion": "A 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 '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.
596
609
"schedulerCount": 42, # Optional. The number of schedulers for Airflow. This field is supported for Cloud Composer environments in versions composer-1.*.*-airflow-2.*.*.
610
+
"webServerPluginsMode": "A String", # 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.
597
611
},
598
612
"webServerConfig": { # The configuration settings for the Airflow web server App Engine instance. Supported for Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*. # Optional. The configuration settings for the Airflow web server App Engine instance. This field is supported for Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*.
599
613
"machineType": "A String", # 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.
@@ -607,6 +621,12 @@ <h3>Method Details</h3>
607
621
],
608
622
},
609
623
"workloadsConfig": { # The Kubernetes workloads configuration for GKE cluster associated with the Cloud Composer environment. Supported for Cloud Composer environments in versions composer-2.*.*-airflow-*.*.* and newer. # 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.
624
+
"dagProcessor": { # Configuration for resources used by Airflow DAG processors. # Optional. Resources used by Airflow DAG processors. This field is supported for Cloud Composer environments in versions composer-3.*.*-airflow-*.*.* and newer.
625
+
"count": 42, # Optional. The number of DAG processors. If not provided or set to 0, a single DAG processor instance will be created.
626
+
"cpu": 3.14, # Optional. CPU request and limit for a single Airflow DAG processor replica.
627
+
"memoryGb": 3.14, # Optional. Memory (GB) request and limit for a single Airflow DAG processor replica.
628
+
"storageGb": 3.14, # Optional. Storage (GB) request and limit for a single Airflow DAG processor replica.
629
+
},
610
630
"scheduler": { # Configuration for resources used by Airflow schedulers. # Optional. Resources used by Airflow schedulers.
611
631
"count": 42, # Optional. The number of schedulers.
612
632
"cpu": 3.14, # Optional. CPU request and limit for a single Airflow scheduler replica.
@@ -694,6 +714,8 @@ <h3>Method Details</h3>
694
714
"enabled": True or False, # Whether or not master authorized networks feature is enabled.
695
715
},
696
716
"nodeConfig": { # The configuration information for the Kubernetes Engine nodes running the Apache Airflow software. # The configuration used for the Kubernetes Engine cluster.
717
+
"composerInternalIpv4CidrBlock": "A String", # 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.
718
+
"composerNetworkAttachment": "A String", # 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.
697
719
"diskSizeGb": 42, # 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-*.*.*.
698
720
"enableIpMasqAgent": True or False, # 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
699
721
"ipAllocationPolicy": { # Configuration for controlling how IPs are allocated in the GKE cluster. # Optional. The IPAllocationPolicy fields for the GKE cluster.
@@ -722,6 +744,7 @@ <h3>Method Details</h3>
722
744
"cloudComposerNetworkIpv4CidrBlock": "A String", # 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.
723
745
"cloudComposerNetworkIpv4ReservedRange": "A String", # 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.
724
746
"cloudSqlIpv4CidrBlock": "A String", # 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
747
+
"enablePrivateBuildsOnly": True or False, # 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.
725
748
"enablePrivateEnvironment": True or False, # 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-*.*.*.
726
749
"enablePrivatelyUsedPublicIps": True or False, # Optional. When enabled, IPs from public (non-RFC1918) ranges can be used for `IPAllocationPolicy.cluster_ipv4_cidr_block` and `IPAllocationPolicy.service_ipv4_cidr_block`.
727
750
"networkingConfig": { # Configuration options for networking connections in the Composer 2 environment. # Optional. Configuration for the network connections configuration in the environment.
@@ -760,6 +783,7 @@ <h3>Method Details</h3>
760
783
},
761
784
"pythonVersion": "A 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 '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.
762
785
"schedulerCount": 42, # Optional. The number of schedulers for Airflow. This field is supported for Cloud Composer environments in versions composer-1.*.*-airflow-2.*.*.
786
+
"webServerPluginsMode": "A String", # 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.
763
787
},
764
788
"webServerConfig": { # The configuration settings for the Airflow web server App Engine instance. Supported for Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*. # Optional. The configuration settings for the Airflow web server App Engine instance. This field is supported for Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*.
765
789
"machineType": "A String", # 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.
@@ -773,6 +797,12 @@ <h3>Method Details</h3>
773
797
],
774
798
},
775
799
"workloadsConfig": { # The Kubernetes workloads configuration for GKE cluster associated with the Cloud Composer environment. Supported for Cloud Composer environments in versions composer-2.*.*-airflow-*.*.* and newer. # 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.
800
+
"dagProcessor": { # Configuration for resources used by Airflow DAG processors. # Optional. Resources used by Airflow DAG processors. This field is supported for Cloud Composer environments in versions composer-3.*.*-airflow-*.*.* and newer.
801
+
"count": 42, # Optional. The number of DAG processors. If not provided or set to 0, a single DAG processor instance will be created.
802
+
"cpu": 3.14, # Optional. CPU request and limit for a single Airflow DAG processor replica.
803
+
"memoryGb": 3.14, # Optional. Memory (GB) request and limit for a single Airflow DAG processor replica.
804
+
"storageGb": 3.14, # Optional. Storage (GB) request and limit for a single Airflow DAG processor replica.
805
+
},
776
806
"scheduler": { # Configuration for resources used by Airflow schedulers. # Optional. Resources used by Airflow schedulers.
777
807
"count": 42, # Optional. The number of schedulers.
778
808
"cpu": 3.14, # Optional. CPU request and limit for a single Airflow scheduler replica.
@@ -914,6 +944,8 @@ <h3>Method Details</h3>
914
944
"enabled": True or False, # Whether or not master authorized networks feature is enabled.
915
945
},
916
946
"nodeConfig": { # The configuration information for the Kubernetes Engine nodes running the Apache Airflow software. # The configuration used for the Kubernetes Engine cluster.
947
+
"composerInternalIpv4CidrBlock": "A String", # 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.
948
+
"composerNetworkAttachment": "A String", # 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.
917
949
"diskSizeGb": 42, # 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-*.*.*.
918
950
"enableIpMasqAgent": True or False, # 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
919
951
"ipAllocationPolicy": { # Configuration for controlling how IPs are allocated in the GKE cluster. # Optional. The IPAllocationPolicy fields for the GKE cluster.
@@ -942,6 +974,7 @@ <h3>Method Details</h3>
942
974
"cloudComposerNetworkIpv4CidrBlock": "A String", # 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.
943
975
"cloudComposerNetworkIpv4ReservedRange": "A String", # 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.
944
976
"cloudSqlIpv4CidrBlock": "A String", # 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
977
+
"enablePrivateBuildsOnly": True or False, # 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.
945
978
"enablePrivateEnvironment": True or False, # 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-*.*.*.
946
979
"enablePrivatelyUsedPublicIps": True or False, # Optional. When enabled, IPs from public (non-RFC1918) ranges can be used for `IPAllocationPolicy.cluster_ipv4_cidr_block` and `IPAllocationPolicy.service_ipv4_cidr_block`.
947
980
"networkingConfig": { # Configuration options for networking connections in the Composer 2 environment. # Optional. Configuration for the network connections configuration in the environment.
@@ -980,6 +1013,7 @@ <h3>Method Details</h3>
980
1013
},
981
1014
"pythonVersion": "A 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 '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.
982
1015
"schedulerCount": 42, # Optional. The number of schedulers for Airflow. This field is supported for Cloud Composer environments in versions composer-1.*.*-airflow-2.*.*.
1016
+
"webServerPluginsMode": "A String", # 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.
983
1017
},
984
1018
"webServerConfig": { # The configuration settings for the Airflow web server App Engine instance. Supported for Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*. # Optional. The configuration settings for the Airflow web server App Engine instance. This field is supported for Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*.
985
1019
"machineType": "A String", # 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.
@@ -993,6 +1027,12 @@ <h3>Method Details</h3>
993
1027
],
994
1028
},
995
1029
"workloadsConfig": { # The Kubernetes workloads configuration for GKE cluster associated with the Cloud Composer environment. Supported for Cloud Composer environments in versions composer-2.*.*-airflow-*.*.* and newer. # 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.
1030
+
"dagProcessor": { # Configuration for resources used by Airflow DAG processors. # Optional. Resources used by Airflow DAG processors. This field is supported for Cloud Composer environments in versions composer-3.*.*-airflow-*.*.* and newer.
1031
+
"count": 42, # Optional. The number of DAG processors. If not provided or set to 0, a single DAG processor instance will be created.
1032
+
"cpu": 3.14, # Optional. CPU request and limit for a single Airflow DAG processor replica.
1033
+
"memoryGb": 3.14, # Optional. Memory (GB) request and limit for a single Airflow DAG processor replica.
1034
+
"storageGb": 3.14, # Optional. Storage (GB) request and limit for a single Airflow DAG processor replica.
1035
+
},
996
1036
"scheduler": { # Configuration for resources used by Airflow schedulers. # Optional. Resources used by Airflow schedulers.
997
1037
"count": 42, # Optional. The number of schedulers.
998
1038
"cpu": 3.14, # Optional. CPU request and limit for a single Airflow scheduler replica.
Copy file name to clipboardexpand all lines: googleapiclient/discovery_cache/documents/composer.v1beta1.json
+58-1
Original file line number
Diff line number
Diff line change
@@ -655,7 +655,7 @@
655
655
}
656
656
}
657
657
},
658
-
"revision": "20231105",
658
+
"revision": "20231129",
659
659
"rootUrl": "https://composer.googleapis.com/",
660
660
"schemas": {
661
661
"AllowedIpRange": {
@@ -753,6 +753,33 @@
753
753
},
754
754
"type": "object"
755
755
},
756
+
"DagProcessorResource": {
757
+
"description": "Configuration for resources used by Airflow DAG processors.",
758
+
"id": "DagProcessorResource",
759
+
"properties": {
760
+
"count": {
761
+
"description": "Optional. The number of DAG processors. If not provided or set to 0, a single DAG processor instance will be created.",
762
+
"format": "int32",
763
+
"type": "integer"
764
+
},
765
+
"cpu": {
766
+
"description": "Optional. CPU request and limit for a single Airflow DAG processor replica.",
767
+
"format": "float",
768
+
"type": "number"
769
+
},
770
+
"memoryGb": {
771
+
"description": "Optional. Memory (GB) request and limit for a single Airflow DAG processor replica.",
772
+
"format": "float",
773
+
"type": "number"
774
+
},
775
+
"storageGb": {
776
+
"description": "Optional. Storage (GB) request and limit for a single Airflow DAG processor replica.",
777
+
"format": "float",
778
+
"type": "number"
779
+
}
780
+
},
781
+
"type": "object"
782
+
},
756
783
"DatabaseConfig": {
757
784
"description": "The configuration of Cloud SQL instance that is used by the Apache Airflow software.",
758
785
"id": "DatabaseConfig",
@@ -1299,6 +1326,14 @@
1299
1326
"description": "The configuration information for the Kubernetes Engine nodes running the Apache Airflow software.",
1300
1327
"id": "NodeConfig",
1301
1328
"properties": {
1329
+
"composerInternalIpv4CidrBlock": {
1330
+
"description": "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.",
1331
+
"type": "string"
1332
+
},
1333
+
"composerNetworkAttachment": {
1334
+
"description": "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.",
1335
+
"type": "string"
1336
+
},
1302
1337
"diskSizeGb": {
1303
1338
"description": "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-*.*.*.",
1304
1339
"format": "int32",
@@ -1543,6 +1578,10 @@
1543
1578
"description": "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",
1544
1579
"type": "string"
1545
1580
},
1581
+
"enablePrivateBuildsOnly": {
1582
+
"description": "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.",
1583
+
"type": "boolean"
1584
+
},
1546
1585
"enablePrivateEnvironment": {
1547
1586
"description": "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-*.*.*.",
1548
1587
"type": "boolean"
@@ -1701,6 +1740,20 @@
1701
1740
"description": "Optional. The number of schedulers for Airflow. This field is supported for Cloud Composer environments in versions composer-1.*.*-airflow-2.*.*.",
1702
1741
"format": "int32",
1703
1742
"type": "integer"
1743
+
},
1744
+
"webServerPluginsMode": {
1745
+
"description": "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.",
1746
+
"enum": [
1747
+
"WEB_SERVER_PLUGINS_MODE_UNSPECIFIED",
1748
+
"PLUGINS_DISABLED",
1749
+
"PLUGINS_ENABLED"
1750
+
],
1751
+
"enumDescriptions": [
1752
+
"Default mode.",
1753
+
"Web server plugins are not supported.",
1754
+
"Web server plugins are supported."
1755
+
],
1756
+
"type": "string"
1704
1757
}
1705
1758
},
1706
1759
"type": "object"
@@ -1889,6 +1942,10 @@
1889
1942
"description": "The Kubernetes workloads configuration for GKE cluster associated with the Cloud Composer environment. Supported for Cloud Composer environments in versions composer-2.*.*-airflow-*.*.* and newer.",
1890
1943
"id": "WorkloadsConfig",
1891
1944
"properties": {
1945
+
"dagProcessor": {
1946
+
"$ref": "DagProcessorResource",
1947
+
"description": "Optional. Resources used by Airflow DAG processors. This field is supported for Cloud Composer environments in versions composer-3.*.*-airflow-*.*.* and newer."
1948
+
},
1892
1949
"scheduler": {
1893
1950
"$ref": "SchedulerResource",
1894
1951
"description": "Optional. Resources used by Airflow schedulers."
0 commit comments