mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-25 12:44:07 +01:00
842 lines
52 KiB
HTML
842 lines
52 KiB
HTML
<!DOCTYPE html>
|
|
<html class="writer-html5" lang="en" >
|
|
<head>
|
|
<meta charset="utf-8" />
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><link rel="canonical" href="http://byron.github.io/google-apis-rs/google-composer1-cli/projects_locations-environments-patch/" />
|
|
<link rel="shortcut icon" href="../img/favicon.ico" />
|
|
<title>Locations Environments Patch - Cloud Composer v5.0.4+20240227</title>
|
|
<link rel="stylesheet" href="../css/theme.css" />
|
|
<link rel="stylesheet" href="../css/theme_extra.css" />
|
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/github.min.css" />
|
|
|
|
<script>
|
|
// Current page data
|
|
var mkdocs_page_name = "Locations Environments Patch";
|
|
var mkdocs_page_input_path = "projects_locations-environments-patch.md";
|
|
var mkdocs_page_url = "/google-apis-rs/google-composer1-cli/projects_locations-environments-patch/";
|
|
</script>
|
|
|
|
<script src="../js/jquery-3.6.0.min.js" defer></script>
|
|
<!--[if lt IE 9]>
|
|
<script src="../js/html5shiv.min.js"></script>
|
|
<![endif]-->
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
|
|
<script>hljs.initHighlightingOnLoad();</script>
|
|
</head>
|
|
|
|
<body class="wy-body-for-nav" role="document">
|
|
|
|
<div class="wy-grid-for-nav">
|
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
|
<div class="wy-side-scroll">
|
|
<div class="wy-side-nav-search">
|
|
<a href=".." class="icon icon-home"> Cloud Composer v5.0.4+20240227
|
|
</a><div role="search">
|
|
<form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
|
|
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
|
|
</form>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="..">Home</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Projects</span></p>
|
|
<ul class="current">
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-environments-create/">Locations Environments Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-environments-database-failover/">Locations Environments Database Failover</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-environments-delete/">Locations Environments Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-environments-execute-airflow-command/">Locations Environments Execute Airflow Command</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-environments-fetch-database-properties/">Locations Environments Fetch Database Properties</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-environments-get/">Locations Environments Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-environments-list/">Locations Environments List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-environments-load-snapshot/">Locations Environments Load Snapshot</a>
|
|
</li>
|
|
<li class="toctree-l1 current"><a class="reference internal current" href="./">Locations Environments Patch</a>
|
|
<ul class="current">
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-environments-poll-airflow-command/">Locations Environments Poll Airflow Command</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-environments-save-snapshot/">Locations Environments Save Snapshot</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-environments-stop-airflow-command/">Locations Environments Stop Airflow Command</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-environments-user-workloads-config-maps-create/">Locations Environments User Workloads Config Maps Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-environments-user-workloads-config-maps-delete/">Locations Environments User Workloads Config Maps Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-environments-user-workloads-config-maps-get/">Locations Environments User Workloads Config Maps Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-environments-user-workloads-config-maps-list/">Locations Environments User Workloads Config Maps List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-environments-user-workloads-config-maps-update/">Locations Environments User Workloads Config Maps Update</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-environments-user-workloads-secrets-create/">Locations Environments User Workloads Secrets Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-environments-user-workloads-secrets-delete/">Locations Environments User Workloads Secrets Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-environments-user-workloads-secrets-get/">Locations Environments User Workloads Secrets Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-environments-user-workloads-secrets-list/">Locations Environments User Workloads Secrets List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-environments-user-workloads-secrets-update/">Locations Environments User Workloads Secrets Update</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-environments-workloads-list/">Locations Environments Workloads List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-image-versions-list/">Locations Image Versions List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-operations-delete/">Locations Operations Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-operations-get/">Locations Operations Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-operations-list/">Locations Operations List</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
|
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
|
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
|
<a href="..">Cloud Composer v5.0.4+20240227</a>
|
|
|
|
</nav>
|
|
<div class="wy-nav-content">
|
|
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
|
|
<ul class="wy-breadcrumbs">
|
|
<li><a href=".." class="icon icon-home" alt="Docs"></a> »</li>
|
|
<li>Projects »</li>
|
|
<li>Locations Environments Patch</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/composer1-cli/edit/master/docs/projects_locations-environments-patch.md"
|
|
class="icon icon-github"> Edit on GitHub</a>
|
|
</li>
|
|
</ul>
|
|
<hr/>
|
|
</div>
|
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
|
<div class="section" itemprop="articleBody">
|
|
|
|
<p>Update an environment.</p>
|
|
<h1 id="scopes">Scopes</h1>
|
|
<p>You will need authorization for the <em>https://www.googleapis.com/auth/cloud-platform</em> scope to make a valid call.</p>
|
|
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/cloud-platform</em>.
|
|
You can set the scope for this method like this: <code>composer1 --scope <scope> projects locations-environments-patch ...</code></p>
|
|
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
|
<ul>
|
|
<li><strong><name></strong> <em>(string)</em><ul>
|
|
<li>The relative resource name of the environment to update, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}"</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h1 id="required-request-value">Required Request Value</h1>
|
|
<p>The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure.
|
|
In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.</p>
|
|
<p>For example, a structure like this:</p>
|
|
<pre><code>Environment:
|
|
config:
|
|
airflow-byoid-uri: string
|
|
airflow-uri: string
|
|
dag-gcs-prefix: string
|
|
data-retention-config:
|
|
airflow-metadata-retention-config:
|
|
retention-days: integer
|
|
retention-mode: string
|
|
task-logs-retention-config:
|
|
storage-mode: string
|
|
database-config:
|
|
machine-type: string
|
|
zone: string
|
|
encryption-config:
|
|
kms-key-name: string
|
|
environment-size: string
|
|
gke-cluster: string
|
|
maintenance-window:
|
|
end-time: string
|
|
recurrence: string
|
|
start-time: string
|
|
master-authorized-networks-config:
|
|
enabled: boolean
|
|
node-config:
|
|
composer-internal-ipv4-cidr-block: string
|
|
composer-network-attachment: string
|
|
disk-size-gb: integer
|
|
enable-ip-masq-agent: boolean
|
|
ip-allocation-policy:
|
|
cluster-ipv4-cidr-block: string
|
|
cluster-secondary-range-name: string
|
|
services-ipv4-cidr-block: string
|
|
services-secondary-range-name: string
|
|
use-ip-aliases: boolean
|
|
location: string
|
|
machine-type: string
|
|
network: string
|
|
oauth-scopes: [string]
|
|
service-account: string
|
|
subnetwork: string
|
|
tags: [string]
|
|
node-count: integer
|
|
private-environment-config:
|
|
cloud-composer-connection-subnetwork: string
|
|
cloud-composer-network-ipv4-cidr-block: string
|
|
cloud-composer-network-ipv4-reserved-range: string
|
|
cloud-sql-ipv4-cidr-block: string
|
|
enable-private-builds-only: boolean
|
|
enable-private-environment: boolean
|
|
enable-privately-used-public-ips: boolean
|
|
networking-config:
|
|
connection-type: string
|
|
private-cluster-config:
|
|
enable-private-endpoint: boolean
|
|
master-ipv4-cidr-block: string
|
|
master-ipv4-reserved-range: string
|
|
web-server-ipv4-cidr-block: string
|
|
web-server-ipv4-reserved-range: string
|
|
recovery-config:
|
|
scheduled-snapshots-config:
|
|
enabled: boolean
|
|
snapshot-creation-schedule: string
|
|
snapshot-location: string
|
|
time-zone: string
|
|
resilience-mode: string
|
|
software-config:
|
|
airflow-config-overrides: { string: string }
|
|
cloud-data-lineage-integration:
|
|
enabled: boolean
|
|
env-variables: { string: string }
|
|
image-version: string
|
|
pypi-packages: { string: string }
|
|
python-version: string
|
|
scheduler-count: integer
|
|
web-server-plugins-mode: string
|
|
web-server-config:
|
|
machine-type: string
|
|
workloads-config:
|
|
dag-processor:
|
|
count: integer
|
|
cpu: number
|
|
memory-gb: number
|
|
storage-gb: number
|
|
scheduler:
|
|
count: integer
|
|
cpu: number
|
|
memory-gb: number
|
|
storage-gb: number
|
|
triggerer:
|
|
count: integer
|
|
cpu: number
|
|
memory-gb: number
|
|
web-server:
|
|
cpu: number
|
|
memory-gb: number
|
|
storage-gb: number
|
|
worker:
|
|
cpu: number
|
|
max-count: integer
|
|
memory-gb: number
|
|
min-count: integer
|
|
storage-gb: number
|
|
create-time: string
|
|
labels: { string: string }
|
|
name: string
|
|
satisfies-pzs: boolean
|
|
state: string
|
|
storage-config:
|
|
bucket: string
|
|
update-time: string
|
|
uuid: string
|
|
|
|
</code></pre>
|
|
<p>can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.</p>
|
|
<ul>
|
|
<li><code>-r .config airflow-byoid-uri=sed</code><ul>
|
|
<li>Output only. The 'bring your own identity' variant of the URI of the Apache Airflow Web UI hosted within this environment, to be accessed with external identities using workforce identity federation (see <a href="/composer/docs/composer-2/access-environments-with-workforce-identity-federation">Access environments with workforce identity federation</a>).</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>airflow-uri=diam</code><ul>
|
|
<li>Output only. The URI of the Apache Airflow Web UI hosted within this environment (see <a href="/composer/docs/how-to/accessing/airflow-web-interface">Airflow web interface</a>).</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>dag-gcs-prefix=dolores</code><ul>
|
|
<li>Output only. The Cloud Storage prefix of the DAGs for this environment. Although Cloud Storage objects reside in a flat namespace, a hierarchical file tree can be simulated using "/"-delimited object name prefixes. DAG objects for this environment reside in a simulated directory with the given prefix.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>data-retention-config.airflow-metadata-retention-config retention-days=32</code><ul>
|
|
<li>Optional. How many days data should be retained for.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>retention-mode=et</code></p>
|
|
<ul>
|
|
<li>Optional. Retention can be either enabled or disabled.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>..task-logs-retention-config storage-mode=sed</code></p>
|
|
<ul>
|
|
<li>Optional. The mode of storage for Airflow workers task logs. For details, see go/composer-store-task-logs-in-cloud-logging-only-design-doc</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>...database-config machine-type=no</code></p>
|
|
<ul>
|
|
<li>Optional. Cloud SQL machine type used by Airflow database. It has to be one of: db-n1-standard-2, db-n1-standard-4, db-n1-standard-8 or db-n1-standard-16. If not specified, db-n1-standard-2 will be used. Supported for Cloud Composer environments in versions composer-1.<em>.</em>-airflow-<em>.</em>.*.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>zone=et</code></p>
|
|
<ul>
|
|
<li>Optional. The Compute Engine zone where the Airflow database is created. If zone is provided, it must be in the region selected for the environment. If zone is not provided, a zone is automatically selected. The zone can only be set during environment creation. Supported for Cloud Composer environments in versions composer-2.<em>.</em>-airflow-<em>.</em>.*.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>..encryption-config kms-key-name=elitr</code></p>
|
|
<ul>
|
|
<li>Optional. Customer-managed Encryption Key available through Google's Key Management Service. Cannot be updated. If not specified, Google-managed key will be used.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. environment-size=sed</code></p>
|
|
<ul>
|
|
<li>Optional. The size of the Cloud Composer environment. This field is supported for Cloud Composer environments in versions composer-2.<em>.</em>-airflow-<em>.</em>.* and newer.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>gke-cluster=no</code><ul>
|
|
<li>Output only. The Kubernetes Engine cluster used to run this environment.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>maintenance-window end-time=nonumy</code><ul>
|
|
<li>Required. Maintenance window end time. It is used only to calculate the duration of the maintenance window. The value for end-time must be in the future, relative to <code>start_time</code>.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>recurrence=at</code><ul>
|
|
<li>Required. Maintenance window recurrence. Format is a subset of <a href="https://tools.ietf.org/html/rfc5545">RFC-5545</a> <code>RRULE</code>. The only allowed values for <code>FREQ</code> field are <code>FREQ=DAILY</code> and <code>FREQ=WEEKLY;BYDAY=...</code> Example values: <code>FREQ=WEEKLY;BYDAY=TU,WE</code>, <code>FREQ=DAILY</code>.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>start-time=sadipscing</code></p>
|
|
<ul>
|
|
<li>Required. Start time of the first recurrence of the maintenance window.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>..master-authorized-networks-config enabled=true</code></p>
|
|
<ul>
|
|
<li>Whether or not master authorized networks feature is enabled.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>..node-config composer-internal-ipv4-cidr-block=sadipscing</code></p>
|
|
<ul>
|
|
<li>Optional. The IP range in CIDR notation to use internally by Cloud Composer. IP addresses are not reserved - and the same range can be used by multiple Cloud Composer environments. In case of overlap, IPs from this range will not be accessible in the user's VPC network. Cannot be updated. If not specified, the default value of '100.64.128.0/20' is used. This field is supported for Cloud Composer environments in versions composer-3.<em>.</em>-airflow-<em>.</em>.* and newer.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>composer-network-attachment=erat</code><ul>
|
|
<li>Optional. Network Attachment that Cloud Composer environment is connected to, which provides connectivity with a user's VPC network. Takes precedence over network and subnetwork settings. If not provided, but network and subnetwork are defined during environment, it will be provisioned. If not provided and network and subnetwork are also empty, then connectivity to user's VPC network is disabled. Network attachment must be provided in format projects/{project}/regions/{region}/networkAttachments/{networkAttachment}. This field is supported for Cloud Composer environments in versions composer-3.<em>.</em>-airflow-<em>.</em>.* and newer.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>disk-size-gb=19</code><ul>
|
|
<li>Optional. The disk size in GB used for node VMs. Minimum size is 30GB. If unspecified, defaults to 100GB. Cannot be updated. This field is supported for Cloud Composer environments in versions composer-1.<em>.</em>-airflow-<em>.</em>.*.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>enable-ip-masq-agent=true</code><ul>
|
|
<li>Optional. Deploys 'ip-masq-agent' daemon set in the GKE cluster and defines nonMasqueradeCIDRs equals to pod IP range so IP masquerading is used for all destination addresses, except between pods traffic. See: https://cloud.google.com/kubernetes-engine/docs/how-to/ip-masquerade-agent</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>ip-allocation-policy cluster-ipv4-cidr-block=est</code><ul>
|
|
<li>Optional. The IP address range used to allocate IP addresses to pods in the GKE cluster. For Cloud Composer environments in versions composer-1.<em>.</em>-airflow-<em>.</em>.*, this field is applicable only when <code>use_ip_aliases</code> is true. Set to blank to have GKE choose a range with the default size. Set to /netmask (e.g. <code>/14</code>) to have GKE choose a range with a specific netmask. Set to a <a href="https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing">CIDR</a> notation (e.g. <code>10.96.0.0/14</code>) from the RFC-1918 private networks (e.g. <code>10.0.0.0/8</code>, <code>172.16.0.0/12</code>, <code>192.168.0.0/16</code>) to pick a specific range to use.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>cluster-secondary-range-name=et</code><ul>
|
|
<li>Optional. The name of the GKE cluster's secondary range used to allocate IP addresses to pods. For Cloud Composer environments in versions composer-1.<em>.</em>-airflow-<em>.</em>.*, this field is applicable only when <code>use_ip_aliases</code> is true.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>services-ipv4-cidr-block=sea</code><ul>
|
|
<li>Optional. The IP address range of the services IP addresses in this GKE cluster. For Cloud Composer environments in versions composer-1.<em>.</em>-airflow-<em>.</em>.*, this field is applicable only when <code>use_ip_aliases</code> is true. Set to blank to have GKE choose a range with the default size. Set to /netmask (e.g. <code>/14</code>) to have GKE choose a range with a specific netmask. Set to a <a href="https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing">CIDR</a> notation (e.g. <code>10.96.0.0/14</code>) from the RFC-1918 private networks (e.g. <code>10.0.0.0/8</code>, <code>172.16.0.0/12</code>, <code>192.168.0.0/16</code>) to pick a specific range to use.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>services-secondary-range-name=consetetur</code><ul>
|
|
<li>Optional. The name of the services' secondary range used to allocate IP addresses to the GKE cluster. For Cloud Composer environments in versions composer-1.<em>.</em>-airflow-<em>.</em>.*, this field is applicable only when <code>use_ip_aliases</code> is true.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>use-ip-aliases=true</code></p>
|
|
<ul>
|
|
<li>Optional. Whether or not to enable Alias IPs in the GKE cluster. If <code>true</code>, a VPC-native cluster is created. This field is only supported for Cloud Composer environments in versions composer-1.<em>.</em>-airflow-<em>.</em>.*. Environments in newer versions always use VPC-native GKE clusters.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. location=stet</code></p>
|
|
<ul>
|
|
<li>Optional. The Compute Engine <a href="/compute/docs/regions-zones">zone</a> in which to deploy the VMs used to run the Apache Airflow software, specified as a <a href="/apis/design/resource_names#relative_resource_name">relative resource name</a>. For example: "projects/{projectId}/zones/{zoneId}". This <code>location</code> must belong to the enclosing environment's project and location. If both this field and <code>nodeConfig.machineType</code> are specified, <code>nodeConfig.machineType</code> must belong to this <code>location</code>; if both are unspecified, the service will pick a zone in the Compute Engine region corresponding to the Cloud Composer location, and propagate that choice to both fields. If only one field (<code>location</code> or <code>nodeConfig.machineType</code>) is specified, the location information from the specified field will be propagated to the unspecified field. This field is supported for Cloud Composer environments in versions composer-1.<em>.</em>-airflow-<em>.</em>.*.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>machine-type=est</code><ul>
|
|
<li>Optional. The Compute Engine <a href="/compute/docs/machine-types">machine type</a> used for cluster instances, specified as a <a href="/apis/design/resource_names#relative_resource_name">relative resource name</a>. For example: "projects/{projectId}/zones/{zoneId}/machineTypes/{machineTypeId}". The <code>machineType</code> must belong to the enclosing environment's project and location. If both this field and <code>nodeConfig.location</code> are specified, this <code>machineType</code> must belong to the <code>nodeConfig.location</code>; if both are unspecified, the service will pick a zone in the Compute Engine region corresponding to the Cloud Composer location, and propagate that choice to both fields. If exactly one of this field and <code>nodeConfig.location</code> is specified, the location information from the specified field will be propagated to the unspecified field. The <code>machineTypeId</code> must not be a <a href="/compute/docs/machine-types#sharedcore">shared-core machine type</a>. If this field is unspecified, the <code>machineTypeId</code> defaults to "n1-standard-1". This field is supported for Cloud Composer environments in versions composer-1.<em>.</em>-airflow-<em>.</em>.*.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>network=aliquyam</code><ul>
|
|
<li>Optional. The Compute Engine network to be used for machine communications, specified as a <a href="/apis/design/resource_names#relative_resource_name">relative resource name</a>. For example: "projects/{projectId}/global/networks/{networkId}". If unspecified, the "default" network ID in the environment's project is used. If a <a href="/vpc/docs/vpc#vpc_networks_and_subnets">Custom Subnet Network</a> is provided, <code>nodeConfig.subnetwork</code> must also be provided. For <a href="/vpc/docs/shared-vpc">Shared VPC</a> subnetwork requirements, see <code>nodeConfig.subnetwork</code>.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>oauth-scopes=elitr</code><ul>
|
|
<li>Optional. The set of Google API scopes to be made available on all node VMs. If <code>oauth_scopes</code> is empty, defaults to ["https://www.googleapis.com/auth/cloud-platform"]. Cannot be updated. This field is supported for Cloud Composer environments in versions composer-1.<em>.</em>-airflow-<em>.</em>.*.</li>
|
|
<li>Each invocation of this argument appends the given value to the array.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>service-account=duo</code><ul>
|
|
<li>Optional. The Google Cloud Platform Service Account to be used by the node VMs. If a service account is not specified, the "default" Compute Engine service account is used. Cannot be updated.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>subnetwork=diam</code><ul>
|
|
<li>Optional. The Compute Engine subnetwork to be used for machine communications, specified as a <a href="/apis/design/resource_names#relative_resource_name">relative resource name</a>. For example: "projects/{projectId}/regions/{regionId}/subnetworks/{subnetworkId}" If a subnetwork is provided, <code>nodeConfig.network</code> must also be provided, and the subnetwork must belong to the enclosing environment's project and location.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>tags=est</code></p>
|
|
<ul>
|
|
<li>Optional. The list of instance tags applied to all node VMs. Tags are used to identify valid sources or targets for network firewalls. Each tag within the list must comply with <a href="https://www.ietf.org/rfc/rfc1035.txt">RFC1035</a>. Cannot be updated.</li>
|
|
<li>Each invocation of this argument appends the given value to the array.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. node-count=48</code></p>
|
|
<ul>
|
|
<li>The number of nodes in the Kubernetes Engine cluster that will be used to run this environment. This field is supported for Cloud Composer environments in versions composer-1.<em>.</em>-airflow-<em>.</em>.*.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>private-environment-config cloud-composer-connection-subnetwork=sed</code><ul>
|
|
<li>Optional. When specified, the environment will use Private Service Connect instead of VPC peerings to connect to Cloud SQL in the Tenant Project, and the PSC endpoint in the Customer Project will use an IP address from this subnetwork.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>cloud-composer-network-ipv4-cidr-block=eos</code><ul>
|
|
<li>Optional. The CIDR block from which IP range for Cloud Composer Network in tenant project will be reserved. Needs to be disjoint from private_cluster_config.master_ipv4_cidr_block and cloud_sql_ipv4_cidr_block. This field is supported for Cloud Composer environments in versions composer-2.<em>.</em>-airflow-<em>.</em>.* and newer.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>cloud-composer-network-ipv4-reserved-range=lorem</code><ul>
|
|
<li>Output only. The IP range reserved for the tenant project's Cloud Composer network. This field is supported for Cloud Composer environments in versions composer-2.<em>.</em>-airflow-<em>.</em>.* and newer.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>cloud-sql-ipv4-cidr-block=ea</code><ul>
|
|
<li>Optional. The CIDR block from which IP range in tenant project will be reserved for Cloud SQL. Needs to be disjoint from <code>web_server_ipv4_cidr_block</code>.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>enable-private-builds-only=true</code><ul>
|
|
<li>Optional. If <code>true</code>, builds performed during operations that install Python packages have only private connectivity to Google services (including Artifact Registry) and VPC network (if either <code>NodeConfig.network</code> and <code>NodeConfig.subnetwork</code> fields or <code>NodeConfig.composer_network_attachment</code> field are specified). If <code>false</code>, the builds also have access to the internet. This field is supported for Cloud Composer environments in versions composer-3.<em>.</em>-airflow-<em>.</em>.* and newer.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>enable-private-environment=false</code><ul>
|
|
<li>Optional. If <code>true</code>, a Private IP Cloud Composer environment is created. If this field is set to true, <code>IPAllocationPolicy.use_ip_aliases</code> must be set to true for Cloud Composer environments in versions composer-1.<em>.</em>-airflow-<em>.</em>.*.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>enable-privately-used-public-ips=false</code><ul>
|
|
<li>Optional. When enabled, IPs from public (non-RFC1918) ranges can be used for <code>IPAllocationPolicy.cluster_ipv4_cidr_block</code> and <code>IPAllocationPolicy.service_ipv4_cidr_block</code>.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>networking-config connection-type=dolore</code></p>
|
|
<ul>
|
|
<li>Optional. Indicates the user requested specifc connection type between Tenant and Customer projects. You cannot set networking connection type in public IP environment.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>..private-cluster-config enable-private-endpoint=true</code></p>
|
|
<ul>
|
|
<li>Optional. If <code>true</code>, access to the public endpoint of the GKE cluster is denied.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>master-ipv4-cidr-block=lorem</code><ul>
|
|
<li>Optional. The CIDR block from which IPv4 range for GKE master will be reserved. If left blank, the default value of '172.16.0.0/23' is used.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>master-ipv4-reserved-range=accusam</code></p>
|
|
<ul>
|
|
<li>Output only. The IP range in CIDR notation to use for the hosted master network. This range is used for assigning internal IP addresses to the GKE cluster master or set of masters and to the internal load balancer virtual IP. This range must not overlap with any other ranges in use within the cluster's network.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. web-server-ipv4-cidr-block=amet</code></p>
|
|
<ul>
|
|
<li>Optional. The CIDR block from which IP range for web server will be reserved. Needs to be disjoint from <code>private_cluster_config.master_ipv4_cidr_block</code> and <code>cloud_sql_ipv4_cidr_block</code>. This field is supported for Cloud Composer environments in versions composer-1.<em>.</em>-airflow-<em>.</em>.*.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>web-server-ipv4-reserved-range=erat</code></p>
|
|
<ul>
|
|
<li>Output only. The IP range reserved for the tenant project's App Engine VMs. This field is supported for Cloud Composer environments in versions composer-1.<em>.</em>-airflow-<em>.</em>.*.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>..recovery-config.scheduled-snapshots-config enabled=true</code></p>
|
|
<ul>
|
|
<li>Optional. Whether scheduled snapshots creation is enabled.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>snapshot-creation-schedule=erat</code><ul>
|
|
<li>Optional. The cron expression representing the time when snapshots creation mechanism runs. This field is subject to additional validation around frequency of execution.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>snapshot-location=accusam</code><ul>
|
|
<li>Optional. The Cloud Storage location for storing automatically created snapshots.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>time-zone=sea</code></p>
|
|
<ul>
|
|
<li>Optional. Time zone that sets the context to interpret snapshot_creation_schedule.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>... resilience-mode=takimata</code></p>
|
|
<ul>
|
|
<li>Optional. Resilience mode of the Cloud Composer Environment. This field is supported for Cloud Composer environments in versions composer-2.2.0-airflow-<em>.</em>.* and newer.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>software-config airflow-config-overrides=key=lorem</code><ul>
|
|
<li>Optional. Apache Airflow configuration properties to override. Property keys contain the section and property names, separated by a hyphen, for example "core-dags_are_paused_at_creation". Section names must not contain hyphens ("-"), opening square brackets ("["), or closing square brackets ("]"). The property name must not be empty and must not contain an equals sign ("=") or semicolon (";"). Section and property names must not contain a period ("."). Apache Airflow configuration property names must be written in <a href="https://en.wikipedia.org/wiki/Snake_case">snake_case</a>. Property values can contain any character, and can be written in any lower/upper case format. Certain Apache Airflow configuration property values are <a href="/composer/docs/concepts/airflow-configurations">blocked</a>, and cannot be overridden.</li>
|
|
<li>the value will be associated with the given <code>key</code></li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>cloud-data-lineage-integration enabled=false</code></p>
|
|
<ul>
|
|
<li>Optional. Whether or not Cloud Data Lineage integration is enabled.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. env-variables=key=dolor</code></p>
|
|
<ul>
|
|
<li>Optional. Additional environment variables to provide to the Apache Airflow scheduler, worker, and webserver processes. Environment variable names must match the regular expression <code>a-zA-Z_*</code>. They cannot specify Apache Airflow software configuration overrides (they cannot match the regular expression <code>AIRFLOW__[A-Z0-9_]+__[A-Z0-9_]+</code>), and they cannot match any of the following reserved names: * <code>AIRFLOW_HOME</code> * <code>C_FORCE_ROOT</code> * <code>CONTAINER_NAME</code> * <code>DAGS_FOLDER</code> * <code>GCP_PROJECT</code> * <code>GCS_BUCKET</code> * <code>GKE_CLUSTER_NAME</code> * <code>SQL_DATABASE</code> * <code>SQL_INSTANCE</code> * <code>SQL_PASSWORD</code> * <code>SQL_PROJECT</code> * <code>SQL_REGION</code> * <code>SQL_USER</code></li>
|
|
<li>the value will be associated with the given <code>key</code></li>
|
|
</ul>
|
|
</li>
|
|
<li><code>image-version=et</code><ul>
|
|
<li>The version of the software running in the environment. This encapsulates both the version of Cloud Composer functionality and the version of Apache Airflow. It must match the regular expression <code>composer-([0-9]+(\.[0-9]+\.[0-9]+(-preview\.[0-9]+)?)?|latest)-airflow-([0-9]+(\.[0-9]+(\.[0-9]+)?)?)</code>. When used as input, the server also checks if the provided version is supported and denies the request for an unsupported version. The Cloud Composer portion of the image version is a full <a href="https://semver.org">semantic version</a>, or an alias in the form of major version number or <code>latest</code>. When an alias is provided, the server replaces it with the current Cloud Composer version that satisfies the alias. The Apache Airflow portion of the image version is a full semantic version that points to one of the supported Apache Airflow versions, or an alias in the form of only major or major.minor versions specified. When an alias is provided, the server replaces it with the latest Apache Airflow version that satisfies the alias and is supported in the given Cloud Composer version. In all cases, the resolved image version is stored in the same field. See also <a href="/composer/docs/concepts/versioning/composer-versions">version list</a> and <a href="/composer/docs/concepts/versioning/composer-versioning-overview">versioning overview</a>.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>pypi-packages=key=sit</code><ul>
|
|
<li>Optional. Custom Python Package Index (PyPI) packages to be installed in the environment. Keys refer to the lowercase package name such as "numpy" and values are the lowercase extras and version specifier such as "==1.12.0", "[devel,gcp_api]", or "[devel]>=1.8.2, <1.9.2". To specify a package without pinning it to a version specifier, use the empty string as the value.</li>
|
|
<li>the value will be associated with the given <code>key</code></li>
|
|
</ul>
|
|
</li>
|
|
<li><code>python-version=erat</code><ul>
|
|
<li>Optional. The major version of Python used to run the Apache Airflow scheduler, worker, and webserver processes. Can be set to '2' or '3'. If not specified, the default is '3'. Cannot be updated. This field is only supported for Cloud Composer environments in versions composer-1.<em>.</em>-airflow-<em>.</em>.*. Environments in newer versions always use Python major version 3.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>scheduler-count=91</code><ul>
|
|
<li>Optional. The number of schedulers for Airflow. This field is supported for Cloud Composer environments in versions composer-1.<em>.</em>-airflow-2.<em>.</em>.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>web-server-plugins-mode=nonumy</code></p>
|
|
<ul>
|
|
<li>Optional. Whether or not the web server uses custom plugins. If unspecified, the field defaults to <code>PLUGINS_ENABLED</code>. This field is supported for Cloud Composer environments in versions composer-3.<em>.</em>-airflow-<em>.</em>.* and newer.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>..web-server-config machine-type=et</code></p>
|
|
<ul>
|
|
<li>Optional. Machine type on which Airflow web server is running. It has to be one of: composer-n1-webserver-2, composer-n1-webserver-4 or composer-n1-webserver-8. If not specified, composer-n1-webserver-2 will be used. Value custom is returned only in response, if Airflow web server parameters were manually changed to a non-standard values.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>..workloads-config.dag-processor count=89</code></p>
|
|
<ul>
|
|
<li>Optional. The number of DAG processors. If not provided or set to 0, a single DAG processor instance will be created.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>cpu=0.6291766861205718</code><ul>
|
|
<li>Optional. CPU request and limit for a single Airflow DAG processor replica.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>memory-gb=0.03937387488958621</code><ul>
|
|
<li>Optional. Memory (GB) request and limit for a single Airflow DAG processor replica.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>storage-gb=0.5399657234545516</code></p>
|
|
<ul>
|
|
<li>Optional. Storage (GB) request and limit for a single Airflow DAG processor replica.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>..scheduler count=24</code></p>
|
|
<ul>
|
|
<li>Optional. The number of schedulers.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>cpu=0.6413061576894121</code><ul>
|
|
<li>Optional. CPU request and limit for a single Airflow scheduler replica.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>memory-gb=0.3069400471690349</code><ul>
|
|
<li>Optional. Memory (GB) request and limit for a single Airflow scheduler replica.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>storage-gb=0.9429759678190598</code></p>
|
|
<ul>
|
|
<li>Optional. Storage (GB) request and limit for a single Airflow scheduler replica.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>..triggerer count=69</code></p>
|
|
<ul>
|
|
<li>Optional. The number of triggerers.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>cpu=0.3151317222476111</code><ul>
|
|
<li>Optional. CPU request and limit for a single Airflow triggerer replica.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>memory-gb=0.4023962607532475</code></p>
|
|
<ul>
|
|
<li>Optional. Memory (GB) request and limit for a single Airflow triggerer replica.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>..web-server cpu=0.3586942197762041</code></p>
|
|
<ul>
|
|
<li>Optional. CPU request and limit for Airflow web server.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>memory-gb=0.9172551803684075</code><ul>
|
|
<li>Optional. Memory (GB) request and limit for Airflow web server.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>storage-gb=0.8918752107029069</code></p>
|
|
<ul>
|
|
<li>Optional. Storage (GB) request and limit for Airflow web server.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>..worker cpu=0.5801385222305127</code></p>
|
|
<ul>
|
|
<li>Optional. CPU request and limit for a single Airflow worker replica.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>max-count=81</code><ul>
|
|
<li>Optional. Maximum number of workers for autoscaling.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>memory-gb=0.38020685422472145</code><ul>
|
|
<li>Optional. Memory (GB) request and limit for a single Airflow worker replica.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>min-count=79</code><ul>
|
|
<li>Optional. Minimum number of workers for autoscaling.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>storage-gb=0.820349993375188</code></p>
|
|
<ul>
|
|
<li>Optional. Storage (GB) request and limit for a single Airflow worker replica.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.... create-time=dolor</code></p>
|
|
<ul>
|
|
<li>Output only. The time at which this environment was created.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>labels=key=lorem</code><ul>
|
|
<li>Optional. User-defined labels for this environment. The labels map can contain no more than 64 entries. Entries of the labels map are UTF8 strings that comply with the following restrictions: * Keys must conform to regexp: \p{Ll}\p{Lo}{0,62} * Values must conform to regexp: [\p{Ll}\p{Lo}\p{N}_-]{0,63} * Both keys and values are additionally constrained to be <= 128 bytes in size.</li>
|
|
<li>the value will be associated with the given <code>key</code></li>
|
|
</ul>
|
|
</li>
|
|
<li><code>name=justo</code><ul>
|
|
<li>The resource name of the environment, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" EnvironmentId must start with a lowercase letter followed by up to 63 lowercase letters, numbers, or hyphens, and cannot end with a hyphen.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>satisfies-pzs=true</code><ul>
|
|
<li>Output only. Reserved for future use.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>state=no</code><ul>
|
|
<li>The current state of the environment.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>storage-config bucket=nonumy</code></p>
|
|
<ul>
|
|
<li>Optional. The name of the Cloud Storage bucket used by the environment. No <code>gs://</code> prefix.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. update-time=sed</code></p>
|
|
<ul>
|
|
<li>Output only. The time at which this environment was last modified.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>uuid=kasd</code><ul>
|
|
<li>Output only. The UUID (Universally Unique IDentifier) associated with this environment. This value is generated when the environment is created.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h3 id="about-cursors">About Cursors</h3>
|
|
<p>The cursor position is key to comfortably set complex nested structures. The following rules apply:</p>
|
|
<ul>
|
|
<li>The cursor position is always set relative to the current one, unless the field name starts with the <code>.</code> character. Fields can be nested such as in <code>-r f.s.o</code> .</li>
|
|
<li>The cursor position is set relative to the top-level structure if it starts with <code>.</code>, e.g. <code>-r .s.s</code></li>
|
|
<li>You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify <code>-r struct.sub_struct=bar</code>.</li>
|
|
<li>You can move the cursor one level up by using <code>..</code>. Each additional <code>.</code> moves it up one additional level. E.g. <code>...</code> would go three levels up.</li>
|
|
</ul>
|
|
<h1 id="optional-output-flags">Optional Output Flags</h1>
|
|
<p>The method's return value a JSON encoded structure, which will be written to standard output by default.</p>
|
|
<ul>
|
|
<li><strong>-o out</strong><ul>
|
|
<li><em>out</em> specifies the <em>destination</em> to which to write the server's result to.
|
|
It will be a JSON-encoded structure.
|
|
The <em>destination</em> may be <code>-</code> to indicate standard output, or a filepath that is to contain the received bytes.
|
|
If unset, it defaults to standard output.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h1 id="optional-method-properties">Optional Method Properties</h1>
|
|
<p>You may set the following properties to further configure the call. Please note that <code>-p</code> is followed by one
|
|
or more key-value-pairs, and is called like this <code>-p k1=v1 k2=v2</code> even though the listing below repeats the
|
|
<code>-p</code> for completeness.</p>
|
|
<ul>
|
|
<li><strong>-p update-mask=string</strong><ul>
|
|
<li>Required. A comma-separated list of paths, relative to <code>Environment</code>, of fields to update. For example, to set the version of scikit-learn to install in the environment to 0.19.0 and to remove an existing installation of numpy, the <code>updateMask</code> parameter would include the following two <code>paths</code> values: "config.softwareConfig.pypiPackages.scikit-learn" and "config.softwareConfig.pypiPackages.numpy". The included patch environment would specify the scikit-learn version as follows: { "config":{ "softwareConfig":{ "pypiPackages":{ "scikit-learn":"==0.19.0" } } } } Note that in the above example, any existing PyPI packages other than scikit-learn and numpy will be unaffected. Only one update type may be included in a single request's <code>updateMask</code>. For example, one cannot update both the PyPI packages and labels in the same request. However, it is possible to update multiple members of a map field simultaneously in the same request. For example, to set the labels "label1" and "label2" while clearing "label3" (assuming it already exists), one can provide the paths "labels.label1", "labels.label2", and "labels.label3" and populate the patch environment as follows: { "labels":{ "label1":"new-label1-value" "label2":"new-label2-value" } } Note that in the above example, any existing labels that are not included in the <code>updateMask</code> will be unaffected. It is also possible to replace an entire map field by providing the map field's path in the <code>updateMask</code>. The new value of the field will be that which is provided in the patch environment. For example, to delete all pre-existing user-specified PyPI packages and install botocore at version 1.7.14, the <code>updateMask</code> would contain the path "config.softwareConfig.pypiPackages", and the patch environment would be the following: { "config":{ "softwareConfig":{ "pypiPackages":{ "botocore":"==1.7.14" } } } } <strong>Note:</strong> Only the following fields can be updated: * <code>config.softwareConfig.pypiPackages</code> * Replace all custom custom PyPI packages. If a replacement package map is not included in <code>environment</code>, all custom PyPI packages are cleared. It is an error to provide both this mask and a mask specifying an individual package. * <code>config.softwareConfig.pypiPackages.</code>packagename * Update the custom PyPI package <em>packagename</em>, preserving other packages. To delete the package, include it in <code>updateMask</code>, and omit the mapping for it in <code>environment.config.softwareConfig.pypiPackages</code>. It is an error to provide both a mask of this form and the <code>config.softwareConfig.pypiPackages</code> mask. * <code>labels</code> * Replace all environment labels. If a replacement labels map is not included in <code>environment</code>, all labels are cleared. It is an error to provide both this mask and a mask specifying one or more individual labels. * <code>labels.</code>labelName * Set the label named <em>labelName</em>, while preserving other labels. To delete the label, include it in <code>updateMask</code> and omit its mapping in <code>environment.labels</code>. It is an error to provide both a mask of this form and the <code>labels</code> mask. * <code>config.nodeCount</code> * Horizontally scale the number of nodes in the environment. An integer greater than or equal to 3 must be provided in the <code>config.nodeCount</code> field. Supported for Cloud Composer environments in versions composer-1.<em>.</em>-airflow-<em>.</em>.<em>. * <code>config.webServerNetworkAccessControl</code> * Replace the environment's current <code>WebServerNetworkAccessControl</code>. * <code>config.softwareConfig.airflowConfigOverrides</code> * Replace all Apache Airflow config overrides. If a replacement config overrides map is not included in <code>environment</code>, all config overrides are cleared. It is an error to provide both this mask and a mask specifying one or more individual config overrides. * <code>config.softwareConfig.airflowConfigOverrides.</code>section-name * Override the Apache Airflow config property </em>name<em> in the section named </em>section<em>, preserving other properties. To delete the property override, include it in <code>updateMask</code> and omit its mapping in <code>environment.config.softwareConfig.airflowConfigOverrides</code>. It is an error to provide both a mask of this form and the <code>config.softwareConfig.airflowConfigOverrides</code> mask. * <code>config.softwareConfig.envVariables</code> * Replace all environment variables. If a replacement environment variable map is not included in <code>environment</code>, all custom environment variables are cleared. * <code>config.softwareConfig.schedulerCount</code> * Horizontally scale the number of schedulers in Airflow. A positive integer not greater than the number of nodes must be provided in the <code>config.softwareConfig.schedulerCount</code> field. Supported for Cloud Composer environments in versions composer-1.</em>.<em>-airflow-2.</em>.<em>. * <code>config.databaseConfig.machineType</code> * Cloud SQL machine type used by Airflow database. It has to be one of: db-n1-standard-2, db-n1-standard-4, db-n1-standard-8 or db-n1-standard-16. Supported for Cloud Composer environments in versions composer-1.</em>.<em>-airflow-</em>.<em>.</em>. * <code>config.webServerConfig.machineType</code> * Machine type on which Airflow web server is running. It has to be one of: composer-n1-webserver-2, composer-n1-webserver-4 or composer-n1-webserver-8. Supported for Cloud Composer environments in versions composer-1.<em>.</em>-airflow-<em>.</em>.*.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h1 id="optional-general-properties">Optional General Properties</h1>
|
|
<p>The following properties can configure any call, and are not specific to this method.</p>
|
|
<ul>
|
|
<li>
|
|
<p><strong>-p $-xgafv=string</strong></p>
|
|
<ul>
|
|
<li>V1 error format.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p access-token=string</strong></p>
|
|
<ul>
|
|
<li>OAuth access token.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p alt=string</strong></p>
|
|
<ul>
|
|
<li>Data format for response.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p callback=string</strong></p>
|
|
<ul>
|
|
<li>JSONP</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p fields=string</strong></p>
|
|
<ul>
|
|
<li>Selector specifying which fields to include in a partial response.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p key=string</strong></p>
|
|
<ul>
|
|
<li>API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p oauth-token=string</strong></p>
|
|
<ul>
|
|
<li>OAuth 2.0 token for the current user.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p pretty-print=boolean</strong></p>
|
|
<ul>
|
|
<li>Returns response with indentations and line breaks.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p quota-user=string</strong></p>
|
|
<ul>
|
|
<li>Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p upload-type=string</strong></p>
|
|
<ul>
|
|
<li>Legacy upload protocol for media (e.g. "media", "multipart").</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p upload-protocol=string</strong></p>
|
|
<ul>
|
|
<li>Upload protocol for media (e.g. "raw", "multipart").</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
|
|
</div>
|
|
</div><footer>
|
|
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
|
|
<a href="../projects_locations-environments-load-snapshot/" class="btn btn-neutral float-left" title="Locations Environments Load Snapshot"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
|
<a href="../projects_locations-environments-poll-airflow-command/" class="btn btn-neutral float-right" title="Locations Environments Poll Airflow Command">Next <span class="icon icon-circle-arrow-right"></span></a>
|
|
</div>
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<!-- Copyright etc -->
|
|
<p>Copyright © 2015-2020, `Sebastian Thiel`</p>
|
|
</div>
|
|
|
|
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
|
</footer>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</section>
|
|
|
|
</div>
|
|
|
|
<div class="rst-versions" role="note" aria-label="Versions">
|
|
<span class="rst-current-version" data-toggle="rst-current-version">
|
|
|
|
<span>
|
|
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/composer1-cli" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
|
|
</span>
|
|
|
|
|
|
<span><a href="../projects_locations-environments-load-snapshot/" style="color: #fcfcfc">« Previous</a></span>
|
|
|
|
|
|
<span><a href="../projects_locations-environments-poll-airflow-command/" style="color: #fcfcfc">Next »</a></span>
|
|
|
|
</span>
|
|
</div>
|
|
<script>var base_url = '..';</script>
|
|
<script src="../js/theme_extra.js" defer></script>
|
|
<script src="../js/theme.js" defer></script>
|
|
<script src="../search/main.js" defer></script>
|
|
<script defer>
|
|
window.onload = function () {
|
|
SphinxRtdTheme.Navigation.enable(true);
|
|
};
|
|
</script>
|
|
|
|
</body>
|
|
</html>
|