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