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

[diff] [blame]

107

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

Bu Sun Kim

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

[diff] [blame]

108

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

109

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

110

#

111

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

112

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

Dan O'Meara

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

[diff] [blame]

113

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

Bu Sun Kim

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

[diff] [blame]

114

# size.

Bu Sun Kim

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

[diff] [blame]

115

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

116

},

Bu Sun Kim

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

[diff] [blame]

117

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

118

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

119

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

120

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

Bu Sun Kim

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

[diff] [blame]

121

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

Bu Sun Kim

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

[diff] [blame]

122

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

Bu Sun Kim

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

[diff] [blame]

123

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

Bu Sun Kim

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

[diff] [blame]

124

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

125

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

126

# environment.

127

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

128

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

129

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

130

# Cloud Composer environment.

131

# environment.

132

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

133

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

134

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

135

# denied.

136

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

137

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

138

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

139

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

140

# within the cluster's network.

Bu Sun Kim

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

[diff] [blame]

141

},

Bu Sun Kim

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

[diff] [blame]

142

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

143

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

144

# to be disjoint from `private_cluster_config.master_ipv4_cidr_block` and

145

# `cloud_sql_ipv4_cidr_block`.

146

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

147

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

148

# set to true.

149

},

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

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

153

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

154

# [relative resource

155

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

156

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

Bu Sun Kim

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

[diff] [blame]

157

#

Bu Sun Kim

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

[diff] [blame]

158

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

159

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

160

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

161

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

162

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

163

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

164

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

165

# propagated to the unspecified field.

166

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

167

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

168

# specified as a

169

# [relative resource

170

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

171

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

172

#

173

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

174

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

175

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

176

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

177

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

178

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

179

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

180

# propagated to the unspecified field.

181

#

182

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

183

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

184

#

185

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

186

# to "n1-standard-1".

187

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

188

# communications, specified as a

189

# [relative resource

190

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

191

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

192

#

193

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

194

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

195

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

196

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

197

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

198

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

199

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

200

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

201

"A String",

202

],

203

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

204

# communications, specified as a

205

# [relative resource

206

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

207

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

208

#

209

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

210

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

211

# location.

212

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

213

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

214

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

215

# GKE cluster running the Apache Airflow software.

216

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

217

# GKE cluster.

218

#

219

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

220

#

221

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

222

#

223

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

228

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

229

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

230

# to use.

231

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

232

# IP addresses to the GKE cluster.

233

#

234

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

235

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

236

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

237

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

238

# the GKE cluster.

239

#

240

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

241

#

242

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

243

#

244

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

249

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

250

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

251

# to use.

252

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

253

# IP addresses to pods.

254

#

255

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

256

},

257

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

258

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

259

# 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

264

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

265

# service account is used. Cannot be updated.

266

},

267

"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

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

Bu Sun Kim

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

[diff] [blame]

272

# scheduler, worker, and webserver processes.

273

#

274

# Environment variable names must match the regular expression

275

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

276

# software configuration overrides (they cannot match the regular expression

277

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

278

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

293

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

294

},

Bu Sun Kim

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

[diff] [blame]

295

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

296

# scheduler, worker, and webserver processes.

297

#

298

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

299

# updated.

300

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

301

# the environment.

302

#

303

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

304

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

305

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

306

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

# the value.

"a_key": "A String",

},

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

311

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

312

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

313

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

314

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

315

# supported and denies the request for an unsupported version.

316

#

317

# The Cloud Composer portion of the version is a

318

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

319

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

320

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

321

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

322

# and stores that version number in the same field.

323

#

324

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

325

# official Apache Airflow repository

326

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

327

#

328

# See also [Version

329

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

330

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

Bu Sun Kim

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

[diff] [blame]

331

#

332

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

Bu Sun Kim

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

[diff] [blame]

333

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

334

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

335

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

336

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

337

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

Bu Sun Kim

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

[diff] [blame]

338

# names must be written in

339

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

340

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

341

#

342

# Certain Apache Airflow configuration property values are

343

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

344

# and cannot be overridden.

Bu Sun Kim

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

[diff] [blame]

345

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

346

},

347

},

Bu Sun Kim

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

[diff] [blame]

348

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

349

# used to run this environment.

350

},

Bu Sun Kim

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

[diff] [blame]

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

Dan O'Meara

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

[diff] [blame]

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.

Bu Sun Kim

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

[diff] [blame]

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.

Bu Sun Kim

2019-06-14 16:50:42 -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-05-20 12:08:20 -0700

[diff] [blame]

371

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

Bu Sun Kim

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

[diff] [blame]

372

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

373

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

374

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

Bu Sun Kim

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

[diff] [blame]

375

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

Bu Sun Kim

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

[diff] [blame]

376

},

Bu Sun Kim

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

[diff] [blame]

377

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

378

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

379

# available.

Bu Sun Kim

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

[diff] [blame]

380

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

381

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

382

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

383

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

384

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

385

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

386

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

387

# `TakeSnapshotResponse`.

Bu Sun Kim

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

[diff] [blame]

388

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

Bu Sun Kim

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

[diff] [blame]

389

},

Bu Sun Kim

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

[diff] [blame]

390

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

391

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

392

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

Bu Sun Kim

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

"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

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

405

# message types for APIs to use.

406

{

407

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

408

},

409

],

410

},

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

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

416

<pre>Delete an environment.

417

418

Args:

419

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

Bu Sun Kim

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

[diff] [blame]

420

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

Bu Sun Kim

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

[diff] [blame]

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

[diff] [blame]

431

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

Bu Sun Kim

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

[diff] [blame]

432

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

433

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

434

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

Bu Sun Kim

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

[diff] [blame]

435

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

Bu Sun Kim

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

[diff] [blame]

436

},

Bu Sun Kim

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

[diff] [blame]

437

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

438

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

439

# available.

Bu Sun Kim

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

[diff] [blame]

440

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

441

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

442

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

443

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

444

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

445

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

446

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

447

# `TakeSnapshotResponse`.

Bu Sun Kim

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

[diff] [blame]

448

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

Bu Sun Kim

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

[diff] [blame]

449

},

Bu Sun Kim

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

[diff] [blame]

450

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

451

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

452

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

Bu Sun Kim

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

"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

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

465

# message types for APIs to use.

466

{

467

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

468

},

469

],

470

},

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

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

476

<pre>Get an existing environment.

477

478

Args:

479

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

Bu Sun Kim

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

[diff] [blame]

480

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

Bu Sun Kim

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

[diff] [blame]

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

[diff] [blame]

490

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

Bu Sun Kim

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

[diff] [blame]

491

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

492

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

493

#

494

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

495

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

496

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

Bu Sun Kim

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

[diff] [blame]

497

# size.

Bu Sun Kim

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

[diff] [blame]

498

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

499

},

Bu Sun Kim

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

[diff] [blame]

500

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

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

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

508

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

509

# environment.

510

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

511

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

512

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

513

# Cloud Composer environment.

514

# environment.

515

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

516

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

517

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

518

# denied.

519

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

520

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

521

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

522

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

523

# within the cluster's network.

Bu Sun Kim

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

[diff] [blame]

524

},

Bu Sun Kim

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

[diff] [blame]

525

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

526

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

527

# to be disjoint from `private_cluster_config.master_ipv4_cidr_block` and

528

# `cloud_sql_ipv4_cidr_block`.

529

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

530

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

531

# set to true.

532

},

533

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

534

# the Apache Airflow software.

535

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

536

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

537

# [relative resource

538

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

539

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

Bu Sun Kim

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

[diff] [blame]

540

#

Bu Sun Kim

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

[diff] [blame]

541

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

542

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

543

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

544

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

545

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

546

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

547

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

548

# propagated to the unspecified field.

549

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

550

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

551

# specified as a

552

# [relative resource

553

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

554

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

555

#

556

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

557

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

558

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

559

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

560

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

561

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

562

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

563

# propagated to the unspecified field.

564

#

565

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

566

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

567

#

568

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

569

# to "n1-standard-1".

570

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

571

# communications, specified as a

572

# [relative resource

573

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

574

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

575

#

576

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

577

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

578

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

579

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

580

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

581

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

582

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

583

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

584

"A String",

585

],

586

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

587

# communications, specified as a

588

# [relative resource

589

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

590

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

591

#

592

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

593

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

594

# location.

595

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

596

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

597

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

598

# GKE cluster running the Apache Airflow software.

599

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

600

# GKE cluster.

601

#

602

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

603

#

604

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

605

#

606

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

611

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

612

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

613

# to use.

614

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

615

# IP addresses to the GKE cluster.

616

#

617

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

618

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

619

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

620

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

621

# the GKE cluster.

622

#

623

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

624

#

625

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

626

#

627

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

632

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

633

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

634

# to use.

635

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

636

# IP addresses to pods.

637

#

638

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

639

},

640

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

641

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

642

# 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

647

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

648

# service account is used. Cannot be updated.

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.

654

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

Bu Sun Kim

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

[diff] [blame]

655

# scheduler, worker, and webserver processes.

656

#

657

# Environment variable names must match the regular expression

658

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

659

# software configuration overrides (they cannot match the regular expression

660

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

661

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

676

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

677

},

Bu Sun Kim

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

[diff] [blame]

678

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

679

# scheduler, worker, and webserver processes.

680

#

681

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

682

# updated.

683

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

684

# the environment.

685

#

686

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

687

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

688

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

689

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

# the value.

"a_key": "A String",

},

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

694

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

695

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

696

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

697

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

698

# supported and denies the request for an unsupported version.

699

#

700

# The Cloud Composer portion of the version is a

701

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

702

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

703

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

704

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

705

# and stores that version number in the same field.

706

#

707

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

708

# official Apache Airflow repository

709

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

710

#

711

# See also [Version

712

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

713

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

Bu Sun Kim

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

[diff] [blame]

714

#

715

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

Bu Sun Kim

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

[diff] [blame]

716

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

717

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

718

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

719

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

720

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

Bu Sun Kim

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

[diff] [blame]

721

# names must be written in

722

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

723

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

724

#

725

# Certain Apache Airflow configuration property values are

726

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

727

# and cannot be overridden.

Bu Sun Kim

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

[diff] [blame]

728

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

729

},

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

Dan O'Meara

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

[diff] [blame]

737

#

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

[diff] [blame]

765

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

Bu Sun Kim

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

[diff] [blame]

766

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

767

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

768

#

769

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

770

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

771

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

Bu Sun Kim

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

[diff] [blame]

772

# size.

Bu Sun Kim

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

[diff] [blame]

773

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

774

},

Bu Sun Kim

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

[diff] [blame]

775

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

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

Bu Sun Kim

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

[diff] [blame]

779

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

Bu Sun Kim

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

[diff] [blame]

780

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

Bu Sun Kim

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

[diff] [blame]

781

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

Bu Sun Kim

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

[diff] [blame]

782

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

783

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

784

# environment.

785

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

786

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

787

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

788

# Cloud Composer environment.

789

# environment.

790

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

791

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

792

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

793

# denied.

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

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

[diff] [blame]

799

},

Bu Sun Kim

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

[diff] [blame]

800

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

801

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

802

# to be disjoint from `private_cluster_config.master_ipv4_cidr_block` and

803

# `cloud_sql_ipv4_cidr_block`.

804

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

805

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

806

# set to true.

807

},

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

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

811

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

812

# [relative resource

813

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

814

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

Bu Sun Kim

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

[diff] [blame]

815

#

Bu Sun Kim

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

[diff] [blame]

816

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

817

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

818

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

819

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

820

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

821

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

822

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

823

# propagated to the unspecified field.

824

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

825

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

826

# specified as a

827

# [relative resource

828

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

829

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

830

#

831

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

832

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

833

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

834

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

835

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

836

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

837

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

838

# propagated to the unspecified field.

839

#

840

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

841

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

842

#

843

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

844

# to "n1-standard-1".

845

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

846

# communications, specified as a

847

# [relative resource

848

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

849

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

850

#

851

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

852

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

853

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

854

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

855

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

856

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

857

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

858

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

859

"A String",

860

],

861

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

862

# communications, specified as a

863

# [relative resource

864

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

865

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

866

#

867

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

868

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

869

# location.

870

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

871

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

872

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

873

# GKE cluster running the Apache Airflow software.

874

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

875

# GKE cluster.

876

#

877

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

878

#

879

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

880

#

881

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

886

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

887

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

888

# to use.

889

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

890

# IP addresses to the GKE cluster.

891

#

892

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

893

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

894

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

895

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

896

# the GKE cluster.

897

#

898

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

899

#

900

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

901

#

902

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

907

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

908

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

909

# to use.

910

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

911

# IP addresses to pods.

912

#

913

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

914

},

915

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

916

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

917

# 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

922

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

923

# service account is used. Cannot be updated.

924

},

925

"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

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

Bu Sun Kim

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

[diff] [blame]

930

# scheduler, worker, and webserver processes.

931

#

932

# Environment variable names must match the regular expression

933

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

934

# software configuration overrides (they cannot match the regular expression

935

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

936

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

951

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

952

},

Bu Sun Kim

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

[diff] [blame]

953

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

954

# scheduler, worker, and webserver processes.

955

#

956

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

957

# updated.

958

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

959

# the environment.

960

#

961

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

962

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

963

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

964

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

# the value.

"a_key": "A String",

},

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

969

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

970

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

971

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

972

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

973

# supported and denies the request for an unsupported version.

974

#

975

# The Cloud Composer portion of the version is a

976

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

977

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

978

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

979

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

980

# and stores that version number in the same field.

981

#

982

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

983

# official Apache Airflow repository

984

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

985

#

986

# See also [Version

987

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

988

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

Bu Sun Kim

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

[diff] [blame]

989

#

990

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

Bu Sun Kim

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

[diff] [blame]

991

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

992

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

993

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

994

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

995

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

Bu Sun Kim

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

[diff] [blame]

996

# names must be written in

997

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

998

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

999

#

1000

# Certain Apache Airflow configuration property values are

1001

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

1002

# and cannot be overridden.

Bu Sun Kim

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

[diff] [blame]

1003

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

1004

},

1005

},

Bu Sun Kim

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

[diff] [blame]

1006

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

1007

# used to run this environment.

1008

},

Bu Sun Kim

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

[diff] [blame]

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

Dan O'Meara

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

[diff] [blame]

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.

Bu Sun Kim

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

[diff] [blame]

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.

Bu Sun Kim

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

[diff] [blame]

1017

},

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

[diff] [blame]

1048

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

Bu Sun Kim

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

[diff] [blame]

1049

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

1050

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

1051

#

1052

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

1053

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

1054

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

Bu Sun Kim

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

[diff] [blame]

1055

# size.

Bu Sun Kim

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

[diff] [blame]

1056

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

1057

},

Bu Sun Kim

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

[diff] [blame]

1058

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

1059

"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

Bu Sun Kim

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

[diff] [blame]

1062

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

Bu Sun Kim

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

[diff] [blame]

1063

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

Bu Sun Kim

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

[diff] [blame]

1064

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

Bu Sun Kim

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

[diff] [blame]

1065

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

1066

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

1067

# environment.

1068

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

1069

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

1070

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

1071

# Cloud Composer environment.

1072

# environment.

1073

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

1074

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

1075

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

1076

# denied.

1077

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

1078

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

1079

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

1080

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

1081

# within the cluster's network.

Bu Sun Kim

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

[diff] [blame]

1082

},

Bu Sun Kim

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

[diff] [blame]

1083

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

1084

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

1085

# to be disjoint from `private_cluster_config.master_ipv4_cidr_block` and

1086

# `cloud_sql_ipv4_cidr_block`.

1087

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

1088

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

1089

# set to true.

1090

},

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

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

1094

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

1095

# [relative resource

1096

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

1097

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

Bu Sun Kim

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

[diff] [blame]

1098

#

Bu Sun Kim

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

[diff] [blame]

1099

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

1100

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

1101

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

1102

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

1103

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

1104

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

1105

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

1106

# propagated to the unspecified field.

1107

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

1108

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

1109

# specified as a

1110

# [relative resource

1111

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

1112

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

1113

#

1114

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

1115

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

1116

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

1117

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

1118

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

1119

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

1120

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

1121

# propagated to the unspecified field.

1122

#

1123

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

1124

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

1125

#

1126

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

1127

# to "n1-standard-1".

1128

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

1129

# communications, specified as a

1130

# [relative resource

1131

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

1132

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

1133

#

1134

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

1135

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

1136

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

1137

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

1138

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

1139

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

1140

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

1141

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

1142

"A String",

1143

],

1144

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

1145

# communications, specified as a

1146

# [relative resource

1147

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

1148

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

1149

#

1150

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

1151

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

1152

# location.

1153

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

1154

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

1155

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

1156

# GKE cluster running the Apache Airflow software.

1157

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

1158

# GKE cluster.

1159

#

1160

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

1161

#

1162

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

1163

#

1164

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

1169

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

1170

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

1171

# to use.

1172

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

1173

# IP addresses to the GKE cluster.

1174

#

1175

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

1176

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

1177

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

1178

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

1179

# the GKE cluster.

1180

#

1181

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

1182

#

1183

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

1184

#

1185

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

1190

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

1191

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

1192

# to use.

1193

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

1194

# IP addresses to pods.

1195

#

1196

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

1197

},

1198

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

1199

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

1200

# 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

1205

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

1206

# service account is used. Cannot be updated.

1207

},

1208

"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

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

Bu Sun Kim

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

[diff] [blame]

1213

# scheduler, worker, and webserver processes.

1214

#

1215

# Environment variable names must match the regular expression

1216

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

1217

# software configuration overrides (they cannot match the regular expression

1218

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

1219

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

1234

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

1235

},

Bu Sun Kim

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

[diff] [blame]

1236

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

1237

# scheduler, worker, and webserver processes.

1238

#

1239

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

1240

# updated.

1241

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

1242

# the environment.

1243

#

1244

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

1245

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

1246

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

1247

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

# the value.

"a_key": "A String",

},

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

1252

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

1253

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

1254

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

1255

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

1256

# supported and denies the request for an unsupported version.

1257

#

1258

# The Cloud Composer portion of the version is a

1259

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

1260

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

1261

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

1262

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

1263

# and stores that version number in the same field.

1264

#

1265

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

1266

# official Apache Airflow repository

1267

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

1268

#

1269

# See also [Version

1270

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

1271

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

Bu Sun Kim

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

[diff] [blame]

1272

#

1273

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

Bu Sun Kim

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

[diff] [blame]

1274

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

1275

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

1276

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

1277

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

1278

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

Bu Sun Kim

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

[diff] [blame]

1279

# names must be written in

1280

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

1281

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

1282

#

1283

# Certain Apache Airflow configuration property values are

1284

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

1285

# and cannot be overridden.

Bu Sun Kim

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

[diff] [blame]

1286

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

1287

},

1288

},

Bu Sun Kim

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

[diff] [blame]

1289

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

1290

# used to run this environment.

1291

},

Bu Sun Kim

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

[diff] [blame]

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

Dan O'Meara

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

[diff] [blame]

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.

Bu Sun Kim

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

[diff] [blame]

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.

Bu Sun Kim

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

[diff] [blame]

1300

}

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

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

Bu Sun Kim

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

[diff] [blame]

1446

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

1447

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

1448

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

Bu Sun Kim

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

[diff] [blame]

1449

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

Bu Sun Kim

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

[diff] [blame]

1450

},

Bu Sun Kim

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

[diff] [blame]

1451

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

1452

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

1453

# available.

Bu Sun Kim

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

[diff] [blame]

1454

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

1455

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

1456

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

1457

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

1458

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

1459

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

1460

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

1461

# `TakeSnapshotResponse`.

Bu Sun Kim

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

[diff] [blame]

1462

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

Bu Sun Kim

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

[diff] [blame]

1463

},

Bu Sun Kim

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

[diff] [blame]

1464

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

1465

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

1466

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

Bu Sun Kim