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-05-27 12:20:54 -0700

[diff] [blame^]

107

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

108

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

109

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

110

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

111

#

112

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

113

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

114

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

# size.

"a_key": "A String",

},

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

119

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

120

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

121

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

122

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

123

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

124

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

125

# environment.

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.

131

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

132

# denied.

133

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

134

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

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.

140

},

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

145

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

146

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

147

# set to true.

148

},

149

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

150

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

151

# the Apache Airflow software.

152

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

153

# communications, specified as a

154

# [relative resource

155

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

156

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

157

#

158

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

159

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

160

# location.

161

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

162

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

163

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

164

# GKE cluster running the Apache Airflow software.

165

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

166

# GKE cluster.

167

#

168

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

169

#

170

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

171

#

172

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

177

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

178

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

179

# to use.

180

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

181

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

182

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

183

# IP addresses to the GKE cluster.

184

#

185

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

186

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

187

# IP addresses to pods.

188

#

189

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

190

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

191

# the GKE cluster.

192

#

193

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

194

#

195

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

196

#

197

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

202

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

203

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

204

# to use.

205

},

206

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

207

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

208

# 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

213

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

214

# service account is used. Cannot be updated.

215

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

216

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

217

# [relative resource

218

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

219

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

220

#

221

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

222

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

223

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

224

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

225

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

226

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

227

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

228

# propagated to the unspecified field.

229

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

230

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

231

# specified as a

232

# [relative resource

233

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

234

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

235

#

236

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

237

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

238

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

239

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

240

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

241

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

242

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

243

# propagated to the unspecified field.

244

#

245

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

246

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

247

#

248

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

249

# to "n1-standard-1".

250

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

251

# communications, specified as a

252

# [relative resource

253

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

254

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

255

#

256

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

257

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

258

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

259

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

260

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

261

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

262

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

263

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

"A String",

],

},

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

268

# [Airflow web

269

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

270

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

271

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

272

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

273

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

274

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

275

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

276

# supported and denies the request for an unsupported version.

277

#

278

# The Cloud Composer portion of the version is a

279

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

280

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

281

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

282

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

283

# and stores that version number in the same field.

284

#

285

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

286

# official Apache Airflow repository

287

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

288

#

289

# See also [Version

290

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

291

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

292

#

293

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

294

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

295

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

296

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

297

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

298

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

299

# names must be written in

300

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

301

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

302

#

303

# Certain Apache Airflow configuration property values are

304

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

305

# and cannot be overridden.

306

"a_key": "A String",

307

},

308

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

309

# scheduler, worker, and webserver processes.

310

#

311

# Environment variable names must match the regular expression

312

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

313

# software configuration overrides (they cannot match the regular expression

314

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

315

# 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",

},

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

333

# scheduler, worker, and webserver processes.

334

#

335

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

336

# updated.

337

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

338

# the environment.

339

#

340

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

341

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

342

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

343

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

# the value.

"a_key": "A String",

},

},

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

349

# used to run this environment.

350

},

351

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

352

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

353

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

354

#

355

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

356

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

357

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

358

# This value is generated when the environment is created.

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.

371

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

372

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

373

# available.

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

},

384

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

385

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

386

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

387

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

388

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

389

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

390

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

391

#

392

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

393

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

394

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

395

# message types for APIs to use.

396

{

397

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

398

},

399

],

400

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

401

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

402

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

403

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

404

},

405

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

406

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

407

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

408

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

409

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

},

}</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.

431

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

432

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

433

# available.

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

},

444

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

445

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

446

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

447

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

448

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

449

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

450

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

451

#

452

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

453

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

454

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

455

# message types for APIs to use.

456

{

457

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

458

},

459

],

460

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

461

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

462

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

463

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

464

},

465

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

466

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

467

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

468

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

469

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

},

}</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.

490

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

491

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

Bu Sun Kim

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

[diff] [blame]

492

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

493

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

Bu Sun Kim

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

[diff] [blame^]

494

#

Bu Sun Kim

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

[diff] [blame]

495

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

496

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

497

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

Bu Sun Kim

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

[diff] [blame]

498

# size.

Bu Sun Kim

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

[diff] [blame]

499

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

500

},

Bu Sun Kim

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

[diff] [blame]

501

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

502

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

503

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

504

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

Bu Sun Kim

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

[diff] [blame]

505

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

Bu Sun Kim

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

[diff] [blame]

506

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

Bu Sun Kim

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

[diff] [blame]

507

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

508

# environment.

509

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

510

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

511

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

512

# Cloud Composer environment.

513

# environment.

Bu Sun Kim

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

[diff] [blame]

514

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

515

# denied.

Bu Sun Kim

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

[diff] [blame^]

516

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

517

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

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

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

[diff] [blame]

523

},

Bu Sun Kim

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

[diff] [blame]

524

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

525

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

526

# to be disjoint from `private_cluster_config.master_ipv4_cidr_block` and

527

# `cloud_sql_ipv4_cidr_block`.

528

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

529

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

530

# set to true.

531

},

Bu Sun Kim

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

[diff] [blame^]

532

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

Bu Sun Kim

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

[diff] [blame]

533

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

534

# the Apache Airflow software.

Bu Sun Kim

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

[diff] [blame^]

535

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

536

# communications, specified as a

537

# [relative resource

538

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

539

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

540

#

541

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

542

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

543

# location.

544

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

545

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

546

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

547

# GKE cluster running the Apache Airflow software.

548

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

549

# GKE cluster.

550

#

551

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

552

#

553

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

554

#

555

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

560

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

561

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

562

# to use.

563

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

564

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

565

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

566

# IP addresses to the GKE cluster.

567

#

568

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

569

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

570

# IP addresses to pods.

571

#

572

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

573

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

574

# the GKE cluster.

575

#

576

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

577

#

578

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

579

#

580

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

585

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

586

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

587

# to use.

588

},

589

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

590

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

591

# 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

596

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

597

# service account is used. Cannot be updated.

Bu Sun Kim

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

[diff] [blame]

598

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

599

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

600

# [relative resource

601

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

602

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

Bu Sun Kim

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

[diff] [blame]

603

#

Bu Sun Kim

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

[diff] [blame]

604

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

605

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

606

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

607

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

608

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

609

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

610

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

611

# propagated to the unspecified field.

612

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

613

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

614

# specified as a

615

# [relative resource

616

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

617

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

618

#

619

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

620

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

621

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

622

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

623

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

624

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

625

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

626

# propagated to the unspecified field.

627

#

628

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

629

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

630

#

631

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

632

# to "n1-standard-1".

633

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

634

# communications, specified as a

635

# [relative resource

636

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

637

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

638

#

639

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

640

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

641

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

642

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

643

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

644

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

645

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

646

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

647

"A String",

648

],

Bu Sun Kim

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

[diff] [blame]

649

},

650

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

651

# [Airflow web

652

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

653

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

Bu Sun Kim

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

[diff] [blame^]

654

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

655

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

656

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

657

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

658

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

659

# supported and denies the request for an unsupported version.

660

#

661

# The Cloud Composer portion of the version is a

662

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

663

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

664

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

665

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

666

# and stores that version number in the same field.

667

#

668

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

669

# official Apache Airflow repository

670

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

671

#

672

# See also [Version

673

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

674

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

675

#

676

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

677

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

678

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

679

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

680

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

681

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

682

# names must be written in

683

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

684

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

685

#

686

# Certain Apache Airflow configuration property values are

687

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

688

# and cannot be overridden.

689

"a_key": "A String",

690

},

Bu Sun Kim

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

[diff] [blame]

691

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

Bu Sun Kim

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

[diff] [blame]

692

# scheduler, worker, and webserver processes.

693

#

694

# Environment variable names must match the regular expression

695

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

696

# software configuration overrides (they cannot match the regular expression

697

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

698

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

713

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

714

},

Bu Sun Kim

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

[diff] [blame]

715

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

716

# scheduler, worker, and webserver processes.

717

#

718

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

719

# updated.

720

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

721

# the environment.

722

#

723

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

724

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

725

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

726

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

727

# the value.

728

"a_key": "A String",

729

},

Bu Sun Kim

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

[diff] [blame]

730

},

Bu Sun Kim

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

[diff] [blame]

731

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

732

# used to run this environment.

733

},

Bu Sun Kim

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

[diff] [blame]

734

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

735

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

736

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

Bu Sun Kim

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

[diff] [blame^]

737

#

Dan O'Meara

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

[diff] [blame]

738

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

739

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

Bu Sun Kim

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

[diff] [blame]

740

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

741

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

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-05-20 12:08:20 -0700

[diff] [blame]

763

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

Bu Sun Kim

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

[diff] [blame]

764

{ # An environment for running orchestration tasks.

Bu Sun Kim

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

[diff] [blame^]

765

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

766

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

767

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

768

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

769

#

770

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

771

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

772

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

773

# size.

774

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

775

},

Bu Sun Kim

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

[diff] [blame^]

776

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

777

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

778

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

779

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

780

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

781

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

782

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

783

# environment.

784

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

785

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

786

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

787

# Cloud Composer environment.

788

# environment.

789

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

790

# denied.

791

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

792

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

793

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

794

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

795

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

796

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

797

# within the cluster's network.

798

},

799

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

800

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

801

# to be disjoint from `private_cluster_config.master_ipv4_cidr_block` and

802

# `cloud_sql_ipv4_cidr_block`.

803

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

804

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

805

# set to true.

806

},

807

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

808

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

809

# the Apache Airflow software.

810

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

811

# communications, specified as a

812

# [relative resource

813

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

814

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

815

#

816

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

817

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

818

# location.

819

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

820

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

821

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

822

# GKE cluster running the Apache Airflow software.

823

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

824

# GKE cluster.

825

#

826

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

827

#

828

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

829

#

830

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

835

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

836

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

837

# to use.

838

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

839

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

840

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

841

# IP addresses to the GKE cluster.

842

#

843

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

844

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

845

# IP addresses to pods.

846

#

847

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

848

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

849

# the GKE cluster.

850

#

851

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

852

#

853

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

854

#

855

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

860

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

861

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

862

# to use.

863

},

864

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

865

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

866

# 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

871

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

872

# service account is used. Cannot be updated.

873

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

874

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

875

# [relative resource

876

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

877

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

878

#

879

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

880

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

881

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

882

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

883

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

884

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

885

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

886

# propagated to the unspecified field.

887

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

888

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

889

# specified as a

890

# [relative resource

891

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

892

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

893

#

894

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

895

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

896

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

897

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

898

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

899

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

900

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

901

# propagated to the unspecified field.

902

#

903

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

904

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

905

#

906

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

907

# to "n1-standard-1".

908

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

909

# communications, specified as a

910

# [relative resource

911

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

912

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

913

#

914

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

915

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

916

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

917

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

918

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

919

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

920

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

921

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

"A String",

],

},

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

926

# [Airflow web

927

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

928

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

929

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

930

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

931

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

932

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

933

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

934

# supported and denies the request for an unsupported version.

935

#

936

# The Cloud Composer portion of the version is a

937

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

938

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

939

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

940

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

941

# and stores that version number in the same field.

942

#

943

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

944

# official Apache Airflow repository

945

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

946

#

947

# See also [Version

948

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

949

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

950

#

951

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

952

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

953

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

954

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

955

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

956

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

957

# names must be written in

958

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

959

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

960

#

961

# Certain Apache Airflow configuration property values are

962

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

963

# and cannot be overridden.

964

"a_key": "A String",

965

},

966

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

967

# scheduler, worker, and webserver processes.

968

#

969

# Environment variable names must match the regular expression

970

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

971

# software configuration overrides (they cannot match the regular expression

972

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

973

# 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",

},

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

991

# scheduler, worker, and webserver processes.

992

#

993

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

994

# updated.

995

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

996

# the environment.

997

#

998

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

999

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

1000

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

1001

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

# the value.

"a_key": "A String",

},

},

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

1007

# used to run this environment.

1008

},

1009

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

1010

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

1011

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

1012

#

1013

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

1014

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

1015

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

1016

# This value is generated when the environment is created.

1017

},

Bu Sun Kim

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

[diff] [blame]

1018

],

Bu Sun Kim

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

[diff] [blame]

1019

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

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-05-27 12:20:54 -0700

[diff] [blame^]

1048

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

1049

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

1050

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

1051

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

1052

#

1053

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

1054

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

1055

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

# size.

"a_key": "A String",

},

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

1060

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

1061

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

1062

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

1063

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

1064

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

1065

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

1066

# environment.

1067

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

1068

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

1069

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

1070

# Cloud Composer environment.

Bu Sun Kim

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

[diff] [blame]

1071

# environment.

Bu Sun Kim

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

[diff] [blame^]

1072

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

1073

# denied.

1074

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

1075

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

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-05-20 12:08:20 -0700

[diff] [blame]

1081

},

Bu Sun Kim

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

[diff] [blame^]

1082

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

1083

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

1084

# to be disjoint from `private_cluster_config.master_ipv4_cidr_block` and

1085

# `cloud_sql_ipv4_cidr_block`.

1086

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

1087

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

1088

# set to true.

Bu Sun Kim

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

[diff] [blame]

1089

},

Bu Sun Kim

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

[diff] [blame^]

1090

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

1091

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

1092

# the Apache Airflow software.

1093

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

1094

# communications, specified as a

1095

# [relative resource

1096

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

1097

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

1098

#

1099

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

1100

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

1101

# location.

1102

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

1103

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

1104

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

1105

# GKE cluster running the Apache Airflow software.

1106

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

1107

# GKE cluster.

1108

#

1109

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

1110

#

1111

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

1112

#

1113

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

1118

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

1119

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

1120

# to use.

1121

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

1122

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

1123

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

1124

# IP addresses to the GKE cluster.

1125

#

1126

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

1127

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

1128

# IP addresses to pods.

1129

#

1130

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

1131

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

1132

# the GKE cluster.

1133

#

1134

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

1135

#

1136

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

1137

#

1138

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

1143

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

1144

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

1145

# to use.

1146

},

1147

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

1148

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

1149

# 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

1154

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

1155

# service account is used. Cannot be updated.

1156

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

1157

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

1158

# [relative resource

1159

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

1160

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

1161

#

1162

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

1163

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

1164

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

1165

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

1166

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

1167

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

1168

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

1169

# propagated to the unspecified field.

1170

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

1171

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

1172

# specified as a

1173

# [relative resource

1174

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

1175

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

1176

#

1177

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

1178

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

1179

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

1180

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

1181

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

1182

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

1183

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

1184

# propagated to the unspecified field.

1185

#

1186

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

1187

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

1188

#

1189

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

1190

# to "n1-standard-1".

1191

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

1192

# communications, specified as a

1193

# [relative resource

1194

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

1195

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

1196

#

1197

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

1198

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

1199

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

1200

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

1201

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

1202

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

1203

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

1204

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

"A String",

],

},

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

1209

# [Airflow web

1210

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

1211

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

1212

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

1213

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

1214

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

1215

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

1216

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

1217

# supported and denies the request for an unsupported version.

1218

#

1219

# The Cloud Composer portion of the version is a

1220

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

1221

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

1222

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

1223

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

1224

# and stores that version number in the same field.

1225

#

1226

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

1227

# official Apache Airflow repository

1228

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

1229

#

1230

# See also [Version

1231

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

1232

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

1233

#

1234

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

1235

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

1236

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

1237

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

1238

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

1239

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

1240

# names must be written in

1241

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

1242

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

1243

#

1244

# Certain Apache Airflow configuration property values are

1245

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

1246

# and cannot be overridden.

1247

"a_key": "A String",

1248

},

1249

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

1250

# scheduler, worker, and webserver processes.

1251

#

1252

# Environment variable names must match the regular expression

1253

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

1254

# software configuration overrides (they cannot match the regular expression

1255

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

1256

# 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",

},

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

1274

# scheduler, worker, and webserver processes.

1275

#

1276

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

1277

# updated.

1278

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

1279

# the environment.

1280

#

1281

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

1282

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

1283

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

1284

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

# the value.

"a_key": "A String",

},

},

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

1290

# used to run this environment.

1291

},

1292

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

1293

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

1294

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

1295

#

1296

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

1297

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

1298

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

1299

# This value is generated when the environment is created.

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-05-20 12:08:20 -0700

[diff] [blame]

1445

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

1446

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

1447

# available.

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-05-20 12:08:20 -0700

[diff] [blame]

1458

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

Bu Sun Kim

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

[diff] [blame]

1459

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

1460

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

Bu Sun Kim