Blame - docs/dyn/composer_v1.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-07-22 17:02:09 -0700

[diff] [blame^]

107

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

108

# This value is generated when the environment is created.

Bu Sun Kim

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

[diff] [blame]

109

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

110

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

111

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

112

#

113

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

114

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

115

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

116

# size.

117

"a_key": "A String",

118

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

119

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

Bu Sun Kim

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

[diff] [blame]

120

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

121

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

122

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

123

# [Airflow web

124

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

Bu Sun Kim

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

[diff] [blame]

125

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

126

# environment.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

127

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

128

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

129

# set to true.

Bu Sun Kim

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

[diff] [blame]

130

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

131

# Cloud Composer environment.

132

# environment.

133

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

134

# denied.

Bu Sun Kim

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

[diff] [blame]

135

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

136

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

137

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

138

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

139

# within the cluster's network.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

140

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

141

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

Bu Sun Kim

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

[diff] [blame]

142

},

143

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

144

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

145

# to be disjoint from `private_cluster_config.master_ipv4_cidr_block` and

146

# `cloud_sql_ipv4_cidr_block`.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

147

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

148

# Cloud SQL. Needs to be disjoint from `web_server_ipv4_cidr_block`.

Bu Sun Kim

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

[diff] [blame]

149

},

Bu Sun Kim

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

[diff] [blame]

150

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

151

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

152

#

153

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

154

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

155

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

156

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

157

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

158

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

159

# names must be written in

160

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

161

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

162

#

163

# Certain Apache Airflow configuration property values are

164

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

165

# and cannot be overridden.

166

"a_key": "A String",

167

},

168

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

169

# scheduler, worker, and webserver processes.

170

#

171

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

172

# updated.

Bu Sun Kim

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

[diff] [blame]

173

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

174

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

175

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

176

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

177

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

178

# supported and denies the request for an unsupported version.

179

#

180

# The Cloud Composer portion of the version is a

181

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

182

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

183

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

184

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

185

# and stores that version number in the same field.

186

#

187

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

188

# official Apache Airflow repository

189

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

190

#

191

# See also [Version

192

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

193

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

194

# the environment.

Bu Sun Kim

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

[diff] [blame]

195

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

196

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

197

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

198

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

199

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

200

# the value.

Bu Sun Kim

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

[diff] [blame]

201

"a_key": "A String",

202

},

203

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

204

# scheduler, worker, and webserver processes.

205

#

206

# Environment variable names must match the regular expression

207

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

208

# software configuration overrides (they cannot match the regular expression

209

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

210

# 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`

"a_key": "A String",

},

Bu Sun Kim

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

[diff] [blame]

227

},

228

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

229

# used to run this environment.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

230

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

231

# the Apache Airflow software.

232

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

233

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

234

# service account is used. Cannot be updated.

235

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

236

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

237

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

238

"A String",

239

],

240

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

241

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

242

# specified as a

243

# [relative resource

244

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

245

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

246

#

247

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

248

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

249

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

250

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

251

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

252

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

253

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

254

# propagated to the unspecified field.

255

#

256

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

257

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

258

#

259

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

260

# to "n1-standard-1".

261

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

262

# GKE cluster running the Apache Airflow software.

263

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

264

# the GKE cluster.

265

#

266

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

267

#

268

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

269

#

270

# 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)

275

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

276

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

277

# to use.

278

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

279

# GKE cluster.

280

#

281

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

282

#

283

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

284

#

285

# 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)

290

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

291

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

292

# to use.

293

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

294

# IP addresses to pods.

295

#

296

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

297

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

298

# IP addresses to the GKE cluster.

299

#

300

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

301

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

302

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

303

},

304

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

305

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

306

# [relative resource

307

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

308

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

309

#

310

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

311

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

312

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

313

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

314

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

315

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

316

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

317

# propagated to the unspecified field.

318

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

319

# communications, specified as a

320

# [relative resource

321

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

322

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

323

#

324

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

325

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

326

# location.

327

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

328

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

329

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

330

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

331

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

# Cannot be updated.

"A String",

],

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

336

# communications, specified as a

337

# [relative resource

338

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

339

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

340

#

341

# [Shared VPC](/vpc/docs/shared-vpc) is not currently supported. The

342

# network must belong to the environment's project. If unspecified, the

343

# "default" network ID in the environment's project is used. If a

344

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

345

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

346

},

347

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

348

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

349

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

350

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

Bu Sun Kim

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

[diff] [blame]

351

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

352

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

Bu Sun Kim

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

[diff] [blame]

353

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

354

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

355

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

356

#

357

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

358

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

Bu Sun Kim

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

[diff] [blame]

359

}

360

361

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

368

369

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

370

# network API call.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

371

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

372

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

373

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

Bu Sun Kim

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

[diff] [blame]

374

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

375

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

376

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

377

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

378

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

379

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

380

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

381

# `TakeSnapshotResponse`.

382

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

383

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

384

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

385

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

386

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

387

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

388

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

389

},

390

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

391

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

392

# available.

Bu Sun Kim

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

[diff] [blame]

393

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

394

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

395

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

396

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

397

#

398

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

399

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

400

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

401

# message types for APIs to use.

402

{

403

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

404

},

405

],

Bu Sun Kim

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

[diff] [blame]

406

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

407

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

408

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

409

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

Bu Sun Kim

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

[diff] [blame]

},

}</pre>

</div>

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

416

<pre>Delete an environment.

417

418

Args:

419

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

420

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

421

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

428

429

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

430

# network API call.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

431

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

432

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

433

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

Bu Sun Kim

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

[diff] [blame]

434

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

435

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

436

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

437

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

438

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

439

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

440

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

441

# `TakeSnapshotResponse`.

442

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

443

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

444

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

445

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

446

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

447

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

448

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

449

},

450

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

451

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

452

# available.

Bu Sun Kim

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

[diff] [blame]

453

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

454

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

455

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

456

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

457

#

458

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

459

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

460

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

461

# message types for APIs to use.

462

{

463

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

464

},

465

],

Bu Sun Kim

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

[diff] [blame]

466

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

467

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

468

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

469

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

Bu Sun Kim

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

[diff] [blame]

},

}</pre>

</div>

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

476

<pre>Get an existing environment.

477

478

Args:

479

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

480

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

481

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

488

489

{ # An environment for running orchestration tasks.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

490

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

491

# This value is generated when the environment is created.

Bu Sun Kim

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

[diff] [blame]

492

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

Bu Sun Kim

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

[diff] [blame]

493

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

494

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

Bu Sun Kim

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

[diff] [blame]

495

#

Bu Sun Kim

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

[diff] [blame]

496

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

497

# * 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]

498

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

Bu Sun Kim

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

[diff] [blame]

499

# size.

Bu Sun Kim

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

[diff] [blame]

500

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

501

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

502

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

Bu Sun Kim

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

[diff] [blame]

503

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

504

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

505

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

506

# [Airflow web

507

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

Bu Sun Kim

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

[diff] [blame]

508

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

509

# environment.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

510

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

511

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

512

# set to true.

Bu Sun Kim

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

[diff] [blame]

513

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

514

# Cloud Composer environment.

515

# environment.

Bu Sun Kim

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

[diff] [blame]

516

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

517

# denied.

518

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

519

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

520

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

521

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

522

# within the cluster's network.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

523

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

524

# 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]

525

},

Bu Sun Kim

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

[diff] [blame]

526

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

527

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

528

# to be disjoint from `private_cluster_config.master_ipv4_cidr_block` and

529

# `cloud_sql_ipv4_cidr_block`.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

530

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

531

# Cloud SQL. Needs to be disjoint from `web_server_ipv4_cidr_block`.

Bu Sun Kim

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

[diff] [blame]

532

},

Bu Sun Kim

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

[diff] [blame]

533

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

534

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

535

#

536

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

537

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

538

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

539

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

540

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

541

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

542

# names must be written in

543

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

544

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

545

#

546

# Certain Apache Airflow configuration property values are

547

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

548

# and cannot be overridden.

549

"a_key": "A String",

550

},

551

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

552

# scheduler, worker, and webserver processes.

553

#

554

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

555

# updated.

Bu Sun Kim

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

[diff] [blame]

556

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

557

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

558

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

559

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

560

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

561

# supported and denies the request for an unsupported version.

562

#

563

# The Cloud Composer portion of the version is a

564

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

565

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

566

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

567

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

568

# and stores that version number in the same field.

569

#

570

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

571

# official Apache Airflow repository

572

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

573

#

574

# See also [Version

575

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

576

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

577

# the environment.

Bu Sun Kim

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

[diff] [blame]

578

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

579

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

580

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

581

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

582

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

583

# the value.

Bu Sun Kim

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

[diff] [blame]

584

"a_key": "A String",

585

},

Bu Sun Kim

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

[diff] [blame]

586

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

Bu Sun Kim

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

[diff] [blame]

587

# scheduler, worker, and webserver processes.

588

#

589

# Environment variable names must match the regular expression

590

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

591

# software configuration overrides (they cannot match the regular expression

592

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

593

# 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]

608

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

609

},

Bu Sun Kim

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

[diff] [blame]

610

},

Bu Sun Kim

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

[diff] [blame]

611

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

Bu Sun Kim

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

[diff] [blame]

612

# used to run this environment.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

613

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

614

# the Apache Airflow software.

615

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

616

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

617

# service account is used. Cannot be updated.

618

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

619

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

620

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

621

"A String",

622

],

623

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

624

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

625

# specified as a

626

# [relative resource

627

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

628

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

629

#

630

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

631

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

632

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

633

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

634

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

635

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

636

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

637

# propagated to the unspecified field.

638

#

639

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

640

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

641

#

642

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

643

# to "n1-standard-1".

644

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

645

# GKE cluster running the Apache Airflow software.

646

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

647

# the GKE cluster.

648

#

649

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

650

#

651

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

652

#

653

# 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)

658

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

659

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

660

# to use.

661

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

662

# GKE cluster.

663

#

664

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

665

#

666

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

667

#

668

# 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)

673

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

674

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

675

# to use.

676

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

677

# IP addresses to pods.

678

#

679

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

680

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

681

# IP addresses to the GKE cluster.

682

#

683

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

684

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

685

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

686

},

687

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

688

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

689

# [relative resource

690

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

691

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

692

#

693

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

694

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

695

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

696

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

697

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

698

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

699

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

700

# propagated to the unspecified field.

701

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

702

# communications, specified as a

703

# [relative resource

704

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

705

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

706

#

707

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

708

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

709

# location.

710

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

711

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

712

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

713

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

714

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

# Cannot be updated.

"A String",

],

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

719

# communications, specified as a

720

# [relative resource

721

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

722

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

723

#

724

# [Shared VPC](/vpc/docs/shared-vpc) is not currently supported. The

725

# network must belong to the environment's project. If unspecified, the

726

# "default" network ID in the environment's project is used. If a

727

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

728

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

729

},

730

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

731

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

732

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

733

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

Bu Sun Kim

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

[diff] [blame]

734

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

735

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

736

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

737

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

738

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

Bu Sun Kim

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

[diff] [blame]

739

#

Dan O'Meara

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

[diff] [blame]

740

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

741

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

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]

746

<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]

747

<pre>List environments.

748

749

Args:

750

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]

751

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

Bu Sun Kim

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

[diff] [blame]

752

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]

753

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

Bu Sun Kim

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

[diff] [blame]

754

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

761

762

{ # The environments in a project and location.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

763

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

Bu Sun Kim

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

[diff] [blame]

764

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

Bu Sun Kim

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

[diff] [blame]

765

{ # An environment for running orchestration tasks.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

766

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

767

# This value is generated when the environment is created.

Bu Sun Kim

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

[diff] [blame]

768

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

769

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

770

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

771

#

772

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

773

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

774

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

775

# size.

776

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

777

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

778

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

Bu Sun Kim

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

[diff] [blame]

779

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

780

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

781

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

782

# [Airflow web

783

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

Bu Sun Kim

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

[diff] [blame]

784

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

785

# environment.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

786

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

787

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

788

# set to true.

Bu Sun Kim

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

[diff] [blame]

789

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

790

# Cloud Composer environment.

791

# environment.

792

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

793

# denied.

Bu Sun Kim

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

[diff] [blame]

794

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

795

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

796

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

797

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

798

# within the cluster's network.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

799

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

800

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

Bu Sun Kim

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

[diff] [blame]

801

},

802

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

803

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

804

# to be disjoint from `private_cluster_config.master_ipv4_cidr_block` and

805

# `cloud_sql_ipv4_cidr_block`.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

806

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

807

# Cloud SQL. Needs to be disjoint from `web_server_ipv4_cidr_block`.

Bu Sun Kim

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

[diff] [blame]

808

},

Bu Sun Kim

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

[diff] [blame]

809

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

810

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

811

#

812

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

813

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

814

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

815

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

816

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

817

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

818

# names must be written in

819

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

820

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

821

#

822

# Certain Apache Airflow configuration property values are

823

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

824

# and cannot be overridden.

825

"a_key": "A String",

826

},

827

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

828

# scheduler, worker, and webserver processes.

829

#

830

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

831

# updated.

Bu Sun Kim

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

[diff] [blame]

832

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

833

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

834

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

835

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

836

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

837

# supported and denies the request for an unsupported version.

838

#

839

# The Cloud Composer portion of the version is a

840

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

841

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

842

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

843

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

844

# and stores that version number in the same field.

845

#

846

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

847

# official Apache Airflow repository

848

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

849

#

850

# See also [Version

851

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

852

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

853

# the environment.

Bu Sun Kim

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

[diff] [blame]

854

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

855

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

856

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

857

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

858

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

859

# the value.

Bu Sun Kim

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

[diff] [blame]

860

"a_key": "A String",

861

},

862

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

863

# scheduler, worker, and webserver processes.

864

#

865

# Environment variable names must match the regular expression

866

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

867

# software configuration overrides (they cannot match the regular expression

868

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

869

# 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`

"a_key": "A String",

},

Bu Sun Kim

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

[diff] [blame]

886

},

887

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

888

# used to run this environment.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

889

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

890

# the Apache Airflow software.

891

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

892

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

893

# service account is used. Cannot be updated.

894

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

895

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

896

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

897

"A String",

898

],

899

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

900

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

901

# specified as a

902

# [relative resource

903

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

904

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

905

#

906

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

907

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

908

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

909

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

910

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

911

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

912

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

913

# propagated to the unspecified field.

914

#

915

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

916

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

917

#

918

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

919

# to "n1-standard-1".

920

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

921

# GKE cluster running the Apache Airflow software.

922

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

923

# the GKE cluster.

924

#

925

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

926

#

927

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

928

#

929

# 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)

934

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

935

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

936

# to use.

937

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

938

# GKE cluster.

939

#

940

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

941

#

942

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

943

#

944

# 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)

949

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

950

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

951

# to use.

952

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

953

# IP addresses to pods.

954

#

955

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

956

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

957

# IP addresses to the GKE cluster.

958

#

959

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

960

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

961

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

962

},

963

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

964

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

965

# [relative resource

966

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

967

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

968

#

969

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

970

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

971

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

972

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

973

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

974

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

975

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

976

# propagated to the unspecified field.

977

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

978

# communications, specified as a

979

# [relative resource

980

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

981

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

982

#

983

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

984

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

985

# location.

986

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

987

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

988

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

989

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

990

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

# Cannot be updated.

"A String",

],

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

995

# communications, specified as a

996

# [relative resource

997

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

998

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

999

#

1000

# [Shared VPC](/vpc/docs/shared-vpc) is not currently supported. The

1001

# network must belong to the environment's project. If unspecified, the

1002

# "default" network ID in the environment's project is used. If a

1003

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

1004

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

1005

},

1006

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

1007

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

1008

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

1009

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

Bu Sun Kim

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

[diff] [blame]

1010

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1011

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

Bu Sun Kim

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

[diff] [blame]

1012

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

1013

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

1014

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

1015

#

1016

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

1017

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

Bu Sun Kim

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

[diff] [blame]

1018

},

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>

1025

<pre>Retrieves the next page of results.

1026

1027

Args:

1028

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

1029

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

1030

1031

Returns:

Bu Sun Kim

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

[diff] [blame]

1032

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]

1033

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]

1038

<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]

1039

<pre>Update an environment.

1040

1041

Args:

1042

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]

1043

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

Dan O'Meara

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

[diff] [blame]

1044

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

1045

The object takes the form of:

1046

1047

{ # An environment for running orchestration tasks.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1048

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

1049

# This value is generated when the environment is created.

Bu Sun Kim

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

[diff] [blame]

1050

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

1051

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

1052

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

1053

#

1054

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

1055

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

1056

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

1057

# size.

1058

"a_key": "A String",

1059

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1060

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

Bu Sun Kim

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

[diff] [blame]

1061

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1062

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

1063

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

1064

# [Airflow web

1065

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

Bu Sun Kim

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

[diff] [blame]

1066

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

1067

# environment.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1068

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

1069

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

1070

# set to true.

Bu Sun Kim

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

[diff] [blame]

1071

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

1072

# Cloud Composer environment.

Bu Sun Kim

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

[diff] [blame]

1073

# environment.

Bu Sun Kim

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

[diff] [blame]

1074

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

1075

# denied.

Bu Sun Kim

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

[diff] [blame]

1076

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

1077

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

1078

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

1079

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

1080

# within the cluster's network.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1081

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

1082

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

Bu Sun Kim

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

[diff] [blame]

1083

},

Bu Sun Kim

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

[diff] [blame]

1084

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

1085

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

1086

# to be disjoint from `private_cluster_config.master_ipv4_cidr_block` and

1087

# `cloud_sql_ipv4_cidr_block`.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1088

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

1089

# Cloud SQL. Needs to be disjoint from `web_server_ipv4_cidr_block`.

Bu Sun Kim

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

[diff] [blame]

1090

},

Bu Sun Kim

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

[diff] [blame]

1091

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1092

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

1093

#

1094

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

1095

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

1096

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

1097

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

1098

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

1099

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

1100

# names must be written in

1101

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

1102

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

1103

#

1104

# Certain Apache Airflow configuration property values are

1105

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

1106

# and cannot be overridden.

1107

"a_key": "A String",

1108

},

1109

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

1110

# scheduler, worker, and webserver processes.

1111

#

1112

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

1113

# updated.

Bu Sun Kim

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

[diff] [blame]

1114

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

1115

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

1116

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

1117

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

1118

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

1119

# supported and denies the request for an unsupported version.

1120

#

1121

# The Cloud Composer portion of the version is a

1122

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

1123

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

1124

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

1125

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

1126

# and stores that version number in the same field.

1127

#

1128

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

1129

# official Apache Airflow repository

1130

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

1131

#

1132

# See also [Version

1133

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1134

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

1135

# the environment.

Bu Sun Kim

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

[diff] [blame]

1136

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1137

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

1138

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

1139

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

1140

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

1141

# the value.

Bu Sun Kim

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

[diff] [blame]

1142

"a_key": "A String",

1143

},

1144

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

1145

# scheduler, worker, and webserver processes.

1146

#

1147

# Environment variable names must match the regular expression

1148

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

1149

# software configuration overrides (they cannot match the regular expression

1150

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

1151

# 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`

"a_key": "A String",

},

Bu Sun Kim

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

[diff] [blame]

1168

},

1169

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

1170

# used to run this environment.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1171

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

1172

# the Apache Airflow software.

1173

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

1174

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

1175

# service account is used. Cannot be updated.

1176

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

1177

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

1178

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

1179

"A String",

1180

],

1181

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

1182

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

1183

# specified as a

1184

# [relative resource

1185

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

1186

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

1187

#

1188

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

1189

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

1190

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

1191

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

1192

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

1193

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

1194

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

1195

# propagated to the unspecified field.

1196

#

1197

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

1198

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

1199

#

1200

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

1201

# to "n1-standard-1".

1202

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

1203

# GKE cluster running the Apache Airflow software.

1204

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

1205

# the GKE cluster.

1206

#

1207

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

1208

#

1209

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

1210

#

1211

# 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)

1216

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

1217

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

1218

# to use.

1219

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

1220

# GKE cluster.

1221

#

1222

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

1223

#

1224

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

1225

#

1226

# 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)

1231

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

1232

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

1233

# to use.

1234

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

1235

# IP addresses to pods.

1236

#

1237

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

1238

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

1239

# IP addresses to the GKE cluster.

1240

#

1241

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

1242

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

1243

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

1244

},

1245

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

1246

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

1247

# [relative resource

1248

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

1249

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

1250

#

1251

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

1252

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

1253

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

1254

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

1255

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

1256

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

1257

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

1258

# propagated to the unspecified field.

1259

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

1260

# communications, specified as a

1261

# [relative resource

1262

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

1263

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

1264

#

1265

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

1266

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

1267

# location.

1268

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

1269

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

1270

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

1271

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

1272

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

# Cannot be updated.

"A String",

],

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

1277

# communications, specified as a

1278

# [relative resource

1279

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

1280

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

1281

#

1282

# [Shared VPC](/vpc/docs/shared-vpc) is not currently supported. The

1283

# network must belong to the environment's project. If unspecified, the

1284

# "default" network ID in the environment's project is used. If a

1285

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

1286

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

1287

},

1288

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

1289

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

1290

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

1291

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

Bu Sun Kim

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

[diff] [blame]

1292

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1293

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

Bu Sun Kim

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

[diff] [blame]

1294

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

1295

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

1296

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

1297

#

1298

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

1299

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

Bu Sun Kim

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

[diff] [blame]

1300

}

Bu Sun Kim

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

[diff] [blame]

1301

1302

updateMask: string, Required. A comma-separated list of paths, relative to `Environment`, of

1303

fields to update.

1304

For example, to set the version of scikit-learn to install in the

1305

environment to 0.19.0 and to remove an existing installation of

1306

numpy, the `updateMask` parameter would include the following two

Bu Sun Kim

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

[diff] [blame]

1307

`paths` values: "config.softwareConfig.pypiPackages.scikit-learn" and

1308

"config.softwareConfig.pypiPackages.numpy". The included patch

Bu Sun Kim

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

[diff] [blame]

1309

environment would specify the scikit-learn version as follows:

1310

1311

{

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

1322

other than scikit-learn and numpy will be unaffected.

1323

Bu Sun Kim

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

[diff] [blame]

1324

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]

1325

For example, one cannot update both the PyPI packages and

1326

labels in the same request. However, it is possible to update multiple

1327

members of a map field simultaneously in the same request. For example,

Bu Sun Kim

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

[diff] [blame]

1328

to set the labels "label1" and "label2" while clearing "label3" (assuming

Bu Sun Kim

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

[diff] [blame]

1329

it already exists), one can

Bu Sun Kim

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

[diff] [blame]

1330

provide the paths "labels.label1", "labels.label2", and "labels.label3"

Bu Sun Kim

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

[diff] [blame]

1331

and populate the patch environment as follows:

1332

1333

{

Bu Sun Kim

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

[diff] [blame]

1334

"labels":{

1335

"label1":"new-label1-value"

1336

"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

1341

included in the `updateMask` will be unaffected.

1342

1343

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]

1344

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]

1345

be that which is provided in the patch environment. For example, to

1346

delete all pre-existing user-specified PyPI packages and

1347

install botocore at version 1.7.14, the `updateMask` would contain

Bu Sun Kim

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

[diff] [blame]

1348

the path "config.softwareConfig.pypiPackages", and

Bu Sun Kim

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

[diff] [blame]

1349

the patch environment would be the following:

1350

1351

{

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]

}

}

}

}

**Note:** Only the following fields can be updated:

1362

Dan O'Meara

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

[diff] [blame]

<table>

<tbody>

<tr>

<td><strong>Purpose</strong></td>

1368

</tr>

1369

<tr>

1370

<td>config.softwareConfig.pypiPackages

1371

</td>

1372

<td>Replace all custom custom PyPI packages. If a replacement

Bu Sun Kim

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

[diff] [blame]

1373

package map is not included in `environment`, all custom

1374

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]

1375

mask specifying an individual package.</td>

1376

</tr>

1377

<tr>

1378

<td>config.softwareConfig.pypiPackages.<var>packagename</var></td>

1379

<td>Update the custom PyPI package <var>packagename</var>,

Bu Sun Kim

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

[diff] [blame]

1380

preserving other packages. To delete the package, include it in

1381

`updateMask`, and omit the mapping for it in

1382

`environment.config.softwareConfig.pypiPackages`. It is an error

1383

to provide both a mask of this form and the

Bu Sun Kim

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

[diff] [blame]

1384

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

1389

included in `environment`, all labels are cleared. It is an error to

1390

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>

1395

<td>Set the label named <var>labelName</var>, while preserving other

Bu Sun Kim

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

[diff] [blame]

1396

labels. To delete the label, include it in `updateMask` and omit its

1397

mapping in `environment.labels`. It is an error to provide both a

Bu Sun Kim

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

[diff] [blame]

1398

mask of this form and the "labels" mask.</td>

Dan O'Meara

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

[diff] [blame]

1399

</tr>

1400

<tr>

1401

<td>config.nodeCount</td>

1402

<td>Horizontally scale the number of nodes in the environment. An integer

Bu Sun Kim

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

[diff] [blame]

1403

greater than or equal to 3 must be provided in the `config.nodeCount`

1404

field.

Dan O'Meara

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

[diff] [blame]

</td>

</tr>

<tr>

<td>config.softwareConfig.airflowConfigOverrides</td>

1409

<td>Replace all Apache Airflow config overrides. If a replacement config

Bu Sun Kim

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

[diff] [blame]

1410

overrides map is not included in `environment`, all config overrides

1411

are cleared.

1412

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]

1413

more individual config overrides.</td>

1414

</tr>

1415

<tr>

1416

<td>config.softwareConfig.airflowConfigOverrides.<var>section</var>-<var>name

1417

</var></td>

1418

<td>Override the Apache Airflow config property <var>name</var> in the

1419

section named <var>section</var>, preserving other properties. To delete

Bu Sun Kim

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

[diff] [blame]

1420

the property override, include it in `updateMask` and omit its mapping

1421

in `environment.config.softwareConfig.airflowConfigOverrides`.

1422

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]

1423

"config.softwareConfig.airflowConfigOverrides" mask.</td>

Dan O'Meara

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

[diff] [blame]

1424

</tr>

1425

<tr>

1426

<td>config.softwareConfig.envVariables</td>

1427

<td>Replace all environment variables. If a replacement environment

Bu Sun Kim

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

[diff] [blame]

1428

variable map is not included in `environment`, all custom environment

1429

variables are cleared.

1430

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]

1431

more individual environment variables.</td>

1432

</tr>

1433

</tbody>

1434

</table>

Bu Sun Kim

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

[diff] [blame]

1435

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1442

1443

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

1444

# network API call.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1445

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

1446

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

1447

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

Bu Sun Kim

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

[diff] [blame]

1448

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

1449

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

1450

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

1451

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

1452

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

1453

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

1454

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

1455

# `TakeSnapshotResponse`.

Bu Sun Kim

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

[diff] [blame]

1456

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

Bu Sun Kim

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

[diff] [blame]

1457

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1458

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

1459

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

1460

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

1461

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

1462

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

1463

},

1464

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

1465

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

1466

# available.

Bu Sun Kim