docs: update docs (#916)
* fix: re-run script
* test: fix noxfile
diff --git a/docs/dyn/composer_v1beta1.projects.locations.environments.html b/docs/dyn/composer_v1beta1.projects.locations.environments.html
index c533ced..8d1add5 100644
--- a/docs/dyn/composer_v1beta1.projects.locations.environments.html
+++ b/docs/dyn/composer_v1beta1.projects.locations.environments.html
@@ -104,7 +104,6 @@
The object takes the form of:
{ # An environment for running orchestration tasks.
- "createTime": "A String", # Output only. The time at which this environment was created.
"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:
@@ -115,68 +114,36 @@
# 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.
"config": { # Configuration information for an environment. # Configuration parameters for this environment.
- "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.
- "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`.
- "description": "A String", # Optional. User-provided description. It must contain at most 300 characters.
- },
- ],
- },
"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.
- "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.
"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.
- "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.
- "enablePrivateEndpoint": True or False, # Optional. If `true`, access to the public endpoint of the GKE cluster is
- # denied.
"masterIpv4ReservedRange": "A String", # Output only. The IP range in CIDR notation to use for the hosted master network. This
# range is used for assigning internal IP addresses to the 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
@@ -262,11 +229,6 @@
},
"nodeConfig": { # The configuration information for the Kubernetes Engine nodes running # The configuration used for the Kubernetes Engine cluster.
# the Apache Airflow software.
- "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",
- ],
"subnetwork": "A String", # Optional. The Compute Engine subnetwork to be used for machine
# communications, specified as a
# [relative resource
@@ -278,13 +240,18 @@
# 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.
- "useIpAliases": True or False, # Optional. Whether or not to enable Alias IPs in the GKE cluster.
- # If `true`, a VPC-native cluster is created.
+ "clusterSecondaryRangeName": "A String", # Optional. The name of the 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.
#
@@ -302,11 +269,6 @@
# to use.
# Specify `cluster_secondary_range_name` or `cluster_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.
"servicesIpv4CidrBlock": "A String", # Optional. The IP address range of the services IP addresses in this
# cluster.
#
@@ -382,9 +344,47 @@
# is provided, `nodeConfig.subnetwork` must also be provided. For
# [Shared VPC](/vpc/docs/shared-vpc) subnetwork requirements, see
# `nodeConfig.subnetwork`.
+ "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`.
+ },
+ ],
},
},
- "state": "A String", # The current state of the environment.
+ "updateTime": "A String", # Output only. The time at which this environment was last modified.
"name": "A String", # The resource name of the environment, in the form:
# "projects/{projectId}/locations/{locationId}/environments/{environmentId}"
#
@@ -404,6 +404,27 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
+ "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
@@ -423,27 +444,6 @@
# `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "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).
- "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.
- },
- ],
- "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.
- },
}</pre>
</div>
@@ -464,6 +464,27 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
+ "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
@@ -483,27 +504,6 @@
# `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "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).
- "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.
- },
- ],
- "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.
- },
}</pre>
</div>
@@ -523,7 +523,6 @@
An object of the form:
{ # An environment for running orchestration tasks.
- "createTime": "A String", # Output only. The time at which this environment was created.
"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:
@@ -534,68 +533,36 @@
# 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.
"config": { # Configuration information for an environment. # Configuration parameters for this environment.
- "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.
- "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`.
- "description": "A String", # Optional. User-provided description. It must contain at most 300 characters.
- },
- ],
- },
"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.
- "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.
"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.
- "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.
- "enablePrivateEndpoint": True or False, # Optional. If `true`, access to the public endpoint of the GKE cluster is
- # denied.
"masterIpv4ReservedRange": "A String", # Output only. The IP range in CIDR notation to use for the hosted master network. This
# range is used for assigning internal IP addresses to the 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
@@ -681,11 +648,6 @@
},
"nodeConfig": { # The configuration information for the Kubernetes Engine nodes running # The configuration used for the Kubernetes Engine cluster.
# the Apache Airflow software.
- "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",
- ],
"subnetwork": "A String", # Optional. The Compute Engine subnetwork to be used for machine
# communications, specified as a
# [relative resource
@@ -697,13 +659,18 @@
# 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.
- "useIpAliases": True or False, # Optional. Whether or not to enable Alias IPs in the GKE cluster.
- # If `true`, a VPC-native cluster is created.
+ "clusterSecondaryRangeName": "A String", # Optional. The name of the 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.
#
@@ -721,11 +688,6 @@
# to use.
# Specify `cluster_secondary_range_name` or `cluster_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.
"servicesIpv4CidrBlock": "A String", # Optional. The IP address range of the services IP addresses in this
# cluster.
#
@@ -801,9 +763,47 @@
# is provided, `nodeConfig.subnetwork` must also be provided. For
# [Shared VPC](/vpc/docs/shared-vpc) subnetwork requirements, see
# `nodeConfig.subnetwork`.
+ "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`.
+ },
+ ],
},
},
- "state": "A String", # The current state of the environment.
+ "updateTime": "A String", # Output only. The time at which this environment was last modified.
"name": "A String", # The resource name of the environment, in the form:
# "projects/{projectId}/locations/{locationId}/environments/{environmentId}"
#
@@ -835,7 +835,6 @@
"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.
- "createTime": "A String", # Output only. The time at which this environment was created.
"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:
@@ -846,68 +845,36 @@
# 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.
"config": { # Configuration information for an environment. # Configuration parameters for this environment.
- "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.
- "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`.
- "description": "A String", # Optional. User-provided description. It must contain at most 300 characters.
- },
- ],
- },
"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.
- "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.
"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.
- "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.
- "enablePrivateEndpoint": True or False, # Optional. If `true`, access to the public endpoint of the GKE cluster is
- # denied.
"masterIpv4ReservedRange": "A String", # Output only. The IP range in CIDR notation to use for the hosted master network. This
# range is used for assigning internal IP addresses to the 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
@@ -993,11 +960,6 @@
},
"nodeConfig": { # The configuration information for the Kubernetes Engine nodes running # The configuration used for the Kubernetes Engine cluster.
# the Apache Airflow software.
- "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",
- ],
"subnetwork": "A String", # Optional. The Compute Engine subnetwork to be used for machine
# communications, specified as a
# [relative resource
@@ -1009,13 +971,18 @@
# 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.
- "useIpAliases": True or False, # Optional. Whether or not to enable Alias IPs in the GKE cluster.
- # If `true`, a VPC-native cluster is created.
+ "clusterSecondaryRangeName": "A String", # Optional. The name of the 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.
#
@@ -1033,11 +1000,6 @@
# to use.
# Specify `cluster_secondary_range_name` or `cluster_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.
"servicesIpv4CidrBlock": "A String", # Optional. The IP address range of the services IP addresses in this
# cluster.
#
@@ -1113,9 +1075,47 @@
# is provided, `nodeConfig.subnetwork` must also be provided. For
# [Shared VPC](/vpc/docs/shared-vpc) subnetwork requirements, see
# `nodeConfig.subnetwork`.
+ "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`.
+ },
+ ],
},
},
- "state": "A String", # The current state of the environment.
+ "updateTime": "A String", # Output only. The time at which this environment was last modified.
"name": "A String", # The resource name of the environment, in the form:
# "projects/{projectId}/locations/{locationId}/environments/{environmentId}"
#
@@ -1153,7 +1153,6 @@
The object takes the form of:
{ # An environment for running orchestration tasks.
- "createTime": "A String", # Output only. The time at which this environment was created.
"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:
@@ -1164,68 +1163,36 @@
# 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.
"config": { # Configuration information for an environment. # Configuration parameters for this environment.
- "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.
- "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`.
- "description": "A String", # Optional. User-provided description. It must contain at most 300 characters.
- },
- ],
- },
"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.
- "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.
"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.
- "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.
- "enablePrivateEndpoint": True or False, # Optional. If `true`, access to the public endpoint of the GKE cluster is
- # denied.
"masterIpv4ReservedRange": "A String", # Output only. The IP range in CIDR notation to use for the hosted master network. This
# range is used for assigning internal IP addresses to the 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
@@ -1311,11 +1278,6 @@
},
"nodeConfig": { # The configuration information for the Kubernetes Engine nodes running # The configuration used for the Kubernetes Engine cluster.
# the Apache Airflow software.
- "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",
- ],
"subnetwork": "A String", # Optional. The Compute Engine subnetwork to be used for machine
# communications, specified as a
# [relative resource
@@ -1327,13 +1289,18 @@
# 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.
- "useIpAliases": True or False, # Optional. Whether or not to enable Alias IPs in the GKE cluster.
- # If `true`, a VPC-native cluster is created.
+ "clusterSecondaryRangeName": "A String", # Optional. The name of the 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.
#
@@ -1351,11 +1318,6 @@
# to use.
# Specify `cluster_secondary_range_name` or `cluster_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.
"servicesIpv4CidrBlock": "A String", # Optional. The IP address range of the services IP addresses in this
# cluster.
#
@@ -1431,9 +1393,47 @@
# is provided, `nodeConfig.subnetwork` must also be provided. For
# [Shared VPC](/vpc/docs/shared-vpc) subnetwork requirements, see
# `nodeConfig.subnetwork`.
+ "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`.
+ },
+ ],
},
},
- "state": "A String", # The current state of the environment.
+ "updateTime": "A String", # Output only. The time at which this environment was last modified.
"name": "A String", # The resource name of the environment, in the form:
# "projects/{projectId}/locations/{locationId}/environments/{environmentId}"
#
@@ -1601,6 +1601,27 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
+ "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
@@ -1620,27 +1641,6 @@
# `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "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).
- "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.
- },
- ],
- "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.
- },
}</pre>
</div>