chore: regens API reference docs (#889)
diff --git a/docs/dyn/composer_v1.projects.locations.environments.html b/docs/dyn/composer_v1.projects.locations.environments.html
index 724f68e..e7b70b3 100644
--- a/docs/dyn/composer_v1.projects.locations.environments.html
+++ b/docs/dyn/composer_v1.projects.locations.environments.html
@@ -75,7 +75,7 @@
<h1><a href="composer_v1.html">Cloud Composer API</a> . <a href="composer_v1.projects.html">projects</a> . <a href="composer_v1.projects.locations.html">locations</a> . <a href="composer_v1.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>
@@ -84,30 +84,28 @@
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Get an existing environment.</p>
<p class="toc_element">
- <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(parent, pageToken=None, x__xgafv=None, pageSize=None)</a></code></p>
<p class="firstline">List environments.</p>
<p class="toc_element">
<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.
+ "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.
"labels": { # Optional. User-defined labels for this environment.
# The labels map can contain no more than 64 entries. Entries of the labels
@@ -115,14 +113,13 @@
#
# * 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.
@@ -141,7 +138,7 @@
# 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).
#
@@ -152,7 +149,7 @@
#
# 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
+ # "==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",
@@ -204,12 +201,10 @@
"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.
+ "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 +223,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
@@ -280,14 +278,84 @@
# 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 configuration for controlling how IPs are allocated in the GKE cluster.
+ # GKE cluster running the Apache Airflow software.
+ "clusterIpv4CidrBlock": "A String", # Optional. The IP address range used to allocate IP addresses to pods in
+ # the GKE cluster.
+ #
+ # This field is applicable only when `use_ip_aliases` is true.
+ #
+ # Set to blank to have GKE choose a range with the default size.
+ #
+ # Set to /netmask (e.g. `/14`) to have GKE choose a range with a specific
+ # netmask.
+ #
+ # Set to a
+ # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)
+ # notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.
+ # `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range
+ # to use.
+ "servicesIpv4CidrBlock": "A String", # Optional. The IP address range of the services IP addresses in this
+ # GKE cluster.
+ #
+ # This field is applicable only when `use_ip_aliases` is true.
+ #
+ # Set to blank to have GKE choose a range with the default size.
+ #
+ # Set to /netmask (e.g. `/14`) to have GKE choose a range with a specific
+ # netmask.
+ #
+ # Set to a
+ # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)
+ # notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.
+ # `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range
+ # to use.
+ "servicesSecondaryRangeName": "A String", # Optional. The name of the services' secondary range used to allocate
+ # IP addresses to the GKE cluster.
+ #
+ # This field is applicable only when `use_ip_aliases` is true.
+ "useIpAliases": True or False, # Optional. Whether or not to enable Alias IPs in the GKE cluster.
+ # If `true`, a VPC-native cluster is created.
+ "clusterSecondaryRangeName": "A String", # Optional. The name of the GKE cluster's secondary range used to allocate
+ # IP addresses to pods.
+ #
+ # This field is applicable only when `use_ip_aliases` is true.
+ },
},
"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 set to true, `IPAllocationPolicy.use_ip_aliases` must be
+ # set to true.
+ "privateClusterConfig": { # Configuration options for the private GKE cluster in a Cloud Composer # Optional. Configuration for the private GKE cluster for a Private IP
+ # Cloud Composer environment.
+ # environment.
+ "enablePrivateEndpoint": True or False, # Optional. If `true`, access to the public endpoint of the GKE cluster is
+ # denied.
+ "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 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.
+ "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.
+ "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}"
+ #
+ # EnvironmentId must start with a lowercase letter followed by up to 63
+ # lowercase letters, numbers, or hyphens, and cannot end with a hyphen.
}
x__xgafv: string, V1 error format.
@@ -308,56 +376,11 @@
},
"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.
@@ -413,56 +436,11 @@
},
"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.
@@ -509,10 +487,8 @@
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.
+ "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.
"labels": { # Optional. User-defined labels for this environment.
# The labels map can contain no more than 64 entries. Entries of the labels
@@ -520,14 +496,13 @@
#
# * 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.
@@ -546,7 +521,7 @@
# 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).
#
@@ -557,7 +532,7 @@
#
# 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
+ # "==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",
@@ -609,12 +584,10 @@
"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.
+ "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
@@ -633,6 +606,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
@@ -685,30 +661,100 @@
# 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 configuration for controlling how IPs are allocated in the GKE cluster.
+ # GKE cluster running the Apache Airflow software.
+ "clusterIpv4CidrBlock": "A String", # Optional. The IP address range used to allocate IP addresses to pods in
+ # the GKE cluster.
+ #
+ # This field is applicable only when `use_ip_aliases` is true.
+ #
+ # Set to blank to have GKE choose a range with the default size.
+ #
+ # Set to /netmask (e.g. `/14`) to have GKE choose a range with a specific
+ # netmask.
+ #
+ # Set to a
+ # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)
+ # notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.
+ # `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range
+ # to use.
+ "servicesIpv4CidrBlock": "A String", # Optional. The IP address range of the services IP addresses in this
+ # GKE cluster.
+ #
+ # This field is applicable only when `use_ip_aliases` is true.
+ #
+ # Set to blank to have GKE choose a range with the default size.
+ #
+ # Set to /netmask (e.g. `/14`) to have GKE choose a range with a specific
+ # netmask.
+ #
+ # Set to a
+ # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)
+ # notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.
+ # `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range
+ # to use.
+ "servicesSecondaryRangeName": "A String", # Optional. The name of the services' secondary range used to allocate
+ # IP addresses to the GKE cluster.
+ #
+ # This field is applicable only when `use_ip_aliases` is true.
+ "useIpAliases": True or False, # Optional. Whether or not to enable Alias IPs in the GKE cluster.
+ # If `true`, a VPC-native cluster is created.
+ "clusterSecondaryRangeName": "A String", # Optional. The name of the GKE cluster's secondary range used to allocate
+ # IP addresses to pods.
+ #
+ # This field is applicable only when `use_ip_aliases` is true.
+ },
},
"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 set to true, `IPAllocationPolicy.use_ip_aliases` must be
+ # set to true.
+ "privateClusterConfig": { # Configuration options for the private GKE cluster in a Cloud Composer # Optional. Configuration for the private GKE cluster for a Private IP
+ # Cloud Composer environment.
+ # environment.
+ "enablePrivateEndpoint": True or False, # Optional. If `true`, access to the public endpoint of the GKE cluster is
+ # denied.
+ "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 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.
+ "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.
+ "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}"
+ #
+ # EnvironmentId must start with a lowercase letter followed by up to 63
+ # lowercase letters, numbers, or hyphens, and cannot end with a hyphen.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(parent, pageToken=None, x__xgafv=None, pageSize=None)</code>
<pre>List environments.
Args:
parent: string, List environments in the given project and location, in the form:
"projects/{projectId}/locations/{locationId}" (required)
- pageSize: integer, The maximum number of environments to return.
pageToken: string, The next_page_token value returned from a previous List request, if any.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
+ pageSize: integer, The maximum number of environments to return.
Returns:
An object of the form:
@@ -717,10 +763,8 @@
"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.
+ "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.
"labels": { # Optional. User-defined labels for this environment.
# The labels map can contain no more than 64 entries. Entries of the labels
@@ -728,14 +772,13 @@
#
# * 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.
@@ -754,7 +797,7 @@
# 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).
#
@@ -765,7 +808,7 @@
#
# 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
+ # "==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",
@@ -817,12 +860,10 @@
"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.
+ "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
@@ -841,6 +882,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
@@ -893,14 +937,84 @@
# 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 configuration for controlling how IPs are allocated in the GKE cluster.
+ # GKE cluster running the Apache Airflow software.
+ "clusterIpv4CidrBlock": "A String", # Optional. The IP address range used to allocate IP addresses to pods in
+ # the GKE cluster.
+ #
+ # This field is applicable only when `use_ip_aliases` is true.
+ #
+ # Set to blank to have GKE choose a range with the default size.
+ #
+ # Set to /netmask (e.g. `/14`) to have GKE choose a range with a specific
+ # netmask.
+ #
+ # Set to a
+ # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)
+ # notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.
+ # `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range
+ # to use.
+ "servicesIpv4CidrBlock": "A String", # Optional. The IP address range of the services IP addresses in this
+ # GKE cluster.
+ #
+ # This field is applicable only when `use_ip_aliases` is true.
+ #
+ # Set to blank to have GKE choose a range with the default size.
+ #
+ # Set to /netmask (e.g. `/14`) to have GKE choose a range with a specific
+ # netmask.
+ #
+ # Set to a
+ # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)
+ # notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.
+ # `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range
+ # to use.
+ "servicesSecondaryRangeName": "A String", # Optional. The name of the services' secondary range used to allocate
+ # IP addresses to the GKE cluster.
+ #
+ # This field is applicable only when `use_ip_aliases` is true.
+ "useIpAliases": True or False, # Optional. Whether or not to enable Alias IPs in the GKE cluster.
+ # If `true`, a VPC-native cluster is created.
+ "clusterSecondaryRangeName": "A String", # Optional. The name of the GKE cluster's secondary range used to allocate
+ # IP addresses to pods.
+ #
+ # This field is applicable only when `use_ip_aliases` is true.
+ },
},
"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 set to true, `IPAllocationPolicy.use_ip_aliases` must be
+ # set to true.
+ "privateClusterConfig": { # Configuration options for the private GKE cluster in a Cloud Composer # Optional. Configuration for the private GKE cluster for a Private IP
+ # Cloud Composer environment.
+ # environment.
+ "enablePrivateEndpoint": True or False, # Optional. If `true`, access to the public endpoint of the GKE cluster is
+ # denied.
+ "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 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.
+ "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.
+ "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}"
+ #
+ # EnvironmentId must start with a lowercase letter followed by up to 63
+ # lowercase letters, numbers, or hyphens, and cannot end with a hyphen.
},
],
}</pre>
@@ -921,20 +1035,18 @@
</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.
+ "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.
"labels": { # Optional. User-defined labels for this environment.
# The labels map can contain no more than 64 entries. Entries of the labels
@@ -942,14 +1054,13 @@
#
# * 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.
@@ -968,7 +1079,7 @@
# 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).
#
@@ -979,7 +1090,7 @@
#
# 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
+ # "==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",
@@ -1031,12 +1142,10 @@
"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.
+ "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
@@ -1055,6 +1164,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
@@ -1107,14 +1219,84 @@
# 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 configuration for controlling how IPs are allocated in the GKE cluster.
+ # GKE cluster running the Apache Airflow software.
+ "clusterIpv4CidrBlock": "A String", # Optional. The IP address range used to allocate IP addresses to pods in
+ # the GKE cluster.
+ #
+ # This field is applicable only when `use_ip_aliases` is true.
+ #
+ # Set to blank to have GKE choose a range with the default size.
+ #
+ # Set to /netmask (e.g. `/14`) to have GKE choose a range with a specific
+ # netmask.
+ #
+ # Set to a
+ # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)
+ # notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.
+ # `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range
+ # to use.
+ "servicesIpv4CidrBlock": "A String", # Optional. The IP address range of the services IP addresses in this
+ # GKE cluster.
+ #
+ # This field is applicable only when `use_ip_aliases` is true.
+ #
+ # Set to blank to have GKE choose a range with the default size.
+ #
+ # Set to /netmask (e.g. `/14`) to have GKE choose a range with a specific
+ # netmask.
+ #
+ # Set to a
+ # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)
+ # notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.
+ # `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range
+ # to use.
+ "servicesSecondaryRangeName": "A String", # Optional. The name of the services' secondary range used to allocate
+ # IP addresses to the GKE cluster.
+ #
+ # This field is applicable only when `use_ip_aliases` is true.
+ "useIpAliases": True or False, # Optional. Whether or not to enable Alias IPs in the GKE cluster.
+ # If `true`, a VPC-native cluster is created.
+ "clusterSecondaryRangeName": "A String", # Optional. The name of the GKE cluster's secondary range used to allocate
+ # IP addresses to pods.
+ #
+ # This field is applicable only when `use_ip_aliases` is true.
+ },
},
"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 set to true, `IPAllocationPolicy.use_ip_aliases` must be
+ # set to true.
+ "privateClusterConfig": { # Configuration options for the private GKE cluster in a Cloud Composer # Optional. Configuration for the private GKE cluster for a Private IP
+ # Cloud Composer environment.
+ # environment.
+ "enablePrivateEndpoint": True or False, # Optional. If `true`, access to the public endpoint of the GKE cluster is
+ # denied.
+ "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 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.
+ "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.
+ "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}"
+ #
+ # EnvironmentId must start with a lowercase letter followed by up to 63
+ # lowercase letters, numbers, or hyphens, and cannot end with a hyphen.
}
updateMask: string, Required. A comma-separated list of paths, relative to `Environment`, of
@@ -1178,78 +1360,78 @@
**Note:** 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>
- </tbody>
- </table>
+ more individual environment variables.</td>
+ </tr>
+ </tbody>
+ </table>
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -1268,56 +1450,11 @@
},
"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.