chore: regens API reference docs (#889)
diff --git a/docs/dyn/composer_v1beta1.projects.locations.environments.html b/docs/dyn/composer_v1beta1.projects.locations.environments.html
index 0bc777c..c64c95f 100644
--- a/docs/dyn/composer_v1beta1.projects.locations.environments.html
+++ b/docs/dyn/composer_v1beta1.projects.locations.environments.html
@@ -75,7 +75,7 @@
<h1><a href="composer_v1beta1.html">Cloud Composer API</a> . <a href="composer_v1beta1.projects.html">projects</a> . <a href="composer_v1beta1.projects.locations.html">locations</a> . <a href="composer_v1beta1.projects.locations.environments.html">environments</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#create">create(parent, body, x__xgafv=None)</a></code></p>
+ <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Create a new environment.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
@@ -90,48 +90,43 @@
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
- <code><a href="#patch">patch(name, body, updateMask=None, x__xgafv=None)</a></code></p>
+ <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Update an environment.</p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="create">create(parent, body, x__xgafv=None)</code>
+ <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
<pre>Create a new environment.
Args:
parent: string, The parent must be of the form
"projects/{projectId}/locations/{locationId}". (required)
- body: object, The request body. (required)
+ body: object, The request body.
The object takes the form of:
{ # An environment for running orchestration tasks.
- "updateTime": "A String", # Output only.
- # The time at which this environment was last modified.
- "uuid": "A String", # Output only.
- # The UUID (Universally Unique IDentifier) associated with this environment.
- # This value is generated when the environment is created.
+ "updateTime": "A String", # Output only. The time at which this environment was last modified.
+ "name": "A String", # 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.
"labels": { # 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
+ # * Both keys and values are additionally constrained to be <= 128 bytes in
# size.
"a_key": "A String",
},
"state": "A String", # The current state of the environment.
"config": { # Configuration information for an environment. # Configuration parameters for this environment.
- "dagGcsPrefix": "A String", # Output only.
- # The Cloud Storage prefix of the DAGs for this environment. Although Cloud
+ "dagGcsPrefix": "A String", # 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.
"softwareConfig": { # Specifies the selection and configuration of software inside the environment. # The configuration settings for software inside the environment.
- "pythonVersion": "A String", # 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 '2'. Cannot be
- # updated.
"imageVersion": "A String", # 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
@@ -146,29 +141,27 @@
# the server replaces `latest` with the current Cloud Composer version
# and stores that version number in the same field.
#
- # The portion of the image version that follows <em>airflow-</em> is an
+ # The portion of the image version that follows <em>airflow-</em> is an
# official Apache Airflow repository
# [release name](https://github.com/apache/incubator-airflow/releases).
#
# See also [Version
# List](/composer/docs/concepts/versioning/composer-versions).
- "airflowConfigOverrides": { # Optional. Apache Airflow configuration properties to override.
+ "pypiPackages": { # Optional. Custom Python Package Index (PyPI) packages to be installed in
+ # the environment.
#
- # 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
- # [snake_case](https://en.wikipedia.org/wiki/Snake_case). Property values can
- # contain any character, and can be written in any lower/upper case format.
- #
- # Certain Apache Airflow configuration property values are
- # [blacklisted](/composer/docs/how-to/managing/setting-airflow-configurations#airflow_configuration_blacklists),
- # and cannot be overridden.
+ # 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.
"a_key": "A String",
},
+ "pythonVersion": "A String", # 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 '2'. Cannot be
+ # updated.
"envVariables": { # Optional. Additional environment variables to provide to the Apache Airflow
# scheduler, worker, and webserver processes.
#
@@ -193,23 +186,45 @@
# * `SQL_USER`
"a_key": "A String",
},
- "pypiPackages": { # Optional. Custom Python Package Index (PyPI) packages to be installed in
- # the environment.
+ "airflowConfigOverrides": { # Optional. Apache Airflow configuration properties to override.
#
- # 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.
+ # 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
+ # [snake_case](https://en.wikipedia.org/wiki/Snake_case). Property values can
+ # contain any character, and can be written in any lower/upper case format.
+ #
+ # Certain Apache Airflow configuration property values are
+ # [blacklisted](/composer/docs/how-to/managing/setting-airflow-configurations#airflow_configuration_blacklists),
+ # and cannot be overridden.
"a_key": "A String",
},
},
- "airflowUri": "A String", # Output only.
- # The URI of the Apache Airflow Web UI hosted within this environment (see
+ "airflowUri": "A String", # Output only. The URI of the Apache Airflow Web UI hosted within this environment (see
# [Airflow web
# interface](/composer/docs/how-to/accessing/airflow-web-interface)).
- "gkeCluster": "A String", # Output only.
- # The Kubernetes Engine cluster used to run this environment.
+ "webServerNetworkAccessControl": { # Network-level access control policy for the Airflow web server. # Optional. The network-level access control policy for the Airflow web server. If
+ # unspecified, no network-level access restrictions will be applied.
+ "allowedIpRanges": [ # A collection of allowed IP ranges with descriptions.
+ { # Allowed IP range with user-provided description.
+ "description": "A String", # Optional. User-provided description. It must contain at most 300 characters.
+ "value": "A String", # IP address or range, defined using CIDR notation, of requests that this
+ # rule applies to.
+ # Examples: `192.168.1.1` or `192.168.0.0/16` or `2001:db8::/32`
+ # or `2001:0db8:0000:0042:0000:8a2e:0370:7334`.
+ #
+ #
+ # <p>IP range prefixes should be properly truncated. For example,
+ # `1.2.3.4/24` should be truncated to `1.2.3.0/24`. Similarly, for IPv6,
+ # `2001:db8::1/32` should be truncated to `2001:db8::/32`.
+ },
+ ],
+ },
+ "gkeCluster": "A String", # Output only. The Kubernetes Engine cluster used to run this environment.
"nodeConfig": { # The configuration information for the Kubernetes Engine nodes running # The configuration used for the Kubernetes Engine cluster.
# the Apache Airflow software.
"machineType": "A String", # Optional. The Compute Engine
@@ -228,6 +243,9 @@
# specified, the location information from the specified field will be
# propagated to the unspecified field.
#
+ # The `machineTypeId` must not be a [shared-core machine
+ # type](/compute/docs/machine-types#sharedcore).
+ #
# If this field is unspecified, the `machineTypeId` defaults
# to "n1-standard-1".
"network": "A String", # Optional. The Compute Engine network to be used for machine
@@ -257,29 +275,6 @@
],
"diskSizeGb": 42, # Optional. The disk size in GB used for node VMs. Minimum size is 20GB.
# If unspecified, defaults to 100GB. Cannot be updated.
- "location": "A String", # Optional. The Compute Engine [zone](/compute/docs/regions-zones) in which
- # to deploy the VMs used to run the Apache Airflow software, specified as a
- # [relative resource
- # name](/apis/design/resource_names#relative_resource_name). For example:
- # "projects/{projectId}/zones/{zoneId}".
- #
- # This `location` must belong to the enclosing environment's project and
- # location. If both this field and `nodeConfig.machineType` are specified,
- # `nodeConfig.machineType` must belong to this `location`; 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 (`location` or `nodeConfig.machineType`) is
- # specified, the location information from the specified field will be
- # propagated to the unspecified field.
- "subnetwork": "A String", # Optional. The Compute Engine subnetwork to be used for machine
- # communications, specified as a
- # [relative resource
- # name](/apis/design/resource_names#relative_resource_name). For example:
- # "projects/{projectId}/regions/{regionId}/subnetworks/{subnetworkId}"
- #
- # If a subnetwork is provided, `nodeConfig.network` must also be provided,
- # and the subnetwork must belong to the enclosing environment's project and
- # location.
"ipAllocationPolicy": { # Configuration for controlling how IPs are allocated in the # Optional. The IPAllocationPolicy fields for the GKE cluster.
# GKE cluster.
"clusterIpv4CidrBlock": "A String", # Optional. The IP address range used to allocate IP addresses to pods in
@@ -329,11 +324,40 @@
#
# This field is applicable only when `use_ip_aliases` is true.
},
+ "subnetwork": "A String", # Optional. The Compute Engine subnetwork to be used for machine
+ # communications, specified as a
+ # [relative resource
+ # name](/apis/design/resource_names#relative_resource_name). For example:
+ # "projects/{projectId}/regions/{regionId}/subnetworks/{subnetworkId}"
+ #
+ # If a subnetwork is provided, `nodeConfig.network` must also be provided,
+ # and the subnetwork must belong to the enclosing environment's project and
+ # location.
+ "location": "A String", # Optional. The Compute Engine [zone](/compute/docs/regions-zones) in which
+ # to deploy the VMs used to run the Apache Airflow software, specified as a
+ # [relative resource
+ # name](/apis/design/resource_names#relative_resource_name). For example:
+ # "projects/{projectId}/zones/{zoneId}".
+ #
+ # This `location` must belong to the enclosing environment's project and
+ # location. If both this field and `nodeConfig.machineType` are specified,
+ # `nodeConfig.machineType` must belong to this `location`; 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 (`location` or `nodeConfig.machineType`) is
+ # specified, the location information from the specified field will be
+ # propagated to the unspecified field.
},
"nodeCount": 42, # The number of nodes in the Kubernetes Engine cluster that will be
# used to run this environment.
"privateEnvironmentConfig": { # The configuration information for configuring a Private IP Cloud Composer # The configuration used for the Private IP Cloud Composer environment.
# environment.
+ "cloudSqlIpv4CidrBlock": "A String", # Optional. The CIDR block from which IP range in tenant project will be reserved for
+ # Cloud SQL. Needs to be disjoint from web_server_ipv4_cidr_block
+ "webServerIpv4CidrBlock": "A String", # Optional. The CIDR block from which IP range for web server will be reserved. Needs
+ # to be disjoint from private_cluster_config.master_ipv4_cidr_block and
+ # cloud_sql_ipv4_cidr_block.
+ "webServerIpv4ReservedRange": "A String", # Output only. The IP range reserved for the tenant project's App Engine VMs.
"enablePrivateEnvironment": True or False, # Optional. If `true`, a Private IP Cloud Composer environment is created.
# If this field is true, `use_ip_aliases` must be true.
"privateClusterConfig": { # Configuration options for the private GKE cluster in a Cloud Composer # Optional. Configuration for the private GKE cluster for a Private IP
@@ -341,19 +365,19 @@
# environment.
"enablePrivateEndpoint": True or False, # Optional. If `true`, access to the public endpoint of the GKE cluster is
# denied.
- "masterIpv4CidrBlock": "A String", # The IP range in CIDR notation to use for the hosted master network. This
+ "masterIpv4ReservedRange": "A String", # 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 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. If left blank, the default value of
- # '172.16.0.0/28' is used.
+ # within the cluster's network.
+ "masterIpv4CidrBlock": "A String", # 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.
},
},
},
- "createTime": "A String", # Output only.
- # The time at which this environment was created.
- "name": "A String", # The resource name of the environment, in the form:
- # "projects/{projectId}/locations/{locationId}/environments/{environmentId}"
+ "createTime": "A String", # Output only. The time at which this environment was created.
+ "uuid": "A String", # Output only. The UUID (Universally Unique IDentifier) associated with this environment.
+ # This value is generated when the environment is created.
}
x__xgafv: string, V1 error format.
@@ -366,64 +390,13 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
- "metadata": { # Service-specific metadata associated with the operation. It typically
- # contains progress information and common metadata such as create time.
- # Some services might not provide such metadata. Any method that returns a
- # long-running operation should document the metadata type, if any.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
"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.
# different programming environments, including REST APIs and RPC APIs. It is
- # used by [gRPC](https://github.com/grpc). The error model is designed to be:
+ # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+ # three pieces of data: error code, error message, and error details.
#
- # - Simple to use and understand for most users
- # - Flexible enough to meet unexpected needs
- #
- # # Overview
- #
- # The `Status` message contains three pieces of data: error code, error
- # message, and error details. The error code should be an enum value of
- # google.rpc.Code, but it may accept additional error codes if needed. The
- # error message should be a developer-facing English message that helps
- # developers *understand* and *resolve* the error. If a localized user-facing
- # error message is needed, put the localized message in the error details or
- # localize it in the client. The optional error details may contain arbitrary
- # information about the error. There is a predefined set of error detail types
- # in the package `google.rpc` that can be used for common error conditions.
- #
- # # Language mapping
- #
- # The `Status` message is the logical representation of the error model, but it
- # is not necessarily the actual wire format. When the `Status` message is
- # exposed in different client libraries and different wire protocols, it can be
- # mapped differently. For example, it will likely be mapped to some exceptions
- # in Java, but more likely mapped to some error codes in C.
- #
- # # Other uses
- #
- # The error model and the `Status` message can be used in a variety of
- # environments, either with or without APIs, to provide a
- # consistent developer experience across different environments.
- #
- # Example uses of this error model include:
- #
- # - Partial errors. If a service needs to return partial errors to the client,
- # it may embed the `Status` in the normal response to indicate the partial
- # errors.
- #
- # - Workflow errors. A typical workflow has multiple steps. Each step may
- # have a `Status` message for error reporting.
- #
- # - Batch operations. If a client uses batch request and batch response, the
- # `Status` message should be used directly inside batch response, one for
- # each error sub-response.
- #
- # - Asynchronous operations. If an API call embeds asynchronous operation
- # results in its response, the status of those operations should be
- # represented directly using the `Status` message.
- #
- # - Logging. If some API errors are stored in logs, the message `Status` could
- # be used directly after any stripping needed for security/privacy reasons.
+ # You can find out more about this error model and how to work with it in the
+ # [API Design Guide](https://cloud.google.com/apis/design/errors).
"message": "A String", # A developer-facing error message, which should be in English. Any
# user-facing error message should be localized and sent in the
# google.rpc.Status.details field, or localized by the client.
@@ -451,6 +424,12 @@
"name": "A String", # The server-assigned name, which is only unique within the same service that
# originally returns it. If you use the default HTTP mapping, the
# `name` should be a resource name ending with `operations/{unique_id}`.
+ "metadata": { # Service-specific metadata associated with the operation. It typically
+ # contains progress information and common metadata such as create time.
+ # Some services might not provide such metadata. Any method that returns a
+ # long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
}</pre>
</div>
@@ -471,64 +450,13 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
- "metadata": { # Service-specific metadata associated with the operation. It typically
- # contains progress information and common metadata such as create time.
- # Some services might not provide such metadata. Any method that returns a
- # long-running operation should document the metadata type, if any.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
"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.
# different programming environments, including REST APIs and RPC APIs. It is
- # used by [gRPC](https://github.com/grpc). The error model is designed to be:
+ # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+ # three pieces of data: error code, error message, and error details.
#
- # - Simple to use and understand for most users
- # - Flexible enough to meet unexpected needs
- #
- # # Overview
- #
- # The `Status` message contains three pieces of data: error code, error
- # message, and error details. The error code should be an enum value of
- # google.rpc.Code, but it may accept additional error codes if needed. The
- # error message should be a developer-facing English message that helps
- # developers *understand* and *resolve* the error. If a localized user-facing
- # error message is needed, put the localized message in the error details or
- # localize it in the client. The optional error details may contain arbitrary
- # information about the error. There is a predefined set of error detail types
- # in the package `google.rpc` that can be used for common error conditions.
- #
- # # Language mapping
- #
- # The `Status` message is the logical representation of the error model, but it
- # is not necessarily the actual wire format. When the `Status` message is
- # exposed in different client libraries and different wire protocols, it can be
- # mapped differently. For example, it will likely be mapped to some exceptions
- # in Java, but more likely mapped to some error codes in C.
- #
- # # Other uses
- #
- # The error model and the `Status` message can be used in a variety of
- # environments, either with or without APIs, to provide a
- # consistent developer experience across different environments.
- #
- # Example uses of this error model include:
- #
- # - Partial errors. If a service needs to return partial errors to the client,
- # it may embed the `Status` in the normal response to indicate the partial
- # errors.
- #
- # - Workflow errors. A typical workflow has multiple steps. Each step may
- # have a `Status` message for error reporting.
- #
- # - Batch operations. If a client uses batch request and batch response, the
- # `Status` message should be used directly inside batch response, one for
- # each error sub-response.
- #
- # - Asynchronous operations. If an API call embeds asynchronous operation
- # results in its response, the status of those operations should be
- # represented directly using the `Status` message.
- #
- # - Logging. If some API errors are stored in logs, the message `Status` could
- # be used directly after any stripping needed for security/privacy reasons.
+ # You can find out more about this error model and how to work with it in the
+ # [API Design Guide](https://cloud.google.com/apis/design/errors).
"message": "A String", # A developer-facing error message, which should be in English. Any
# user-facing error message should be localized and sent in the
# google.rpc.Status.details field, or localized by the client.
@@ -556,6 +484,12 @@
"name": "A String", # The server-assigned name, which is only unique within the same service that
# originally returns it. If you use the default HTTP mapping, the
# `name` should be a resource name ending with `operations/{unique_id}`.
+ "metadata": { # Service-specific metadata associated with the operation. It typically
+ # contains progress information and common metadata such as create time.
+ # Some services might not provide such metadata. Any method that returns a
+ # long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
}</pre>
</div>
@@ -575,34 +509,29 @@
An object of the form:
{ # An environment for running orchestration tasks.
- "updateTime": "A String", # Output only.
- # The time at which this environment was last modified.
- "uuid": "A String", # Output only.
- # The UUID (Universally Unique IDentifier) associated with this environment.
- # This value is generated when the environment is created.
+ "updateTime": "A String", # Output only. The time at which this environment was last modified.
+ "name": "A String", # 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.
"labels": { # 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
+ # * Both keys and values are additionally constrained to be <= 128 bytes in
# size.
"a_key": "A String",
},
"state": "A String", # The current state of the environment.
"config": { # Configuration information for an environment. # Configuration parameters for this environment.
- "dagGcsPrefix": "A String", # Output only.
- # The Cloud Storage prefix of the DAGs for this environment. Although Cloud
+ "dagGcsPrefix": "A String", # 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.
"softwareConfig": { # Specifies the selection and configuration of software inside the environment. # The configuration settings for software inside the environment.
- "pythonVersion": "A String", # 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 '2'. Cannot be
- # updated.
"imageVersion": "A String", # 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
@@ -617,29 +546,27 @@
# the server replaces `latest` with the current Cloud Composer version
# and stores that version number in the same field.
#
- # The portion of the image version that follows <em>airflow-</em> is an
+ # The portion of the image version that follows <em>airflow-</em> is an
# official Apache Airflow repository
# [release name](https://github.com/apache/incubator-airflow/releases).
#
# See also [Version
# List](/composer/docs/concepts/versioning/composer-versions).
- "airflowConfigOverrides": { # Optional. Apache Airflow configuration properties to override.
+ "pypiPackages": { # Optional. Custom Python Package Index (PyPI) packages to be installed in
+ # the environment.
#
- # 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
- # [snake_case](https://en.wikipedia.org/wiki/Snake_case). Property values can
- # contain any character, and can be written in any lower/upper case format.
- #
- # Certain Apache Airflow configuration property values are
- # [blacklisted](/composer/docs/how-to/managing/setting-airflow-configurations#airflow_configuration_blacklists),
- # and cannot be overridden.
+ # 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.
"a_key": "A String",
},
+ "pythonVersion": "A String", # 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 '2'. Cannot be
+ # updated.
"envVariables": { # Optional. Additional environment variables to provide to the Apache Airflow
# scheduler, worker, and webserver processes.
#
@@ -664,23 +591,45 @@
# * `SQL_USER`
"a_key": "A String",
},
- "pypiPackages": { # Optional. Custom Python Package Index (PyPI) packages to be installed in
- # the environment.
+ "airflowConfigOverrides": { # Optional. Apache Airflow configuration properties to override.
#
- # 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.
+ # 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
+ # [snake_case](https://en.wikipedia.org/wiki/Snake_case). Property values can
+ # contain any character, and can be written in any lower/upper case format.
+ #
+ # Certain Apache Airflow configuration property values are
+ # [blacklisted](/composer/docs/how-to/managing/setting-airflow-configurations#airflow_configuration_blacklists),
+ # and cannot be overridden.
"a_key": "A String",
},
},
- "airflowUri": "A String", # Output only.
- # The URI of the Apache Airflow Web UI hosted within this environment (see
+ "airflowUri": "A String", # Output only. The URI of the Apache Airflow Web UI hosted within this environment (see
# [Airflow web
# interface](/composer/docs/how-to/accessing/airflow-web-interface)).
- "gkeCluster": "A String", # Output only.
- # The Kubernetes Engine cluster used to run this environment.
+ "webServerNetworkAccessControl": { # Network-level access control policy for the Airflow web server. # Optional. The network-level access control policy for the Airflow web server. If
+ # unspecified, no network-level access restrictions will be applied.
+ "allowedIpRanges": [ # A collection of allowed IP ranges with descriptions.
+ { # Allowed IP range with user-provided description.
+ "description": "A String", # Optional. User-provided description. It must contain at most 300 characters.
+ "value": "A String", # IP address or range, defined using CIDR notation, of requests that this
+ # rule applies to.
+ # Examples: `192.168.1.1` or `192.168.0.0/16` or `2001:db8::/32`
+ # or `2001:0db8:0000:0042:0000:8a2e:0370:7334`.
+ #
+ #
+ # <p>IP range prefixes should be properly truncated. For example,
+ # `1.2.3.4/24` should be truncated to `1.2.3.0/24`. Similarly, for IPv6,
+ # `2001:db8::1/32` should be truncated to `2001:db8::/32`.
+ },
+ ],
+ },
+ "gkeCluster": "A String", # Output only. The Kubernetes Engine cluster used to run this environment.
"nodeConfig": { # The configuration information for the Kubernetes Engine nodes running # The configuration used for the Kubernetes Engine cluster.
# the Apache Airflow software.
"machineType": "A String", # Optional. The Compute Engine
@@ -699,6 +648,9 @@
# specified, the location information from the specified field will be
# propagated to the unspecified field.
#
+ # The `machineTypeId` must not be a [shared-core machine
+ # type](/compute/docs/machine-types#sharedcore).
+ #
# If this field is unspecified, the `machineTypeId` defaults
# to "n1-standard-1".
"network": "A String", # Optional. The Compute Engine network to be used for machine
@@ -728,29 +680,6 @@
],
"diskSizeGb": 42, # Optional. The disk size in GB used for node VMs. Minimum size is 20GB.
# If unspecified, defaults to 100GB. Cannot be updated.
- "location": "A String", # Optional. The Compute Engine [zone](/compute/docs/regions-zones) in which
- # to deploy the VMs used to run the Apache Airflow software, specified as a
- # [relative resource
- # name](/apis/design/resource_names#relative_resource_name). For example:
- # "projects/{projectId}/zones/{zoneId}".
- #
- # This `location` must belong to the enclosing environment's project and
- # location. If both this field and `nodeConfig.machineType` are specified,
- # `nodeConfig.machineType` must belong to this `location`; 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 (`location` or `nodeConfig.machineType`) is
- # specified, the location information from the specified field will be
- # propagated to the unspecified field.
- "subnetwork": "A String", # Optional. The Compute Engine subnetwork to be used for machine
- # communications, specified as a
- # [relative resource
- # name](/apis/design/resource_names#relative_resource_name). For example:
- # "projects/{projectId}/regions/{regionId}/subnetworks/{subnetworkId}"
- #
- # If a subnetwork is provided, `nodeConfig.network` must also be provided,
- # and the subnetwork must belong to the enclosing environment's project and
- # location.
"ipAllocationPolicy": { # Configuration for controlling how IPs are allocated in the # Optional. The IPAllocationPolicy fields for the GKE cluster.
# GKE cluster.
"clusterIpv4CidrBlock": "A String", # Optional. The IP address range used to allocate IP addresses to pods in
@@ -800,11 +729,40 @@
#
# This field is applicable only when `use_ip_aliases` is true.
},
+ "subnetwork": "A String", # Optional. The Compute Engine subnetwork to be used for machine
+ # communications, specified as a
+ # [relative resource
+ # name](/apis/design/resource_names#relative_resource_name). For example:
+ # "projects/{projectId}/regions/{regionId}/subnetworks/{subnetworkId}"
+ #
+ # If a subnetwork is provided, `nodeConfig.network` must also be provided,
+ # and the subnetwork must belong to the enclosing environment's project and
+ # location.
+ "location": "A String", # Optional. The Compute Engine [zone](/compute/docs/regions-zones) in which
+ # to deploy the VMs used to run the Apache Airflow software, specified as a
+ # [relative resource
+ # name](/apis/design/resource_names#relative_resource_name). For example:
+ # "projects/{projectId}/zones/{zoneId}".
+ #
+ # This `location` must belong to the enclosing environment's project and
+ # location. If both this field and `nodeConfig.machineType` are specified,
+ # `nodeConfig.machineType` must belong to this `location`; 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 (`location` or `nodeConfig.machineType`) is
+ # specified, the location information from the specified field will be
+ # propagated to the unspecified field.
},
"nodeCount": 42, # The number of nodes in the Kubernetes Engine cluster that will be
# used to run this environment.
"privateEnvironmentConfig": { # The configuration information for configuring a Private IP Cloud Composer # The configuration used for the Private IP Cloud Composer environment.
# environment.
+ "cloudSqlIpv4CidrBlock": "A String", # Optional. The CIDR block from which IP range in tenant project will be reserved for
+ # Cloud SQL. Needs to be disjoint from web_server_ipv4_cidr_block
+ "webServerIpv4CidrBlock": "A String", # Optional. The CIDR block from which IP range for web server will be reserved. Needs
+ # to be disjoint from private_cluster_config.master_ipv4_cidr_block and
+ # cloud_sql_ipv4_cidr_block.
+ "webServerIpv4ReservedRange": "A String", # Output only. The IP range reserved for the tenant project's App Engine VMs.
"enablePrivateEnvironment": True or False, # Optional. If `true`, a Private IP Cloud Composer environment is created.
# If this field is true, `use_ip_aliases` must be true.
"privateClusterConfig": { # Configuration options for the private GKE cluster in a Cloud Composer # Optional. Configuration for the private GKE cluster for a Private IP
@@ -812,19 +770,19 @@
# environment.
"enablePrivateEndpoint": True or False, # Optional. If `true`, access to the public endpoint of the GKE cluster is
# denied.
- "masterIpv4CidrBlock": "A String", # The IP range in CIDR notation to use for the hosted master network. This
+ "masterIpv4ReservedRange": "A String", # 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 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. If left blank, the default value of
- # '172.16.0.0/28' is used.
+ # within the cluster's network.
+ "masterIpv4CidrBlock": "A String", # 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.
},
},
},
- "createTime": "A String", # Output only.
- # The time at which this environment was created.
- "name": "A String", # The resource name of the environment, in the form:
- # "projects/{projectId}/locations/{locationId}/environments/{environmentId}"
+ "createTime": "A String", # Output only. The time at which this environment was created.
+ "uuid": "A String", # Output only. The UUID (Universally Unique IDentifier) associated with this environment.
+ # This value is generated when the environment is created.
}</pre>
</div>
@@ -849,34 +807,29 @@
"nextPageToken": "A String", # The page token used to query for the next page if one exists.
"environments": [ # The list of environments returned by a ListEnvironmentsRequest.
{ # An environment for running orchestration tasks.
- "updateTime": "A String", # Output only.
- # The time at which this environment was last modified.
- "uuid": "A String", # Output only.
- # The UUID (Universally Unique IDentifier) associated with this environment.
- # This value is generated when the environment is created.
+ "updateTime": "A String", # Output only. The time at which this environment was last modified.
+ "name": "A String", # 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.
"labels": { # 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
+ # * Both keys and values are additionally constrained to be <= 128 bytes in
# size.
"a_key": "A String",
},
"state": "A String", # The current state of the environment.
"config": { # Configuration information for an environment. # Configuration parameters for this environment.
- "dagGcsPrefix": "A String", # Output only.
- # The Cloud Storage prefix of the DAGs for this environment. Although Cloud
+ "dagGcsPrefix": "A String", # 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.
"softwareConfig": { # Specifies the selection and configuration of software inside the environment. # The configuration settings for software inside the environment.
- "pythonVersion": "A String", # 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 '2'. Cannot be
- # updated.
"imageVersion": "A String", # 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
@@ -891,29 +844,27 @@
# the server replaces `latest` with the current Cloud Composer version
# and stores that version number in the same field.
#
- # The portion of the image version that follows <em>airflow-</em> is an
+ # The portion of the image version that follows <em>airflow-</em> is an
# official Apache Airflow repository
# [release name](https://github.com/apache/incubator-airflow/releases).
#
# See also [Version
# List](/composer/docs/concepts/versioning/composer-versions).
- "airflowConfigOverrides": { # Optional. Apache Airflow configuration properties to override.
+ "pypiPackages": { # Optional. Custom Python Package Index (PyPI) packages to be installed in
+ # the environment.
#
- # 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
- # [snake_case](https://en.wikipedia.org/wiki/Snake_case). Property values can
- # contain any character, and can be written in any lower/upper case format.
- #
- # Certain Apache Airflow configuration property values are
- # [blacklisted](/composer/docs/how-to/managing/setting-airflow-configurations#airflow_configuration_blacklists),
- # and cannot be overridden.
+ # 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.
"a_key": "A String",
},
+ "pythonVersion": "A String", # 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 '2'. Cannot be
+ # updated.
"envVariables": { # Optional. Additional environment variables to provide to the Apache Airflow
# scheduler, worker, and webserver processes.
#
@@ -938,23 +889,45 @@
# * `SQL_USER`
"a_key": "A String",
},
- "pypiPackages": { # Optional. Custom Python Package Index (PyPI) packages to be installed in
- # the environment.
+ "airflowConfigOverrides": { # Optional. Apache Airflow configuration properties to override.
#
- # 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.
+ # 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
+ # [snake_case](https://en.wikipedia.org/wiki/Snake_case). Property values can
+ # contain any character, and can be written in any lower/upper case format.
+ #
+ # Certain Apache Airflow configuration property values are
+ # [blacklisted](/composer/docs/how-to/managing/setting-airflow-configurations#airflow_configuration_blacklists),
+ # and cannot be overridden.
"a_key": "A String",
},
},
- "airflowUri": "A String", # Output only.
- # The URI of the Apache Airflow Web UI hosted within this environment (see
+ "airflowUri": "A String", # Output only. The URI of the Apache Airflow Web UI hosted within this environment (see
# [Airflow web
# interface](/composer/docs/how-to/accessing/airflow-web-interface)).
- "gkeCluster": "A String", # Output only.
- # The Kubernetes Engine cluster used to run this environment.
+ "webServerNetworkAccessControl": { # Network-level access control policy for the Airflow web server. # Optional. The network-level access control policy for the Airflow web server. If
+ # unspecified, no network-level access restrictions will be applied.
+ "allowedIpRanges": [ # A collection of allowed IP ranges with descriptions.
+ { # Allowed IP range with user-provided description.
+ "description": "A String", # Optional. User-provided description. It must contain at most 300 characters.
+ "value": "A String", # IP address or range, defined using CIDR notation, of requests that this
+ # rule applies to.
+ # Examples: `192.168.1.1` or `192.168.0.0/16` or `2001:db8::/32`
+ # or `2001:0db8:0000:0042:0000:8a2e:0370:7334`.
+ #
+ #
+ # <p>IP range prefixes should be properly truncated. For example,
+ # `1.2.3.4/24` should be truncated to `1.2.3.0/24`. Similarly, for IPv6,
+ # `2001:db8::1/32` should be truncated to `2001:db8::/32`.
+ },
+ ],
+ },
+ "gkeCluster": "A String", # Output only. The Kubernetes Engine cluster used to run this environment.
"nodeConfig": { # The configuration information for the Kubernetes Engine nodes running # The configuration used for the Kubernetes Engine cluster.
# the Apache Airflow software.
"machineType": "A String", # Optional. The Compute Engine
@@ -973,6 +946,9 @@
# specified, the location information from the specified field will be
# propagated to the unspecified field.
#
+ # The `machineTypeId` must not be a [shared-core machine
+ # type](/compute/docs/machine-types#sharedcore).
+ #
# If this field is unspecified, the `machineTypeId` defaults
# to "n1-standard-1".
"network": "A String", # Optional. The Compute Engine network to be used for machine
@@ -1002,29 +978,6 @@
],
"diskSizeGb": 42, # Optional. The disk size in GB used for node VMs. Minimum size is 20GB.
# If unspecified, defaults to 100GB. Cannot be updated.
- "location": "A String", # Optional. The Compute Engine [zone](/compute/docs/regions-zones) in which
- # to deploy the VMs used to run the Apache Airflow software, specified as a
- # [relative resource
- # name](/apis/design/resource_names#relative_resource_name). For example:
- # "projects/{projectId}/zones/{zoneId}".
- #
- # This `location` must belong to the enclosing environment's project and
- # location. If both this field and `nodeConfig.machineType` are specified,
- # `nodeConfig.machineType` must belong to this `location`; 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 (`location` or `nodeConfig.machineType`) is
- # specified, the location information from the specified field will be
- # propagated to the unspecified field.
- "subnetwork": "A String", # Optional. The Compute Engine subnetwork to be used for machine
- # communications, specified as a
- # [relative resource
- # name](/apis/design/resource_names#relative_resource_name). For example:
- # "projects/{projectId}/regions/{regionId}/subnetworks/{subnetworkId}"
- #
- # If a subnetwork is provided, `nodeConfig.network` must also be provided,
- # and the subnetwork must belong to the enclosing environment's project and
- # location.
"ipAllocationPolicy": { # Configuration for controlling how IPs are allocated in the # Optional. The IPAllocationPolicy fields for the GKE cluster.
# GKE cluster.
"clusterIpv4CidrBlock": "A String", # Optional. The IP address range used to allocate IP addresses to pods in
@@ -1074,11 +1027,40 @@
#
# This field is applicable only when `use_ip_aliases` is true.
},
+ "subnetwork": "A String", # Optional. The Compute Engine subnetwork to be used for machine
+ # communications, specified as a
+ # [relative resource
+ # name](/apis/design/resource_names#relative_resource_name). For example:
+ # "projects/{projectId}/regions/{regionId}/subnetworks/{subnetworkId}"
+ #
+ # If a subnetwork is provided, `nodeConfig.network` must also be provided,
+ # and the subnetwork must belong to the enclosing environment's project and
+ # location.
+ "location": "A String", # Optional. The Compute Engine [zone](/compute/docs/regions-zones) in which
+ # to deploy the VMs used to run the Apache Airflow software, specified as a
+ # [relative resource
+ # name](/apis/design/resource_names#relative_resource_name). For example:
+ # "projects/{projectId}/zones/{zoneId}".
+ #
+ # This `location` must belong to the enclosing environment's project and
+ # location. If both this field and `nodeConfig.machineType` are specified,
+ # `nodeConfig.machineType` must belong to this `location`; 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 (`location` or `nodeConfig.machineType`) is
+ # specified, the location information from the specified field will be
+ # propagated to the unspecified field.
},
"nodeCount": 42, # The number of nodes in the Kubernetes Engine cluster that will be
# used to run this environment.
"privateEnvironmentConfig": { # The configuration information for configuring a Private IP Cloud Composer # The configuration used for the Private IP Cloud Composer environment.
# environment.
+ "cloudSqlIpv4CidrBlock": "A String", # Optional. The CIDR block from which IP range in tenant project will be reserved for
+ # Cloud SQL. Needs to be disjoint from web_server_ipv4_cidr_block
+ "webServerIpv4CidrBlock": "A String", # Optional. The CIDR block from which IP range for web server will be reserved. Needs
+ # to be disjoint from private_cluster_config.master_ipv4_cidr_block and
+ # cloud_sql_ipv4_cidr_block.
+ "webServerIpv4ReservedRange": "A String", # Output only. The IP range reserved for the tenant project's App Engine VMs.
"enablePrivateEnvironment": True or False, # Optional. If `true`, a Private IP Cloud Composer environment is created.
# If this field is true, `use_ip_aliases` must be true.
"privateClusterConfig": { # Configuration options for the private GKE cluster in a Cloud Composer # Optional. Configuration for the private GKE cluster for a Private IP
@@ -1086,19 +1068,19 @@
# environment.
"enablePrivateEndpoint": True or False, # Optional. If `true`, access to the public endpoint of the GKE cluster is
# denied.
- "masterIpv4CidrBlock": "A String", # The IP range in CIDR notation to use for the hosted master network. This
+ "masterIpv4ReservedRange": "A String", # 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 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. If left blank, the default value of
- # '172.16.0.0/28' is used.
+ # within the cluster's network.
+ "masterIpv4CidrBlock": "A String", # 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.
},
},
},
- "createTime": "A String", # Output only.
- # The time at which this environment was created.
- "name": "A String", # The resource name of the environment, in the form:
- # "projects/{projectId}/locations/{locationId}/environments/{environmentId}"
+ "createTime": "A String", # Output only. The time at which this environment was created.
+ "uuid": "A String", # Output only. The UUID (Universally Unique IDentifier) associated with this environment.
+ # This value is generated when the environment is created.
},
],
}</pre>
@@ -1119,44 +1101,39 @@
</div>
<div class="method">
- <code class="details" id="patch">patch(name, body, updateMask=None, x__xgafv=None)</code>
+ <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
<pre>Update an environment.
Args:
name: string, The relative resource name of the environment to update, in the form:
"projects/{projectId}/locations/{locationId}/environments/{environmentId}" (required)
- body: object, The request body. (required)
+ body: object, The request body.
The object takes the form of:
{ # An environment for running orchestration tasks.
- "updateTime": "A String", # Output only.
- # The time at which this environment was last modified.
- "uuid": "A String", # Output only.
- # The UUID (Universally Unique IDentifier) associated with this environment.
- # This value is generated when the environment is created.
+ "updateTime": "A String", # Output only. The time at which this environment was last modified.
+ "name": "A String", # 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.
"labels": { # 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
+ # * Both keys and values are additionally constrained to be <= 128 bytes in
# size.
"a_key": "A String",
},
"state": "A String", # The current state of the environment.
"config": { # Configuration information for an environment. # Configuration parameters for this environment.
- "dagGcsPrefix": "A String", # Output only.
- # The Cloud Storage prefix of the DAGs for this environment. Although Cloud
+ "dagGcsPrefix": "A String", # 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.
"softwareConfig": { # Specifies the selection and configuration of software inside the environment. # The configuration settings for software inside the environment.
- "pythonVersion": "A String", # 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 '2'. Cannot be
- # updated.
"imageVersion": "A String", # 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
@@ -1171,29 +1148,27 @@
# the server replaces `latest` with the current Cloud Composer version
# and stores that version number in the same field.
#
- # The portion of the image version that follows <em>airflow-</em> is an
+ # The portion of the image version that follows <em>airflow-</em> is an
# official Apache Airflow repository
# [release name](https://github.com/apache/incubator-airflow/releases).
#
# See also [Version
# List](/composer/docs/concepts/versioning/composer-versions).
- "airflowConfigOverrides": { # Optional. Apache Airflow configuration properties to override.
+ "pypiPackages": { # Optional. Custom Python Package Index (PyPI) packages to be installed in
+ # the environment.
#
- # 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
- # [snake_case](https://en.wikipedia.org/wiki/Snake_case). Property values can
- # contain any character, and can be written in any lower/upper case format.
- #
- # Certain Apache Airflow configuration property values are
- # [blacklisted](/composer/docs/how-to/managing/setting-airflow-configurations#airflow_configuration_blacklists),
- # and cannot be overridden.
+ # 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.
"a_key": "A String",
},
+ "pythonVersion": "A String", # 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 '2'. Cannot be
+ # updated.
"envVariables": { # Optional. Additional environment variables to provide to the Apache Airflow
# scheduler, worker, and webserver processes.
#
@@ -1218,23 +1193,45 @@
# * `SQL_USER`
"a_key": "A String",
},
- "pypiPackages": { # Optional. Custom Python Package Index (PyPI) packages to be installed in
- # the environment.
+ "airflowConfigOverrides": { # Optional. Apache Airflow configuration properties to override.
#
- # 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.
+ # 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
+ # [snake_case](https://en.wikipedia.org/wiki/Snake_case). Property values can
+ # contain any character, and can be written in any lower/upper case format.
+ #
+ # Certain Apache Airflow configuration property values are
+ # [blacklisted](/composer/docs/how-to/managing/setting-airflow-configurations#airflow_configuration_blacklists),
+ # and cannot be overridden.
"a_key": "A String",
},
},
- "airflowUri": "A String", # Output only.
- # The URI of the Apache Airflow Web UI hosted within this environment (see
+ "airflowUri": "A String", # Output only. The URI of the Apache Airflow Web UI hosted within this environment (see
# [Airflow web
# interface](/composer/docs/how-to/accessing/airflow-web-interface)).
- "gkeCluster": "A String", # Output only.
- # The Kubernetes Engine cluster used to run this environment.
+ "webServerNetworkAccessControl": { # Network-level access control policy for the Airflow web server. # Optional. The network-level access control policy for the Airflow web server. If
+ # unspecified, no network-level access restrictions will be applied.
+ "allowedIpRanges": [ # A collection of allowed IP ranges with descriptions.
+ { # Allowed IP range with user-provided description.
+ "description": "A String", # Optional. User-provided description. It must contain at most 300 characters.
+ "value": "A String", # IP address or range, defined using CIDR notation, of requests that this
+ # rule applies to.
+ # Examples: `192.168.1.1` or `192.168.0.0/16` or `2001:db8::/32`
+ # or `2001:0db8:0000:0042:0000:8a2e:0370:7334`.
+ #
+ #
+ # <p>IP range prefixes should be properly truncated. For example,
+ # `1.2.3.4/24` should be truncated to `1.2.3.0/24`. Similarly, for IPv6,
+ # `2001:db8::1/32` should be truncated to `2001:db8::/32`.
+ },
+ ],
+ },
+ "gkeCluster": "A String", # Output only. The Kubernetes Engine cluster used to run this environment.
"nodeConfig": { # The configuration information for the Kubernetes Engine nodes running # The configuration used for the Kubernetes Engine cluster.
# the Apache Airflow software.
"machineType": "A String", # Optional. The Compute Engine
@@ -1253,6 +1250,9 @@
# specified, the location information from the specified field will be
# propagated to the unspecified field.
#
+ # The `machineTypeId` must not be a [shared-core machine
+ # type](/compute/docs/machine-types#sharedcore).
+ #
# If this field is unspecified, the `machineTypeId` defaults
# to "n1-standard-1".
"network": "A String", # Optional. The Compute Engine network to be used for machine
@@ -1282,29 +1282,6 @@
],
"diskSizeGb": 42, # Optional. The disk size in GB used for node VMs. Minimum size is 20GB.
# If unspecified, defaults to 100GB. Cannot be updated.
- "location": "A String", # Optional. The Compute Engine [zone](/compute/docs/regions-zones) in which
- # to deploy the VMs used to run the Apache Airflow software, specified as a
- # [relative resource
- # name](/apis/design/resource_names#relative_resource_name). For example:
- # "projects/{projectId}/zones/{zoneId}".
- #
- # This `location` must belong to the enclosing environment's project and
- # location. If both this field and `nodeConfig.machineType` are specified,
- # `nodeConfig.machineType` must belong to this `location`; 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 (`location` or `nodeConfig.machineType`) is
- # specified, the location information from the specified field will be
- # propagated to the unspecified field.
- "subnetwork": "A String", # Optional. The Compute Engine subnetwork to be used for machine
- # communications, specified as a
- # [relative resource
- # name](/apis/design/resource_names#relative_resource_name). For example:
- # "projects/{projectId}/regions/{regionId}/subnetworks/{subnetworkId}"
- #
- # If a subnetwork is provided, `nodeConfig.network` must also be provided,
- # and the subnetwork must belong to the enclosing environment's project and
- # location.
"ipAllocationPolicy": { # Configuration for controlling how IPs are allocated in the # Optional. The IPAllocationPolicy fields for the GKE cluster.
# GKE cluster.
"clusterIpv4CidrBlock": "A String", # Optional. The IP address range used to allocate IP addresses to pods in
@@ -1354,11 +1331,40 @@
#
# This field is applicable only when `use_ip_aliases` is true.
},
+ "subnetwork": "A String", # Optional. The Compute Engine subnetwork to be used for machine
+ # communications, specified as a
+ # [relative resource
+ # name](/apis/design/resource_names#relative_resource_name). For example:
+ # "projects/{projectId}/regions/{regionId}/subnetworks/{subnetworkId}"
+ #
+ # If a subnetwork is provided, `nodeConfig.network` must also be provided,
+ # and the subnetwork must belong to the enclosing environment's project and
+ # location.
+ "location": "A String", # Optional. The Compute Engine [zone](/compute/docs/regions-zones) in which
+ # to deploy the VMs used to run the Apache Airflow software, specified as a
+ # [relative resource
+ # name](/apis/design/resource_names#relative_resource_name). For example:
+ # "projects/{projectId}/zones/{zoneId}".
+ #
+ # This `location` must belong to the enclosing environment's project and
+ # location. If both this field and `nodeConfig.machineType` are specified,
+ # `nodeConfig.machineType` must belong to this `location`; 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 (`location` or `nodeConfig.machineType`) is
+ # specified, the location information from the specified field will be
+ # propagated to the unspecified field.
},
"nodeCount": 42, # The number of nodes in the Kubernetes Engine cluster that will be
# used to run this environment.
"privateEnvironmentConfig": { # The configuration information for configuring a Private IP Cloud Composer # The configuration used for the Private IP Cloud Composer environment.
# environment.
+ "cloudSqlIpv4CidrBlock": "A String", # Optional. The CIDR block from which IP range in tenant project will be reserved for
+ # Cloud SQL. Needs to be disjoint from web_server_ipv4_cidr_block
+ "webServerIpv4CidrBlock": "A String", # Optional. The CIDR block from which IP range for web server will be reserved. Needs
+ # to be disjoint from private_cluster_config.master_ipv4_cidr_block and
+ # cloud_sql_ipv4_cidr_block.
+ "webServerIpv4ReservedRange": "A String", # Output only. The IP range reserved for the tenant project's App Engine VMs.
"enablePrivateEnvironment": True or False, # Optional. If `true`, a Private IP Cloud Composer environment is created.
# If this field is true, `use_ip_aliases` must be true.
"privateClusterConfig": { # Configuration options for the private GKE cluster in a Cloud Composer # Optional. Configuration for the private GKE cluster for a Private IP
@@ -1366,19 +1372,19 @@
# environment.
"enablePrivateEndpoint": True or False, # Optional. If `true`, access to the public endpoint of the GKE cluster is
# denied.
- "masterIpv4CidrBlock": "A String", # The IP range in CIDR notation to use for the hosted master network. This
+ "masterIpv4ReservedRange": "A String", # 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 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. If left blank, the default value of
- # '172.16.0.0/28' is used.
+ # within the cluster's network.
+ "masterIpv4CidrBlock": "A String", # 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.
},
},
},
- "createTime": "A String", # Output only.
- # The time at which this environment was created.
- "name": "A String", # The resource name of the environment, in the form:
- # "projects/{projectId}/locations/{locationId}/environments/{environmentId}"
+ "createTime": "A String", # Output only. The time at which this environment was created.
+ "uuid": "A String", # Output only. The UUID (Universally Unique IDentifier) associated with this environment.
+ # This value is generated when the environment is created.
}
updateMask: string, Required. A comma-separated list of paths, relative to `Environment`, of
@@ -1440,90 +1446,90 @@
}
}
-<strong>Note:</strong> Only the following fields can be updated:
+<strong>Note:</strong> Only the following fields can be updated:
- <table>
- <tbody>
- <tr>
- <td><strong>Mask</strong></td>
- <td><strong>Purpose</strong></td>
- </tr>
- <tr>
- <td>config.softwareConfig.pypiPackages
- </td>
- <td>Replace all custom custom PyPI packages. If a replacement
+ <table>
+ <tbody>
+ <tr>
+ <td><strong>Mask</strong></td>
+ <td><strong>Purpose</strong></td>
+ </tr>
+ <tr>
+ <td>config.softwareConfig.pypiPackages
+ </td>
+ <td>Replace all custom custom PyPI packages. If a replacement
package map is not included in `environment`, all custom
PyPI packages are cleared. It is an error to provide both this mask and a
- mask specifying an individual package.</td>
- </tr>
- <tr>
- <td>config.softwareConfig.pypiPackages.<var>packagename</var></td>
- <td>Update the custom PyPI package <var>packagename</var>,
+ mask specifying an individual package.</td>
+ </tr>
+ <tr>
+ <td>config.softwareConfig.pypiPackages.<var>packagename</var></td>
+ <td>Update the custom PyPI package <var>packagename</var>,
preserving other packages. To delete the package, include it in
`updateMask`, and omit the mapping for it in
`environment.config.softwareConfig.pypiPackages`. It is an error
to provide both a mask of this form and the
- "config.softwareConfig.pypiPackages" mask.</td>
- </tr>
- <tr>
- <td>labels</td>
- <td>Replace all environment labels. If a replacement labels map is not
+ "config.softwareConfig.pypiPackages" mask.</td>
+ </tr>
+ <tr>
+ <td>labels</td>
+ <td>Replace all environment labels. If a replacement labels map is not
included in `environment`, all labels are cleared. It is an error to
provide both this mask and a mask specifying one or more individual
- labels.</td>
- </tr>
- <tr>
- <td>labels.<var>labelName</var></td>
- <td>Set the label named <var>labelName</var>, while preserving other
+ labels.</td>
+ </tr>
+ <tr>
+ <td>labels.<var>labelName</var></td>
+ <td>Set the label named <var>labelName</var>, while preserving other
labels. To delete the label, include it in `updateMask` and omit its
mapping in `environment.labels`. It is an error to provide both a
- mask of this form and the "labels" mask.</td>
- </tr>
- <tr>
- <td>config.nodeCount</td>
- <td>Horizontally scale the number of nodes in the environment. An integer
+ mask of this form and the "labels" mask.</td>
+ </tr>
+ <tr>
+ <td>config.nodeCount</td>
+ <td>Horizontally scale the number of nodes in the environment. An integer
greater than or equal to 3 must be provided in the `config.nodeCount`
field.
- </td>
- </tr>
- <tr>
- <td>config.softwareConfig.airflowConfigOverrides</td>
- <td>Replace all Apache Airflow config overrides. If a replacement config
+ </td>
+ </tr>
+ <tr>
+ <td>config.softwareConfig.airflowConfigOverrides</td>
+ <td>Replace all Apache Airflow config overrides. If a replacement config
overrides map is not included in `environment`, all config overrides
are cleared.
It is an error to provide both this mask and a mask specifying one or
- more individual config overrides.</td>
- </tr>
- <tr>
- <td>config.softwareConfig.airflowConfigOverrides.<var>section</var>-<var>name
- </var></td>
- <td>Override the Apache Airflow config property <var>name</var> in the
- section named <var>section</var>, preserving other properties. To delete
+ more individual config overrides.</td>
+ </tr>
+ <tr>
+ <td>config.softwareConfig.airflowConfigOverrides.<var>section</var>-<var>name
+ </var></td>
+ <td>Override the Apache Airflow config property <var>name</var> in the
+ section named <var>section</var>, preserving other properties. To delete
the property override, include it in `updateMask` and omit its mapping
in `environment.config.softwareConfig.airflowConfigOverrides`.
It is an error to provide both a mask of this form and the
- "config.softwareConfig.airflowConfigOverrides" mask.</td>
- </tr>
- <tr>
- <td>config.softwareConfig.envVariables</td>
- <td>Replace all environment variables. If a replacement environment
+ "config.softwareConfig.airflowConfigOverrides" mask.</td>
+ </tr>
+ <tr>
+ <td>config.softwareConfig.envVariables</td>
+ <td>Replace all environment variables. If a replacement environment
variable map is not included in `environment`, all custom environment
variables are cleared.
It is an error to provide both this mask and a mask specifying one or
- more individual environment variables.</td>
- </tr>
- <tr>
- <td>config.softwareConfig.imageVersion</td>
- <td>Upgrade the version of the environment in-place. Refer to
+ more individual environment variables.</td>
+ </tr>
+ <tr>
+ <td>config.softwareConfig.imageVersion</td>
+ <td>Upgrade the version of the environment in-place. Refer to
`SoftwareConfig.image_version` for information on how to format the new
image version. Additionally, the new image version cannot effect a version
downgrade and must match the current image version's Composer major
version and Airflow major and minor versions. Consult the
- <a href="/composer/docs/concepts/versioning/composer-versions">Cloud
- Composer Version List</a> for valid values.</td>
- </tr>
- </tbody>
- </table>
+ <a href="/composer/docs/concepts/versioning/composer-versions">Cloud
+ Composer Version List</a> for valid values.</td>
+ </tr>
+ </tbody>
+ </table>
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -1534,64 +1540,13 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
- "metadata": { # Service-specific metadata associated with the operation. It typically
- # contains progress information and common metadata such as create time.
- # Some services might not provide such metadata. Any method that returns a
- # long-running operation should document the metadata type, if any.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
"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.
# different programming environments, including REST APIs and RPC APIs. It is
- # used by [gRPC](https://github.com/grpc). The error model is designed to be:
+ # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+ # three pieces of data: error code, error message, and error details.
#
- # - Simple to use and understand for most users
- # - Flexible enough to meet unexpected needs
- #
- # # Overview
- #
- # The `Status` message contains three pieces of data: error code, error
- # message, and error details. The error code should be an enum value of
- # google.rpc.Code, but it may accept additional error codes if needed. The
- # error message should be a developer-facing English message that helps
- # developers *understand* and *resolve* the error. If a localized user-facing
- # error message is needed, put the localized message in the error details or
- # localize it in the client. The optional error details may contain arbitrary
- # information about the error. There is a predefined set of error detail types
- # in the package `google.rpc` that can be used for common error conditions.
- #
- # # Language mapping
- #
- # The `Status` message is the logical representation of the error model, but it
- # is not necessarily the actual wire format. When the `Status` message is
- # exposed in different client libraries and different wire protocols, it can be
- # mapped differently. For example, it will likely be mapped to some exceptions
- # in Java, but more likely mapped to some error codes in C.
- #
- # # Other uses
- #
- # The error model and the `Status` message can be used in a variety of
- # environments, either with or without APIs, to provide a
- # consistent developer experience across different environments.
- #
- # Example uses of this error model include:
- #
- # - Partial errors. If a service needs to return partial errors to the client,
- # it may embed the `Status` in the normal response to indicate the partial
- # errors.
- #
- # - Workflow errors. A typical workflow has multiple steps. Each step may
- # have a `Status` message for error reporting.
- #
- # - Batch operations. If a client uses batch request and batch response, the
- # `Status` message should be used directly inside batch response, one for
- # each error sub-response.
- #
- # - Asynchronous operations. If an API call embeds asynchronous operation
- # results in its response, the status of those operations should be
- # represented directly using the `Status` message.
- #
- # - Logging. If some API errors are stored in logs, the message `Status` could
- # be used directly after any stripping needed for security/privacy reasons.
+ # You can find out more about this error model and how to work with it in the
+ # [API Design Guide](https://cloud.google.com/apis/design/errors).
"message": "A String", # A developer-facing error message, which should be in English. Any
# user-facing error message should be localized and sent in the
# google.rpc.Status.details field, or localized by the client.
@@ -1619,6 +1574,12 @@
"name": "A String", # The server-assigned name, which is only unique within the same service that
# originally returns it. If you use the default HTTP mapping, the
# `name` should be a resource name ending with `operations/{unique_id}`.
+ "metadata": { # Service-specific metadata associated with the operation. It typically
+ # contains progress information and common metadata such as create time.
+ # Some services might not provide such metadata. Any method that returns a
+ # long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
}</pre>
</div>