| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, h1, h2, h3, div, span, p, pre, a { |
| 5 | margin: 0; |
| 6 | padding: 0; |
| 7 | border: 0; |
| 8 | font-weight: inherit; |
| 9 | font-style: inherit; |
| 10 | font-size: 100%; |
| 11 | font-family: inherit; |
| 12 | vertical-align: baseline; |
| 13 | } |
| 14 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, h2, h3 { |
| 50 | border-bottom: solid #CCC 1px; |
| 51 | } |
| 52 | |
| 53 | .toc_element { |
| 54 | margin-top: 0.5em; |
| 55 | } |
| 56 | |
| 57 | .firstline { |
| 58 | margin-left: 2 em; |
| 59 | } |
| 60 | |
| 61 | .method { |
| 62 | margin-top: 1em; |
| 63 | border: solid 1px #CCC; |
| 64 | padding: 1em; |
| 65 | background: #EEE; |
| 66 | } |
| 67 | |
| 68 | .details { |
| 69 | font-weight: bold; |
| 70 | font-size: 14px; |
| 71 | } |
| 72 | |
| 73 | </style> |
| 74 | |
| 75 | <h1><a href="composer_v1beta1.html">Cloud Composer API</a> . <a href="composer_v1beta1.projects.html">projects</a> . <a href="composer_v1beta1.projects.locations.html">locations</a> . <a href="composer_v1beta1.projects.locations.environments.html">environments</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 78 | <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 79 | <p class="firstline">Create a new environment.</p> |
| 80 | <p class="toc_element"> |
| 81 | <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> |
| 82 | <p class="firstline">Delete an environment.</p> |
| 83 | <p class="toc_element"> |
| 84 | <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| 85 | <p class="firstline">Get an existing environment.</p> |
| 86 | <p class="toc_element"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 87 | <code><a href="#list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 88 | <p class="firstline">List environments.</p> |
| 89 | <p class="toc_element"> |
| 90 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 91 | <p class="firstline">Retrieves the next page of results.</p> |
| 92 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 93 | <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 94 | <p class="firstline">Update an environment.</p> |
| 95 | <h3>Method Details</h3> |
| 96 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 97 | <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 98 | <pre>Create a new environment. |
| 99 | |
| 100 | Args: |
| 101 | parent: string, The parent must be of the form |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 102 | "projects/{projectId}/locations/{locationId}". (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 103 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 104 | The object takes the form of: |
| 105 | |
| 106 | { # An environment for running orchestration tasks. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 107 | "createTime": "A String", # Output only. The time at which this environment was created. |
| 108 | "labels": { # Optional. User-defined labels for this environment. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 109 | # The labels map can contain no more than 64 entries. Entries of the labels |
| 110 | # map are UTF8 strings that comply with the following restrictions: |
| 111 | # |
| 112 | # * Keys must conform to regexp: \p{Ll}\p{Lo}{0,62} |
| 113 | # * Values must conform to regexp: [\p{Ll}\p{Lo}\p{N}_-]{0,63} |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 114 | # * Both keys and values are additionally constrained to be <= 128 bytes in |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 115 | # size. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 116 | "a_key": "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 117 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 118 | "updateTime": "A String", # Output only. The time at which this environment was last modified. |
| 119 | "config": { # Configuration information for an environment. # Configuration parameters for this environment. |
| 120 | "nodeCount": 42, # The number of nodes in the Kubernetes Engine cluster that will be |
| 121 | # used to run this environment. |
| 122 | "databaseConfig": { # The configuration of Cloud SQL instance that is used by the Apache Airflow # Optional. The configuration settings for Cloud SQL instance used internally by Apache |
| 123 | # Airflow software. |
| 124 | # software. |
| 125 | "machineType": "A String", # Optional. Cloud SQL tier used by Airflow database. |
| 126 | # If not specified, db-n1-standard-2 will be used. |
| 127 | }, |
| 128 | "webServerConfig": { # The configuration settings for the Airflow web server App Engine instance. # Optional. The configuration settings for the Airflow web server App Engine instance. |
| 129 | "machineType": "A String", # Optional. Machine type on which Airflow web server is running. |
| 130 | # For example: composer-n1-webserver-2, composer-n1-webserver-4, |
| 131 | # composer-n1-webserver-8. |
| 132 | # If not specified, composer-n1-webserver-2 will be used. |
| 133 | # Value custom is returned only in response, if Airflow web server parameters |
| 134 | # were manually changed to a non-standard values. |
| 135 | }, |
| 136 | "webServerNetworkAccessControl": { # Network-level access control policy for the Airflow web server. # Optional. The network-level access control policy for the Airflow web server. If |
| 137 | # unspecified, no network-level access restrictions will be applied. |
| 138 | "allowedIpRanges": [ # A collection of allowed IP ranges with descriptions. |
| 139 | { # Allowed IP range with user-provided description. |
| 140 | "value": "A String", # IP address or range, defined using CIDR notation, of requests that this |
| 141 | # rule applies to. |
| 142 | # Examples: `192.168.1.1` or `192.168.0.0/16` or `2001:db8::/32` |
| 143 | # or `2001:0db8:0000:0042:0000:8a2e:0370:7334`. |
| 144 | # |
| 145 | # |
| 146 | # <p>IP range prefixes should be properly truncated. For example, |
| 147 | # `1.2.3.4/24` should be truncated to `1.2.3.0/24`. Similarly, for IPv6, |
| 148 | # `2001:db8::1/32` should be truncated to `2001:db8::/32`. |
| 149 | "description": "A String", # Optional. User-provided description. It must contain at most 300 characters. |
| 150 | }, |
| 151 | ], |
| 152 | }, |
| 153 | "dagGcsPrefix": "A String", # Output only. The Cloud Storage prefix of the DAGs for this environment. Although Cloud |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 154 | # Storage objects reside in a flat namespace, a hierarchical file tree |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 155 | # can be simulated using "/"-delimited object name prefixes. DAG objects for |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 156 | # this environment reside in a simulated directory with the given prefix. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 157 | "privateEnvironmentConfig": { # The configuration information for configuring a Private IP Cloud Composer # The configuration used for the Private IP Cloud Composer environment. |
| 158 | # environment. |
| 159 | "enablePrivateEnvironment": True or False, # Optional. If `true`, a Private IP Cloud Composer environment is created. |
| 160 | # If this field is true, `use_ip_aliases` must be true. |
| 161 | "cloudSqlIpv4CidrBlock": "A String", # Optional. The CIDR block from which IP range in tenant project will be reserved for |
| 162 | # Cloud SQL. Needs to be disjoint from web_server_ipv4_cidr_block |
| 163 | "privateClusterConfig": { # Configuration options for the private GKE cluster in a Cloud Composer # Optional. Configuration for the private GKE cluster for a Private IP |
| 164 | # Cloud Composer environment. |
| 165 | # environment. |
| 166 | "masterIpv4CidrBlock": "A String", # Optional. The CIDR block from which IPv4 range for GKE master will be reserved. If |
| 167 | # left blank, the default value of '172.16.0.0/23' is used. |
| 168 | "enablePrivateEndpoint": True or False, # Optional. If `true`, access to the public endpoint of the GKE cluster is |
| 169 | # denied. |
| 170 | "masterIpv4ReservedRange": "A String", # Output only. The IP range in CIDR notation to use for the hosted master network. This |
| 171 | # range is used for assigning internal IP addresses to the cluster |
| 172 | # master or set of masters and to the internal load balancer virtual IP. |
| 173 | # This range must not overlap with any other ranges in use |
| 174 | # within the cluster's network. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 175 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 176 | "webServerIpv4ReservedRange": "A String", # Output only. The IP range reserved for the tenant project's App Engine VMs. |
| 177 | "webServerIpv4CidrBlock": "A String", # Optional. The CIDR block from which IP range for web server will be reserved. Needs |
| 178 | # to be disjoint from private_cluster_config.master_ipv4_cidr_block and |
| 179 | # cloud_sql_ipv4_cidr_block. |
| 180 | }, |
| 181 | "gkeCluster": "A String", # Output only. The Kubernetes Engine cluster used to run this environment. |
| 182 | "airflowUri": "A String", # Output only. The URI of the Apache Airflow Web UI hosted within this environment (see |
| 183 | # [Airflow web |
| 184 | # interface](/composer/docs/how-to/accessing/airflow-web-interface)). |
| 185 | "softwareConfig": { # Specifies the selection and configuration of software inside the environment. # The configuration settings for software inside the environment. |
| 186 | "envVariables": { # Optional. Additional environment variables to provide to the Apache Airflow |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 187 | # scheduler, worker, and webserver processes. |
| 188 | # |
| 189 | # Environment variable names must match the regular expression |
| 190 | # `a-zA-Z_*`. They cannot specify Apache Airflow |
| 191 | # software configuration overrides (they cannot match the regular expression |
| 192 | # `AIRFLOW__[A-Z0-9_]+__[A-Z0-9_]+`), and they cannot match any of the |
| 193 | # following reserved names: |
| 194 | # |
| 195 | # * `AIRFLOW_HOME` |
| 196 | # * `C_FORCE_ROOT` |
| 197 | # * `CONTAINER_NAME` |
| 198 | # * `DAGS_FOLDER` |
| 199 | # * `GCP_PROJECT` |
| 200 | # * `GCS_BUCKET` |
| 201 | # * `GKE_CLUSTER_NAME` |
| 202 | # * `SQL_DATABASE` |
| 203 | # * `SQL_INSTANCE` |
| 204 | # * `SQL_PASSWORD` |
| 205 | # * `SQL_PROJECT` |
| 206 | # * `SQL_REGION` |
| 207 | # * `SQL_USER` |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 208 | "a_key": "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 209 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 210 | "pythonVersion": "A String", # Optional. The major version of Python used to run the Apache Airflow |
| 211 | # scheduler, worker, and webserver processes. |
| 212 | # |
| 213 | # Can be set to '2' or '3'. If not specified, the default is '2'. Cannot be |
| 214 | # updated. |
| 215 | "pypiPackages": { # Optional. Custom Python Package Index (PyPI) packages to be installed in |
| 216 | # the environment. |
| 217 | # |
| 218 | # Keys refer to the lowercase package name such as "numpy" |
| 219 | # and values are the lowercase extras and version specifier such as |
| 220 | # "==1.12.0", "[devel,gcp_api]", or "[devel]>=1.8.2, <1.9.2". To specify a |
| 221 | # package without pinning it to a version specifier, use the empty string as |
| 222 | # the value. |
| 223 | "a_key": "A String", |
| 224 | }, |
| 225 | "imageVersion": "A String", # The version of the software running in the environment. |
| 226 | # This encapsulates both the version of Cloud Composer functionality and the |
| 227 | # version of Apache Airflow. It must match the regular expression |
| 228 | # `composer-([0-9]+\.[0-9]+\.[0-9]+|latest)-airflow-[0-9]+\.[0-9]+(\.[0-9]+.*)?`. |
| 229 | # When used as input, the server also checks if the provided version is |
| 230 | # supported and denies the request for an unsupported version. |
| 231 | # |
| 232 | # The Cloud Composer portion of the version is a |
| 233 | # [semantic version](https://semver.org) or `latest`. When the patch version |
| 234 | # is omitted, the current Cloud Composer patch version is selected. |
| 235 | # When `latest` is provided instead of an explicit version number, |
| 236 | # the server replaces `latest` with the current Cloud Composer version |
| 237 | # and stores that version number in the same field. |
| 238 | # |
| 239 | # The portion of the image version that follows <em>airflow-</em> is an |
| 240 | # official Apache Airflow repository |
| 241 | # [release name](https://github.com/apache/incubator-airflow/releases). |
| 242 | # |
| 243 | # See also [Version |
| 244 | # List](/composer/docs/concepts/versioning/composer-versions). |
| 245 | "airflowConfigOverrides": { # Optional. Apache Airflow configuration properties to override. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 246 | # |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 247 | # Property keys contain the section and property names, separated by a |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 248 | # hyphen, for example "core-dags_are_paused_at_creation". Section names must |
| 249 | # not contain hyphens ("-"), opening square brackets ("["), or closing |
| 250 | # square brackets ("]"). The property name must not be empty and must not |
| 251 | # contain an equals sign ("=") or semicolon (";"). Section and property names |
| 252 | # must not contain a period ("."). Apache Airflow configuration property |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 253 | # names must be written in |
| 254 | # [snake_case](https://en.wikipedia.org/wiki/Snake_case). Property values can |
| 255 | # contain any character, and can be written in any lower/upper case format. |
| 256 | # |
| 257 | # Certain Apache Airflow configuration property values are |
| 258 | # [blacklisted](/composer/docs/how-to/managing/setting-airflow-configurations#airflow_configuration_blacklists), |
| 259 | # and cannot be overridden. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 260 | "a_key": "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 261 | }, |
| 262 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 263 | "nodeConfig": { # The configuration information for the Kubernetes Engine nodes running # The configuration used for the Kubernetes Engine cluster. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 264 | # the Apache Airflow software. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 265 | "oauthScopes": [ # Optional. The set of Google API scopes to be made available on all |
| 266 | # node VMs. If `oauth_scopes` is empty, defaults to |
| 267 | # ["https://www.googleapis.com/auth/cloud-platform"]. Cannot be updated. |
| 268 | "A String", |
| 269 | ], |
| 270 | "subnetwork": "A String", # Optional. The Compute Engine subnetwork to be used for machine |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 271 | # communications, specified as a |
| 272 | # [relative resource |
| 273 | # name](/apis/design/resource_names#relative_resource_name). For example: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 274 | # "projects/{projectId}/regions/{regionId}/subnetworks/{subnetworkId}" |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 275 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 276 | # If a subnetwork is provided, `nodeConfig.network` must also be provided, |
| 277 | # and the subnetwork must belong to the enclosing environment's project and |
| 278 | # location. |
| 279 | "ipAllocationPolicy": { # Configuration for controlling how IPs are allocated in the # Optional. The IPAllocationPolicy fields for the GKE cluster. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 280 | # GKE cluster. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 281 | "servicesSecondaryRangeName": "A String", # Optional. The name of the services' secondary range used to allocate |
| 282 | # IP addresses to the cluster. Specify either `services_secondary_range_name` |
| 283 | # or `services_ipv4_cidr_block` but not both. |
| 284 | # |
| 285 | # This field is applicable only when `use_ip_aliases` is true. |
| 286 | "useIpAliases": True or False, # Optional. Whether or not to enable Alias IPs in the GKE cluster. |
| 287 | # If `true`, a VPC-native cluster is created. |
| 288 | "clusterIpv4CidrBlock": "A String", # Optional. The IP address range used to allocate IP addresses to pods in |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 289 | # the cluster. |
| 290 | # |
| 291 | # This field is applicable only when `use_ip_aliases` is true. |
| 292 | # |
| 293 | # Set to blank to have GKE choose a range with the default size. |
| 294 | # |
| 295 | # Set to /netmask (e.g. `/14`) to have GKE choose a range with a specific |
| 296 | # netmask. |
| 297 | # |
| 298 | # Set to a |
| 299 | # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) |
| 300 | # notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. |
| 301 | # `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range |
| 302 | # to use. |
| 303 | # Specify `cluster_secondary_range_name` or `cluster_ipv4_cidr_block` |
| 304 | # but not both. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 305 | "clusterSecondaryRangeName": "A String", # Optional. The name of the cluster's secondary range used to allocate |
| 306 | # IP addresses to pods. Specify either `cluster_secondary_range_name` |
| 307 | # or `cluster_ipv4_cidr_block` but not both. |
| 308 | # |
| 309 | # This field is applicable only when `use_ip_aliases` is true. |
| 310 | "servicesIpv4CidrBlock": "A String", # Optional. The IP address range of the services IP addresses in this |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 311 | # cluster. |
| 312 | # |
| 313 | # This field is applicable only when `use_ip_aliases` is true. |
| 314 | # |
| 315 | # Set to blank to have GKE choose a range with the default size. |
| 316 | # |
| 317 | # Set to /netmask (e.g. `/14`) to have GKE choose a range with a specific |
| 318 | # netmask. |
| 319 | # |
| 320 | # Set to a |
| 321 | # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) |
| 322 | # notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. |
| 323 | # `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range |
| 324 | # to use. |
| 325 | # Specify `services_secondary_range_name` or `services_ipv4_cidr_block` |
| 326 | # but not both. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 327 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 328 | "diskSizeGb": 42, # Optional. The disk size in GB used for node VMs. Minimum size is 20GB. |
| 329 | # If unspecified, defaults to 100GB. Cannot be updated. |
| 330 | "tags": [ # Optional. The list of instance tags applied to all node VMs. Tags are used |
| 331 | # to identify valid sources or targets for network firewalls. Each tag within |
| 332 | # the list must comply with [RFC1035](https://www.ietf.org/rfc/rfc1035.txt). |
| 333 | # Cannot be updated. |
| 334 | "A String", |
| 335 | ], |
| 336 | "serviceAccount": "A String", # Optional. The Google Cloud Platform Service Account to be used by the node |
| 337 | # VMs. If a service account is not specified, the "default" Compute Engine |
| 338 | # service account is used. Cannot be updated. |
| 339 | "location": "A String", # Optional. The Compute Engine [zone](/compute/docs/regions-zones) in which |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 340 | # to deploy the VMs used to run the Apache Airflow software, specified as a |
| 341 | # [relative resource |
| 342 | # name](/apis/design/resource_names#relative_resource_name). For example: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 343 | # "projects/{projectId}/zones/{zoneId}". |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 344 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 345 | # This `location` must belong to the enclosing environment's project and |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 346 | # location. If both this field and `nodeConfig.machineType` are specified, |
| 347 | # `nodeConfig.machineType` must belong to this `location`; if both are |
| 348 | # unspecified, the service will pick a zone in the Compute Engine region |
| 349 | # corresponding to the Cloud Composer location, and propagate that choice to |
| 350 | # both fields. If only one field (`location` or `nodeConfig.machineType`) is |
| 351 | # specified, the location information from the specified field will be |
| 352 | # propagated to the unspecified field. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 353 | "machineType": "A String", # Optional. The Compute Engine |
| 354 | # [machine type](/compute/docs/machine-types) used for cluster instances, |
| 355 | # specified as a |
| 356 | # [relative resource |
| 357 | # name](/apis/design/resource_names#relative_resource_name). For example: |
| 358 | # "projects/{projectId}/zones/{zoneId}/machineTypes/{machineTypeId}". |
| 359 | # |
| 360 | # The `machineType` must belong to the enclosing environment's project and |
| 361 | # location. If both this field and `nodeConfig.location` are specified, |
| 362 | # this `machineType` must belong to the `nodeConfig.location`; if both are |
| 363 | # unspecified, the service will pick a zone in the Compute Engine region |
| 364 | # corresponding to the Cloud Composer location, and propagate that choice to |
| 365 | # both fields. If exactly one of this field and `nodeConfig.location` is |
| 366 | # specified, the location information from the specified field will be |
| 367 | # propagated to the unspecified field. |
| 368 | # |
| 369 | # The `machineTypeId` must not be a [shared-core machine |
| 370 | # type](/compute/docs/machine-types#sharedcore). |
| 371 | # |
| 372 | # If this field is unspecified, the `machineTypeId` defaults |
| 373 | # to "n1-standard-1". |
| 374 | "network": "A String", # Optional. The Compute Engine network to be used for machine |
| 375 | # communications, specified as a |
| 376 | # [relative resource |
| 377 | # name](/apis/design/resource_names#relative_resource_name). For example: |
| 378 | # "projects/{projectId}/global/networks/{networkId}". |
| 379 | # |
| 380 | # If unspecified, the default network in the environment's project is used. |
| 381 | # If a [Custom Subnet Network](/vpc/docs/vpc#vpc_networks_and_subnets) |
| 382 | # is provided, `nodeConfig.subnetwork` must also be provided. For |
| 383 | # [Shared VPC](/vpc/docs/shared-vpc) subnetwork requirements, see |
| 384 | # `nodeConfig.subnetwork`. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 385 | }, |
| 386 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 387 | "state": "A String", # The current state of the environment. |
| 388 | "name": "A String", # The resource name of the environment, in the form: |
| 389 | # "projects/{projectId}/locations/{locationId}/environments/{environmentId}" |
| 390 | # |
| 391 | # EnvironmentId must start with a lowercase letter followed by up to 63 |
| 392 | # lowercase letters, numbers, or hyphens, and cannot end with a hyphen. |
| 393 | "uuid": "A String", # Output only. The UUID (Universally Unique IDentifier) associated with this environment. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 394 | # This value is generated when the environment is created. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 395 | } |
| 396 | |
| 397 | x__xgafv: string, V1 error format. |
| 398 | Allowed values |
| 399 | 1 - v1 error format |
| 400 | 2 - v2 error format |
| 401 | |
| 402 | Returns: |
| 403 | An object of the form: |
| 404 | |
| 405 | { # This resource represents a long-running operation that is the result of a |
| 406 | # network API call. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 407 | "metadata": { # Service-specific metadata associated with the operation. It typically |
| 408 | # contains progress information and common metadata such as create time. |
| 409 | # Some services might not provide such metadata. Any method that returns a |
| 410 | # long-running operation should document the metadata type, if any. |
| 411 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 412 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 413 | "done": True or False, # If the value is `false`, it means the operation is still in progress. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 414 | # If `true`, the operation is completed, and either `error` or `response` is |
| 415 | # available. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 416 | "response": { # The normal response of the operation in case of success. If the original |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 417 | # method returns no data on success, such as `Delete`, the response is |
| 418 | # `google.protobuf.Empty`. If the original method is standard |
| 419 | # `Get`/`Create`/`Update`, the response should be the resource. For other |
| 420 | # methods, the response should have the type `XxxResponse`, where `Xxx` |
| 421 | # is the original method name. For example, if the original method name |
| 422 | # is `TakeSnapshot()`, the inferred response type is |
| 423 | # `TakeSnapshotResponse`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 424 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 425 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 426 | "name": "A String", # The server-assigned name, which is only unique within the same service that |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 427 | # originally returns it. If you use the default HTTP mapping, the |
| 428 | # `name` should be a resource name ending with `operations/{unique_id}`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 429 | "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation. |
| 430 | # different programming environments, including REST APIs and RPC APIs. It is |
| 431 | # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| 432 | # three pieces of data: error code, error message, and error details. |
| 433 | # |
| 434 | # You can find out more about this error model and how to work with it in the |
| 435 | # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| 436 | "details": [ # A list of messages that carry the error details. There is a common set of |
| 437 | # message types for APIs to use. |
| 438 | { |
| 439 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 440 | }, |
| 441 | ], |
| 442 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 443 | "message": "A String", # A developer-facing error message, which should be in English. Any |
| 444 | # user-facing error message should be localized and sent in the |
| 445 | # google.rpc.Status.details field, or localized by the client. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 446 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 447 | }</pre> |
| 448 | </div> |
| 449 | |
| 450 | <div class="method"> |
| 451 | <code class="details" id="delete">delete(name, x__xgafv=None)</code> |
| 452 | <pre>Delete an environment. |
| 453 | |
| 454 | Args: |
| 455 | name: string, The environment to delete, in the form: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 456 | "projects/{projectId}/locations/{locationId}/environments/{environmentId}" (required) |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 457 | x__xgafv: string, V1 error format. |
| 458 | Allowed values |
| 459 | 1 - v1 error format |
| 460 | 2 - v2 error format |
| 461 | |
| 462 | Returns: |
| 463 | An object of the form: |
| 464 | |
| 465 | { # This resource represents a long-running operation that is the result of a |
| 466 | # network API call. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 467 | "metadata": { # Service-specific metadata associated with the operation. It typically |
| 468 | # contains progress information and common metadata such as create time. |
| 469 | # Some services might not provide such metadata. Any method that returns a |
| 470 | # long-running operation should document the metadata type, if any. |
| 471 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 472 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 473 | "done": True or False, # If the value is `false`, it means the operation is still in progress. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 474 | # If `true`, the operation is completed, and either `error` or `response` is |
| 475 | # available. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 476 | "response": { # The normal response of the operation in case of success. If the original |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 477 | # method returns no data on success, such as `Delete`, the response is |
| 478 | # `google.protobuf.Empty`. If the original method is standard |
| 479 | # `Get`/`Create`/`Update`, the response should be the resource. For other |
| 480 | # methods, the response should have the type `XxxResponse`, where `Xxx` |
| 481 | # is the original method name. For example, if the original method name |
| 482 | # is `TakeSnapshot()`, the inferred response type is |
| 483 | # `TakeSnapshotResponse`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 484 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 485 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 486 | "name": "A String", # The server-assigned name, which is only unique within the same service that |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 487 | # originally returns it. If you use the default HTTP mapping, the |
| 488 | # `name` should be a resource name ending with `operations/{unique_id}`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 489 | "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation. |
| 490 | # different programming environments, including REST APIs and RPC APIs. It is |
| 491 | # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| 492 | # three pieces of data: error code, error message, and error details. |
| 493 | # |
| 494 | # You can find out more about this error model and how to work with it in the |
| 495 | # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| 496 | "details": [ # A list of messages that carry the error details. There is a common set of |
| 497 | # message types for APIs to use. |
| 498 | { |
| 499 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 500 | }, |
| 501 | ], |
| 502 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 503 | "message": "A String", # A developer-facing error message, which should be in English. Any |
| 504 | # user-facing error message should be localized and sent in the |
| 505 | # google.rpc.Status.details field, or localized by the client. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 506 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 507 | }</pre> |
| 508 | </div> |
| 509 | |
| 510 | <div class="method"> |
| 511 | <code class="details" id="get">get(name, x__xgafv=None)</code> |
| 512 | <pre>Get an existing environment. |
| 513 | |
| 514 | Args: |
| 515 | name: string, The resource name of the environment to get, in the form: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 516 | "projects/{projectId}/locations/{locationId}/environments/{environmentId}" (required) |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 517 | x__xgafv: string, V1 error format. |
| 518 | Allowed values |
| 519 | 1 - v1 error format |
| 520 | 2 - v2 error format |
| 521 | |
| 522 | Returns: |
| 523 | An object of the form: |
| 524 | |
| 525 | { # An environment for running orchestration tasks. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 526 | "createTime": "A String", # Output only. The time at which this environment was created. |
| 527 | "labels": { # Optional. User-defined labels for this environment. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 528 | # The labels map can contain no more than 64 entries. Entries of the labels |
| 529 | # map are UTF8 strings that comply with the following restrictions: |
| 530 | # |
| 531 | # * Keys must conform to regexp: \p{Ll}\p{Lo}{0,62} |
| 532 | # * Values must conform to regexp: [\p{Ll}\p{Lo}\p{N}_-]{0,63} |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 533 | # * Both keys and values are additionally constrained to be <= 128 bytes in |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 534 | # size. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 535 | "a_key": "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 536 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 537 | "updateTime": "A String", # Output only. The time at which this environment was last modified. |
| 538 | "config": { # Configuration information for an environment. # Configuration parameters for this environment. |
| 539 | "nodeCount": 42, # The number of nodes in the Kubernetes Engine cluster that will be |
| 540 | # used to run this environment. |
| 541 | "databaseConfig": { # The configuration of Cloud SQL instance that is used by the Apache Airflow # Optional. The configuration settings for Cloud SQL instance used internally by Apache |
| 542 | # Airflow software. |
| 543 | # software. |
| 544 | "machineType": "A String", # Optional. Cloud SQL tier used by Airflow database. |
| 545 | # If not specified, db-n1-standard-2 will be used. |
| 546 | }, |
| 547 | "webServerConfig": { # The configuration settings for the Airflow web server App Engine instance. # Optional. The configuration settings for the Airflow web server App Engine instance. |
| 548 | "machineType": "A String", # Optional. Machine type on which Airflow web server is running. |
| 549 | # For example: composer-n1-webserver-2, composer-n1-webserver-4, |
| 550 | # composer-n1-webserver-8. |
| 551 | # If not specified, composer-n1-webserver-2 will be used. |
| 552 | # Value custom is returned only in response, if Airflow web server parameters |
| 553 | # were manually changed to a non-standard values. |
| 554 | }, |
| 555 | "webServerNetworkAccessControl": { # Network-level access control policy for the Airflow web server. # Optional. The network-level access control policy for the Airflow web server. If |
| 556 | # unspecified, no network-level access restrictions will be applied. |
| 557 | "allowedIpRanges": [ # A collection of allowed IP ranges with descriptions. |
| 558 | { # Allowed IP range with user-provided description. |
| 559 | "value": "A String", # IP address or range, defined using CIDR notation, of requests that this |
| 560 | # rule applies to. |
| 561 | # Examples: `192.168.1.1` or `192.168.0.0/16` or `2001:db8::/32` |
| 562 | # or `2001:0db8:0000:0042:0000:8a2e:0370:7334`. |
| 563 | # |
| 564 | # |
| 565 | # <p>IP range prefixes should be properly truncated. For example, |
| 566 | # `1.2.3.4/24` should be truncated to `1.2.3.0/24`. Similarly, for IPv6, |
| 567 | # `2001:db8::1/32` should be truncated to `2001:db8::/32`. |
| 568 | "description": "A String", # Optional. User-provided description. It must contain at most 300 characters. |
| 569 | }, |
| 570 | ], |
| 571 | }, |
| 572 | "dagGcsPrefix": "A String", # Output only. The Cloud Storage prefix of the DAGs for this environment. Although Cloud |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 573 | # Storage objects reside in a flat namespace, a hierarchical file tree |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 574 | # can be simulated using "/"-delimited object name prefixes. DAG objects for |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 575 | # this environment reside in a simulated directory with the given prefix. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 576 | "privateEnvironmentConfig": { # The configuration information for configuring a Private IP Cloud Composer # The configuration used for the Private IP Cloud Composer environment. |
| 577 | # environment. |
| 578 | "enablePrivateEnvironment": True or False, # Optional. If `true`, a Private IP Cloud Composer environment is created. |
| 579 | # If this field is true, `use_ip_aliases` must be true. |
| 580 | "cloudSqlIpv4CidrBlock": "A String", # Optional. The CIDR block from which IP range in tenant project will be reserved for |
| 581 | # Cloud SQL. Needs to be disjoint from web_server_ipv4_cidr_block |
| 582 | "privateClusterConfig": { # Configuration options for the private GKE cluster in a Cloud Composer # Optional. Configuration for the private GKE cluster for a Private IP |
| 583 | # Cloud Composer environment. |
| 584 | # environment. |
| 585 | "masterIpv4CidrBlock": "A String", # Optional. The CIDR block from which IPv4 range for GKE master will be reserved. If |
| 586 | # left blank, the default value of '172.16.0.0/23' is used. |
| 587 | "enablePrivateEndpoint": True or False, # Optional. If `true`, access to the public endpoint of the GKE cluster is |
| 588 | # denied. |
| 589 | "masterIpv4ReservedRange": "A String", # Output only. The IP range in CIDR notation to use for the hosted master network. This |
| 590 | # range is used for assigning internal IP addresses to the cluster |
| 591 | # master or set of masters and to the internal load balancer virtual IP. |
| 592 | # This range must not overlap with any other ranges in use |
| 593 | # within the cluster's network. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 594 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 595 | "webServerIpv4ReservedRange": "A String", # Output only. The IP range reserved for the tenant project's App Engine VMs. |
| 596 | "webServerIpv4CidrBlock": "A String", # Optional. The CIDR block from which IP range for web server will be reserved. Needs |
| 597 | # to be disjoint from private_cluster_config.master_ipv4_cidr_block and |
| 598 | # cloud_sql_ipv4_cidr_block. |
| 599 | }, |
| 600 | "gkeCluster": "A String", # Output only. The Kubernetes Engine cluster used to run this environment. |
| 601 | "airflowUri": "A String", # Output only. The URI of the Apache Airflow Web UI hosted within this environment (see |
| 602 | # [Airflow web |
| 603 | # interface](/composer/docs/how-to/accessing/airflow-web-interface)). |
| 604 | "softwareConfig": { # Specifies the selection and configuration of software inside the environment. # The configuration settings for software inside the environment. |
| 605 | "envVariables": { # Optional. Additional environment variables to provide to the Apache Airflow |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 606 | # scheduler, worker, and webserver processes. |
| 607 | # |
| 608 | # Environment variable names must match the regular expression |
| 609 | # `a-zA-Z_*`. They cannot specify Apache Airflow |
| 610 | # software configuration overrides (they cannot match the regular expression |
| 611 | # `AIRFLOW__[A-Z0-9_]+__[A-Z0-9_]+`), and they cannot match any of the |
| 612 | # following reserved names: |
| 613 | # |
| 614 | # * `AIRFLOW_HOME` |
| 615 | # * `C_FORCE_ROOT` |
| 616 | # * `CONTAINER_NAME` |
| 617 | # * `DAGS_FOLDER` |
| 618 | # * `GCP_PROJECT` |
| 619 | # * `GCS_BUCKET` |
| 620 | # * `GKE_CLUSTER_NAME` |
| 621 | # * `SQL_DATABASE` |
| 622 | # * `SQL_INSTANCE` |
| 623 | # * `SQL_PASSWORD` |
| 624 | # * `SQL_PROJECT` |
| 625 | # * `SQL_REGION` |
| 626 | # * `SQL_USER` |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 627 | "a_key": "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 628 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 629 | "pythonVersion": "A String", # Optional. The major version of Python used to run the Apache Airflow |
| 630 | # scheduler, worker, and webserver processes. |
| 631 | # |
| 632 | # Can be set to '2' or '3'. If not specified, the default is '2'. Cannot be |
| 633 | # updated. |
| 634 | "pypiPackages": { # Optional. Custom Python Package Index (PyPI) packages to be installed in |
| 635 | # the environment. |
| 636 | # |
| 637 | # Keys refer to the lowercase package name such as "numpy" |
| 638 | # and values are the lowercase extras and version specifier such as |
| 639 | # "==1.12.0", "[devel,gcp_api]", or "[devel]>=1.8.2, <1.9.2". To specify a |
| 640 | # package without pinning it to a version specifier, use the empty string as |
| 641 | # the value. |
| 642 | "a_key": "A String", |
| 643 | }, |
| 644 | "imageVersion": "A String", # The version of the software running in the environment. |
| 645 | # This encapsulates both the version of Cloud Composer functionality and the |
| 646 | # version of Apache Airflow. It must match the regular expression |
| 647 | # `composer-([0-9]+\.[0-9]+\.[0-9]+|latest)-airflow-[0-9]+\.[0-9]+(\.[0-9]+.*)?`. |
| 648 | # When used as input, the server also checks if the provided version is |
| 649 | # supported and denies the request for an unsupported version. |
| 650 | # |
| 651 | # The Cloud Composer portion of the version is a |
| 652 | # [semantic version](https://semver.org) or `latest`. When the patch version |
| 653 | # is omitted, the current Cloud Composer patch version is selected. |
| 654 | # When `latest` is provided instead of an explicit version number, |
| 655 | # the server replaces `latest` with the current Cloud Composer version |
| 656 | # and stores that version number in the same field. |
| 657 | # |
| 658 | # The portion of the image version that follows <em>airflow-</em> is an |
| 659 | # official Apache Airflow repository |
| 660 | # [release name](https://github.com/apache/incubator-airflow/releases). |
| 661 | # |
| 662 | # See also [Version |
| 663 | # List](/composer/docs/concepts/versioning/composer-versions). |
| 664 | "airflowConfigOverrides": { # Optional. Apache Airflow configuration properties to override. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 665 | # |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 666 | # Property keys contain the section and property names, separated by a |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 667 | # hyphen, for example "core-dags_are_paused_at_creation". Section names must |
| 668 | # not contain hyphens ("-"), opening square brackets ("["), or closing |
| 669 | # square brackets ("]"). The property name must not be empty and must not |
| 670 | # contain an equals sign ("=") or semicolon (";"). Section and property names |
| 671 | # must not contain a period ("."). Apache Airflow configuration property |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 672 | # names must be written in |
| 673 | # [snake_case](https://en.wikipedia.org/wiki/Snake_case). Property values can |
| 674 | # contain any character, and can be written in any lower/upper case format. |
| 675 | # |
| 676 | # Certain Apache Airflow configuration property values are |
| 677 | # [blacklisted](/composer/docs/how-to/managing/setting-airflow-configurations#airflow_configuration_blacklists), |
| 678 | # and cannot be overridden. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 679 | "a_key": "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 680 | }, |
| 681 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 682 | "nodeConfig": { # The configuration information for the Kubernetes Engine nodes running # The configuration used for the Kubernetes Engine cluster. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 683 | # the Apache Airflow software. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 684 | "oauthScopes": [ # Optional. The set of Google API scopes to be made available on all |
| 685 | # node VMs. If `oauth_scopes` is empty, defaults to |
| 686 | # ["https://www.googleapis.com/auth/cloud-platform"]. Cannot be updated. |
| 687 | "A String", |
| 688 | ], |
| 689 | "subnetwork": "A String", # Optional. The Compute Engine subnetwork to be used for machine |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 690 | # communications, specified as a |
| 691 | # [relative resource |
| 692 | # name](/apis/design/resource_names#relative_resource_name). For example: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 693 | # "projects/{projectId}/regions/{regionId}/subnetworks/{subnetworkId}" |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 694 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 695 | # If a subnetwork is provided, `nodeConfig.network` must also be provided, |
| 696 | # and the subnetwork must belong to the enclosing environment's project and |
| 697 | # location. |
| 698 | "ipAllocationPolicy": { # Configuration for controlling how IPs are allocated in the # Optional. The IPAllocationPolicy fields for the GKE cluster. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 699 | # GKE cluster. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 700 | "servicesSecondaryRangeName": "A String", # Optional. The name of the services' secondary range used to allocate |
| 701 | # IP addresses to the cluster. Specify either `services_secondary_range_name` |
| 702 | # or `services_ipv4_cidr_block` but not both. |
| 703 | # |
| 704 | # This field is applicable only when `use_ip_aliases` is true. |
| 705 | "useIpAliases": True or False, # Optional. Whether or not to enable Alias IPs in the GKE cluster. |
| 706 | # If `true`, a VPC-native cluster is created. |
| 707 | "clusterIpv4CidrBlock": "A String", # Optional. The IP address range used to allocate IP addresses to pods in |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 708 | # the cluster. |
| 709 | # |
| 710 | # This field is applicable only when `use_ip_aliases` is true. |
| 711 | # |
| 712 | # Set to blank to have GKE choose a range with the default size. |
| 713 | # |
| 714 | # Set to /netmask (e.g. `/14`) to have GKE choose a range with a specific |
| 715 | # netmask. |
| 716 | # |
| 717 | # Set to a |
| 718 | # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) |
| 719 | # notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. |
| 720 | # `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range |
| 721 | # to use. |
| 722 | # Specify `cluster_secondary_range_name` or `cluster_ipv4_cidr_block` |
| 723 | # but not both. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 724 | "clusterSecondaryRangeName": "A String", # Optional. The name of the cluster's secondary range used to allocate |
| 725 | # IP addresses to pods. Specify either `cluster_secondary_range_name` |
| 726 | # or `cluster_ipv4_cidr_block` but not both. |
| 727 | # |
| 728 | # This field is applicable only when `use_ip_aliases` is true. |
| 729 | "servicesIpv4CidrBlock": "A String", # Optional. The IP address range of the services IP addresses in this |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 730 | # cluster. |
| 731 | # |
| 732 | # This field is applicable only when `use_ip_aliases` is true. |
| 733 | # |
| 734 | # Set to blank to have GKE choose a range with the default size. |
| 735 | # |
| 736 | # Set to /netmask (e.g. `/14`) to have GKE choose a range with a specific |
| 737 | # netmask. |
| 738 | # |
| 739 | # Set to a |
| 740 | # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) |
| 741 | # notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. |
| 742 | # `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range |
| 743 | # to use. |
| 744 | # Specify `services_secondary_range_name` or `services_ipv4_cidr_block` |
| 745 | # but not both. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 746 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 747 | "diskSizeGb": 42, # Optional. The disk size in GB used for node VMs. Minimum size is 20GB. |
| 748 | # If unspecified, defaults to 100GB. Cannot be updated. |
| 749 | "tags": [ # Optional. The list of instance tags applied to all node VMs. Tags are used |
| 750 | # to identify valid sources or targets for network firewalls. Each tag within |
| 751 | # the list must comply with [RFC1035](https://www.ietf.org/rfc/rfc1035.txt). |
| 752 | # Cannot be updated. |
| 753 | "A String", |
| 754 | ], |
| 755 | "serviceAccount": "A String", # Optional. The Google Cloud Platform Service Account to be used by the node |
| 756 | # VMs. If a service account is not specified, the "default" Compute Engine |
| 757 | # service account is used. Cannot be updated. |
| 758 | "location": "A String", # Optional. The Compute Engine [zone](/compute/docs/regions-zones) in which |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 759 | # to deploy the VMs used to run the Apache Airflow software, specified as a |
| 760 | # [relative resource |
| 761 | # name](/apis/design/resource_names#relative_resource_name). For example: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 762 | # "projects/{projectId}/zones/{zoneId}". |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 763 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 764 | # This `location` must belong to the enclosing environment's project and |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 765 | # location. If both this field and `nodeConfig.machineType` are specified, |
| 766 | # `nodeConfig.machineType` must belong to this `location`; if both are |
| 767 | # unspecified, the service will pick a zone in the Compute Engine region |
| 768 | # corresponding to the Cloud Composer location, and propagate that choice to |
| 769 | # both fields. If only one field (`location` or `nodeConfig.machineType`) is |
| 770 | # specified, the location information from the specified field will be |
| 771 | # propagated to the unspecified field. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 772 | "machineType": "A String", # Optional. The Compute Engine |
| 773 | # [machine type](/compute/docs/machine-types) used for cluster instances, |
| 774 | # specified as a |
| 775 | # [relative resource |
| 776 | # name](/apis/design/resource_names#relative_resource_name). For example: |
| 777 | # "projects/{projectId}/zones/{zoneId}/machineTypes/{machineTypeId}". |
| 778 | # |
| 779 | # The `machineType` must belong to the enclosing environment's project and |
| 780 | # location. If both this field and `nodeConfig.location` are specified, |
| 781 | # this `machineType` must belong to the `nodeConfig.location`; if both are |
| 782 | # unspecified, the service will pick a zone in the Compute Engine region |
| 783 | # corresponding to the Cloud Composer location, and propagate that choice to |
| 784 | # both fields. If exactly one of this field and `nodeConfig.location` is |
| 785 | # specified, the location information from the specified field will be |
| 786 | # propagated to the unspecified field. |
| 787 | # |
| 788 | # The `machineTypeId` must not be a [shared-core machine |
| 789 | # type](/compute/docs/machine-types#sharedcore). |
| 790 | # |
| 791 | # If this field is unspecified, the `machineTypeId` defaults |
| 792 | # to "n1-standard-1". |
| 793 | "network": "A String", # Optional. The Compute Engine network to be used for machine |
| 794 | # communications, specified as a |
| 795 | # [relative resource |
| 796 | # name](/apis/design/resource_names#relative_resource_name). For example: |
| 797 | # "projects/{projectId}/global/networks/{networkId}". |
| 798 | # |
| 799 | # If unspecified, the default network in the environment's project is used. |
| 800 | # If a [Custom Subnet Network](/vpc/docs/vpc#vpc_networks_and_subnets) |
| 801 | # is provided, `nodeConfig.subnetwork` must also be provided. For |
| 802 | # [Shared VPC](/vpc/docs/shared-vpc) subnetwork requirements, see |
| 803 | # `nodeConfig.subnetwork`. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 804 | }, |
| 805 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 806 | "state": "A String", # The current state of the environment. |
| 807 | "name": "A String", # The resource name of the environment, in the form: |
| 808 | # "projects/{projectId}/locations/{locationId}/environments/{environmentId}" |
| 809 | # |
| 810 | # EnvironmentId must start with a lowercase letter followed by up to 63 |
| 811 | # lowercase letters, numbers, or hyphens, and cannot end with a hyphen. |
| 812 | "uuid": "A String", # Output only. The UUID (Universally Unique IDentifier) associated with this environment. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 813 | # This value is generated when the environment is created. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 814 | }</pre> |
| 815 | </div> |
| 816 | |
| 817 | <div class="method"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 818 | <code class="details" id="list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 819 | <pre>List environments. |
| 820 | |
| 821 | Args: |
| 822 | parent: string, List environments in the given project and location, in the form: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 823 | "projects/{projectId}/locations/{locationId}" (required) |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 824 | pageToken: string, The next_page_token value returned from a previous List request, if any. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 825 | pageSize: integer, The maximum number of environments to return. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 826 | x__xgafv: string, V1 error format. |
| 827 | Allowed values |
| 828 | 1 - v1 error format |
| 829 | 2 - v2 error format |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 830 | |
| 831 | Returns: |
| 832 | An object of the form: |
| 833 | |
| 834 | { # The environments in a project and location. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 835 | "nextPageToken": "A String", # The page token used to query for the next page if one exists. |
| 836 | "environments": [ # The list of environments returned by a ListEnvironmentsRequest. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 837 | { # An environment for running orchestration tasks. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 838 | "createTime": "A String", # Output only. The time at which this environment was created. |
| 839 | "labels": { # Optional. User-defined labels for this environment. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 840 | # The labels map can contain no more than 64 entries. Entries of the labels |
| 841 | # map are UTF8 strings that comply with the following restrictions: |
| 842 | # |
| 843 | # * Keys must conform to regexp: \p{Ll}\p{Lo}{0,62} |
| 844 | # * Values must conform to regexp: [\p{Ll}\p{Lo}\p{N}_-]{0,63} |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 845 | # * Both keys and values are additionally constrained to be <= 128 bytes in |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 846 | # size. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 847 | "a_key": "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 848 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 849 | "updateTime": "A String", # Output only. The time at which this environment was last modified. |
| 850 | "config": { # Configuration information for an environment. # Configuration parameters for this environment. |
| 851 | "nodeCount": 42, # The number of nodes in the Kubernetes Engine cluster that will be |
| 852 | # used to run this environment. |
| 853 | "databaseConfig": { # The configuration of Cloud SQL instance that is used by the Apache Airflow # Optional. The configuration settings for Cloud SQL instance used internally by Apache |
| 854 | # Airflow software. |
| 855 | # software. |
| 856 | "machineType": "A String", # Optional. Cloud SQL tier used by Airflow database. |
| 857 | # If not specified, db-n1-standard-2 will be used. |
| 858 | }, |
| 859 | "webServerConfig": { # The configuration settings for the Airflow web server App Engine instance. # Optional. The configuration settings for the Airflow web server App Engine instance. |
| 860 | "machineType": "A String", # Optional. Machine type on which Airflow web server is running. |
| 861 | # For example: composer-n1-webserver-2, composer-n1-webserver-4, |
| 862 | # composer-n1-webserver-8. |
| 863 | # If not specified, composer-n1-webserver-2 will be used. |
| 864 | # Value custom is returned only in response, if Airflow web server parameters |
| 865 | # were manually changed to a non-standard values. |
| 866 | }, |
| 867 | "webServerNetworkAccessControl": { # Network-level access control policy for the Airflow web server. # Optional. The network-level access control policy for the Airflow web server. If |
| 868 | # unspecified, no network-level access restrictions will be applied. |
| 869 | "allowedIpRanges": [ # A collection of allowed IP ranges with descriptions. |
| 870 | { # Allowed IP range with user-provided description. |
| 871 | "value": "A String", # IP address or range, defined using CIDR notation, of requests that this |
| 872 | # rule applies to. |
| 873 | # Examples: `192.168.1.1` or `192.168.0.0/16` or `2001:db8::/32` |
| 874 | # or `2001:0db8:0000:0042:0000:8a2e:0370:7334`. |
| 875 | # |
| 876 | # |
| 877 | # <p>IP range prefixes should be properly truncated. For example, |
| 878 | # `1.2.3.4/24` should be truncated to `1.2.3.0/24`. Similarly, for IPv6, |
| 879 | # `2001:db8::1/32` should be truncated to `2001:db8::/32`. |
| 880 | "description": "A String", # Optional. User-provided description. It must contain at most 300 characters. |
| 881 | }, |
| 882 | ], |
| 883 | }, |
| 884 | "dagGcsPrefix": "A String", # Output only. The Cloud Storage prefix of the DAGs for this environment. Although Cloud |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 885 | # Storage objects reside in a flat namespace, a hierarchical file tree |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 886 | # can be simulated using "/"-delimited object name prefixes. DAG objects for |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 887 | # this environment reside in a simulated directory with the given prefix. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 888 | "privateEnvironmentConfig": { # The configuration information for configuring a Private IP Cloud Composer # The configuration used for the Private IP Cloud Composer environment. |
| 889 | # environment. |
| 890 | "enablePrivateEnvironment": True or False, # Optional. If `true`, a Private IP Cloud Composer environment is created. |
| 891 | # If this field is true, `use_ip_aliases` must be true. |
| 892 | "cloudSqlIpv4CidrBlock": "A String", # Optional. The CIDR block from which IP range in tenant project will be reserved for |
| 893 | # Cloud SQL. Needs to be disjoint from web_server_ipv4_cidr_block |
| 894 | "privateClusterConfig": { # Configuration options for the private GKE cluster in a Cloud Composer # Optional. Configuration for the private GKE cluster for a Private IP |
| 895 | # Cloud Composer environment. |
| 896 | # environment. |
| 897 | "masterIpv4CidrBlock": "A String", # Optional. The CIDR block from which IPv4 range for GKE master will be reserved. If |
| 898 | # left blank, the default value of '172.16.0.0/23' is used. |
| 899 | "enablePrivateEndpoint": True or False, # Optional. If `true`, access to the public endpoint of the GKE cluster is |
| 900 | # denied. |
| 901 | "masterIpv4ReservedRange": "A String", # Output only. The IP range in CIDR notation to use for the hosted master network. This |
| 902 | # range is used for assigning internal IP addresses to the cluster |
| 903 | # master or set of masters and to the internal load balancer virtual IP. |
| 904 | # This range must not overlap with any other ranges in use |
| 905 | # within the cluster's network. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 906 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 907 | "webServerIpv4ReservedRange": "A String", # Output only. The IP range reserved for the tenant project's App Engine VMs. |
| 908 | "webServerIpv4CidrBlock": "A String", # Optional. The CIDR block from which IP range for web server will be reserved. Needs |
| 909 | # to be disjoint from private_cluster_config.master_ipv4_cidr_block and |
| 910 | # cloud_sql_ipv4_cidr_block. |
| 911 | }, |
| 912 | "gkeCluster": "A String", # Output only. The Kubernetes Engine cluster used to run this environment. |
| 913 | "airflowUri": "A String", # Output only. The URI of the Apache Airflow Web UI hosted within this environment (see |
| 914 | # [Airflow web |
| 915 | # interface](/composer/docs/how-to/accessing/airflow-web-interface)). |
| 916 | "softwareConfig": { # Specifies the selection and configuration of software inside the environment. # The configuration settings for software inside the environment. |
| 917 | "envVariables": { # Optional. Additional environment variables to provide to the Apache Airflow |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 918 | # scheduler, worker, and webserver processes. |
| 919 | # |
| 920 | # Environment variable names must match the regular expression |
| 921 | # `a-zA-Z_*`. They cannot specify Apache Airflow |
| 922 | # software configuration overrides (they cannot match the regular expression |
| 923 | # `AIRFLOW__[A-Z0-9_]+__[A-Z0-9_]+`), and they cannot match any of the |
| 924 | # following reserved names: |
| 925 | # |
| 926 | # * `AIRFLOW_HOME` |
| 927 | # * `C_FORCE_ROOT` |
| 928 | # * `CONTAINER_NAME` |
| 929 | # * `DAGS_FOLDER` |
| 930 | # * `GCP_PROJECT` |
| 931 | # * `GCS_BUCKET` |
| 932 | # * `GKE_CLUSTER_NAME` |
| 933 | # * `SQL_DATABASE` |
| 934 | # * `SQL_INSTANCE` |
| 935 | # * `SQL_PASSWORD` |
| 936 | # * `SQL_PROJECT` |
| 937 | # * `SQL_REGION` |
| 938 | # * `SQL_USER` |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 939 | "a_key": "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 940 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 941 | "pythonVersion": "A String", # Optional. The major version of Python used to run the Apache Airflow |
| 942 | # scheduler, worker, and webserver processes. |
| 943 | # |
| 944 | # Can be set to '2' or '3'. If not specified, the default is '2'. Cannot be |
| 945 | # updated. |
| 946 | "pypiPackages": { # Optional. Custom Python Package Index (PyPI) packages to be installed in |
| 947 | # the environment. |
| 948 | # |
| 949 | # Keys refer to the lowercase package name such as "numpy" |
| 950 | # and values are the lowercase extras and version specifier such as |
| 951 | # "==1.12.0", "[devel,gcp_api]", or "[devel]>=1.8.2, <1.9.2". To specify a |
| 952 | # package without pinning it to a version specifier, use the empty string as |
| 953 | # the value. |
| 954 | "a_key": "A String", |
| 955 | }, |
| 956 | "imageVersion": "A String", # The version of the software running in the environment. |
| 957 | # This encapsulates both the version of Cloud Composer functionality and the |
| 958 | # version of Apache Airflow. It must match the regular expression |
| 959 | # `composer-([0-9]+\.[0-9]+\.[0-9]+|latest)-airflow-[0-9]+\.[0-9]+(\.[0-9]+.*)?`. |
| 960 | # When used as input, the server also checks if the provided version is |
| 961 | # supported and denies the request for an unsupported version. |
| 962 | # |
| 963 | # The Cloud Composer portion of the version is a |
| 964 | # [semantic version](https://semver.org) or `latest`. When the patch version |
| 965 | # is omitted, the current Cloud Composer patch version is selected. |
| 966 | # When `latest` is provided instead of an explicit version number, |
| 967 | # the server replaces `latest` with the current Cloud Composer version |
| 968 | # and stores that version number in the same field. |
| 969 | # |
| 970 | # The portion of the image version that follows <em>airflow-</em> is an |
| 971 | # official Apache Airflow repository |
| 972 | # [release name](https://github.com/apache/incubator-airflow/releases). |
| 973 | # |
| 974 | # See also [Version |
| 975 | # List](/composer/docs/concepts/versioning/composer-versions). |
| 976 | "airflowConfigOverrides": { # Optional. Apache Airflow configuration properties to override. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 977 | # |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 978 | # Property keys contain the section and property names, separated by a |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 979 | # hyphen, for example "core-dags_are_paused_at_creation". Section names must |
| 980 | # not contain hyphens ("-"), opening square brackets ("["), or closing |
| 981 | # square brackets ("]"). The property name must not be empty and must not |
| 982 | # contain an equals sign ("=") or semicolon (";"). Section and property names |
| 983 | # must not contain a period ("."). Apache Airflow configuration property |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 984 | # names must be written in |
| 985 | # [snake_case](https://en.wikipedia.org/wiki/Snake_case). Property values can |
| 986 | # contain any character, and can be written in any lower/upper case format. |
| 987 | # |
| 988 | # Certain Apache Airflow configuration property values are |
| 989 | # [blacklisted](/composer/docs/how-to/managing/setting-airflow-configurations#airflow_configuration_blacklists), |
| 990 | # and cannot be overridden. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 991 | "a_key": "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 992 | }, |
| 993 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 994 | "nodeConfig": { # The configuration information for the Kubernetes Engine nodes running # The configuration used for the Kubernetes Engine cluster. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 995 | # the Apache Airflow software. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 996 | "oauthScopes": [ # Optional. The set of Google API scopes to be made available on all |
| 997 | # node VMs. If `oauth_scopes` is empty, defaults to |
| 998 | # ["https://www.googleapis.com/auth/cloud-platform"]. Cannot be updated. |
| 999 | "A String", |
| 1000 | ], |
| 1001 | "subnetwork": "A String", # Optional. The Compute Engine subnetwork to be used for machine |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1002 | # communications, specified as a |
| 1003 | # [relative resource |
| 1004 | # name](/apis/design/resource_names#relative_resource_name). For example: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1005 | # "projects/{projectId}/regions/{regionId}/subnetworks/{subnetworkId}" |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1006 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1007 | # If a subnetwork is provided, `nodeConfig.network` must also be provided, |
| 1008 | # and the subnetwork must belong to the enclosing environment's project and |
| 1009 | # location. |
| 1010 | "ipAllocationPolicy": { # Configuration for controlling how IPs are allocated in the # Optional. The IPAllocationPolicy fields for the GKE cluster. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1011 | # GKE cluster. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1012 | "servicesSecondaryRangeName": "A String", # Optional. The name of the services' secondary range used to allocate |
| 1013 | # IP addresses to the cluster. Specify either `services_secondary_range_name` |
| 1014 | # or `services_ipv4_cidr_block` but not both. |
| 1015 | # |
| 1016 | # This field is applicable only when `use_ip_aliases` is true. |
| 1017 | "useIpAliases": True or False, # Optional. Whether or not to enable Alias IPs in the GKE cluster. |
| 1018 | # If `true`, a VPC-native cluster is created. |
| 1019 | "clusterIpv4CidrBlock": "A String", # Optional. The IP address range used to allocate IP addresses to pods in |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1020 | # the cluster. |
| 1021 | # |
| 1022 | # This field is applicable only when `use_ip_aliases` is true. |
| 1023 | # |
| 1024 | # Set to blank to have GKE choose a range with the default size. |
| 1025 | # |
| 1026 | # Set to /netmask (e.g. `/14`) to have GKE choose a range with a specific |
| 1027 | # netmask. |
| 1028 | # |
| 1029 | # Set to a |
| 1030 | # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) |
| 1031 | # notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. |
| 1032 | # `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range |
| 1033 | # to use. |
| 1034 | # Specify `cluster_secondary_range_name` or `cluster_ipv4_cidr_block` |
| 1035 | # but not both. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1036 | "clusterSecondaryRangeName": "A String", # Optional. The name of the cluster's secondary range used to allocate |
| 1037 | # IP addresses to pods. Specify either `cluster_secondary_range_name` |
| 1038 | # or `cluster_ipv4_cidr_block` but not both. |
| 1039 | # |
| 1040 | # This field is applicable only when `use_ip_aliases` is true. |
| 1041 | "servicesIpv4CidrBlock": "A String", # Optional. The IP address range of the services IP addresses in this |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1042 | # cluster. |
| 1043 | # |
| 1044 | # This field is applicable only when `use_ip_aliases` is true. |
| 1045 | # |
| 1046 | # Set to blank to have GKE choose a range with the default size. |
| 1047 | # |
| 1048 | # Set to /netmask (e.g. `/14`) to have GKE choose a range with a specific |
| 1049 | # netmask. |
| 1050 | # |
| 1051 | # Set to a |
| 1052 | # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) |
| 1053 | # notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. |
| 1054 | # `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range |
| 1055 | # to use. |
| 1056 | # Specify `services_secondary_range_name` or `services_ipv4_cidr_block` |
| 1057 | # but not both. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1058 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1059 | "diskSizeGb": 42, # Optional. The disk size in GB used for node VMs. Minimum size is 20GB. |
| 1060 | # If unspecified, defaults to 100GB. Cannot be updated. |
| 1061 | "tags": [ # Optional. The list of instance tags applied to all node VMs. Tags are used |
| 1062 | # to identify valid sources or targets for network firewalls. Each tag within |
| 1063 | # the list must comply with [RFC1035](https://www.ietf.org/rfc/rfc1035.txt). |
| 1064 | # Cannot be updated. |
| 1065 | "A String", |
| 1066 | ], |
| 1067 | "serviceAccount": "A String", # Optional. The Google Cloud Platform Service Account to be used by the node |
| 1068 | # VMs. If a service account is not specified, the "default" Compute Engine |
| 1069 | # service account is used. Cannot be updated. |
| 1070 | "location": "A String", # Optional. The Compute Engine [zone](/compute/docs/regions-zones) in which |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1071 | # to deploy the VMs used to run the Apache Airflow software, specified as a |
| 1072 | # [relative resource |
| 1073 | # name](/apis/design/resource_names#relative_resource_name). For example: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1074 | # "projects/{projectId}/zones/{zoneId}". |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1075 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1076 | # This `location` must belong to the enclosing environment's project and |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1077 | # location. If both this field and `nodeConfig.machineType` are specified, |
| 1078 | # `nodeConfig.machineType` must belong to this `location`; if both are |
| 1079 | # unspecified, the service will pick a zone in the Compute Engine region |
| 1080 | # corresponding to the Cloud Composer location, and propagate that choice to |
| 1081 | # both fields. If only one field (`location` or `nodeConfig.machineType`) is |
| 1082 | # specified, the location information from the specified field will be |
| 1083 | # propagated to the unspecified field. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1084 | "machineType": "A String", # Optional. The Compute Engine |
| 1085 | # [machine type](/compute/docs/machine-types) used for cluster instances, |
| 1086 | # specified as a |
| 1087 | # [relative resource |
| 1088 | # name](/apis/design/resource_names#relative_resource_name). For example: |
| 1089 | # "projects/{projectId}/zones/{zoneId}/machineTypes/{machineTypeId}". |
| 1090 | # |
| 1091 | # The `machineType` must belong to the enclosing environment's project and |
| 1092 | # location. If both this field and `nodeConfig.location` are specified, |
| 1093 | # this `machineType` must belong to the `nodeConfig.location`; if both are |
| 1094 | # unspecified, the service will pick a zone in the Compute Engine region |
| 1095 | # corresponding to the Cloud Composer location, and propagate that choice to |
| 1096 | # both fields. If exactly one of this field and `nodeConfig.location` is |
| 1097 | # specified, the location information from the specified field will be |
| 1098 | # propagated to the unspecified field. |
| 1099 | # |
| 1100 | # The `machineTypeId` must not be a [shared-core machine |
| 1101 | # type](/compute/docs/machine-types#sharedcore). |
| 1102 | # |
| 1103 | # If this field is unspecified, the `machineTypeId` defaults |
| 1104 | # to "n1-standard-1". |
| 1105 | "network": "A String", # Optional. The Compute Engine network to be used for machine |
| 1106 | # communications, specified as a |
| 1107 | # [relative resource |
| 1108 | # name](/apis/design/resource_names#relative_resource_name). For example: |
| 1109 | # "projects/{projectId}/global/networks/{networkId}". |
| 1110 | # |
| 1111 | # If unspecified, the default network in the environment's project is used. |
| 1112 | # If a [Custom Subnet Network](/vpc/docs/vpc#vpc_networks_and_subnets) |
| 1113 | # is provided, `nodeConfig.subnetwork` must also be provided. For |
| 1114 | # [Shared VPC](/vpc/docs/shared-vpc) subnetwork requirements, see |
| 1115 | # `nodeConfig.subnetwork`. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1116 | }, |
| 1117 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1118 | "state": "A String", # The current state of the environment. |
| 1119 | "name": "A String", # The resource name of the environment, in the form: |
| 1120 | # "projects/{projectId}/locations/{locationId}/environments/{environmentId}" |
| 1121 | # |
| 1122 | # EnvironmentId must start with a lowercase letter followed by up to 63 |
| 1123 | # lowercase letters, numbers, or hyphens, and cannot end with a hyphen. |
| 1124 | "uuid": "A String", # Output only. The UUID (Universally Unique IDentifier) associated with this environment. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1125 | # This value is generated when the environment is created. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1126 | }, |
| 1127 | ], |
| 1128 | }</pre> |
| 1129 | </div> |
| 1130 | |
| 1131 | <div class="method"> |
| 1132 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 1133 | <pre>Retrieves the next page of results. |
| 1134 | |
| 1135 | Args: |
| 1136 | previous_request: The request for the previous page. (required) |
| 1137 | previous_response: The response from the request for the previous page. (required) |
| 1138 | |
| 1139 | Returns: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1140 | A request object that you can call 'execute()' on to request the next |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1141 | page. Returns None if there are no more items in the collection. |
| 1142 | </pre> |
| 1143 | </div> |
| 1144 | |
| 1145 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1146 | <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1147 | <pre>Update an environment. |
| 1148 | |
| 1149 | Args: |
| 1150 | name: string, The relative resource name of the environment to update, in the form: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1151 | "projects/{projectId}/locations/{locationId}/environments/{environmentId}" (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1152 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1153 | The object takes the form of: |
| 1154 | |
| 1155 | { # An environment for running orchestration tasks. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1156 | "createTime": "A String", # Output only. The time at which this environment was created. |
| 1157 | "labels": { # Optional. User-defined labels for this environment. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1158 | # The labels map can contain no more than 64 entries. Entries of the labels |
| 1159 | # map are UTF8 strings that comply with the following restrictions: |
| 1160 | # |
| 1161 | # * Keys must conform to regexp: \p{Ll}\p{Lo}{0,62} |
| 1162 | # * Values must conform to regexp: [\p{Ll}\p{Lo}\p{N}_-]{0,63} |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1163 | # * Both keys and values are additionally constrained to be <= 128 bytes in |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1164 | # size. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1165 | "a_key": "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1166 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1167 | "updateTime": "A String", # Output only. The time at which this environment was last modified. |
| 1168 | "config": { # Configuration information for an environment. # Configuration parameters for this environment. |
| 1169 | "nodeCount": 42, # The number of nodes in the Kubernetes Engine cluster that will be |
| 1170 | # used to run this environment. |
| 1171 | "databaseConfig": { # The configuration of Cloud SQL instance that is used by the Apache Airflow # Optional. The configuration settings for Cloud SQL instance used internally by Apache |
| 1172 | # Airflow software. |
| 1173 | # software. |
| 1174 | "machineType": "A String", # Optional. Cloud SQL tier used by Airflow database. |
| 1175 | # If not specified, db-n1-standard-2 will be used. |
| 1176 | }, |
| 1177 | "webServerConfig": { # The configuration settings for the Airflow web server App Engine instance. # Optional. The configuration settings for the Airflow web server App Engine instance. |
| 1178 | "machineType": "A String", # Optional. Machine type on which Airflow web server is running. |
| 1179 | # For example: composer-n1-webserver-2, composer-n1-webserver-4, |
| 1180 | # composer-n1-webserver-8. |
| 1181 | # If not specified, composer-n1-webserver-2 will be used. |
| 1182 | # Value custom is returned only in response, if Airflow web server parameters |
| 1183 | # were manually changed to a non-standard values. |
| 1184 | }, |
| 1185 | "webServerNetworkAccessControl": { # Network-level access control policy for the Airflow web server. # Optional. The network-level access control policy for the Airflow web server. If |
| 1186 | # unspecified, no network-level access restrictions will be applied. |
| 1187 | "allowedIpRanges": [ # A collection of allowed IP ranges with descriptions. |
| 1188 | { # Allowed IP range with user-provided description. |
| 1189 | "value": "A String", # IP address or range, defined using CIDR notation, of requests that this |
| 1190 | # rule applies to. |
| 1191 | # Examples: `192.168.1.1` or `192.168.0.0/16` or `2001:db8::/32` |
| 1192 | # or `2001:0db8:0000:0042:0000:8a2e:0370:7334`. |
| 1193 | # |
| 1194 | # |
| 1195 | # <p>IP range prefixes should be properly truncated. For example, |
| 1196 | # `1.2.3.4/24` should be truncated to `1.2.3.0/24`. Similarly, for IPv6, |
| 1197 | # `2001:db8::1/32` should be truncated to `2001:db8::/32`. |
| 1198 | "description": "A String", # Optional. User-provided description. It must contain at most 300 characters. |
| 1199 | }, |
| 1200 | ], |
| 1201 | }, |
| 1202 | "dagGcsPrefix": "A String", # Output only. The Cloud Storage prefix of the DAGs for this environment. Although Cloud |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1203 | # Storage objects reside in a flat namespace, a hierarchical file tree |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1204 | # can be simulated using "/"-delimited object name prefixes. DAG objects for |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1205 | # this environment reside in a simulated directory with the given prefix. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1206 | "privateEnvironmentConfig": { # The configuration information for configuring a Private IP Cloud Composer # The configuration used for the Private IP Cloud Composer environment. |
| 1207 | # environment. |
| 1208 | "enablePrivateEnvironment": True or False, # Optional. If `true`, a Private IP Cloud Composer environment is created. |
| 1209 | # If this field is true, `use_ip_aliases` must be true. |
| 1210 | "cloudSqlIpv4CidrBlock": "A String", # Optional. The CIDR block from which IP range in tenant project will be reserved for |
| 1211 | # Cloud SQL. Needs to be disjoint from web_server_ipv4_cidr_block |
| 1212 | "privateClusterConfig": { # Configuration options for the private GKE cluster in a Cloud Composer # Optional. Configuration for the private GKE cluster for a Private IP |
| 1213 | # Cloud Composer environment. |
| 1214 | # environment. |
| 1215 | "masterIpv4CidrBlock": "A String", # Optional. The CIDR block from which IPv4 range for GKE master will be reserved. If |
| 1216 | # left blank, the default value of '172.16.0.0/23' is used. |
| 1217 | "enablePrivateEndpoint": True or False, # Optional. If `true`, access to the public endpoint of the GKE cluster is |
| 1218 | # denied. |
| 1219 | "masterIpv4ReservedRange": "A String", # Output only. The IP range in CIDR notation to use for the hosted master network. This |
| 1220 | # range is used for assigning internal IP addresses to the cluster |
| 1221 | # master or set of masters and to the internal load balancer virtual IP. |
| 1222 | # This range must not overlap with any other ranges in use |
| 1223 | # within the cluster's network. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1224 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1225 | "webServerIpv4ReservedRange": "A String", # Output only. The IP range reserved for the tenant project's App Engine VMs. |
| 1226 | "webServerIpv4CidrBlock": "A String", # Optional. The CIDR block from which IP range for web server will be reserved. Needs |
| 1227 | # to be disjoint from private_cluster_config.master_ipv4_cidr_block and |
| 1228 | # cloud_sql_ipv4_cidr_block. |
| 1229 | }, |
| 1230 | "gkeCluster": "A String", # Output only. The Kubernetes Engine cluster used to run this environment. |
| 1231 | "airflowUri": "A String", # Output only. The URI of the Apache Airflow Web UI hosted within this environment (see |
| 1232 | # [Airflow web |
| 1233 | # interface](/composer/docs/how-to/accessing/airflow-web-interface)). |
| 1234 | "softwareConfig": { # Specifies the selection and configuration of software inside the environment. # The configuration settings for software inside the environment. |
| 1235 | "envVariables": { # Optional. Additional environment variables to provide to the Apache Airflow |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1236 | # scheduler, worker, and webserver processes. |
| 1237 | # |
| 1238 | # Environment variable names must match the regular expression |
| 1239 | # `a-zA-Z_*`. They cannot specify Apache Airflow |
| 1240 | # software configuration overrides (they cannot match the regular expression |
| 1241 | # `AIRFLOW__[A-Z0-9_]+__[A-Z0-9_]+`), and they cannot match any of the |
| 1242 | # following reserved names: |
| 1243 | # |
| 1244 | # * `AIRFLOW_HOME` |
| 1245 | # * `C_FORCE_ROOT` |
| 1246 | # * `CONTAINER_NAME` |
| 1247 | # * `DAGS_FOLDER` |
| 1248 | # * `GCP_PROJECT` |
| 1249 | # * `GCS_BUCKET` |
| 1250 | # * `GKE_CLUSTER_NAME` |
| 1251 | # * `SQL_DATABASE` |
| 1252 | # * `SQL_INSTANCE` |
| 1253 | # * `SQL_PASSWORD` |
| 1254 | # * `SQL_PROJECT` |
| 1255 | # * `SQL_REGION` |
| 1256 | # * `SQL_USER` |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1257 | "a_key": "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1258 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1259 | "pythonVersion": "A String", # Optional. The major version of Python used to run the Apache Airflow |
| 1260 | # scheduler, worker, and webserver processes. |
| 1261 | # |
| 1262 | # Can be set to '2' or '3'. If not specified, the default is '2'. Cannot be |
| 1263 | # updated. |
| 1264 | "pypiPackages": { # Optional. Custom Python Package Index (PyPI) packages to be installed in |
| 1265 | # the environment. |
| 1266 | # |
| 1267 | # Keys refer to the lowercase package name such as "numpy" |
| 1268 | # and values are the lowercase extras and version specifier such as |
| 1269 | # "==1.12.0", "[devel,gcp_api]", or "[devel]>=1.8.2, <1.9.2". To specify a |
| 1270 | # package without pinning it to a version specifier, use the empty string as |
| 1271 | # the value. |
| 1272 | "a_key": "A String", |
| 1273 | }, |
| 1274 | "imageVersion": "A String", # The version of the software running in the environment. |
| 1275 | # This encapsulates both the version of Cloud Composer functionality and the |
| 1276 | # version of Apache Airflow. It must match the regular expression |
| 1277 | # `composer-([0-9]+\.[0-9]+\.[0-9]+|latest)-airflow-[0-9]+\.[0-9]+(\.[0-9]+.*)?`. |
| 1278 | # When used as input, the server also checks if the provided version is |
| 1279 | # supported and denies the request for an unsupported version. |
| 1280 | # |
| 1281 | # The Cloud Composer portion of the version is a |
| 1282 | # [semantic version](https://semver.org) or `latest`. When the patch version |
| 1283 | # is omitted, the current Cloud Composer patch version is selected. |
| 1284 | # When `latest` is provided instead of an explicit version number, |
| 1285 | # the server replaces `latest` with the current Cloud Composer version |
| 1286 | # and stores that version number in the same field. |
| 1287 | # |
| 1288 | # The portion of the image version that follows <em>airflow-</em> is an |
| 1289 | # official Apache Airflow repository |
| 1290 | # [release name](https://github.com/apache/incubator-airflow/releases). |
| 1291 | # |
| 1292 | # See also [Version |
| 1293 | # List](/composer/docs/concepts/versioning/composer-versions). |
| 1294 | "airflowConfigOverrides": { # Optional. Apache Airflow configuration properties to override. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1295 | # |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1296 | # Property keys contain the section and property names, separated by a |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1297 | # hyphen, for example "core-dags_are_paused_at_creation". Section names must |
| 1298 | # not contain hyphens ("-"), opening square brackets ("["), or closing |
| 1299 | # square brackets ("]"). The property name must not be empty and must not |
| 1300 | # contain an equals sign ("=") or semicolon (";"). Section and property names |
| 1301 | # must not contain a period ("."). Apache Airflow configuration property |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1302 | # names must be written in |
| 1303 | # [snake_case](https://en.wikipedia.org/wiki/Snake_case). Property values can |
| 1304 | # contain any character, and can be written in any lower/upper case format. |
| 1305 | # |
| 1306 | # Certain Apache Airflow configuration property values are |
| 1307 | # [blacklisted](/composer/docs/how-to/managing/setting-airflow-configurations#airflow_configuration_blacklists), |
| 1308 | # and cannot be overridden. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1309 | "a_key": "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1310 | }, |
| 1311 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1312 | "nodeConfig": { # The configuration information for the Kubernetes Engine nodes running # The configuration used for the Kubernetes Engine cluster. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1313 | # the Apache Airflow software. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1314 | "oauthScopes": [ # Optional. The set of Google API scopes to be made available on all |
| 1315 | # node VMs. If `oauth_scopes` is empty, defaults to |
| 1316 | # ["https://www.googleapis.com/auth/cloud-platform"]. Cannot be updated. |
| 1317 | "A String", |
| 1318 | ], |
| 1319 | "subnetwork": "A String", # Optional. The Compute Engine subnetwork to be used for machine |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1320 | # communications, specified as a |
| 1321 | # [relative resource |
| 1322 | # name](/apis/design/resource_names#relative_resource_name). For example: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1323 | # "projects/{projectId}/regions/{regionId}/subnetworks/{subnetworkId}" |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1324 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1325 | # If a subnetwork is provided, `nodeConfig.network` must also be provided, |
| 1326 | # and the subnetwork must belong to the enclosing environment's project and |
| 1327 | # location. |
| 1328 | "ipAllocationPolicy": { # Configuration for controlling how IPs are allocated in the # Optional. The IPAllocationPolicy fields for the GKE cluster. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1329 | # GKE cluster. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1330 | "servicesSecondaryRangeName": "A String", # Optional. The name of the services' secondary range used to allocate |
| 1331 | # IP addresses to the cluster. Specify either `services_secondary_range_name` |
| 1332 | # or `services_ipv4_cidr_block` but not both. |
| 1333 | # |
| 1334 | # This field is applicable only when `use_ip_aliases` is true. |
| 1335 | "useIpAliases": True or False, # Optional. Whether or not to enable Alias IPs in the GKE cluster. |
| 1336 | # If `true`, a VPC-native cluster is created. |
| 1337 | "clusterIpv4CidrBlock": "A String", # Optional. The IP address range used to allocate IP addresses to pods in |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1338 | # the cluster. |
| 1339 | # |
| 1340 | # This field is applicable only when `use_ip_aliases` is true. |
| 1341 | # |
| 1342 | # Set to blank to have GKE choose a range with the default size. |
| 1343 | # |
| 1344 | # Set to /netmask (e.g. `/14`) to have GKE choose a range with a specific |
| 1345 | # netmask. |
| 1346 | # |
| 1347 | # Set to a |
| 1348 | # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) |
| 1349 | # notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. |
| 1350 | # `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range |
| 1351 | # to use. |
| 1352 | # Specify `cluster_secondary_range_name` or `cluster_ipv4_cidr_block` |
| 1353 | # but not both. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1354 | "clusterSecondaryRangeName": "A String", # Optional. The name of the cluster's secondary range used to allocate |
| 1355 | # IP addresses to pods. Specify either `cluster_secondary_range_name` |
| 1356 | # or `cluster_ipv4_cidr_block` but not both. |
| 1357 | # |
| 1358 | # This field is applicable only when `use_ip_aliases` is true. |
| 1359 | "servicesIpv4CidrBlock": "A String", # Optional. The IP address range of the services IP addresses in this |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1360 | # cluster. |
| 1361 | # |
| 1362 | # This field is applicable only when `use_ip_aliases` is true. |
| 1363 | # |
| 1364 | # Set to blank to have GKE choose a range with the default size. |
| 1365 | # |
| 1366 | # Set to /netmask (e.g. `/14`) to have GKE choose a range with a specific |
| 1367 | # netmask. |
| 1368 | # |
| 1369 | # Set to a |
| 1370 | # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) |
| 1371 | # notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. |
| 1372 | # `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range |
| 1373 | # to use. |
| 1374 | # Specify `services_secondary_range_name` or `services_ipv4_cidr_block` |
| 1375 | # but not both. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1376 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1377 | "diskSizeGb": 42, # Optional. The disk size in GB used for node VMs. Minimum size is 20GB. |
| 1378 | # If unspecified, defaults to 100GB. Cannot be updated. |
| 1379 | "tags": [ # Optional. The list of instance tags applied to all node VMs. Tags are used |
| 1380 | # to identify valid sources or targets for network firewalls. Each tag within |
| 1381 | # the list must comply with [RFC1035](https://www.ietf.org/rfc/rfc1035.txt). |
| 1382 | # Cannot be updated. |
| 1383 | "A String", |
| 1384 | ], |
| 1385 | "serviceAccount": "A String", # Optional. The Google Cloud Platform Service Account to be used by the node |
| 1386 | # VMs. If a service account is not specified, the "default" Compute Engine |
| 1387 | # service account is used. Cannot be updated. |
| 1388 | "location": "A String", # Optional. The Compute Engine [zone](/compute/docs/regions-zones) in which |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1389 | # to deploy the VMs used to run the Apache Airflow software, specified as a |
| 1390 | # [relative resource |
| 1391 | # name](/apis/design/resource_names#relative_resource_name). For example: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1392 | # "projects/{projectId}/zones/{zoneId}". |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1393 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1394 | # This `location` must belong to the enclosing environment's project and |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1395 | # location. If both this field and `nodeConfig.machineType` are specified, |
| 1396 | # `nodeConfig.machineType` must belong to this `location`; if both are |
| 1397 | # unspecified, the service will pick a zone in the Compute Engine region |
| 1398 | # corresponding to the Cloud Composer location, and propagate that choice to |
| 1399 | # both fields. If only one field (`location` or `nodeConfig.machineType`) is |
| 1400 | # specified, the location information from the specified field will be |
| 1401 | # propagated to the unspecified field. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1402 | "machineType": "A String", # Optional. The Compute Engine |
| 1403 | # [machine type](/compute/docs/machine-types) used for cluster instances, |
| 1404 | # specified as a |
| 1405 | # [relative resource |
| 1406 | # name](/apis/design/resource_names#relative_resource_name). For example: |
| 1407 | # "projects/{projectId}/zones/{zoneId}/machineTypes/{machineTypeId}". |
| 1408 | # |
| 1409 | # The `machineType` must belong to the enclosing environment's project and |
| 1410 | # location. If both this field and `nodeConfig.location` are specified, |
| 1411 | # this `machineType` must belong to the `nodeConfig.location`; if both are |
| 1412 | # unspecified, the service will pick a zone in the Compute Engine region |
| 1413 | # corresponding to the Cloud Composer location, and propagate that choice to |
| 1414 | # both fields. If exactly one of this field and `nodeConfig.location` is |
| 1415 | # specified, the location information from the specified field will be |
| 1416 | # propagated to the unspecified field. |
| 1417 | # |
| 1418 | # The `machineTypeId` must not be a [shared-core machine |
| 1419 | # type](/compute/docs/machine-types#sharedcore). |
| 1420 | # |
| 1421 | # If this field is unspecified, the `machineTypeId` defaults |
| 1422 | # to "n1-standard-1". |
| 1423 | "network": "A String", # Optional. The Compute Engine network to be used for machine |
| 1424 | # communications, specified as a |
| 1425 | # [relative resource |
| 1426 | # name](/apis/design/resource_names#relative_resource_name). For example: |
| 1427 | # "projects/{projectId}/global/networks/{networkId}". |
| 1428 | # |
| 1429 | # If unspecified, the default network in the environment's project is used. |
| 1430 | # If a [Custom Subnet Network](/vpc/docs/vpc#vpc_networks_and_subnets) |
| 1431 | # is provided, `nodeConfig.subnetwork` must also be provided. For |
| 1432 | # [Shared VPC](/vpc/docs/shared-vpc) subnetwork requirements, see |
| 1433 | # `nodeConfig.subnetwork`. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1434 | }, |
| 1435 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1436 | "state": "A String", # The current state of the environment. |
| 1437 | "name": "A String", # The resource name of the environment, in the form: |
| 1438 | # "projects/{projectId}/locations/{locationId}/environments/{environmentId}" |
| 1439 | # |
| 1440 | # EnvironmentId must start with a lowercase letter followed by up to 63 |
| 1441 | # lowercase letters, numbers, or hyphens, and cannot end with a hyphen. |
| 1442 | "uuid": "A String", # Output only. The UUID (Universally Unique IDentifier) associated with this environment. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1443 | # This value is generated when the environment is created. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1444 | } |
| 1445 | |
| 1446 | updateMask: string, Required. A comma-separated list of paths, relative to `Environment`, of |
| 1447 | fields to update. |
| 1448 | For example, to set the version of scikit-learn to install in the |
| 1449 | environment to 0.19.0 and to remove an existing installation of |
| 1450 | argparse, the `updateMask` parameter would include the following two |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1451 | `paths` values: "config.softwareConfig.pypiPackages.scikit-learn" and |
| 1452 | "config.softwareConfig.pypiPackages.argparse". The included patch |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1453 | environment would specify the scikit-learn version as follows: |
| 1454 | |
| 1455 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1456 | "config":{ |
| 1457 | "softwareConfig":{ |
| 1458 | "pypiPackages":{ |
| 1459 | "scikit-learn":"==0.19.0" |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1460 | } |
| 1461 | } |
| 1462 | } |
| 1463 | } |
| 1464 | |
| 1465 | Note that in the above example, any existing PyPI packages |
| 1466 | other than scikit-learn and argparse will be unaffected. |
| 1467 | |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1468 | Only one update type may be included in a single request's `updateMask`. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1469 | For example, one cannot update both the PyPI packages and |
| 1470 | labels in the same request. However, it is possible to update multiple |
| 1471 | members of a map field simultaneously in the same request. For example, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1472 | to set the labels "label1" and "label2" while clearing "label3" (assuming |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1473 | it already exists), one can |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1474 | provide the paths "labels.label1", "labels.label2", and "labels.label3" |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1475 | and populate the patch environment as follows: |
| 1476 | |
| 1477 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1478 | "labels":{ |
| 1479 | "label1":"new-label1-value" |
| 1480 | "label2":"new-label2-value" |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1481 | } |
| 1482 | } |
| 1483 | |
| 1484 | Note that in the above example, any existing labels that are not |
| 1485 | included in the `updateMask` will be unaffected. |
| 1486 | |
| 1487 | It is also possible to replace an entire map field by providing the |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1488 | map field's path in the `updateMask`. The new value of the field will |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1489 | be that which is provided in the patch environment. For example, to |
| 1490 | delete all pre-existing user-specified PyPI packages and |
| 1491 | install botocore at version 1.7.14, the `updateMask` would contain |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1492 | the path "config.softwareConfig.pypiPackages", and |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1493 | the patch environment would be the following: |
| 1494 | |
| 1495 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1496 | "config":{ |
| 1497 | "softwareConfig":{ |
| 1498 | "pypiPackages":{ |
| 1499 | "botocore":"==1.7.14" |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1500 | } |
| 1501 | } |
| 1502 | } |
| 1503 | } |
| 1504 | |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1505 | <strong>Note:</strong> Only the following fields can be updated: |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1506 | |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1507 | <table> |
| 1508 | <tbody> |
| 1509 | <tr> |
| 1510 | <td><strong>Mask</strong></td> |
| 1511 | <td><strong>Purpose</strong></td> |
| 1512 | </tr> |
| 1513 | <tr> |
| 1514 | <td>config.softwareConfig.pypiPackages |
| 1515 | </td> |
| 1516 | <td>Replace all custom custom PyPI packages. If a replacement |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1517 | package map is not included in `environment`, all custom |
| 1518 | PyPI packages are cleared. It is an error to provide both this mask and a |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1519 | mask specifying an individual package.</td> |
| 1520 | </tr> |
| 1521 | <tr> |
| 1522 | <td>config.softwareConfig.pypiPackages.<var>packagename</var></td> |
| 1523 | <td>Update the custom PyPI package <var>packagename</var>, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1524 | preserving other packages. To delete the package, include it in |
| 1525 | `updateMask`, and omit the mapping for it in |
| 1526 | `environment.config.softwareConfig.pypiPackages`. It is an error |
| 1527 | to provide both a mask of this form and the |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1528 | "config.softwareConfig.pypiPackages" mask.</td> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1529 | </tr> |
| 1530 | <tr> |
| 1531 | <td>labels</td> |
| 1532 | <td>Replace all environment labels. If a replacement labels map is not |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1533 | included in `environment`, all labels are cleared. It is an error to |
| 1534 | provide both this mask and a mask specifying one or more individual |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1535 | labels.</td> |
| 1536 | </tr> |
| 1537 | <tr> |
| 1538 | <td>labels.<var>labelName</var></td> |
| 1539 | <td>Set the label named <var>labelName</var>, while preserving other |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1540 | labels. To delete the label, include it in `updateMask` and omit its |
| 1541 | mapping in `environment.labels`. It is an error to provide both a |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1542 | mask of this form and the "labels" mask.</td> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1543 | </tr> |
| 1544 | <tr> |
| 1545 | <td>config.nodeCount</td> |
| 1546 | <td>Horizontally scale the number of nodes in the environment. An integer |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1547 | greater than or equal to 3 must be provided in the `config.nodeCount` |
| 1548 | field. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1549 | </td> |
| 1550 | </tr> |
| 1551 | <tr> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1552 | <td>config.webServerNetworkAccessControl</td> |
| 1553 | <td>Replace the environment's current WebServerNetworkAccessControl. |
| 1554 | </td> |
| 1555 | </tr> |
| 1556 | <tr> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1557 | <td>config.softwareConfig.airflowConfigOverrides</td> |
| 1558 | <td>Replace all Apache Airflow config overrides. If a replacement config |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1559 | overrides map is not included in `environment`, all config overrides |
| 1560 | are cleared. |
| 1561 | It is an error to provide both this mask and a mask specifying one or |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1562 | more individual config overrides.</td> |
| 1563 | </tr> |
| 1564 | <tr> |
| 1565 | <td>config.softwareConfig.airflowConfigOverrides.<var>section</var>-<var>name |
| 1566 | </var></td> |
| 1567 | <td>Override the Apache Airflow config property <var>name</var> in the |
| 1568 | section named <var>section</var>, preserving other properties. To delete |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1569 | the property override, include it in `updateMask` and omit its mapping |
| 1570 | in `environment.config.softwareConfig.airflowConfigOverrides`. |
| 1571 | It is an error to provide both a mask of this form and the |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1572 | "config.softwareConfig.airflowConfigOverrides" mask.</td> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1573 | </tr> |
| 1574 | <tr> |
| 1575 | <td>config.softwareConfig.envVariables</td> |
| 1576 | <td>Replace all environment variables. If a replacement environment |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1577 | variable map is not included in `environment`, all custom environment |
| 1578 | variables are cleared. |
| 1579 | It is an error to provide both this mask and a mask specifying one or |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1580 | more individual environment variables.</td> |
| 1581 | </tr> |
| 1582 | <tr> |
| 1583 | <td>config.softwareConfig.imageVersion</td> |
| 1584 | <td>Upgrade the version of the environment in-place. Refer to |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1585 | `SoftwareConfig.image_version` for information on how to format the new |
| 1586 | image version. Additionally, the new image version cannot effect a version |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1587 | downgrade and must match the current image version's Composer major |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1588 | version and Airflow major and minor versions. Consult the |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1589 | <a href="/composer/docs/concepts/versioning/composer-versions">Cloud |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1590 | Composer Version List</a> for valid values.</td> |
| 1591 | </tr> |
| 1592 | </tbody> |
| 1593 | </table> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1594 | x__xgafv: string, V1 error format. |
| 1595 | Allowed values |
| 1596 | 1 - v1 error format |
| 1597 | 2 - v2 error format |
| 1598 | |
| 1599 | Returns: |
| 1600 | An object of the form: |
| 1601 | |
| 1602 | { # This resource represents a long-running operation that is the result of a |
| 1603 | # network API call. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1604 | "metadata": { # Service-specific metadata associated with the operation. It typically |
| 1605 | # contains progress information and common metadata such as create time. |
| 1606 | # Some services might not provide such metadata. Any method that returns a |
| 1607 | # long-running operation should document the metadata type, if any. |
| 1608 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1609 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1610 | "done": True or False, # If the value is `false`, it means the operation is still in progress. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1611 | # If `true`, the operation is completed, and either `error` or `response` is |
| 1612 | # available. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1613 | "response": { # The normal response of the operation in case of success. If the original |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1614 | # method returns no data on success, such as `Delete`, the response is |
| 1615 | # `google.protobuf.Empty`. If the original method is standard |
| 1616 | # `Get`/`Create`/`Update`, the response should be the resource. For other |
| 1617 | # methods, the response should have the type `XxxResponse`, where `Xxx` |
| 1618 | # is the original method name. For example, if the original method name |
| 1619 | # is `TakeSnapshot()`, the inferred response type is |
| 1620 | # `TakeSnapshotResponse`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1621 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1622 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1623 | "name": "A String", # The server-assigned name, which is only unique within the same service that |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1624 | # originally returns it. If you use the default HTTP mapping, the |
| 1625 | # `name` should be a resource name ending with `operations/{unique_id}`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1626 | "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation. |
| 1627 | # different programming environments, including REST APIs and RPC APIs. It is |
| 1628 | # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| 1629 | # three pieces of data: error code, error message, and error details. |
| 1630 | # |
| 1631 | # You can find out more about this error model and how to work with it in the |
| 1632 | # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| 1633 | "details": [ # A list of messages that carry the error details. There is a common set of |
| 1634 | # message types for APIs to use. |
| 1635 | { |
| 1636 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 1637 | }, |
| 1638 | ], |
| 1639 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 1640 | "message": "A String", # A developer-facing error message, which should be in English. Any |
| 1641 | # user-facing error message should be localized and sent in the |
| 1642 | # google.rpc.Status.details field, or localized by the client. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1643 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1644 | }</pre> |
| 1645 | </div> |
| 1646 | |
| 1647 | </body></html> |