Blame - docs/dyn/composer_v1beta1.projects.locations.environments.html - platform/external/python/google-api-python-client

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

2019-06-14 16:50:42 -0700

[diff] [blame]

79

<p class="firstline">Create a new environment.</p>

80

81

<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>

82

<p class="firstline">Delete an environment.</p>

83

84

<code><a href="#get">get(name, x__xgafv=None)</a></code></p>

85

<p class="firstline">Get an existing environment.</p>

86

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

87

<code><a href="#list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

88

<p class="firstline">List environments.</p>

89

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

Dan O'Meara

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

2019-06-14 16:50:42 -0700

[diff] [blame]

94

<p class="firstline">Update an environment.</p>

95

<h3>Method Details</h3>

96

Dan O'Meara

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

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

2020-05-20 12:08:20 -0700

[diff] [blame]

102

"projects/{projectId}/locations/{locationId}". (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

103

body: object, The request body.

Bu Sun Kim

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

2020-05-20 12:08:20 -0700

[diff] [blame]

107

"labels": { # Optional. User-defined labels for this environment.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

108

# The labels map can contain no more than 64 entries. Entries of the labels

109

# map are UTF8 strings that comply with the following restrictions:

110

#

111

# * Keys must conform to regexp: \p{Ll}\p{Lo}{0,62}

112

# * Values must conform to regexp: [\p{Ll}\p{Lo}\p{N}_-]{0,63}

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

113

# * Both keys and values are additionally constrained to be <= 128 bytes in

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

114

# size.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

115

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

116

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

117

"createTime": "A String", # Output only. The time at which this environment was created.

118

"state": "A String", # The current state of the environment.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

119

"config": { # Configuration information for an environment. # Configuration parameters for this environment.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

120

"dagGcsPrefix": "A String", # Output only. The Cloud Storage prefix of the DAGs for this environment. Although Cloud

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

121

# Storage objects reside in a flat namespace, a hierarchical file tree

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

122

# can be simulated using "/"-delimited object name prefixes. DAG objects for

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

123

# this environment reside in a simulated directory with the given prefix.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

124

"privateEnvironmentConfig": { # The configuration information for configuring a Private IP Cloud Composer # The configuration used for the Private IP Cloud Composer environment.

125

# environment.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

126

"cloudSqlIpv4CidrBlock": "A String", # Optional. The CIDR block from which IP range in tenant project will be reserved for

127

# Cloud SQL. Needs to be disjoint from web_server_ipv4_cidr_block

128

"privateClusterConfig": { # Configuration options for the private GKE cluster in a Cloud Composer # Optional. Configuration for the private GKE cluster for a Private IP

129

# Cloud Composer environment.

130

# environment.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

131

"masterIpv4ReservedRange": "A String", # Output only. The IP range in CIDR notation to use for the hosted master network. This

132

# range is used for assigning internal IP addresses to the cluster

133

# master or set of masters and to the internal load balancer virtual IP.

134

# This range must not overlap with any other ranges in use

135

# within the cluster's network.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

136

"enablePrivateEndpoint": True or False, # Optional. If `true`, access to the public endpoint of the GKE cluster is

137

# denied.

138

"masterIpv4CidrBlock": "A String", # Optional. The CIDR block from which IPv4 range for GKE master will be reserved. If

139

# left blank, the default value of '172.16.0.0/23' is used.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

140

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

141

"webServerIpv4ReservedRange": "A String", # Output only. The IP range reserved for the tenant project's App Engine VMs.

142

"webServerIpv4CidrBlock": "A String", # Optional. The CIDR block from which IP range for web server will be reserved. Needs

143

# to be disjoint from private_cluster_config.master_ipv4_cidr_block and

144

# cloud_sql_ipv4_cidr_block.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

145

"enablePrivateEnvironment": True or False, # Optional. If `true`, a Private IP Cloud Composer environment is created.

146

# If this field is true, `use_ip_aliases` must be true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

147

},

148

"gkeCluster": "A String", # Output only. The Kubernetes Engine cluster used to run this environment.

149

"airflowUri": "A String", # Output only. The URI of the Apache Airflow Web UI hosted within this environment (see

150

# [Airflow web

151

# interface](/composer/docs/how-to/accessing/airflow-web-interface)).

152

"softwareConfig": { # Specifies the selection and configuration of software inside the environment. # The configuration settings for software inside the environment.

153

"envVariables": { # Optional. Additional environment variables to provide to the Apache Airflow

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

154

# scheduler, worker, and webserver processes.

155

#

156

# Environment variable names must match the regular expression

157

# `a-zA-Z_*`. They cannot specify Apache Airflow

158

# software configuration overrides (they cannot match the regular expression

159

# `AIRFLOW__[A-Z0-9_]+__[A-Z0-9_]+`), and they cannot match any of the

160

# following reserved names:

#

# * `AIRFLOW_HOME`

# * `C_FORCE_ROOT`

# * `CONTAINER_NAME`

# * `DAGS_FOLDER`

# * `GCP_PROJECT`

# * `GCS_BUCKET`

# * `GKE_CLUSTER_NAME`

# * `SQL_DATABASE`

# * `SQL_INSTANCE`

# * `SQL_PASSWORD`

# * `SQL_PROJECT`

# * `SQL_REGION`

# * `SQL_USER`

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

175

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

176

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

177

"pythonVersion": "A String", # Optional. The major version of Python used to run the Apache Airflow

178

# scheduler, worker, and webserver processes.

179

#

180

# Can be set to '2' or '3'. If not specified, the default is '2'. Cannot be

181

# updated.

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

# the value.

"a_key": "A String",

},

"imageVersion": "A String", # The version of the software running in the environment.

193

# This encapsulates both the version of Cloud Composer functionality and the

194

# version of Apache Airflow. It must match the regular expression

195

# `composer-([0-9]+\.[0-9]+\.[0-9]+|latest)-airflow-[0-9]+\.[0-9]+(\.[0-9]+.*)?`.

196

# When used as input, the server also checks if the provided version is

197

# supported and denies the request for an unsupported version.

198

#

199

# The Cloud Composer portion of the version is a

200

# [semantic version](https://semver.org) or `latest`. When the patch version

201

# is omitted, the current Cloud Composer patch version is selected.

202

# When `latest` is provided instead of an explicit version number,

203

# the server replaces `latest` with the current Cloud Composer version

204

# and stores that version number in the same field.

205

#

206

# The portion of the image version that follows <em>airflow-</em> is an

207

# official Apache Airflow repository

208

# [release name](https://github.com/apache/incubator-airflow/releases).

209

#

210

# See also [Version

211

# List](/composer/docs/concepts/versioning/composer-versions).

212

"airflowConfigOverrides": { # Optional. Apache Airflow configuration properties to override.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

213

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

214

# Property keys contain the section and property names, separated by a

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

215

# hyphen, for example "core-dags_are_paused_at_creation". Section names must

216

# not contain hyphens ("-"), opening square brackets ("["), or closing

217

# square brackets ("]"). The property name must not be empty and must not

218

# contain an equals sign ("=") or semicolon (";"). Section and property names

219

# must not contain a period ("."). Apache Airflow configuration property

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

220

# names must be written in

221

# [snake_case](https://en.wikipedia.org/wiki/Snake_case). Property values can

222

# contain any character, and can be written in any lower/upper case format.

223

#

224

# Certain Apache Airflow configuration property values are

225

# [blacklisted](/composer/docs/how-to/managing/setting-airflow-configurations#airflow_configuration_blacklists),

226

# and cannot be overridden.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

227

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

228

},

229

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

230

"nodeConfig": { # The configuration information for the Kubernetes Engine nodes running # The configuration used for the Kubernetes Engine cluster.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

231

# the Apache Airflow software.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

232

"subnetwork": "A String", # Optional. The Compute Engine subnetwork to be used for machine

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

233

# communications, specified as a

234

# [relative resource

235

# name](/apis/design/resource_names#relative_resource_name). For example:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

236

# "projects/{projectId}/regions/{regionId}/subnetworks/{subnetworkId}"

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

237

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

238

# If a subnetwork is provided, `nodeConfig.network` must also be provided,

239

# and the subnetwork must belong to the enclosing environment's project and

240

# location.

241

"ipAllocationPolicy": { # Configuration for controlling how IPs are allocated in the # Optional. The IPAllocationPolicy fields for the GKE cluster.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

242

# GKE cluster.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

243

"useIpAliases": True or False, # Optional. Whether or not to enable Alias IPs in the GKE cluster.

244

# If `true`, a VPC-native cluster is created.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

245

"servicesSecondaryRangeName": "A String", # Optional. The name of the services' secondary range used to allocate

246

# IP addresses to the cluster. Specify either `services_secondary_range_name`

247

# or `services_ipv4_cidr_block` but not both.

248

#

249

# This field is applicable only when `use_ip_aliases` is true.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

250

"clusterSecondaryRangeName": "A String", # Optional. The name of the cluster's secondary range used to allocate

251

# IP addresses to pods. Specify either `cluster_secondary_range_name`

252

# or `cluster_ipv4_cidr_block` but not both.

253

#

254

# This field is applicable only when `use_ip_aliases` is true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

255

"clusterIpv4CidrBlock": "A String", # Optional. The IP address range used to allocate IP addresses to pods in

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

256

# the cluster.

257

#

258

# This field is applicable only when `use_ip_aliases` is true.

259

#

260

# Set to blank to have GKE choose a range with the default size.

261

#

262

# Set to /netmask (e.g. `/14`) to have GKE choose a range with a specific

# netmask.

#

# Set to a

# [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)

267

# notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.

268

# `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range

269

# to use.

270

# Specify `cluster_secondary_range_name` or `cluster_ipv4_cidr_block`

271

# but not both.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

272

"servicesIpv4CidrBlock": "A String", # Optional. The IP address range of the services IP addresses in this

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

273

# cluster.

274

#

275

# This field is applicable only when `use_ip_aliases` is true.

276

#

277

# Set to blank to have GKE choose a range with the default size.

278

#

279

# Set to /netmask (e.g. `/14`) to have GKE choose a range with a specific

# netmask.

#

# Set to a

# [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)

284

# notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.

285

# `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range

286

# to use.

287

# Specify `services_secondary_range_name` or `services_ipv4_cidr_block`

288

# but not both.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

289

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

290

"diskSizeGb": 42, # Optional. The disk size in GB used for node VMs. Minimum size is 20GB.

291

# If unspecified, defaults to 100GB. Cannot be updated.

292

"tags": [ # Optional. The list of instance tags applied to all node VMs. Tags are used

293

# to identify valid sources or targets for network firewalls. Each tag within

294

# the list must comply with [RFC1035](https://www.ietf.org/rfc/rfc1035.txt).

# Cannot be updated.

"A String",

],

"serviceAccount": "A String", # Optional. The Google Cloud Platform Service Account to be used by the node

299

# VMs. If a service account is not specified, the "default" Compute Engine

300

# service account is used. Cannot be updated.

301

"location": "A String", # Optional. The Compute Engine [zone](/compute/docs/regions-zones) in which

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

302

# to deploy the VMs used to run the Apache Airflow software, specified as a

303

# [relative resource

304

# name](/apis/design/resource_names#relative_resource_name). For example:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

305

# "projects/{projectId}/zones/{zoneId}".

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

306

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

307

# This `location` must belong to the enclosing environment's project and

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

308

# location. If both this field and `nodeConfig.machineType` are specified,

309

# `nodeConfig.machineType` must belong to this `location`; if both are

310

# unspecified, the service will pick a zone in the Compute Engine region

311

# corresponding to the Cloud Composer location, and propagate that choice to

312

# both fields. If only one field (`location` or `nodeConfig.machineType`) is

313

# specified, the location information from the specified field will be

314

# propagated to the unspecified field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

315

"machineType": "A String", # Optional. The Compute Engine

316

# [machine type](/compute/docs/machine-types) used for cluster instances,

317

# specified as a

318

# [relative resource

319

# name](/apis/design/resource_names#relative_resource_name). For example:

320

# "projects/{projectId}/zones/{zoneId}/machineTypes/{machineTypeId}".

321

#

322

# The `machineType` must belong to the enclosing environment's project and

323

# location. If both this field and `nodeConfig.location` are specified,

324

# this `machineType` must belong to the `nodeConfig.location`; if both are

325

# unspecified, the service will pick a zone in the Compute Engine region

326

# corresponding to the Cloud Composer location, and propagate that choice to

327

# both fields. If exactly one of this field and `nodeConfig.location` is

328

# specified, the location information from the specified field will be

329

# propagated to the unspecified field.

330

#

331

# The `machineTypeId` must not be a [shared-core machine

332

# type](/compute/docs/machine-types#sharedcore).

333

#

334

# If this field is unspecified, the `machineTypeId` defaults

335

# to "n1-standard-1".

336

"network": "A String", # Optional. The Compute Engine network to be used for machine

337

# communications, specified as a

338

# [relative resource

339

# name](/apis/design/resource_names#relative_resource_name). For example:

340

# "projects/{projectId}/global/networks/{networkId}".

341

#

342

# If unspecified, the default network in the environment's project is used.

343

# If a [Custom Subnet Network](/vpc/docs/vpc#vpc_networks_and_subnets)

344

# is provided, `nodeConfig.subnetwork` must also be provided. For

345

# [Shared VPC](/vpc/docs/shared-vpc) subnetwork requirements, see

346

# `nodeConfig.subnetwork`.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

347

"oauthScopes": [ # Optional. The set of Google API scopes to be made available on all

348

# node VMs. If `oauth_scopes` is empty, defaults to

349

# ["https://www.googleapis.com/auth/cloud-platform"]. Cannot be updated.

"A String",

],

},

"nodeCount": 42, # The number of nodes in the Kubernetes Engine cluster that will be

354

# used to run this environment.

355

"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

356

# Airflow software.

357

# software.

358

"machineType": "A String", # Optional. Cloud SQL tier used by Airflow database.

359

# If not specified, db-n1-standard-2 will be used.

360

},

361

"webServerConfig": { # The configuration settings for the Airflow web server App Engine instance. # Optional. The configuration settings for the Airflow web server App Engine instance.

362

"machineType": "A String", # Optional. Machine type on which Airflow web server is running.

363

# For example: composer-n1-webserver-2, composer-n1-webserver-4,

364

# composer-n1-webserver-8.

365

# If not specified, composer-n1-webserver-2 will be used.

366

# Value custom is returned only in response, if Airflow web server parameters

367

# were manually changed to a non-standard values.

368

},

369

"webServerNetworkAccessControl": { # Network-level access control policy for the Airflow web server. # Optional. The network-level access control policy for the Airflow web server. If

370

# unspecified, no network-level access restrictions will be applied.

371

"allowedIpRanges": [ # A collection of allowed IP ranges with descriptions.

372

{ # Allowed IP range with user-provided description.

373

"description": "A String", # Optional. User-provided description. It must contain at most 300 characters.

374

"value": "A String", # IP address or range, defined using CIDR notation, of requests that this

375

# rule applies to.

376

# Examples: `192.168.1.1` or `192.168.0.0/16` or `2001:db8::/32`

377

# or `2001:0db8:0000:0042:0000:8a2e:0370:7334`.

378

#

379

#

380

# <p>IP range prefixes should be properly truncated. For example,

381

# `1.2.3.4/24` should be truncated to `1.2.3.0/24`. Similarly, for IPv6,

382

# `2001:db8::1/32` should be truncated to `2001:db8::/32`.

383

},

384

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

385

},

386

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

387

"updateTime": "A String", # Output only. The time at which this environment was last modified.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

388

"name": "A String", # The resource name of the environment, in the form:

389

# "projects/{projectId}/locations/{locationId}/environments/{environmentId}"

390

#

391

# EnvironmentId must start with a lowercase letter followed by up to 63

392

# lowercase letters, numbers, or hyphens, and cannot end with a hyphen.

393

"uuid": "A String", # Output only. The UUID (Universally Unique IDentifier) associated with this environment.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

394

# This value is generated when the environment is created.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

395

}

396

397

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

404

405

{ # This resource represents a long-running operation that is the result of a

406

# network API call.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

407

"name": "A String", # The server-assigned name, which is only unique within the same service that

408

# originally returns it. If you use the default HTTP mapping, the

409

# `name` should be a resource name ending with `operations/{unique_id}`.

410

"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.

411

# different programming environments, including REST APIs and RPC APIs. It is

412

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

413

# three pieces of data: error code, error message, and error details.

414

#

415

# You can find out more about this error model and how to work with it in the

416

# [API Design Guide](https://cloud.google.com/apis/design/errors).

417

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

418

"message": "A String", # A developer-facing error message, which should be in English. Any

419

# user-facing error message should be localized and sent in the

420

# google.rpc.Status.details field, or localized by the client.

421

"details": [ # A list of messages that carry the error details. There is a common set of

422

# message types for APIs to use.

423

{

424

"a_key": "", # Properties of the object. Contains field @type with type URL.

425

},

426

],

427

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

428

"metadata": { # Service-specific metadata associated with the operation. It typically

429

# contains progress information and common metadata such as create time.

430

# Some services might not provide such metadata. Any method that returns a

431

# long-running operation should document the metadata type, if any.

432

"a_key": "", # Properties of the object. Contains field @type with type URL.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

433

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

434

"done": True or False, # If the value is `false`, it means the operation is still in progress.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

435

# If `true`, the operation is completed, and either `error` or `response` is

436

# available.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

437

"response": { # The normal response of the operation in case of success. If the original

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

438

# method returns no data on success, such as `Delete`, the response is

439

# `google.protobuf.Empty`. If the original method is standard

440

# `Get`/`Create`/`Update`, the response should be the resource. For other

441

# methods, the response should have the type `XxxResponse`, where `Xxx`

442

# is the original method name. For example, if the original method name

443

# is `TakeSnapshot()`, the inferred response type is

444

# `TakeSnapshotResponse`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

445

"a_key": "", # Properties of the object. Contains field @type with type URL.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

446

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="delete">delete(name, x__xgafv=None)</code>

452

<pre>Delete an environment.

453

454

Args:

455

name: string, The environment to delete, in the form:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

456

"projects/{projectId}/locations/{locationId}/environments/{environmentId}" (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

457

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

464

465

{ # This resource represents a long-running operation that is the result of a

466

# network API call.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

467

"name": "A String", # The server-assigned name, which is only unique within the same service that

468

# originally returns it. If you use the default HTTP mapping, the

469

# `name` should be a resource name ending with `operations/{unique_id}`.

470

"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.

471

# different programming environments, including REST APIs and RPC APIs. It is

472

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

473

# three pieces of data: error code, error message, and error details.

474

#

475

# You can find out more about this error model and how to work with it in the

476

# [API Design Guide](https://cloud.google.com/apis/design/errors).

477

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

478

"message": "A String", # A developer-facing error message, which should be in English. Any

479

# user-facing error message should be localized and sent in the

480

# google.rpc.Status.details field, or localized by the client.

481

"details": [ # A list of messages that carry the error details. There is a common set of

482

# message types for APIs to use.

483

{

484

"a_key": "", # Properties of the object. Contains field @type with type URL.

485

},

486

],

487

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

488

"metadata": { # Service-specific metadata associated with the operation. It typically

489

# contains progress information and common metadata such as create time.

490

# Some services might not provide such metadata. Any method that returns a

491

# long-running operation should document the metadata type, if any.

492

"a_key": "", # Properties of the object. Contains field @type with type URL.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

493

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

494

"done": True or False, # If the value is `false`, it means the operation is still in progress.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

495

# If `true`, the operation is completed, and either `error` or `response` is

496

# available.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

497

"response": { # The normal response of the operation in case of success. If the original

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

498

# method returns no data on success, such as `Delete`, the response is

499

# `google.protobuf.Empty`. If the original method is standard

500

# `Get`/`Create`/`Update`, the response should be the resource. For other

501

# methods, the response should have the type `XxxResponse`, where `Xxx`

502

# is the original method name. For example, if the original method name

503

# is `TakeSnapshot()`, the inferred response type is

504

# `TakeSnapshotResponse`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

505

"a_key": "", # Properties of the object. Contains field @type with type URL.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

506

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="get">get(name, x__xgafv=None)</code>

512

<pre>Get an existing environment.

513

514

Args:

515

name: string, The resource name of the environment to get, in the form:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

516

"projects/{projectId}/locations/{locationId}/environments/{environmentId}" (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

517

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

524

525

{ # An environment for running orchestration tasks.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

526

"labels": { # Optional. User-defined labels for this environment.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

527

# The labels map can contain no more than 64 entries. Entries of the labels

528

# map are UTF8 strings that comply with the following restrictions:

529

#

530

# * Keys must conform to regexp: \p{Ll}\p{Lo}{0,62}

531

# * Values must conform to regexp: [\p{Ll}\p{Lo}\p{N}_-]{0,63}

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

532

# * Both keys and values are additionally constrained to be <= 128 bytes in

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

533

# size.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

534

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

535

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

536

"createTime": "A String", # Output only. The time at which this environment was created.

537

"state": "A String", # The current state of the environment.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

538

"config": { # Configuration information for an environment. # Configuration parameters for this environment.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

539

"dagGcsPrefix": "A String", # Output only. The Cloud Storage prefix of the DAGs for this environment. Although Cloud

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

540

# Storage objects reside in a flat namespace, a hierarchical file tree

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

541

# can be simulated using "/"-delimited object name prefixes. DAG objects for

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

542

# this environment reside in a simulated directory with the given prefix.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

543

"privateEnvironmentConfig": { # The configuration information for configuring a Private IP Cloud Composer # The configuration used for the Private IP Cloud Composer environment.

544

# environment.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

545

"cloudSqlIpv4CidrBlock": "A String", # Optional. The CIDR block from which IP range in tenant project will be reserved for

546

# Cloud SQL. Needs to be disjoint from web_server_ipv4_cidr_block

547

"privateClusterConfig": { # Configuration options for the private GKE cluster in a Cloud Composer # Optional. Configuration for the private GKE cluster for a Private IP

548

# Cloud Composer environment.

549

# environment.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

550

"masterIpv4ReservedRange": "A String", # Output only. The IP range in CIDR notation to use for the hosted master network. This

551

# range is used for assigning internal IP addresses to the cluster

552

# master or set of masters and to the internal load balancer virtual IP.

553

# This range must not overlap with any other ranges in use

554

# within the cluster's network.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

555

"enablePrivateEndpoint": True or False, # Optional. If `true`, access to the public endpoint of the GKE cluster is

556

# denied.

557

"masterIpv4CidrBlock": "A String", # Optional. The CIDR block from which IPv4 range for GKE master will be reserved. If

558

# left blank, the default value of '172.16.0.0/23' is used.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

559

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

560

"webServerIpv4ReservedRange": "A String", # Output only. The IP range reserved for the tenant project's App Engine VMs.

561

"webServerIpv4CidrBlock": "A String", # Optional. The CIDR block from which IP range for web server will be reserved. Needs

562

# to be disjoint from private_cluster_config.master_ipv4_cidr_block and

563

# cloud_sql_ipv4_cidr_block.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

564

"enablePrivateEnvironment": True or False, # Optional. If `true`, a Private IP Cloud Composer environment is created.

565

# If this field is true, `use_ip_aliases` must be true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

566

},

567

"gkeCluster": "A String", # Output only. The Kubernetes Engine cluster used to run this environment.

568

"airflowUri": "A String", # Output only. The URI of the Apache Airflow Web UI hosted within this environment (see

569

# [Airflow web

570

# interface](/composer/docs/how-to/accessing/airflow-web-interface)).

571

"softwareConfig": { # Specifies the selection and configuration of software inside the environment. # The configuration settings for software inside the environment.

572

"envVariables": { # Optional. Additional environment variables to provide to the Apache Airflow

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

573

# scheduler, worker, and webserver processes.

574

#

575

# Environment variable names must match the regular expression

576

# `a-zA-Z_*`. They cannot specify Apache Airflow

577

# software configuration overrides (they cannot match the regular expression

578

# `AIRFLOW__[A-Z0-9_]+__[A-Z0-9_]+`), and they cannot match any of the

579

# following reserved names:

#

# * `AIRFLOW_HOME`

# * `C_FORCE_ROOT`

# * `CONTAINER_NAME`

# * `DAGS_FOLDER`

# * `GCP_PROJECT`

# * `GCS_BUCKET`

# * `GKE_CLUSTER_NAME`

# * `SQL_DATABASE`

# * `SQL_INSTANCE`

# * `SQL_PASSWORD`

# * `SQL_PROJECT`

# * `SQL_REGION`

# * `SQL_USER`

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

594

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

595

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

596

"pythonVersion": "A String", # Optional. The major version of Python used to run the Apache Airflow

597

# scheduler, worker, and webserver processes.

598

#

599

# Can be set to '2' or '3'. If not specified, the default is '2'. Cannot be

600

# updated.

601

"pypiPackages": { # Optional. Custom Python Package Index (PyPI) packages to be installed in

602

# the environment.

603

#

604

# Keys refer to the lowercase package name such as "numpy"

605

# and values are the lowercase extras and version specifier such as

606

# "==1.12.0", "[devel,gcp_api]", or "[devel]>=1.8.2, <1.9.2". To specify a

607

# package without pinning it to a version specifier, use the empty string as

# the value.

"a_key": "A String",

},

"imageVersion": "A String", # The version of the software running in the environment.

612

# This encapsulates both the version of Cloud Composer functionality and the

613

# version of Apache Airflow. It must match the regular expression

614

# `composer-([0-9]+\.[0-9]+\.[0-9]+|latest)-airflow-[0-9]+\.[0-9]+(\.[0-9]+.*)?`.

615

# When used as input, the server also checks if the provided version is

616

# supported and denies the request for an unsupported version.

617

#

618

# The Cloud Composer portion of the version is a

619

# [semantic version](https://semver.org) or `latest`. When the patch version

620

# is omitted, the current Cloud Composer patch version is selected.

621

# When `latest` is provided instead of an explicit version number,

622

# the server replaces `latest` with the current Cloud Composer version

623

# and stores that version number in the same field.

624

#

625

# The portion of the image version that follows <em>airflow-</em> is an

626

# official Apache Airflow repository

627

# [release name](https://github.com/apache/incubator-airflow/releases).

628

#

629

# See also [Version

630

# List](/composer/docs/concepts/versioning/composer-versions).

631

"airflowConfigOverrides": { # Optional. Apache Airflow configuration properties to override.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

632

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

633

# Property keys contain the section and property names, separated by a

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

634

# hyphen, for example "core-dags_are_paused_at_creation". Section names must

635

# not contain hyphens ("-"), opening square brackets ("["), or closing

636

# square brackets ("]"). The property name must not be empty and must not

637

# contain an equals sign ("=") or semicolon (";"). Section and property names

638

# must not contain a period ("."). Apache Airflow configuration property

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

639

# names must be written in

640

# [snake_case](https://en.wikipedia.org/wiki/Snake_case). Property values can

641

# contain any character, and can be written in any lower/upper case format.

642

#

643

# Certain Apache Airflow configuration property values are

644

# [blacklisted](/composer/docs/how-to/managing/setting-airflow-configurations#airflow_configuration_blacklists),

645

# and cannot be overridden.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

646

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

647

},

648

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

649

"nodeConfig": { # The configuration information for the Kubernetes Engine nodes running # The configuration used for the Kubernetes Engine cluster.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

650

# the Apache Airflow software.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

651

"subnetwork": "A String", # Optional. The Compute Engine subnetwork to be used for machine

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

652

# communications, specified as a

653

# [relative resource

654

# name](/apis/design/resource_names#relative_resource_name). For example:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

655

# "projects/{projectId}/regions/{regionId}/subnetworks/{subnetworkId}"

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

656

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

657

# If a subnetwork is provided, `nodeConfig.network` must also be provided,

658

# and the subnetwork must belong to the enclosing environment's project and

659

# location.

660

"ipAllocationPolicy": { # Configuration for controlling how IPs are allocated in the # Optional. The IPAllocationPolicy fields for the GKE cluster.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

661

# GKE cluster.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

662

"useIpAliases": True or False, # Optional. Whether or not to enable Alias IPs in the GKE cluster.

663

# If `true`, a VPC-native cluster is created.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

664

"servicesSecondaryRangeName": "A String", # Optional. The name of the services' secondary range used to allocate

665

# IP addresses to the cluster. Specify either `services_secondary_range_name`

666

# or `services_ipv4_cidr_block` but not both.

667

#

668

# This field is applicable only when `use_ip_aliases` is true.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

669

"clusterSecondaryRangeName": "A String", # Optional. The name of the cluster's secondary range used to allocate

670

# IP addresses to pods. Specify either `cluster_secondary_range_name`

671

# or `cluster_ipv4_cidr_block` but not both.

672

#

673

# This field is applicable only when `use_ip_aliases` is true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

674

"clusterIpv4CidrBlock": "A String", # Optional. The IP address range used to allocate IP addresses to pods in

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

675

# the cluster.

676

#

677

# This field is applicable only when `use_ip_aliases` is true.

678

#

679

# Set to blank to have GKE choose a range with the default size.

680

#

681

# Set to /netmask (e.g. `/14`) to have GKE choose a range with a specific

# netmask.

#

# Set to a

# [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)

686

# notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.

687

# `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range

688

# to use.

689

# Specify `cluster_secondary_range_name` or `cluster_ipv4_cidr_block`

690

# but not both.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

691

"servicesIpv4CidrBlock": "A String", # Optional. The IP address range of the services IP addresses in this

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

692

# cluster.

693

#

694

# This field is applicable only when `use_ip_aliases` is true.

695

#

696

# Set to blank to have GKE choose a range with the default size.

697

#

698

# Set to /netmask (e.g. `/14`) to have GKE choose a range with a specific

# netmask.

#

# Set to a

# [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)

703

# notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.

704

# `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range

705

# to use.

706

# Specify `services_secondary_range_name` or `services_ipv4_cidr_block`

707

# but not both.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

708

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

709

"diskSizeGb": 42, # Optional. The disk size in GB used for node VMs. Minimum size is 20GB.

710

# If unspecified, defaults to 100GB. Cannot be updated.

711

"tags": [ # Optional. The list of instance tags applied to all node VMs. Tags are used

712

# to identify valid sources or targets for network firewalls. Each tag within

713

# the list must comply with [RFC1035](https://www.ietf.org/rfc/rfc1035.txt).

# Cannot be updated.

"A String",

],

"serviceAccount": "A String", # Optional. The Google Cloud Platform Service Account to be used by the node

718

# VMs. If a service account is not specified, the "default" Compute Engine

719

# service account is used. Cannot be updated.

720

"location": "A String", # Optional. The Compute Engine [zone](/compute/docs/regions-zones) in which

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

721

# to deploy the VMs used to run the Apache Airflow software, specified as a

722

# [relative resource

723

# name](/apis/design/resource_names#relative_resource_name). For example:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

724

# "projects/{projectId}/zones/{zoneId}".

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

725

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

726

# This `location` must belong to the enclosing environment's project and

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

727

# location. If both this field and `nodeConfig.machineType` are specified,

728

# `nodeConfig.machineType` must belong to this `location`; if both are

729

# unspecified, the service will pick a zone in the Compute Engine region

730

# corresponding to the Cloud Composer location, and propagate that choice to

731

# both fields. If only one field (`location` or `nodeConfig.machineType`) is

732

# specified, the location information from the specified field will be

733

# propagated to the unspecified field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

734

"machineType": "A String", # Optional. The Compute Engine

735

# [machine type](/compute/docs/machine-types) used for cluster instances,

736

# specified as a

737

# [relative resource

738

# name](/apis/design/resource_names#relative_resource_name). For example:

739

# "projects/{projectId}/zones/{zoneId}/machineTypes/{machineTypeId}".

740

#

741

# The `machineType` must belong to the enclosing environment's project and

742

# location. If both this field and `nodeConfig.location` are specified,

743

# this `machineType` must belong to the `nodeConfig.location`; if both are

744

# unspecified, the service will pick a zone in the Compute Engine region

745

# corresponding to the Cloud Composer location, and propagate that choice to

746

# both fields. If exactly one of this field and `nodeConfig.location` is

747

# specified, the location information from the specified field will be

748

# propagated to the unspecified field.

749

#

750

# The `machineTypeId` must not be a [shared-core machine

751

# type](/compute/docs/machine-types#sharedcore).

752

#

753

# If this field is unspecified, the `machineTypeId` defaults

754

# to "n1-standard-1".

755

"network": "A String", # Optional. The Compute Engine network to be used for machine

756

# communications, specified as a

757

# [relative resource

758

# name](/apis/design/resource_names#relative_resource_name). For example:

759

# "projects/{projectId}/global/networks/{networkId}".

760

#

761

# If unspecified, the default network in the environment's project is used.

762

# If a [Custom Subnet Network](/vpc/docs/vpc#vpc_networks_and_subnets)

763

# is provided, `nodeConfig.subnetwork` must also be provided. For

764

# [Shared VPC](/vpc/docs/shared-vpc) subnetwork requirements, see

765

# `nodeConfig.subnetwork`.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

766

"oauthScopes": [ # Optional. The set of Google API scopes to be made available on all

767

# node VMs. If `oauth_scopes` is empty, defaults to

768

# ["https://www.googleapis.com/auth/cloud-platform"]. Cannot be updated.

"A String",

],

},

"nodeCount": 42, # The number of nodes in the Kubernetes Engine cluster that will be

773

# used to run this environment.

774

"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

775

# Airflow software.

776

# software.

777

"machineType": "A String", # Optional. Cloud SQL tier used by Airflow database.

778

# If not specified, db-n1-standard-2 will be used.

779

},

780

"webServerConfig": { # The configuration settings for the Airflow web server App Engine instance. # Optional. The configuration settings for the Airflow web server App Engine instance.

781

"machineType": "A String", # Optional. Machine type on which Airflow web server is running.

782

# For example: composer-n1-webserver-2, composer-n1-webserver-4,

783

# composer-n1-webserver-8.

784

# If not specified, composer-n1-webserver-2 will be used.

785

# Value custom is returned only in response, if Airflow web server parameters

786

# were manually changed to a non-standard values.

787

},

788

"webServerNetworkAccessControl": { # Network-level access control policy for the Airflow web server. # Optional. The network-level access control policy for the Airflow web server. If

789

# unspecified, no network-level access restrictions will be applied.

790

"allowedIpRanges": [ # A collection of allowed IP ranges with descriptions.

791

{ # Allowed IP range with user-provided description.

792

"description": "A String", # Optional. User-provided description. It must contain at most 300 characters.

793

"value": "A String", # IP address or range, defined using CIDR notation, of requests that this

794

# rule applies to.

795

# Examples: `192.168.1.1` or `192.168.0.0/16` or `2001:db8::/32`

796

# or `2001:0db8:0000:0042:0000:8a2e:0370:7334`.

797

#

798

#

799

# <p>IP range prefixes should be properly truncated. For example,

800

# `1.2.3.4/24` should be truncated to `1.2.3.0/24`. Similarly, for IPv6,

801

# `2001:db8::1/32` should be truncated to `2001:db8::/32`.

802

},

803

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

804

},

805

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

806

"updateTime": "A String", # Output only. The time at which this environment was last modified.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

807

"name": "A String", # The resource name of the environment, in the form:

808

# "projects/{projectId}/locations/{locationId}/environments/{environmentId}"

809

#

810

# EnvironmentId must start with a lowercase letter followed by up to 63

811

# lowercase letters, numbers, or hyphens, and cannot end with a hyphen.

812

"uuid": "A String", # Output only. The UUID (Universally Unique IDentifier) associated with this environment.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

813

# This value is generated when the environment is created.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

818

<code class="details" id="list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

819

<pre>List environments.

820

821

Args:

822

parent: string, List environments in the given project and location, in the form:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

823

"projects/{projectId}/locations/{locationId}" (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

824

pageToken: string, The next_page_token value returned from a previous List request, if any.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

825

pageSize: integer, The maximum number of environments to return.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

826

x__xgafv: string, V1 error format.

827

Allowed values

828

1 - v1 error format

829

2 - v2 error format

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

830

831

Returns:

832

An object of the form:

833

834

{ # The environments in a project and location.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

835

"nextPageToken": "A String", # The page token used to query for the next page if one exists.

836

"environments": [ # The list of environments returned by a ListEnvironmentsRequest.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

837

{ # An environment for running orchestration tasks.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

838

"labels": { # Optional. User-defined labels for this environment.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

839

# The labels map can contain no more than 64 entries. Entries of the labels

840

# map are UTF8 strings that comply with the following restrictions:

841

#

842

# * Keys must conform to regexp: \p{Ll}\p{Lo}{0,62}

843

# * Values must conform to regexp: [\p{Ll}\p{Lo}\p{N}_-]{0,63}

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

844

# * Both keys and values are additionally constrained to be <= 128 bytes in

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

845

# size.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

846

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

847

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

848

"createTime": "A String", # Output only. The time at which this environment was created.

849

"state": "A String", # The current state of the environment.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

850

"config": { # Configuration information for an environment. # Configuration parameters for this environment.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

851

"dagGcsPrefix": "A String", # Output only. The Cloud Storage prefix of the DAGs for this environment. Although Cloud

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

852

# Storage objects reside in a flat namespace, a hierarchical file tree

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

853

# can be simulated using "/"-delimited object name prefixes. DAG objects for

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

854

# this environment reside in a simulated directory with the given prefix.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

855

"privateEnvironmentConfig": { # The configuration information for configuring a Private IP Cloud Composer # The configuration used for the Private IP Cloud Composer environment.

856

# environment.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

857

"cloudSqlIpv4CidrBlock": "A String", # Optional. The CIDR block from which IP range in tenant project will be reserved for

858

# Cloud SQL. Needs to be disjoint from web_server_ipv4_cidr_block

859

"privateClusterConfig": { # Configuration options for the private GKE cluster in a Cloud Composer # Optional. Configuration for the private GKE cluster for a Private IP

860

# Cloud Composer environment.

861

# environment.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

862

"masterIpv4ReservedRange": "A String", # Output only. The IP range in CIDR notation to use for the hosted master network. This

863

# range is used for assigning internal IP addresses to the cluster

864

# master or set of masters and to the internal load balancer virtual IP.

865

# This range must not overlap with any other ranges in use

866

# within the cluster's network.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

867

"enablePrivateEndpoint": True or False, # Optional. If `true`, access to the public endpoint of the GKE cluster is

868

# denied.

869

"masterIpv4CidrBlock": "A String", # Optional. The CIDR block from which IPv4 range for GKE master will be reserved. If

870

# left blank, the default value of '172.16.0.0/23' is used.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

871

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

872

"webServerIpv4ReservedRange": "A String", # Output only. The IP range reserved for the tenant project's App Engine VMs.

873

"webServerIpv4CidrBlock": "A String", # Optional. The CIDR block from which IP range for web server will be reserved. Needs

874

# to be disjoint from private_cluster_config.master_ipv4_cidr_block and

875

# cloud_sql_ipv4_cidr_block.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

876

"enablePrivateEnvironment": True or False, # Optional. If `true`, a Private IP Cloud Composer environment is created.

877

# If this field is true, `use_ip_aliases` must be true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

878

},

879

"gkeCluster": "A String", # Output only. The Kubernetes Engine cluster used to run this environment.

880

"airflowUri": "A String", # Output only. The URI of the Apache Airflow Web UI hosted within this environment (see

881

# [Airflow web

882

# interface](/composer/docs/how-to/accessing/airflow-web-interface)).

883

"softwareConfig": { # Specifies the selection and configuration of software inside the environment. # The configuration settings for software inside the environment.

884

"envVariables": { # Optional. Additional environment variables to provide to the Apache Airflow

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

885

# scheduler, worker, and webserver processes.

886

#

887

# Environment variable names must match the regular expression

888

# `a-zA-Z_*`. They cannot specify Apache Airflow

889

# software configuration overrides (they cannot match the regular expression

890

# `AIRFLOW__[A-Z0-9_]+__[A-Z0-9_]+`), and they cannot match any of the

891

# following reserved names:

#

# * `AIRFLOW_HOME`

# * `C_FORCE_ROOT`

# * `CONTAINER_NAME`

# * `DAGS_FOLDER`

# * `GCP_PROJECT`

# * `GCS_BUCKET`

# * `GKE_CLUSTER_NAME`

# * `SQL_DATABASE`

# * `SQL_INSTANCE`

# * `SQL_PASSWORD`

# * `SQL_PROJECT`

# * `SQL_REGION`

# * `SQL_USER`

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

906

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

907

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

908

"pythonVersion": "A String", # Optional. The major version of Python used to run the Apache Airflow

909

# scheduler, worker, and webserver processes.

910

#

911

# Can be set to '2' or '3'. If not specified, the default is '2'. Cannot be

912

# updated.

913

"pypiPackages": { # Optional. Custom Python Package Index (PyPI) packages to be installed in

914

# the environment.

915

#

916

# Keys refer to the lowercase package name such as "numpy"

917

# and values are the lowercase extras and version specifier such as

918

# "==1.12.0", "[devel,gcp_api]", or "[devel]>=1.8.2, <1.9.2". To specify a

919

# package without pinning it to a version specifier, use the empty string as

# the value.

"a_key": "A String",

},

"imageVersion": "A String", # The version of the software running in the environment.

924

# This encapsulates both the version of Cloud Composer functionality and the

925

# version of Apache Airflow. It must match the regular expression

926

# `composer-([0-9]+\.[0-9]+\.[0-9]+|latest)-airflow-[0-9]+\.[0-9]+(\.[0-9]+.*)?`.

927

# When used as input, the server also checks if the provided version is

928

# supported and denies the request for an unsupported version.

929

#

930

# The Cloud Composer portion of the version is a

931

# [semantic version](https://semver.org) or `latest`. When the patch version

932

# is omitted, the current Cloud Composer patch version is selected.

933

# When `latest` is provided instead of an explicit version number,

934

# the server replaces `latest` with the current Cloud Composer version

935

# and stores that version number in the same field.

936

#

937

# The portion of the image version that follows <em>airflow-</em> is an

938

# official Apache Airflow repository

939

# [release name](https://github.com/apache/incubator-airflow/releases).

940

#

941

# See also [Version

942

# List](/composer/docs/concepts/versioning/composer-versions).

943

"airflowConfigOverrides": { # Optional. Apache Airflow configuration properties to override.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

944

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

945

# Property keys contain the section and property names, separated by a

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

946

# hyphen, for example "core-dags_are_paused_at_creation". Section names must

947

# not contain hyphens ("-"), opening square brackets ("["), or closing

948

# square brackets ("]"). The property name must not be empty and must not

949

# contain an equals sign ("=") or semicolon (";"). Section and property names

950

# must not contain a period ("."). Apache Airflow configuration property

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

951

# names must be written in

952

# [snake_case](https://en.wikipedia.org/wiki/Snake_case). Property values can

953

# contain any character, and can be written in any lower/upper case format.

954

#

955

# Certain Apache Airflow configuration property values are

956

# [blacklisted](/composer/docs/how-to/managing/setting-airflow-configurations#airflow_configuration_blacklists),

957

# and cannot be overridden.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

958

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

959

},

960

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

961

"nodeConfig": { # The configuration information for the Kubernetes Engine nodes running # The configuration used for the Kubernetes Engine cluster.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

962

# the Apache Airflow software.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

963

"subnetwork": "A String", # Optional. The Compute Engine subnetwork to be used for machine

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

964

# communications, specified as a

965

# [relative resource

966

# name](/apis/design/resource_names#relative_resource_name). For example:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

967

# "projects/{projectId}/regions/{regionId}/subnetworks/{subnetworkId}"

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

968

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

969

# If a subnetwork is provided, `nodeConfig.network` must also be provided,

970

# and the subnetwork must belong to the enclosing environment's project and

971

# location.

972

"ipAllocationPolicy": { # Configuration for controlling how IPs are allocated in the # Optional. The IPAllocationPolicy fields for the GKE cluster.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

973

# GKE cluster.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

974

"useIpAliases": True or False, # Optional. Whether or not to enable Alias IPs in the GKE cluster.

975

# If `true`, a VPC-native cluster is created.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

976

"servicesSecondaryRangeName": "A String", # Optional. The name of the services' secondary range used to allocate

977

# IP addresses to the cluster. Specify either `services_secondary_range_name`

978

# or `services_ipv4_cidr_block` but not both.

979

#

980

# This field is applicable only when `use_ip_aliases` is true.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

981

"clusterSecondaryRangeName": "A String", # Optional. The name of the cluster's secondary range used to allocate

982

# IP addresses to pods. Specify either `cluster_secondary_range_name`

983

# or `cluster_ipv4_cidr_block` but not both.

984

#

985

# This field is applicable only when `use_ip_aliases` is true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

986

"clusterIpv4CidrBlock": "A String", # Optional. The IP address range used to allocate IP addresses to pods in

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

987

# the cluster.

988

#

989

# This field is applicable only when `use_ip_aliases` is true.

990

#

991

# Set to blank to have GKE choose a range with the default size.

992

#

993

# Set to /netmask (e.g. `/14`) to have GKE choose a range with a specific

# netmask.

#

# Set to a

# [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)

998

# notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.

999

# `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range

1000

# to use.

1001

# Specify `cluster_secondary_range_name` or `cluster_ipv4_cidr_block`

1002

# but not both.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1003

"servicesIpv4CidrBlock": "A String", # Optional. The IP address range of the services IP addresses in this

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1004

# cluster.

1005

#

1006

# This field is applicable only when `use_ip_aliases` is true.

1007

#

1008

# Set to blank to have GKE choose a range with the default size.

1009

#

1010

# Set to /netmask (e.g. `/14`) to have GKE choose a range with a specific

# netmask.

#

# Set to a

# [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)

1015

# notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.

1016

# `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range

1017

# to use.

1018

# Specify `services_secondary_range_name` or `services_ipv4_cidr_block`

1019

# but not both.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1020

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1021

"diskSizeGb": 42, # Optional. The disk size in GB used for node VMs. Minimum size is 20GB.

1022

# If unspecified, defaults to 100GB. Cannot be updated.

1023

"tags": [ # Optional. The list of instance tags applied to all node VMs. Tags are used

1024

# to identify valid sources or targets for network firewalls. Each tag within

1025

# the list must comply with [RFC1035](https://www.ietf.org/rfc/rfc1035.txt).

# Cannot be updated.

"A String",

],

"serviceAccount": "A String", # Optional. The Google Cloud Platform Service Account to be used by the node

1030

# VMs. If a service account is not specified, the "default" Compute Engine

1031

# service account is used. Cannot be updated.

1032

"location": "A String", # Optional. The Compute Engine [zone](/compute/docs/regions-zones) in which

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1033

# to deploy the VMs used to run the Apache Airflow software, specified as a

1034

# [relative resource

1035

# name](/apis/design/resource_names#relative_resource_name). For example:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1036

# "projects/{projectId}/zones/{zoneId}".

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1037

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1038

# This `location` must belong to the enclosing environment's project and

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1039

# location. If both this field and `nodeConfig.machineType` are specified,

1040

# `nodeConfig.machineType` must belong to this `location`; if both are

1041

# unspecified, the service will pick a zone in the Compute Engine region

1042

# corresponding to the Cloud Composer location, and propagate that choice to

1043

# both fields. If only one field (`location` or `nodeConfig.machineType`) is

1044

# specified, the location information from the specified field will be

1045

# propagated to the unspecified field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1046

"machineType": "A String", # Optional. The Compute Engine

1047

# [machine type](/compute/docs/machine-types) used for cluster instances,

1048

# specified as a

1049

# [relative resource

1050

# name](/apis/design/resource_names#relative_resource_name). For example:

1051

# "projects/{projectId}/zones/{zoneId}/machineTypes/{machineTypeId}".

1052

#

1053

# The `machineType` must belong to the enclosing environment's project and

1054

# location. If both this field and `nodeConfig.location` are specified,

1055

# this `machineType` must belong to the `nodeConfig.location`; if both are

1056

# unspecified, the service will pick a zone in the Compute Engine region

1057

# corresponding to the Cloud Composer location, and propagate that choice to

1058

# both fields. If exactly one of this field and `nodeConfig.location` is

1059

# specified, the location information from the specified field will be

1060

# propagated to the unspecified field.

1061

#

1062

# The `machineTypeId` must not be a [shared-core machine

1063

# type](/compute/docs/machine-types#sharedcore).

1064

#

1065

# If this field is unspecified, the `machineTypeId` defaults

1066

# to "n1-standard-1".

1067

"network": "A String", # Optional. The Compute Engine network to be used for machine

1068

# communications, specified as a

1069

# [relative resource

1070

# name](/apis/design/resource_names#relative_resource_name). For example:

1071

# "projects/{projectId}/global/networks/{networkId}".

1072

#

1073

# If unspecified, the default network in the environment's project is used.

1074

# If a [Custom Subnet Network](/vpc/docs/vpc#vpc_networks_and_subnets)

1075

# is provided, `nodeConfig.subnetwork` must also be provided. For

1076

# [Shared VPC](/vpc/docs/shared-vpc) subnetwork requirements, see

1077

# `nodeConfig.subnetwork`.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1078

"oauthScopes": [ # Optional. The set of Google API scopes to be made available on all

1079

# node VMs. If `oauth_scopes` is empty, defaults to

1080

# ["https://www.googleapis.com/auth/cloud-platform"]. Cannot be updated.

"A String",

],

},

"nodeCount": 42, # The number of nodes in the Kubernetes Engine cluster that will be

1085

# used to run this environment.

1086

"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

1087

# Airflow software.

1088

# software.

1089

"machineType": "A String", # Optional. Cloud SQL tier used by Airflow database.

1090

# If not specified, db-n1-standard-2 will be used.

1091

},

1092

"webServerConfig": { # The configuration settings for the Airflow web server App Engine instance. # Optional. The configuration settings for the Airflow web server App Engine instance.

1093

"machineType": "A String", # Optional. Machine type on which Airflow web server is running.

1094

# For example: composer-n1-webserver-2, composer-n1-webserver-4,

1095

# composer-n1-webserver-8.

1096

# If not specified, composer-n1-webserver-2 will be used.

1097

# Value custom is returned only in response, if Airflow web server parameters

1098

# were manually changed to a non-standard values.

1099

},

1100

"webServerNetworkAccessControl": { # Network-level access control policy for the Airflow web server. # Optional. The network-level access control policy for the Airflow web server. If

1101

# unspecified, no network-level access restrictions will be applied.

1102

"allowedIpRanges": [ # A collection of allowed IP ranges with descriptions.

1103

{ # Allowed IP range with user-provided description.

1104

"description": "A String", # Optional. User-provided description. It must contain at most 300 characters.

1105

"value": "A String", # IP address or range, defined using CIDR notation, of requests that this

1106

# rule applies to.

1107

# Examples: `192.168.1.1` or `192.168.0.0/16` or `2001:db8::/32`

1108

# or `2001:0db8:0000:0042:0000:8a2e:0370:7334`.

1109

#

1110

#

1111

# <p>IP range prefixes should be properly truncated. For example,

1112

# `1.2.3.4/24` should be truncated to `1.2.3.0/24`. Similarly, for IPv6,

1113

# `2001:db8::1/32` should be truncated to `2001:db8::/32`.

1114

},

1115

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1116

},

1117

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1118

"updateTime": "A String", # Output only. The time at which this environment was last modified.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1119

"name": "A String", # The resource name of the environment, in the form:

1120

# "projects/{projectId}/locations/{locationId}/environments/{environmentId}"

1121

#

1122

# EnvironmentId must start with a lowercase letter followed by up to 63

1123

# lowercase letters, numbers, or hyphens, and cannot end with a hyphen.

1124

"uuid": "A String", # Output only. The UUID (Universally Unique IDentifier) associated with this environment.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1125

# This value is generated when the environment is created.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

},

],

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

1133

<pre>Retrieves the next page of results.

1134

1135

Args:

1136

previous_request: The request for the previous page. (required)

1137

previous_response: The response from the request for the previous page. (required)

1138

1139

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1140

A request object that you can call 'execute()' on to request the next

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1141

page. Returns None if there are no more items in the collection.

</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1146

<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1147

<pre>Update an environment.

1148

1149

Args:

1150

name: string, The relative resource name of the environment to update, in the form:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1151

"projects/{projectId}/locations/{locationId}/environments/{environmentId}" (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1152

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1153

The object takes the form of:

1154

1155

{ # An environment for running orchestration tasks.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1156

"labels": { # Optional. User-defined labels for this environment.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1157

# The labels map can contain no more than 64 entries. Entries of the labels

1158

# map are UTF8 strings that comply with the following restrictions:

1159

#

1160

# * Keys must conform to regexp: \p{Ll}\p{Lo}{0,62}

1161

# * Values must conform to regexp: [\p{Ll}\p{Lo}\p{N}_-]{0,63}

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1162

# * Both keys and values are additionally constrained to be <= 128 bytes in

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1163

# size.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1164

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1165

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1166

"createTime": "A String", # Output only. The time at which this environment was created.

1167

"state": "A String", # The current state of the environment.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1168

"config": { # Configuration information for an environment. # Configuration parameters for this environment.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1169

"dagGcsPrefix": "A String", # Output only. The Cloud Storage prefix of the DAGs for this environment. Although Cloud

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1170

# Storage objects reside in a flat namespace, a hierarchical file tree

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1171

# can be simulated using "/"-delimited object name prefixes. DAG objects for

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1172

# this environment reside in a simulated directory with the given prefix.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1173

"privateEnvironmentConfig": { # The configuration information for configuring a Private IP Cloud Composer # The configuration used for the Private IP Cloud Composer environment.

1174

# environment.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1175

"cloudSqlIpv4CidrBlock": "A String", # Optional. The CIDR block from which IP range in tenant project will be reserved for

1176

# Cloud SQL. Needs to be disjoint from web_server_ipv4_cidr_block

1177

"privateClusterConfig": { # Configuration options for the private GKE cluster in a Cloud Composer # Optional. Configuration for the private GKE cluster for a Private IP

1178

# Cloud Composer environment.

1179

# environment.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1180

"masterIpv4ReservedRange": "A String", # Output only. The IP range in CIDR notation to use for the hosted master network. This

1181

# range is used for assigning internal IP addresses to the cluster

1182

# master or set of masters and to the internal load balancer virtual IP.

1183

# This range must not overlap with any other ranges in use

1184

# within the cluster's network.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1185

"enablePrivateEndpoint": True or False, # Optional. If `true`, access to the public endpoint of the GKE cluster is

1186

# denied.

1187

"masterIpv4CidrBlock": "A String", # Optional. The CIDR block from which IPv4 range for GKE master will be reserved. If

1188

# left blank, the default value of '172.16.0.0/23' is used.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1189

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1190

"webServerIpv4ReservedRange": "A String", # Output only. The IP range reserved for the tenant project's App Engine VMs.

1191

"webServerIpv4CidrBlock": "A String", # Optional. The CIDR block from which IP range for web server will be reserved. Needs

1192

# to be disjoint from private_cluster_config.master_ipv4_cidr_block and

1193

# cloud_sql_ipv4_cidr_block.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1194

"enablePrivateEnvironment": True or False, # Optional. If `true`, a Private IP Cloud Composer environment is created.

1195

# If this field is true, `use_ip_aliases` must be true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1196

},

1197

"gkeCluster": "A String", # Output only. The Kubernetes Engine cluster used to run this environment.

1198

"airflowUri": "A String", # Output only. The URI of the Apache Airflow Web UI hosted within this environment (see

1199

# [Airflow web

1200

# interface](/composer/docs/how-to/accessing/airflow-web-interface)).

1201

"softwareConfig": { # Specifies the selection and configuration of software inside the environment. # The configuration settings for software inside the environment.

1202

"envVariables": { # Optional. Additional environment variables to provide to the Apache Airflow

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1203

# scheduler, worker, and webserver processes.

1204

#

1205

# Environment variable names must match the regular expression

1206

# `a-zA-Z_*`. They cannot specify Apache Airflow

1207

# software configuration overrides (they cannot match the regular expression

1208

# `AIRFLOW__[A-Z0-9_]+__[A-Z0-9_]+`), and they cannot match any of the

1209

# following reserved names:

#

# * `AIRFLOW_HOME`

# * `C_FORCE_ROOT`

# * `CONTAINER_NAME`

# * `DAGS_FOLDER`

# * `GCP_PROJECT`

# * `GCS_BUCKET`

# * `GKE_CLUSTER_NAME`

# * `SQL_DATABASE`

# * `SQL_INSTANCE`

# * `SQL_PASSWORD`

# * `SQL_PROJECT`

# * `SQL_REGION`

# * `SQL_USER`

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1224

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1225

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1226

"pythonVersion": "A String", # Optional. The major version of Python used to run the Apache Airflow

1227

# scheduler, worker, and webserver processes.

1228

#

1229

# Can be set to '2' or '3'. If not specified, the default is '2'. Cannot be

1230

# updated.

1231

"pypiPackages": { # Optional. Custom Python Package Index (PyPI) packages to be installed in

1232

# the environment.

1233

#

1234

# Keys refer to the lowercase package name such as "numpy"

1235

# and values are the lowercase extras and version specifier such as

1236

# "==1.12.0", "[devel,gcp_api]", or "[devel]>=1.8.2, <1.9.2". To specify a

1237

# package without pinning it to a version specifier, use the empty string as

# the value.

"a_key": "A String",

},

"imageVersion": "A String", # The version of the software running in the environment.

1242

# This encapsulates both the version of Cloud Composer functionality and the

1243

# version of Apache Airflow. It must match the regular expression

1244

# `composer-([0-9]+\.[0-9]+\.[0-9]+|latest)-airflow-[0-9]+\.[0-9]+(\.[0-9]+.*)?`.

1245

# When used as input, the server also checks if the provided version is

1246

# supported and denies the request for an unsupported version.

1247

#

1248

# The Cloud Composer portion of the version is a

1249

# [semantic version](https://semver.org) or `latest`. When the patch version

1250

# is omitted, the current Cloud Composer patch version is selected.

1251

# When `latest` is provided instead of an explicit version number,

1252

# the server replaces `latest` with the current Cloud Composer version

1253

# and stores that version number in the same field.

1254

#

1255

# The portion of the image version that follows <em>airflow-</em> is an

1256

# official Apache Airflow repository

1257

# [release name](https://github.com/apache/incubator-airflow/releases).

1258

#

1259

# See also [Version

1260

# List](/composer/docs/concepts/versioning/composer-versions).

1261

"airflowConfigOverrides": { # Optional. Apache Airflow configuration properties to override.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1262

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1263

# Property keys contain the section and property names, separated by a

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1264

# hyphen, for example "core-dags_are_paused_at_creation". Section names must

1265

# not contain hyphens ("-"), opening square brackets ("["), or closing

1266

# square brackets ("]"). The property name must not be empty and must not

1267

# contain an equals sign ("=") or semicolon (";"). Section and property names

1268

# must not contain a period ("."). Apache Airflow configuration property

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1269

# names must be written in

1270

# [snake_case](https://en.wikipedia.org/wiki/Snake_case). Property values can

1271

# contain any character, and can be written in any lower/upper case format.

1272

#

1273

# Certain Apache Airflow configuration property values are

1274

# [blacklisted](/composer/docs/how-to/managing/setting-airflow-configurations#airflow_configuration_blacklists),

1275

# and cannot be overridden.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1276

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1277

},

1278

},

Bu Sun Kim

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

2019-06-14 16:50:42 -0700

[diff] [blame]

1280

# the Apache Airflow software.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1281

"subnetwork": "A String", # Optional. The Compute Engine subnetwork to be used for machine

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1282

# communications, specified as a

1283

# [relative resource

1284

# name](/apis/design/resource_names#relative_resource_name). For example:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1285

# "projects/{projectId}/regions/{regionId}/subnetworks/{subnetworkId}"

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1286

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1287

# If a subnetwork is provided, `nodeConfig.network` must also be provided,

1288

# and the subnetwork must belong to the enclosing environment's project and

1289

# location.

1290

"ipAllocationPolicy": { # Configuration for controlling how IPs are allocated in the # Optional. The IPAllocationPolicy fields for the GKE cluster.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1291

# GKE cluster.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1292

"useIpAliases": True or False, # Optional. Whether or not to enable Alias IPs in the GKE cluster.

1293

# If `true`, a VPC-native cluster is created.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1294

"servicesSecondaryRangeName": "A String", # Optional. The name of the services' secondary range used to allocate

1295

# IP addresses to the cluster. Specify either `services_secondary_range_name`

1296

# or `services_ipv4_cidr_block` but not both.

1297

#

1298

# This field is applicable only when `use_ip_aliases` is true.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1299

"clusterSecondaryRangeName": "A String", # Optional. The name of the cluster's secondary range used to allocate

1300

# IP addresses to pods. Specify either `cluster_secondary_range_name`

1301

# or `cluster_ipv4_cidr_block` but not both.

1302

#

1303

# This field is applicable only when `use_ip_aliases` is true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1304

"clusterIpv4CidrBlock": "A String", # Optional. The IP address range used to allocate IP addresses to pods in

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1305

# the cluster.

1306

#

1307

# This field is applicable only when `use_ip_aliases` is true.

1308

#

1309

# Set to blank to have GKE choose a range with the default size.

1310

#

1311

# Set to /netmask (e.g. `/14`) to have GKE choose a range with a specific

# netmask.

#

# Set to a

# [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)

1316

# notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.

1317

# `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range

1318

# to use.

1319

# Specify `cluster_secondary_range_name` or `cluster_ipv4_cidr_block`

1320

# but not both.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1321

"servicesIpv4CidrBlock": "A String", # Optional. The IP address range of the services IP addresses in this

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1322

# cluster.

1323

#

1324

# This field is applicable only when `use_ip_aliases` is true.

1325

#

1326

# Set to blank to have GKE choose a range with the default size.

1327

#

1328

# Set to /netmask (e.g. `/14`) to have GKE choose a range with a specific

# netmask.

#

# Set to a

# [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)

1333

# notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.

1334

# `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range

1335

# to use.

1336

# Specify `services_secondary_range_name` or `services_ipv4_cidr_block`

1337

# but not both.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1338

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1339

"diskSizeGb": 42, # Optional. The disk size in GB used for node VMs. Minimum size is 20GB.

1340

# If unspecified, defaults to 100GB. Cannot be updated.

1341

"tags": [ # Optional. The list of instance tags applied to all node VMs. Tags are used

1342

# to identify valid sources or targets for network firewalls. Each tag within

1343

# the list must comply with [RFC1035](https://www.ietf.org/rfc/rfc1035.txt).

# Cannot be updated.

"A String",

],

"serviceAccount": "A String", # Optional. The Google Cloud Platform Service Account to be used by the node

1348

# VMs. If a service account is not specified, the "default" Compute Engine

1349

# service account is used. Cannot be updated.

1350

"location": "A String", # Optional. The Compute Engine [zone](/compute/docs/regions-zones) in which

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1351

# to deploy the VMs used to run the Apache Airflow software, specified as a

1352

# [relative resource

1353

# name](/apis/design/resource_names#relative_resource_name). For example:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1354

# "projects/{projectId}/zones/{zoneId}".

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1355

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1356

# This `location` must belong to the enclosing environment's project and

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1357

# location. If both this field and `nodeConfig.machineType` are specified,

1358

# `nodeConfig.machineType` must belong to this `location`; if both are

1359

# unspecified, the service will pick a zone in the Compute Engine region

1360

# corresponding to the Cloud Composer location, and propagate that choice to

1361

# both fields. If only one field (`location` or `nodeConfig.machineType`) is

1362

# specified, the location information from the specified field will be

1363

# propagated to the unspecified field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1364

"machineType": "A String", # Optional. The Compute Engine

1365

# [machine type](/compute/docs/machine-types) used for cluster instances,

1366

# specified as a

1367

# [relative resource

1368

# name](/apis/design/resource_names#relative_resource_name). For example:

1369

# "projects/{projectId}/zones/{zoneId}/machineTypes/{machineTypeId}".

1370

#

1371

# The `machineType` must belong to the enclosing environment's project and

1372

# location. If both this field and `nodeConfig.location` are specified,

1373

# this `machineType` must belong to the `nodeConfig.location`; if both are

1374

# unspecified, the service will pick a zone in the Compute Engine region

1375

# corresponding to the Cloud Composer location, and propagate that choice to

1376

# both fields. If exactly one of this field and `nodeConfig.location` is

1377

# specified, the location information from the specified field will be

1378

# propagated to the unspecified field.

1379

#

1380

# The `machineTypeId` must not be a [shared-core machine

1381

# type](/compute/docs/machine-types#sharedcore).

1382

#

1383

# If this field is unspecified, the `machineTypeId` defaults

1384

# to "n1-standard-1".

1385

"network": "A String", # Optional. The Compute Engine network to be used for machine

1386

# communications, specified as a

1387

# [relative resource

1388

# name](/apis/design/resource_names#relative_resource_name). For example:

1389

# "projects/{projectId}/global/networks/{networkId}".

1390

#

1391

# If unspecified, the default network in the environment's project is used.

1392

# If a [Custom Subnet Network](/vpc/docs/vpc#vpc_networks_and_subnets)

1393

# is provided, `nodeConfig.subnetwork` must also be provided. For

1394

# [Shared VPC](/vpc/docs/shared-vpc) subnetwork requirements, see

1395

# `nodeConfig.subnetwork`.

Bu Sun Kim

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.

"A String",

],

},

"nodeCount": 42, # The number of nodes in the Kubernetes Engine cluster that will be

1403

# used to run this environment.

1404

"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

1405

# Airflow software.

1406

# software.

1407

"machineType": "A String", # Optional. Cloud SQL tier used by Airflow database.

1408

# If not specified, db-n1-standard-2 will be used.

1409

},

1410

"webServerConfig": { # The configuration settings for the Airflow web server App Engine instance. # Optional. The configuration settings for the Airflow web server App Engine instance.

1411

"machineType": "A String", # Optional. Machine type on which Airflow web server is running.

1412

# For example: composer-n1-webserver-2, composer-n1-webserver-4,

1413

# composer-n1-webserver-8.

1414

# If not specified, composer-n1-webserver-2 will be used.

1415

# Value custom is returned only in response, if Airflow web server parameters

1416

# were manually changed to a non-standard values.

1417

},

1418

"webServerNetworkAccessControl": { # Network-level access control policy for the Airflow web server. # Optional. The network-level access control policy for the Airflow web server. If

1419

# unspecified, no network-level access restrictions will be applied.

1420

"allowedIpRanges": [ # A collection of allowed IP ranges with descriptions.

1421

{ # Allowed IP range with user-provided description.

1422

"description": "A String", # Optional. User-provided description. It must contain at most 300 characters.

1423

"value": "A String", # IP address or range, defined using CIDR notation, of requests that this

1424

# rule applies to.

1425

# Examples: `192.168.1.1` or `192.168.0.0/16` or `2001:db8::/32`

1426

# or `2001:0db8:0000:0042:0000:8a2e:0370:7334`.

1427

#

1428

#

1429

# <p>IP range prefixes should be properly truncated. For example,

1430

# `1.2.3.4/24` should be truncated to `1.2.3.0/24`. Similarly, for IPv6,

1431

# `2001:db8::1/32` should be truncated to `2001:db8::/32`.

1432

},

1433

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1434

},

1435

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1436

"updateTime": "A String", # Output only. The time at which this environment was last modified.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1437

"name": "A String", # The resource name of the environment, in the form:

1438

# "projects/{projectId}/locations/{locationId}/environments/{environmentId}"

1439

#

1440

# EnvironmentId must start with a lowercase letter followed by up to 63

1441

# lowercase letters, numbers, or hyphens, and cannot end with a hyphen.

1442

"uuid": "A String", # Output only. The UUID (Universally Unique IDentifier) associated with this environment.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1443

# This value is generated when the environment is created.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1444

}

1445

1446

updateMask: string, Required. A comma-separated list of paths, relative to `Environment`, of

1447

fields to update.

1448

For example, to set the version of scikit-learn to install in the

1449

environment to 0.19.0 and to remove an existing installation of

1450

argparse, the `updateMask` parameter would include the following two

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1451

`paths` values: "config.softwareConfig.pypiPackages.scikit-learn" and

1452

"config.softwareConfig.pypiPackages.argparse". The included patch

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1453

environment would specify the scikit-learn version as follows:

1454

1455

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

"config":{

"softwareConfig":{

"pypiPackages":{

"scikit-learn":"==0.19.0"

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}

}

}

}

Note that in the above example, any existing PyPI packages

1466

other than scikit-learn and argparse will be unaffected.

1467

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1468

Only one update type may be included in a single request's `updateMask`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1469

For example, one cannot update both the PyPI packages and

1470

labels in the same request. However, it is possible to update multiple

1471

members of a map field simultaneously in the same request. For example,

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1472

to set the labels "label1" and "label2" while clearing "label3" (assuming

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1473

it already exists), one can

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1474

provide the paths "labels.label1", "labels.label2", and "labels.label3"

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1475

and populate the patch environment as follows:

1476

1477

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1478

"labels":{

1479

"label1":"new-label1-value"

1480

"label2":"new-label2-value"

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}

}

Note that in the above example, any existing labels that are not

1485

included in the `updateMask` will be unaffected.

1486

1487

It is also possible to replace an entire map field by providing the

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1488

map field's path in the `updateMask`. The new value of the field will

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1489

be that which is provided in the patch environment. For example, to

1490

delete all pre-existing user-specified PyPI packages and

1491

install botocore at version 1.7.14, the `updateMask` would contain

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1492

the path "config.softwareConfig.pypiPackages", and

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1493

the patch environment would be the following:

1494

1495

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

"config":{

"softwareConfig":{

"pypiPackages":{

"botocore":"==1.7.14"

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}

}

}

}

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1505

<strong>Note:</strong> Only the following fields can be updated:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1506

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

<table>

<tbody>

<tr>

<td><strong>Purpose</strong></td>

1512

</tr>

1513

<tr>

1514

<td>config.softwareConfig.pypiPackages

1515

</td>

1516

<td>Replace all custom custom PyPI packages. If a replacement

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1517

package map is not included in `environment`, all custom

1518

PyPI packages are cleared. It is an error to provide both this mask and a

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1519

mask specifying an individual package.</td>

1520

</tr>

1521

<tr>

1522

<td>config.softwareConfig.pypiPackages.<var>packagename</var></td>

1523

<td>Update the custom PyPI package <var>packagename</var>,

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1524

preserving other packages. To delete the package, include it in

1525

`updateMask`, and omit the mapping for it in

1526

`environment.config.softwareConfig.pypiPackages`. It is an error

1527

to provide both a mask of this form and the

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1528

"config.softwareConfig.pypiPackages" mask.</td>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

</tr>

<tr>

<td>labels</td>

<td>Replace all environment labels. If a replacement labels map is not

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1533

included in `environment`, all labels are cleared. It is an error to

1534

provide both this mask and a mask specifying one or more individual

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

labels.</td>

</tr>

<tr>

<td>labels.<var>labelName</var></td>

1539

<td>Set the label named <var>labelName</var>, while preserving other

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1540

labels. To delete the label, include it in `updateMask` and omit its

1541

mapping in `environment.labels`. It is an error to provide both a

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1542

mask of this form and the "labels" mask.</td>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1543

</tr>

1544

<tr>

1545

<td>config.nodeCount</td>

1546

<td>Horizontally scale the number of nodes in the environment. An integer

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1547

greater than or equal to 3 must be provided in the `config.nodeCount`

1548

field.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1549

</td>

1550

</tr>

1551

<tr>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1552

<td>config.webServerNetworkAccessControl</td>

1553

<td>Replace the environment's current WebServerNetworkAccessControl.

1554

</td>

1555

</tr>

1556

<tr>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1557

<td>config.softwareConfig.airflowConfigOverrides</td>

1558

<td>Replace all Apache Airflow config overrides. If a replacement config

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1559

overrides map is not included in `environment`, all config overrides

1560

are cleared.

1561

It is an error to provide both this mask and a mask specifying one or

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1562

more individual config overrides.</td>

1563

</tr>

1564

<tr>

1565

<td>config.softwareConfig.airflowConfigOverrides.<var>section</var>-<var>name

1566

</var></td>

1567

<td>Override the Apache Airflow config property <var>name</var> in the

1568

section named <var>section</var>, preserving other properties. To delete

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1569

the property override, include it in `updateMask` and omit its mapping

1570

in `environment.config.softwareConfig.airflowConfigOverrides`.

1571

It is an error to provide both a mask of this form and the

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1572

"config.softwareConfig.airflowConfigOverrides" mask.</td>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1573

</tr>

1574

<tr>

1575

<td>config.softwareConfig.envVariables</td>

1576

<td>Replace all environment variables. If a replacement environment

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1577

variable map is not included in `environment`, all custom environment

1578

variables are cleared.

1579

It is an error to provide both this mask and a mask specifying one or

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1580

more individual environment variables.</td>

1581

</tr>

1582

<tr>

1583

<td>config.softwareConfig.imageVersion</td>

1584

<td>Upgrade the version of the environment in-place. Refer to

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1585

`SoftwareConfig.image_version` for information on how to format the new

1586

image version. Additionally, the new image version cannot effect a version

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1587

downgrade and must match the current image version's Composer major

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1588

version and Airflow major and minor versions. Consult the

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1589

<a href="/composer/docs/concepts/versioning/composer-versions">Cloud

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1590

Composer Version List</a> for valid values.</td>

1591

</tr>

1592

</tbody>

1593

</table>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1594

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1601

1602

{ # This resource represents a long-running operation that is the result of a

1603

# network API call.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1604

"name": "A String", # The server-assigned name, which is only unique within the same service that

1605

# originally returns it. If you use the default HTTP mapping, the

1606

# `name` should be a resource name ending with `operations/{unique_id}`.

1607

"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.

1608

# different programming environments, including REST APIs and RPC APIs. It is

1609

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

1610

# three pieces of data: error code, error message, and error details.

1611

#

1612

# You can find out more about this error model and how to work with it in the

1613

# [API Design Guide](https://cloud.google.com/apis/design/errors).

1614

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

1615

"message": "A String", # A developer-facing error message, which should be in English. Any

1616

# user-facing error message should be localized and sent in the

1617

# google.rpc.Status.details field, or localized by the client.

1618

"details": [ # A list of messages that carry the error details. There is a common set of

1619

# message types for APIs to use.

1620

{

1621

"a_key": "", # Properties of the object. Contains field @type with type URL.

1622

},

1623

],

1624

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1625

"metadata": { # Service-specific metadata associated with the operation. It typically

1626

# contains progress information and common metadata such as create time.

1627

# Some services might not provide such metadata. Any method that returns a

1628

# long-running operation should document the metadata type, if any.

1629

"a_key": "", # Properties of the object. Contains field @type with type URL.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1630

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1631

"done": True or False, # If the value is `false`, it means the operation is still in progress.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1632

# If `true`, the operation is completed, and either `error` or `response` is

1633

# available.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1634

"response": { # The normal response of the operation in case of success. If the original

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1635

# method returns no data on success, such as `Delete`, the response is

1636

# `google.protobuf.Empty`. If the original method is standard

1637

# `Get`/`Create`/`Update`, the response should be the resource. For other

1638

# methods, the response should have the type `XxxResponse`, where `Xxx`

1639

# is the original method name. For example, if the original method name

1640

# is `TakeSnapshot()`, the inferred response type is

1641

# `TakeSnapshotResponse`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1642

"a_key": "", # Properties of the object. Contains field @type with type URL.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1643

},

Bu Sun Kim