docs: update generated docs (#981)
diff --git a/docs/dyn/composer_v1beta1.projects.locations.environments.html b/docs/dyn/composer_v1beta1.projects.locations.environments.html
index 8d1add5..0987f0f 100644
--- a/docs/dyn/composer_v1beta1.projects.locations.environments.html
+++ b/docs/dyn/composer_v1beta1.projects.locations.environments.html
@@ -84,7 +84,7 @@
<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, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=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>
@@ -104,52 +104,57 @@
The object takes the form of:
{ # An environment for running orchestration tasks.
- "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
- # size.
- "a_key": "A String",
- },
- "createTime": "A String", # Output only. The time at which this environment was created.
- "state": "A String", # The current state of the environment.
+ "uuid": "A String", # Output only. The UUID (Universally Unique IDentifier) associated with this environment.
+ # This value is generated when the environment is created.
"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
- # 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.
- "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
- "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.
- "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.
- "enablePrivateEndpoint": True or False, # Optional. If `true`, access to the public endpoint of the GKE cluster is
- # denied.
- "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.
- },
- "webServerIpv4ReservedRange": "A String", # Output only. The IP range reserved for the tenant project's App Engine VMs.
- "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.
- "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.
- },
"gkeCluster": "A String", # Output only. The Kubernetes Engine cluster used to run this environment.
- "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)).
+ "nodeCount": 42, # The number of nodes in the Kubernetes Engine cluster that will be
+ # used to run this environment.
+ "databaseConfig": { # The configuration of Cloud SQL instance that is used by the Apache Airflow # Optional. The configuration settings for Cloud SQL instance used internally by Apache
+ # Airflow software.
+ # software.
+ "machineType": "A String", # Optional. Cloud SQL machine type used by Airflow database.
+ # It has to be one of: db-n1-standard-2, db-n1-standard-4, db-n1-standard-8
+ # or db-n1-standard-16. If not specified, db-n1-standard-2 will be used.
+ },
"softwareConfig": { # Specifies the selection and configuration of software inside the environment. # The configuration settings for software inside the environment.
+ "airflowConfigOverrides": { # Optional. Apache Airflow configuration properties to override.
+ #
+ # Property keys contain the section and property names, separated by a
+ # hyphen, for example "core-dags_are_paused_at_creation". Section names must
+ # not contain hyphens ("-"), opening square brackets ("["), or closing
+ # square brackets ("]"). The property name must not be empty and must not
+ # contain an equals sign ("=") or semicolon (";"). Section and property names
+ # must not contain a period ("."). Apache Airflow configuration property
+ # names must be written in
+ # [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",
+ },
+ "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
+ # `composer-([0-9]+\.[0-9]+\.[0-9]+|latest)-airflow-[0-9]+\.[0-9]+(\.[0-9]+.*)?`.
+ # When used as input, the server also checks if the provided version is
+ # supported and denies the request for an unsupported version.
+ #
+ # The Cloud Composer portion of the version is a
+ # [semantic version](https://semver.org) or `latest`. When the patch version
+ # is omitted, the current Cloud Composer patch version is selected.
+ # When `latest` is provided instead of an explicit version number,
+ # 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
+ # official Apache Airflow repository
+ # [release name](https://github.com/apache/incubator-airflow/releases).
+ #
+ # See also [Version
+ # List](/composer/docs/concepts/versioning/composer-versions).
"envVariables": { # Optional. Additional environment variables to provide to the Apache Airflow
# scheduler, worker, and webserver processes.
#
@@ -174,11 +179,6 @@
# * `SQL_USER`
"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.
"pypiPackages": { # Optional. Custom Python Package Index (PyPI) packages to be installed in
# the environment.
#
@@ -189,46 +189,51 @@
# the value.
"a_key": "A String",
},
- "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
- # `composer-([0-9]+\.[0-9]+\.[0-9]+|latest)-airflow-[0-9]+\.[0-9]+(\.[0-9]+.*)?`.
- # When used as input, the server also checks if the provided version is
- # supported and denies the request for an unsupported version.
+ "pythonVersion": "A String", # Optional. The major version of Python used to run the Apache Airflow
+ # scheduler, worker, and webserver processes.
#
- # The Cloud Composer portion of the version is a
- # [semantic version](https://semver.org) or `latest`. When the patch version
- # is omitted, the current Cloud Composer patch version is selected.
- # When `latest` is provided instead of an explicit version number,
- # 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
- # 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.
- #
- # 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",
- },
+ # Can be set to '2' or '3'. If not specified, the default is '2'. Cannot be
+ # updated.
+ },
+ "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.
+ "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`.
+ },
+ ],
+ },
+ "webServerConfig": { # The configuration settings for the Airflow web server App Engine instance. # Optional. The configuration settings for the Airflow web server App Engine instance.
+ "machineType": "A String", # Optional. Machine type on which Airflow web server is running.
+ # It has to be one of: composer-n1-webserver-2, composer-n1-webserver-4 or
+ # composer-n1-webserver-8.
+ # If not specified, composer-n1-webserver-2 will be used.
+ # Value custom is returned only in response, if Airflow web server parameters
+ # were manually changed to a non-standard values.
},
"nodeConfig": { # The configuration information for the Kubernetes Engine nodes running # The configuration used for the Kubernetes Engine cluster.
# the Apache Airflow software.
+ "tags": [ # Optional. The list of instance tags applied to all node VMs. Tags are used
+ # to identify valid sources or targets for network firewalls. Each tag within
+ # the list must comply with [RFC1035](https://www.ietf.org/rfc/rfc1035.txt).
+ # Cannot be updated.
+ "A String",
+ ],
+ "diskSizeGb": 42, # Optional. The disk size in GB used for node VMs. Minimum size is 20GB.
+ # If unspecified, defaults to 100GB. Cannot be updated.
"subnetwork": "A String", # Optional. The Compute Engine subnetwork to be used for machine
# communications, specified as a
# [relative resource
@@ -238,63 +243,17 @@
# 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.
- "useIpAliases": True or False, # Optional. Whether or not to enable Alias IPs in the GKE cluster.
- # If `true`, a VPC-native cluster is created.
- "servicesSecondaryRangeName": "A String", # Optional. The name of the services' secondary range used to allocate
- # IP addresses to the cluster. Specify either `services_secondary_range_name`
- # or `services_ipv4_cidr_block` but not both.
- #
- # This field is applicable only when `use_ip_aliases` is true.
- "clusterSecondaryRangeName": "A String", # Optional. The name of the cluster's secondary range used to allocate
- # IP addresses to pods. Specify either `cluster_secondary_range_name`
- # or `cluster_ipv4_cidr_block` but not both.
- #
- # This field is applicable only when `use_ip_aliases` is true.
- "clusterIpv4CidrBlock": "A String", # Optional. The IP address range used to allocate IP addresses to pods in
- # the 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.
- # Specify `cluster_secondary_range_name` or `cluster_ipv4_cidr_block`
- # but not both.
- "servicesIpv4CidrBlock": "A String", # Optional. The IP address range of the services IP addresses in this
- # 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.
- # Specify `services_secondary_range_name` or `services_ipv4_cidr_block`
- # but not both.
- },
- "diskSizeGb": 42, # Optional. The disk size in GB used for node VMs. Minimum size is 20GB.
- # If unspecified, defaults to 100GB. Cannot be updated.
- "tags": [ # Optional. The list of instance tags applied to all node VMs. Tags are used
- # to identify valid sources or targets for network firewalls. Each tag within
- # the list must comply with [RFC1035](https://www.ietf.org/rfc/rfc1035.txt).
- # Cannot be updated.
- "A String",
- ],
+ "network": "A String", # Optional. The Compute Engine network to be used for machine
+ # communications, specified as a
+ # [relative resource
+ # name](/apis/design/resource_names#relative_resource_name). For example:
+ # "projects/{projectId}/global/networks/{networkId}".
+ #
+ # If unspecified, the default network in the environment's project is used.
+ # If a [Custom Subnet Network](/vpc/docs/vpc#vpc_networks_and_subnets)
+ # is provided, `nodeConfig.subnetwork` must also be provided. For
+ # [Shared VPC](/vpc/docs/shared-vpc) subnetwork requirements, see
+ # `nodeConfig.subnetwork`.
"serviceAccount": "A String", # Optional. The Google Cloud Platform Service Account to be used by the node
# VMs. If a service account is not specified, the "default" Compute Engine
# service account is used. Cannot be updated.
@@ -333,65 +292,107 @@
#
# 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
- # communications, specified as a
- # [relative resource
- # name](/apis/design/resource_names#relative_resource_name). For example:
- # "projects/{projectId}/global/networks/{networkId}".
- #
- # If unspecified, the default network in the environment's project is used.
- # If a [Custom Subnet Network](/vpc/docs/vpc#vpc_networks_and_subnets)
- # is provided, `nodeConfig.subnetwork` must also be provided. For
- # [Shared VPC](/vpc/docs/shared-vpc) subnetwork requirements, see
- # `nodeConfig.subnetwork`.
+ "ipAllocationPolicy": { # Configuration for controlling how IPs are allocated in the # Optional. The IPAllocationPolicy fields for the GKE cluster.
+ # GKE cluster.
+ "useIpAliases": True or False, # Optional. Whether or not to enable Alias IPs in the GKE cluster.
+ # If `true`, a VPC-native cluster is created.
+ "clusterIpv4CidrBlock": "A String", # Optional. The IP address range used to allocate IP addresses to pods in
+ # the 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.
+ # Specify `cluster_secondary_range_name` or `cluster_ipv4_cidr_block`
+ # but not both.
+ "servicesIpv4CidrBlock": "A String", # Optional. The IP address range of the services IP addresses in this
+ # 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.
+ # Specify `services_secondary_range_name` or `services_ipv4_cidr_block`
+ # but not both.
+ "clusterSecondaryRangeName": "A String", # Optional. The name of the cluster's secondary range used to allocate
+ # IP addresses to pods. Specify either `cluster_secondary_range_name`
+ # or `cluster_ipv4_cidr_block` but not both.
+ #
+ # This field is applicable only when `use_ip_aliases` is true.
+ "servicesSecondaryRangeName": "A String", # Optional. The name of the services' secondary range used to allocate
+ # IP addresses to the cluster. Specify either `services_secondary_range_name`
+ # or `services_ipv4_cidr_block` but not both.
+ #
+ # This field is applicable only when `use_ip_aliases` is true.
+ },
"oauthScopes": [ # Optional. The set of Google API scopes to be made available on all
# node VMs. If `oauth_scopes` is empty, defaults to
# ["https://www.googleapis.com/auth/cloud-platform"]. Cannot be updated.
"A String",
],
},
- "nodeCount": 42, # The number of nodes in the Kubernetes Engine cluster that will be
- # used to run this environment.
- "databaseConfig": { # The configuration of Cloud SQL instance that is used by the Apache Airflow # Optional. The configuration settings for Cloud SQL instance used internally by Apache
- # Airflow software.
- # software.
- "machineType": "A String", # Optional. Cloud SQL tier used by Airflow database.
- # If not specified, db-n1-standard-2 will be used.
- },
- "webServerConfig": { # The configuration settings for the Airflow web server App Engine instance. # Optional. The configuration settings for the Airflow web server App Engine instance.
- "machineType": "A String", # Optional. Machine type on which Airflow web server is running.
- # For example: composer-n1-webserver-2, composer-n1-webserver-4,
- # composer-n1-webserver-8.
- # If not specified, composer-n1-webserver-2 will be used.
- # Value custom is returned only in response, if Airflow web server parameters
- # were manually changed to a non-standard values.
- },
- "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`.
- },
- ],
+ "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)).
+ "privateEnvironmentConfig": { # The configuration information for configuring a Private IP Cloud Composer # The configuration used for the Private IP Cloud Composer environment.
+ # environment.
+ "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.
+ "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.
+ "enablePrivateEndpoint": True or False, # Optional. If `true`, access to the public endpoint of the GKE cluster is
+ # denied.
+ "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.
+ },
+ "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.
+ "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.
+ "webServerIpv4ReservedRange": "A String", # Output only. The IP range reserved for the tenant project's App Engine VMs.
},
},
+ "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
+ # size.
+ "a_key": "A String",
+ },
"updateTime": "A String", # Output only. The time at which this environment was last modified.
+ "createTime": "A String", # Output only. The time at which this environment was created.
+ "state": "A String", # The current state of the environment.
"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.
- "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.
@@ -407,30 +408,6 @@
"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}`.
- "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). Each `Status` message contains
- # three pieces of data: error code, error message, and error details.
- #
- # 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).
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "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.
- "details": [ # A list of messages that carry the error details. There is a common set of
- # message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- ],
- },
- "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.
- },
"done": True or False, # If the value is `false`, it means the operation is still in progress.
# If `true`, the operation is completed, and either `error` or `response` is
# available.
@@ -444,6 +421,30 @@
# `TakeSnapshotResponse`.
"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). Each `Status` message contains
+ # three pieces of data: error code, error message, and error details.
+ #
+ # 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.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of
+ # message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "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>
@@ -467,30 +468,6 @@
"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}`.
- "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). Each `Status` message contains
- # three pieces of data: error code, error message, and error details.
- #
- # 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).
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "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.
- "details": [ # A list of messages that carry the error details. There is a common set of
- # message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- ],
- },
- "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.
- },
"done": True or False, # If the value is `false`, it means the operation is still in progress.
# If `true`, the operation is completed, and either `error` or `response` is
# available.
@@ -504,6 +481,30 @@
# `TakeSnapshotResponse`.
"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). Each `Status` message contains
+ # three pieces of data: error code, error message, and error details.
+ #
+ # 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.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of
+ # message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "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>
@@ -523,52 +524,57 @@
An object of the form:
{ # An environment for running orchestration tasks.
- "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
- # size.
- "a_key": "A String",
- },
- "createTime": "A String", # Output only. The time at which this environment was created.
- "state": "A String", # The current state of the environment.
+ "uuid": "A String", # Output only. The UUID (Universally Unique IDentifier) associated with this environment.
+ # This value is generated when the environment is created.
"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
- # 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.
- "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
- "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.
- "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.
- "enablePrivateEndpoint": True or False, # Optional. If `true`, access to the public endpoint of the GKE cluster is
- # denied.
- "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.
- },
- "webServerIpv4ReservedRange": "A String", # Output only. The IP range reserved for the tenant project's App Engine VMs.
- "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.
- "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.
- },
"gkeCluster": "A String", # Output only. The Kubernetes Engine cluster used to run this environment.
- "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)).
+ "nodeCount": 42, # The number of nodes in the Kubernetes Engine cluster that will be
+ # used to run this environment.
+ "databaseConfig": { # The configuration of Cloud SQL instance that is used by the Apache Airflow # Optional. The configuration settings for Cloud SQL instance used internally by Apache
+ # Airflow software.
+ # software.
+ "machineType": "A String", # Optional. Cloud SQL machine type used by Airflow database.
+ # It has to be one of: db-n1-standard-2, db-n1-standard-4, db-n1-standard-8
+ # or db-n1-standard-16. If not specified, db-n1-standard-2 will be used.
+ },
"softwareConfig": { # Specifies the selection and configuration of software inside the environment. # The configuration settings for software inside the environment.
+ "airflowConfigOverrides": { # Optional. Apache Airflow configuration properties to override.
+ #
+ # Property keys contain the section and property names, separated by a
+ # hyphen, for example "core-dags_are_paused_at_creation". Section names must
+ # not contain hyphens ("-"), opening square brackets ("["), or closing
+ # square brackets ("]"). The property name must not be empty and must not
+ # contain an equals sign ("=") or semicolon (";"). Section and property names
+ # must not contain a period ("."). Apache Airflow configuration property
+ # names must be written in
+ # [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",
+ },
+ "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
+ # `composer-([0-9]+\.[0-9]+\.[0-9]+|latest)-airflow-[0-9]+\.[0-9]+(\.[0-9]+.*)?`.
+ # When used as input, the server also checks if the provided version is
+ # supported and denies the request for an unsupported version.
+ #
+ # The Cloud Composer portion of the version is a
+ # [semantic version](https://semver.org) or `latest`. When the patch version
+ # is omitted, the current Cloud Composer patch version is selected.
+ # When `latest` is provided instead of an explicit version number,
+ # 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
+ # official Apache Airflow repository
+ # [release name](https://github.com/apache/incubator-airflow/releases).
+ #
+ # See also [Version
+ # List](/composer/docs/concepts/versioning/composer-versions).
"envVariables": { # Optional. Additional environment variables to provide to the Apache Airflow
# scheduler, worker, and webserver processes.
#
@@ -593,11 +599,6 @@
# * `SQL_USER`
"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.
"pypiPackages": { # Optional. Custom Python Package Index (PyPI) packages to be installed in
# the environment.
#
@@ -608,46 +609,51 @@
# the value.
"a_key": "A String",
},
- "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
- # `composer-([0-9]+\.[0-9]+\.[0-9]+|latest)-airflow-[0-9]+\.[0-9]+(\.[0-9]+.*)?`.
- # When used as input, the server also checks if the provided version is
- # supported and denies the request for an unsupported version.
+ "pythonVersion": "A String", # Optional. The major version of Python used to run the Apache Airflow
+ # scheduler, worker, and webserver processes.
#
- # The Cloud Composer portion of the version is a
- # [semantic version](https://semver.org) or `latest`. When the patch version
- # is omitted, the current Cloud Composer patch version is selected.
- # When `latest` is provided instead of an explicit version number,
- # 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
- # 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.
- #
- # 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",
- },
+ # Can be set to '2' or '3'. If not specified, the default is '2'. Cannot be
+ # updated.
+ },
+ "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.
+ "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`.
+ },
+ ],
+ },
+ "webServerConfig": { # The configuration settings for the Airflow web server App Engine instance. # Optional. The configuration settings for the Airflow web server App Engine instance.
+ "machineType": "A String", # Optional. Machine type on which Airflow web server is running.
+ # It has to be one of: composer-n1-webserver-2, composer-n1-webserver-4 or
+ # composer-n1-webserver-8.
+ # If not specified, composer-n1-webserver-2 will be used.
+ # Value custom is returned only in response, if Airflow web server parameters
+ # were manually changed to a non-standard values.
},
"nodeConfig": { # The configuration information for the Kubernetes Engine nodes running # The configuration used for the Kubernetes Engine cluster.
# the Apache Airflow software.
+ "tags": [ # Optional. The list of instance tags applied to all node VMs. Tags are used
+ # to identify valid sources or targets for network firewalls. Each tag within
+ # the list must comply with [RFC1035](https://www.ietf.org/rfc/rfc1035.txt).
+ # Cannot be updated.
+ "A String",
+ ],
+ "diskSizeGb": 42, # Optional. The disk size in GB used for node VMs. Minimum size is 20GB.
+ # If unspecified, defaults to 100GB. Cannot be updated.
"subnetwork": "A String", # Optional. The Compute Engine subnetwork to be used for machine
# communications, specified as a
# [relative resource
@@ -657,63 +663,17 @@
# 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.
- "useIpAliases": True or False, # Optional. Whether or not to enable Alias IPs in the GKE cluster.
- # If `true`, a VPC-native cluster is created.
- "servicesSecondaryRangeName": "A String", # Optional. The name of the services' secondary range used to allocate
- # IP addresses to the cluster. Specify either `services_secondary_range_name`
- # or `services_ipv4_cidr_block` but not both.
- #
- # This field is applicable only when `use_ip_aliases` is true.
- "clusterSecondaryRangeName": "A String", # Optional. The name of the cluster's secondary range used to allocate
- # IP addresses to pods. Specify either `cluster_secondary_range_name`
- # or `cluster_ipv4_cidr_block` but not both.
- #
- # This field is applicable only when `use_ip_aliases` is true.
- "clusterIpv4CidrBlock": "A String", # Optional. The IP address range used to allocate IP addresses to pods in
- # the 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.
- # Specify `cluster_secondary_range_name` or `cluster_ipv4_cidr_block`
- # but not both.
- "servicesIpv4CidrBlock": "A String", # Optional. The IP address range of the services IP addresses in this
- # 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.
- # Specify `services_secondary_range_name` or `services_ipv4_cidr_block`
- # but not both.
- },
- "diskSizeGb": 42, # Optional. The disk size in GB used for node VMs. Minimum size is 20GB.
- # If unspecified, defaults to 100GB. Cannot be updated.
- "tags": [ # Optional. The list of instance tags applied to all node VMs. Tags are used
- # to identify valid sources or targets for network firewalls. Each tag within
- # the list must comply with [RFC1035](https://www.ietf.org/rfc/rfc1035.txt).
- # Cannot be updated.
- "A String",
- ],
+ "network": "A String", # Optional. The Compute Engine network to be used for machine
+ # communications, specified as a
+ # [relative resource
+ # name](/apis/design/resource_names#relative_resource_name). For example:
+ # "projects/{projectId}/global/networks/{networkId}".
+ #
+ # If unspecified, the default network in the environment's project is used.
+ # If a [Custom Subnet Network](/vpc/docs/vpc#vpc_networks_and_subnets)
+ # is provided, `nodeConfig.subnetwork` must also be provided. For
+ # [Shared VPC](/vpc/docs/shared-vpc) subnetwork requirements, see
+ # `nodeConfig.subnetwork`.
"serviceAccount": "A String", # Optional. The Google Cloud Platform Service Account to be used by the node
# VMs. If a service account is not specified, the "default" Compute Engine
# service account is used. Cannot be updated.
@@ -752,77 +712,119 @@
#
# 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
- # communications, specified as a
- # [relative resource
- # name](/apis/design/resource_names#relative_resource_name). For example:
- # "projects/{projectId}/global/networks/{networkId}".
- #
- # If unspecified, the default network in the environment's project is used.
- # If a [Custom Subnet Network](/vpc/docs/vpc#vpc_networks_and_subnets)
- # is provided, `nodeConfig.subnetwork` must also be provided. For
- # [Shared VPC](/vpc/docs/shared-vpc) subnetwork requirements, see
- # `nodeConfig.subnetwork`.
+ "ipAllocationPolicy": { # Configuration for controlling how IPs are allocated in the # Optional. The IPAllocationPolicy fields for the GKE cluster.
+ # GKE cluster.
+ "useIpAliases": True or False, # Optional. Whether or not to enable Alias IPs in the GKE cluster.
+ # If `true`, a VPC-native cluster is created.
+ "clusterIpv4CidrBlock": "A String", # Optional. The IP address range used to allocate IP addresses to pods in
+ # the 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.
+ # Specify `cluster_secondary_range_name` or `cluster_ipv4_cidr_block`
+ # but not both.
+ "servicesIpv4CidrBlock": "A String", # Optional. The IP address range of the services IP addresses in this
+ # 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.
+ # Specify `services_secondary_range_name` or `services_ipv4_cidr_block`
+ # but not both.
+ "clusterSecondaryRangeName": "A String", # Optional. The name of the cluster's secondary range used to allocate
+ # IP addresses to pods. Specify either `cluster_secondary_range_name`
+ # or `cluster_ipv4_cidr_block` but not both.
+ #
+ # This field is applicable only when `use_ip_aliases` is true.
+ "servicesSecondaryRangeName": "A String", # Optional. The name of the services' secondary range used to allocate
+ # IP addresses to the cluster. Specify either `services_secondary_range_name`
+ # or `services_ipv4_cidr_block` but not both.
+ #
+ # This field is applicable only when `use_ip_aliases` is true.
+ },
"oauthScopes": [ # Optional. The set of Google API scopes to be made available on all
# node VMs. If `oauth_scopes` is empty, defaults to
# ["https://www.googleapis.com/auth/cloud-platform"]. Cannot be updated.
"A String",
],
},
- "nodeCount": 42, # The number of nodes in the Kubernetes Engine cluster that will be
- # used to run this environment.
- "databaseConfig": { # The configuration of Cloud SQL instance that is used by the Apache Airflow # Optional. The configuration settings for Cloud SQL instance used internally by Apache
- # Airflow software.
- # software.
- "machineType": "A String", # Optional. Cloud SQL tier used by Airflow database.
- # If not specified, db-n1-standard-2 will be used.
- },
- "webServerConfig": { # The configuration settings for the Airflow web server App Engine instance. # Optional. The configuration settings for the Airflow web server App Engine instance.
- "machineType": "A String", # Optional. Machine type on which Airflow web server is running.
- # For example: composer-n1-webserver-2, composer-n1-webserver-4,
- # composer-n1-webserver-8.
- # If not specified, composer-n1-webserver-2 will be used.
- # Value custom is returned only in response, if Airflow web server parameters
- # were manually changed to a non-standard values.
- },
- "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`.
- },
- ],
+ "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)).
+ "privateEnvironmentConfig": { # The configuration information for configuring a Private IP Cloud Composer # The configuration used for the Private IP Cloud Composer environment.
+ # environment.
+ "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.
+ "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.
+ "enablePrivateEndpoint": True or False, # Optional. If `true`, access to the public endpoint of the GKE cluster is
+ # denied.
+ "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.
+ },
+ "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.
+ "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.
+ "webServerIpv4ReservedRange": "A String", # Output only. The IP range reserved for the tenant project's App Engine VMs.
},
},
+ "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
+ # size.
+ "a_key": "A String",
+ },
"updateTime": "A String", # Output only. The time at which this environment was last modified.
+ "createTime": "A String", # Output only. The time at which this environment was created.
+ "state": "A String", # The current state of the environment.
"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.
- "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>
<div class="method">
- <code class="details" id="list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>List environments.
Args:
parent: string, List environments in the given project and location, in the form:
"projects/{projectId}/locations/{locationId}" (required)
- pageToken: string, The next_page_token value returned from a previous List request, if any.
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
@@ -835,52 +837,57 @@
"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.
- "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
- # size.
- "a_key": "A String",
- },
- "createTime": "A String", # Output only. The time at which this environment was created.
- "state": "A String", # The current state of the environment.
+ "uuid": "A String", # Output only. The UUID (Universally Unique IDentifier) associated with this environment.
+ # This value is generated when the environment is created.
"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
- # 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.
- "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
- "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.
- "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.
- "enablePrivateEndpoint": True or False, # Optional. If `true`, access to the public endpoint of the GKE cluster is
- # denied.
- "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.
- },
- "webServerIpv4ReservedRange": "A String", # Output only. The IP range reserved for the tenant project's App Engine VMs.
- "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.
- "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.
- },
"gkeCluster": "A String", # Output only. The Kubernetes Engine cluster used to run this environment.
- "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)).
+ "nodeCount": 42, # The number of nodes in the Kubernetes Engine cluster that will be
+ # used to run this environment.
+ "databaseConfig": { # The configuration of Cloud SQL instance that is used by the Apache Airflow # Optional. The configuration settings for Cloud SQL instance used internally by Apache
+ # Airflow software.
+ # software.
+ "machineType": "A String", # Optional. Cloud SQL machine type used by Airflow database.
+ # It has to be one of: db-n1-standard-2, db-n1-standard-4, db-n1-standard-8
+ # or db-n1-standard-16. If not specified, db-n1-standard-2 will be used.
+ },
"softwareConfig": { # Specifies the selection and configuration of software inside the environment. # The configuration settings for software inside the environment.
+ "airflowConfigOverrides": { # Optional. Apache Airflow configuration properties to override.
+ #
+ # Property keys contain the section and property names, separated by a
+ # hyphen, for example "core-dags_are_paused_at_creation". Section names must
+ # not contain hyphens ("-"), opening square brackets ("["), or closing
+ # square brackets ("]"). The property name must not be empty and must not
+ # contain an equals sign ("=") or semicolon (";"). Section and property names
+ # must not contain a period ("."). Apache Airflow configuration property
+ # names must be written in
+ # [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",
+ },
+ "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
+ # `composer-([0-9]+\.[0-9]+\.[0-9]+|latest)-airflow-[0-9]+\.[0-9]+(\.[0-9]+.*)?`.
+ # When used as input, the server also checks if the provided version is
+ # supported and denies the request for an unsupported version.
+ #
+ # The Cloud Composer portion of the version is a
+ # [semantic version](https://semver.org) or `latest`. When the patch version
+ # is omitted, the current Cloud Composer patch version is selected.
+ # When `latest` is provided instead of an explicit version number,
+ # 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
+ # official Apache Airflow repository
+ # [release name](https://github.com/apache/incubator-airflow/releases).
+ #
+ # See also [Version
+ # List](/composer/docs/concepts/versioning/composer-versions).
"envVariables": { # Optional. Additional environment variables to provide to the Apache Airflow
# scheduler, worker, and webserver processes.
#
@@ -905,11 +912,6 @@
# * `SQL_USER`
"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.
"pypiPackages": { # Optional. Custom Python Package Index (PyPI) packages to be installed in
# the environment.
#
@@ -920,46 +922,51 @@
# the value.
"a_key": "A String",
},
- "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
- # `composer-([0-9]+\.[0-9]+\.[0-9]+|latest)-airflow-[0-9]+\.[0-9]+(\.[0-9]+.*)?`.
- # When used as input, the server also checks if the provided version is
- # supported and denies the request for an unsupported version.
+ "pythonVersion": "A String", # Optional. The major version of Python used to run the Apache Airflow
+ # scheduler, worker, and webserver processes.
#
- # The Cloud Composer portion of the version is a
- # [semantic version](https://semver.org) or `latest`. When the patch version
- # is omitted, the current Cloud Composer patch version is selected.
- # When `latest` is provided instead of an explicit version number,
- # 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
- # 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.
- #
- # 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",
- },
+ # Can be set to '2' or '3'. If not specified, the default is '2'. Cannot be
+ # updated.
+ },
+ "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.
+ "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`.
+ },
+ ],
+ },
+ "webServerConfig": { # The configuration settings for the Airflow web server App Engine instance. # Optional. The configuration settings for the Airflow web server App Engine instance.
+ "machineType": "A String", # Optional. Machine type on which Airflow web server is running.
+ # It has to be one of: composer-n1-webserver-2, composer-n1-webserver-4 or
+ # composer-n1-webserver-8.
+ # If not specified, composer-n1-webserver-2 will be used.
+ # Value custom is returned only in response, if Airflow web server parameters
+ # were manually changed to a non-standard values.
},
"nodeConfig": { # The configuration information for the Kubernetes Engine nodes running # The configuration used for the Kubernetes Engine cluster.
# the Apache Airflow software.
+ "tags": [ # Optional. The list of instance tags applied to all node VMs. Tags are used
+ # to identify valid sources or targets for network firewalls. Each tag within
+ # the list must comply with [RFC1035](https://www.ietf.org/rfc/rfc1035.txt).
+ # Cannot be updated.
+ "A String",
+ ],
+ "diskSizeGb": 42, # Optional. The disk size in GB used for node VMs. Minimum size is 20GB.
+ # If unspecified, defaults to 100GB. Cannot be updated.
"subnetwork": "A String", # Optional. The Compute Engine subnetwork to be used for machine
# communications, specified as a
# [relative resource
@@ -969,63 +976,17 @@
# 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.
- "useIpAliases": True or False, # Optional. Whether or not to enable Alias IPs in the GKE cluster.
- # If `true`, a VPC-native cluster is created.
- "servicesSecondaryRangeName": "A String", # Optional. The name of the services' secondary range used to allocate
- # IP addresses to the cluster. Specify either `services_secondary_range_name`
- # or `services_ipv4_cidr_block` but not both.
- #
- # This field is applicable only when `use_ip_aliases` is true.
- "clusterSecondaryRangeName": "A String", # Optional. The name of the cluster's secondary range used to allocate
- # IP addresses to pods. Specify either `cluster_secondary_range_name`
- # or `cluster_ipv4_cidr_block` but not both.
- #
- # This field is applicable only when `use_ip_aliases` is true.
- "clusterIpv4CidrBlock": "A String", # Optional. The IP address range used to allocate IP addresses to pods in
- # the 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.
- # Specify `cluster_secondary_range_name` or `cluster_ipv4_cidr_block`
- # but not both.
- "servicesIpv4CidrBlock": "A String", # Optional. The IP address range of the services IP addresses in this
- # 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.
- # Specify `services_secondary_range_name` or `services_ipv4_cidr_block`
- # but not both.
- },
- "diskSizeGb": 42, # Optional. The disk size in GB used for node VMs. Minimum size is 20GB.
- # If unspecified, defaults to 100GB. Cannot be updated.
- "tags": [ # Optional. The list of instance tags applied to all node VMs. Tags are used
- # to identify valid sources or targets for network firewalls. Each tag within
- # the list must comply with [RFC1035](https://www.ietf.org/rfc/rfc1035.txt).
- # Cannot be updated.
- "A String",
- ],
+ "network": "A String", # Optional. The Compute Engine network to be used for machine
+ # communications, specified as a
+ # [relative resource
+ # name](/apis/design/resource_names#relative_resource_name). For example:
+ # "projects/{projectId}/global/networks/{networkId}".
+ #
+ # If unspecified, the default network in the environment's project is used.
+ # If a [Custom Subnet Network](/vpc/docs/vpc#vpc_networks_and_subnets)
+ # is provided, `nodeConfig.subnetwork` must also be provided. For
+ # [Shared VPC](/vpc/docs/shared-vpc) subnetwork requirements, see
+ # `nodeConfig.subnetwork`.
"serviceAccount": "A String", # Optional. The Google Cloud Platform Service Account to be used by the node
# VMs. If a service account is not specified, the "default" Compute Engine
# service account is used. Cannot be updated.
@@ -1064,65 +1025,107 @@
#
# 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
- # communications, specified as a
- # [relative resource
- # name](/apis/design/resource_names#relative_resource_name). For example:
- # "projects/{projectId}/global/networks/{networkId}".
- #
- # If unspecified, the default network in the environment's project is used.
- # If a [Custom Subnet Network](/vpc/docs/vpc#vpc_networks_and_subnets)
- # is provided, `nodeConfig.subnetwork` must also be provided. For
- # [Shared VPC](/vpc/docs/shared-vpc) subnetwork requirements, see
- # `nodeConfig.subnetwork`.
+ "ipAllocationPolicy": { # Configuration for controlling how IPs are allocated in the # Optional. The IPAllocationPolicy fields for the GKE cluster.
+ # GKE cluster.
+ "useIpAliases": True or False, # Optional. Whether or not to enable Alias IPs in the GKE cluster.
+ # If `true`, a VPC-native cluster is created.
+ "clusterIpv4CidrBlock": "A String", # Optional. The IP address range used to allocate IP addresses to pods in
+ # the 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.
+ # Specify `cluster_secondary_range_name` or `cluster_ipv4_cidr_block`
+ # but not both.
+ "servicesIpv4CidrBlock": "A String", # Optional. The IP address range of the services IP addresses in this
+ # 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.
+ # Specify `services_secondary_range_name` or `services_ipv4_cidr_block`
+ # but not both.
+ "clusterSecondaryRangeName": "A String", # Optional. The name of the cluster's secondary range used to allocate
+ # IP addresses to pods. Specify either `cluster_secondary_range_name`
+ # or `cluster_ipv4_cidr_block` but not both.
+ #
+ # This field is applicable only when `use_ip_aliases` is true.
+ "servicesSecondaryRangeName": "A String", # Optional. The name of the services' secondary range used to allocate
+ # IP addresses to the cluster. Specify either `services_secondary_range_name`
+ # or `services_ipv4_cidr_block` but not both.
+ #
+ # This field is applicable only when `use_ip_aliases` is true.
+ },
"oauthScopes": [ # Optional. The set of Google API scopes to be made available on all
# node VMs. If `oauth_scopes` is empty, defaults to
# ["https://www.googleapis.com/auth/cloud-platform"]. Cannot be updated.
"A String",
],
},
- "nodeCount": 42, # The number of nodes in the Kubernetes Engine cluster that will be
- # used to run this environment.
- "databaseConfig": { # The configuration of Cloud SQL instance that is used by the Apache Airflow # Optional. The configuration settings for Cloud SQL instance used internally by Apache
- # Airflow software.
- # software.
- "machineType": "A String", # Optional. Cloud SQL tier used by Airflow database.
- # If not specified, db-n1-standard-2 will be used.
- },
- "webServerConfig": { # The configuration settings for the Airflow web server App Engine instance. # Optional. The configuration settings for the Airflow web server App Engine instance.
- "machineType": "A String", # Optional. Machine type on which Airflow web server is running.
- # For example: composer-n1-webserver-2, composer-n1-webserver-4,
- # composer-n1-webserver-8.
- # If not specified, composer-n1-webserver-2 will be used.
- # Value custom is returned only in response, if Airflow web server parameters
- # were manually changed to a non-standard values.
- },
- "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`.
- },
- ],
+ "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)).
+ "privateEnvironmentConfig": { # The configuration information for configuring a Private IP Cloud Composer # The configuration used for the Private IP Cloud Composer environment.
+ # environment.
+ "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.
+ "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.
+ "enablePrivateEndpoint": True or False, # Optional. If `true`, access to the public endpoint of the GKE cluster is
+ # denied.
+ "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.
+ },
+ "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.
+ "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.
+ "webServerIpv4ReservedRange": "A String", # Output only. The IP range reserved for the tenant project's App Engine VMs.
},
},
+ "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
+ # size.
+ "a_key": "A String",
+ },
"updateTime": "A String", # Output only. The time at which this environment was last modified.
+ "createTime": "A String", # Output only. The time at which this environment was created.
+ "state": "A String", # The current state of the environment.
"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.
- "uuid": "A String", # Output only. The UUID (Universally Unique IDentifier) associated with this environment.
- # This value is generated when the environment is created.
},
],
}</pre>
@@ -1153,52 +1156,57 @@
The object takes the form of:
{ # An environment for running orchestration tasks.
- "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
- # size.
- "a_key": "A String",
- },
- "createTime": "A String", # Output only. The time at which this environment was created.
- "state": "A String", # The current state of the environment.
+ "uuid": "A String", # Output only. The UUID (Universally Unique IDentifier) associated with this environment.
+ # This value is generated when the environment is created.
"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
- # 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.
- "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
- "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.
- "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.
- "enablePrivateEndpoint": True or False, # Optional. If `true`, access to the public endpoint of the GKE cluster is
- # denied.
- "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.
- },
- "webServerIpv4ReservedRange": "A String", # Output only. The IP range reserved for the tenant project's App Engine VMs.
- "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.
- "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.
- },
"gkeCluster": "A String", # Output only. The Kubernetes Engine cluster used to run this environment.
- "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)).
+ "nodeCount": 42, # The number of nodes in the Kubernetes Engine cluster that will be
+ # used to run this environment.
+ "databaseConfig": { # The configuration of Cloud SQL instance that is used by the Apache Airflow # Optional. The configuration settings for Cloud SQL instance used internally by Apache
+ # Airflow software.
+ # software.
+ "machineType": "A String", # Optional. Cloud SQL machine type used by Airflow database.
+ # It has to be one of: db-n1-standard-2, db-n1-standard-4, db-n1-standard-8
+ # or db-n1-standard-16. If not specified, db-n1-standard-2 will be used.
+ },
"softwareConfig": { # Specifies the selection and configuration of software inside the environment. # The configuration settings for software inside the environment.
+ "airflowConfigOverrides": { # Optional. Apache Airflow configuration properties to override.
+ #
+ # Property keys contain the section and property names, separated by a
+ # hyphen, for example "core-dags_are_paused_at_creation". Section names must
+ # not contain hyphens ("-"), opening square brackets ("["), or closing
+ # square brackets ("]"). The property name must not be empty and must not
+ # contain an equals sign ("=") or semicolon (";"). Section and property names
+ # must not contain a period ("."). Apache Airflow configuration property
+ # names must be written in
+ # [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",
+ },
+ "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
+ # `composer-([0-9]+\.[0-9]+\.[0-9]+|latest)-airflow-[0-9]+\.[0-9]+(\.[0-9]+.*)?`.
+ # When used as input, the server also checks if the provided version is
+ # supported and denies the request for an unsupported version.
+ #
+ # The Cloud Composer portion of the version is a
+ # [semantic version](https://semver.org) or `latest`. When the patch version
+ # is omitted, the current Cloud Composer patch version is selected.
+ # When `latest` is provided instead of an explicit version number,
+ # 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
+ # official Apache Airflow repository
+ # [release name](https://github.com/apache/incubator-airflow/releases).
+ #
+ # See also [Version
+ # List](/composer/docs/concepts/versioning/composer-versions).
"envVariables": { # Optional. Additional environment variables to provide to the Apache Airflow
# scheduler, worker, and webserver processes.
#
@@ -1223,11 +1231,6 @@
# * `SQL_USER`
"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.
"pypiPackages": { # Optional. Custom Python Package Index (PyPI) packages to be installed in
# the environment.
#
@@ -1238,46 +1241,51 @@
# the value.
"a_key": "A String",
},
- "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
- # `composer-([0-9]+\.[0-9]+\.[0-9]+|latest)-airflow-[0-9]+\.[0-9]+(\.[0-9]+.*)?`.
- # When used as input, the server also checks if the provided version is
- # supported and denies the request for an unsupported version.
+ "pythonVersion": "A String", # Optional. The major version of Python used to run the Apache Airflow
+ # scheduler, worker, and webserver processes.
#
- # The Cloud Composer portion of the version is a
- # [semantic version](https://semver.org) or `latest`. When the patch version
- # is omitted, the current Cloud Composer patch version is selected.
- # When `latest` is provided instead of an explicit version number,
- # 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
- # 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.
- #
- # 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",
- },
+ # Can be set to '2' or '3'. If not specified, the default is '2'. Cannot be
+ # updated.
+ },
+ "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.
+ "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`.
+ },
+ ],
+ },
+ "webServerConfig": { # The configuration settings for the Airflow web server App Engine instance. # Optional. The configuration settings for the Airflow web server App Engine instance.
+ "machineType": "A String", # Optional. Machine type on which Airflow web server is running.
+ # It has to be one of: composer-n1-webserver-2, composer-n1-webserver-4 or
+ # composer-n1-webserver-8.
+ # If not specified, composer-n1-webserver-2 will be used.
+ # Value custom is returned only in response, if Airflow web server parameters
+ # were manually changed to a non-standard values.
},
"nodeConfig": { # The configuration information for the Kubernetes Engine nodes running # The configuration used for the Kubernetes Engine cluster.
# the Apache Airflow software.
+ "tags": [ # Optional. The list of instance tags applied to all node VMs. Tags are used
+ # to identify valid sources or targets for network firewalls. Each tag within
+ # the list must comply with [RFC1035](https://www.ietf.org/rfc/rfc1035.txt).
+ # Cannot be updated.
+ "A String",
+ ],
+ "diskSizeGb": 42, # Optional. The disk size in GB used for node VMs. Minimum size is 20GB.
+ # If unspecified, defaults to 100GB. Cannot be updated.
"subnetwork": "A String", # Optional. The Compute Engine subnetwork to be used for machine
# communications, specified as a
# [relative resource
@@ -1287,63 +1295,17 @@
# 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.
- "useIpAliases": True or False, # Optional. Whether or not to enable Alias IPs in the GKE cluster.
- # If `true`, a VPC-native cluster is created.
- "servicesSecondaryRangeName": "A String", # Optional. The name of the services' secondary range used to allocate
- # IP addresses to the cluster. Specify either `services_secondary_range_name`
- # or `services_ipv4_cidr_block` but not both.
- #
- # This field is applicable only when `use_ip_aliases` is true.
- "clusterSecondaryRangeName": "A String", # Optional. The name of the cluster's secondary range used to allocate
- # IP addresses to pods. Specify either `cluster_secondary_range_name`
- # or `cluster_ipv4_cidr_block` but not both.
- #
- # This field is applicable only when `use_ip_aliases` is true.
- "clusterIpv4CidrBlock": "A String", # Optional. The IP address range used to allocate IP addresses to pods in
- # the 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.
- # Specify `cluster_secondary_range_name` or `cluster_ipv4_cidr_block`
- # but not both.
- "servicesIpv4CidrBlock": "A String", # Optional. The IP address range of the services IP addresses in this
- # 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.
- # Specify `services_secondary_range_name` or `services_ipv4_cidr_block`
- # but not both.
- },
- "diskSizeGb": 42, # Optional. The disk size in GB used for node VMs. Minimum size is 20GB.
- # If unspecified, defaults to 100GB. Cannot be updated.
- "tags": [ # Optional. The list of instance tags applied to all node VMs. Tags are used
- # to identify valid sources or targets for network firewalls. Each tag within
- # the list must comply with [RFC1035](https://www.ietf.org/rfc/rfc1035.txt).
- # Cannot be updated.
- "A String",
- ],
+ "network": "A String", # Optional. The Compute Engine network to be used for machine
+ # communications, specified as a
+ # [relative resource
+ # name](/apis/design/resource_names#relative_resource_name). For example:
+ # "projects/{projectId}/global/networks/{networkId}".
+ #
+ # If unspecified, the default network in the environment's project is used.
+ # If a [Custom Subnet Network](/vpc/docs/vpc#vpc_networks_and_subnets)
+ # is provided, `nodeConfig.subnetwork` must also be provided. For
+ # [Shared VPC](/vpc/docs/shared-vpc) subnetwork requirements, see
+ # `nodeConfig.subnetwork`.
"serviceAccount": "A String", # Optional. The Google Cloud Platform Service Account to be used by the node
# VMs. If a service account is not specified, the "default" Compute Engine
# service account is used. Cannot be updated.
@@ -1382,65 +1344,107 @@
#
# 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
- # communications, specified as a
- # [relative resource
- # name](/apis/design/resource_names#relative_resource_name). For example:
- # "projects/{projectId}/global/networks/{networkId}".
- #
- # If unspecified, the default network in the environment's project is used.
- # If a [Custom Subnet Network](/vpc/docs/vpc#vpc_networks_and_subnets)
- # is provided, `nodeConfig.subnetwork` must also be provided. For
- # [Shared VPC](/vpc/docs/shared-vpc) subnetwork requirements, see
- # `nodeConfig.subnetwork`.
+ "ipAllocationPolicy": { # Configuration for controlling how IPs are allocated in the # Optional. The IPAllocationPolicy fields for the GKE cluster.
+ # GKE cluster.
+ "useIpAliases": True or False, # Optional. Whether or not to enable Alias IPs in the GKE cluster.
+ # If `true`, a VPC-native cluster is created.
+ "clusterIpv4CidrBlock": "A String", # Optional. The IP address range used to allocate IP addresses to pods in
+ # the 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.
+ # Specify `cluster_secondary_range_name` or `cluster_ipv4_cidr_block`
+ # but not both.
+ "servicesIpv4CidrBlock": "A String", # Optional. The IP address range of the services IP addresses in this
+ # 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.
+ # Specify `services_secondary_range_name` or `services_ipv4_cidr_block`
+ # but not both.
+ "clusterSecondaryRangeName": "A String", # Optional. The name of the cluster's secondary range used to allocate
+ # IP addresses to pods. Specify either `cluster_secondary_range_name`
+ # or `cluster_ipv4_cidr_block` but not both.
+ #
+ # This field is applicable only when `use_ip_aliases` is true.
+ "servicesSecondaryRangeName": "A String", # Optional. The name of the services' secondary range used to allocate
+ # IP addresses to the cluster. Specify either `services_secondary_range_name`
+ # or `services_ipv4_cidr_block` but not both.
+ #
+ # This field is applicable only when `use_ip_aliases` is true.
+ },
"oauthScopes": [ # Optional. The set of Google API scopes to be made available on all
# node VMs. If `oauth_scopes` is empty, defaults to
# ["https://www.googleapis.com/auth/cloud-platform"]. Cannot be updated.
"A String",
],
},
- "nodeCount": 42, # The number of nodes in the Kubernetes Engine cluster that will be
- # used to run this environment.
- "databaseConfig": { # The configuration of Cloud SQL instance that is used by the Apache Airflow # Optional. The configuration settings for Cloud SQL instance used internally by Apache
- # Airflow software.
- # software.
- "machineType": "A String", # Optional. Cloud SQL tier used by Airflow database.
- # If not specified, db-n1-standard-2 will be used.
- },
- "webServerConfig": { # The configuration settings for the Airflow web server App Engine instance. # Optional. The configuration settings for the Airflow web server App Engine instance.
- "machineType": "A String", # Optional. Machine type on which Airflow web server is running.
- # For example: composer-n1-webserver-2, composer-n1-webserver-4,
- # composer-n1-webserver-8.
- # If not specified, composer-n1-webserver-2 will be used.
- # Value custom is returned only in response, if Airflow web server parameters
- # were manually changed to a non-standard values.
- },
- "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`.
- },
- ],
+ "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)).
+ "privateEnvironmentConfig": { # The configuration information for configuring a Private IP Cloud Composer # The configuration used for the Private IP Cloud Composer environment.
+ # environment.
+ "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.
+ "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.
+ "enablePrivateEndpoint": True or False, # Optional. If `true`, access to the public endpoint of the GKE cluster is
+ # denied.
+ "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.
+ },
+ "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.
+ "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.
+ "webServerIpv4ReservedRange": "A String", # Output only. The IP range reserved for the tenant project's App Engine VMs.
},
},
+ "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
+ # size.
+ "a_key": "A String",
+ },
"updateTime": "A String", # Output only. The time at which this environment was last modified.
+ "createTime": "A String", # Output only. The time at which this environment was created.
+ "state": "A String", # The current state of the environment.
"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.
- "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
@@ -1589,6 +1593,19 @@
<a href="/composer/docs/concepts/versioning/composer-versions">Cloud
Composer Version List</a> for valid values.</td>
</tr>
+ <tr>
+ <td>config.databaseConfig.machineType</td>
+ <td>Cloud SQL machine type used by Airflow database.
+ It has to be one of: db-n1-standard-2, db-n1-standard-4, db-n1-standard-8
+ or db-n1-standard-16.</td>
+ </tr>
+ <tr>
+ <td>config.webServerConfig.machineType</td>
+ <td>Machine type on which Airflow web server is running.
+ It has to be one of: composer-n1-webserver-2, composer-n1-webserver-4 or
+ composer-n1-webserver-8.
+ </td>
+ </tr>
</tbody>
</table>
x__xgafv: string, V1 error format.
@@ -1604,30 +1621,6 @@
"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}`.
- "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). Each `Status` message contains
- # three pieces of data: error code, error message, and error details.
- #
- # 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).
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "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.
- "details": [ # A list of messages that carry the error details. There is a common set of
- # message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- ],
- },
- "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.
- },
"done": True or False, # If the value is `false`, it means the operation is still in progress.
# If `true`, the operation is completed, and either `error` or `response` is
# available.
@@ -1641,6 +1634,30 @@
# `TakeSnapshotResponse`.
"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). Each `Status` message contains
+ # three pieces of data: error code, error message, and error details.
+ #
+ # 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.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of
+ # message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "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>