google-cloud-orchestration-airflow-service-v1 0.1.0

data/proto_docs/google/cloud/orchestration/airflow/service/v1/environments.rb

@@ -0,0 +1,762 @@
+# frozen_string_literal: true
+
+# Copyright 2021 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module Orchestration
+      module Airflow
+        module Service
+          module V1
+            # Create a new environment.
+            # @!attribute [rw] parent
+            #   @return [::String]
+            #     The parent must be of the form
+            #     "projects/\\{projectId}/locations/\\{locationId}".
+            # @!attribute [rw] environment
+            #   @return [::Google::Cloud::Orchestration::Airflow::Service::V1::Environment]
+            #     The environment to create.
+            class CreateEnvironmentRequest
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+
+            # Get an environment.
+            # @!attribute [rw] name
+            #   @return [::String]
+            #     The resource name of the environment to get, in the form:
+            #     "projects/\\{projectId}/locations/\\{locationId}/environments/\\{environmentId}"
+            class GetEnvironmentRequest
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+
+            # List environments in a project and location.
+            # @!attribute [rw] parent
+            #   @return [::String]
+            #     List environments in the given project and location, in the form:
+            #     "projects/\\{projectId}/locations/\\{locationId}"
+            # @!attribute [rw] page_size
+            #   @return [::Integer]
+            #     The maximum number of environments to return.
+            # @!attribute [rw] page_token
+            #   @return [::String]
+            #     The next_page_token value returned from a previous List request, if any.
+            class ListEnvironmentsRequest
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+
+            # The environments in a project and location.
+            # @!attribute [rw] environments
+            #   @return [::Array<::Google::Cloud::Orchestration::Airflow::Service::V1::Environment>]
+            #     The list of environments returned by a ListEnvironmentsRequest.
+            # @!attribute [rw] next_page_token
+            #   @return [::String]
+            #     The page token used to query for the next page if one exists.
+            class ListEnvironmentsResponse
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+
+            # Delete an environment.
+            # @!attribute [rw] name
+            #   @return [::String]
+            #     The environment to delete, in the form:
+            #     "projects/\\{projectId}/locations/\\{locationId}/environments/\\{environmentId}"
+            class DeleteEnvironmentRequest
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+
+            # Update an environment.
+            # @!attribute [rw] name
+            #   @return [::String]
+            #     The relative resource name of the environment to update, in the form:
+            #     "projects/\\{projectId}/locations/\\{locationId}/environments/\\{environmentId}"
+            # @!attribute [rw] environment
+            #   @return [::Google::Cloud::Orchestration::Airflow::Service::V1::Environment]
+            #     A patch environment. Fields specified by the `updateMask` will be copied
+            #     from the patch environment into the environment under update.
+            # @!attribute [rw] update_mask
+            #   @return [::Google::Protobuf::FieldMask]
+            #     Required. A comma-separated list of paths, relative to `Environment`, of
+            #     fields to update.
+            #     For example, to set the version of scikit-learn to install in the
+            #     environment to 0.19.0 and to remove an existing installation of
+            #     numpy, the `updateMask` parameter would include the following two
+            #     `paths` values: "config.softwareConfig.pypiPackages.scikit-learn" and
+            #     "config.softwareConfig.pypiPackages.numpy". The included patch
+            #     environment would specify the scikit-learn version as follows:
+            #
+            #         {
+            #           "config":{
+            #             "softwareConfig":{
+            #               "pypiPackages":{
+            #                 "scikit-learn":"==0.19.0"
+            #               }
+            #             }
+            #           }
+            #         }
+            #
+            #     Note that in the above example, any existing PyPI packages
+            #     other than scikit-learn and numpy will be unaffected.
+            #
+            #     Only one update type may be included in a single request's `updateMask`.
+            #     For example, one cannot update both the PyPI packages and
+            #     labels in the same request. However, it is possible to update multiple
+            #     members of a map field simultaneously in the same request. For example,
+            #     to set the labels "label1" and "label2" while clearing "label3" (assuming
+            #     it already exists), one can
+            #     provide the paths "labels.label1", "labels.label2", and "labels.label3"
+            #     and populate the patch environment as follows:
+            #
+            #         {
+            #           "labels":{
+            #             "label1":"new-label1-value"
+            #             "label2":"new-label2-value"
+            #           }
+            #         }
+            #
+            #     Note that in the above example, any existing labels that are not
+            #     included in the `updateMask` will be unaffected.
+            #
+            #     It is also possible to replace an entire map field by providing the
+            #     map field's path in the `updateMask`. The new value of the field will
+            #     be that which is provided in the patch environment. For example, to
+            #     delete all pre-existing user-specified PyPI packages and
+            #     install botocore at version 1.7.14, the `updateMask` would contain
+            #     the path "config.softwareConfig.pypiPackages", and
+            #     the patch environment would be the following:
+            #
+            #         {
+            #           "config":{
+            #             "softwareConfig":{
+            #               "pypiPackages":{
+            #                 "botocore":"==1.7.14"
+            #               }
+            #             }
+            #           }
+            #         }
+            #
+            #     **Note:** Only the following fields can be updated:
+            #
+            #     * `config.softwareConfig.pypiPackages`
+            #         * Replace all custom custom PyPI packages. If a replacement
+            #           package map is not included in `environment`, all custom
+            #           PyPI packages are cleared. It is an error to provide both
+            #           this mask and a mask specifying an individual package.
+            #     * `config.softwareConfig.pypiPackages.`packagename
+            #         * Update the custom PyPI package *packagename*,
+            #           preserving other packages. To delete the package, include it in
+            #           `updateMask`, and omit the mapping for it in
+            #           `environment.config.softwareConfig.pypiPackages`. It is an error
+            #           to provide both a mask of this form and the
+            #           `config.softwareConfig.pypiPackages` mask.
+            #     * `labels`
+            #         * Replace all environment labels. If a replacement labels map is not
+            #           included in `environment`, all labels are cleared. It is an error to
+            #           provide both this mask and a mask specifying one or more individual
+            #           labels.
+            #     * `labels.`labelName
+            #         * Set the label named *labelName*, while preserving other
+            #           labels. To delete the label, include it in `updateMask` and omit its
+            #           mapping in `environment.labels`. It is an error to provide both a
+            #           mask of this form and the `labels` mask.
+            #     * `config.nodeCount`
+            #         * Horizontally scale the number of nodes in the environment. An integer
+            #           greater than or equal to 3 must be provided in the `config.nodeCount`
+            #           field.
+            #     * `config.webServerNetworkAccessControl`
+            #         * Replace the environment's current `WebServerNetworkAccessControl`.
+            #     * `config.databaseConfig`
+            #         * Replace the environment's current `DatabaseConfig`.
+            #     * `config.webServerConfig`
+            #         * Replace the environment's current `WebServerConfig`.
+            #     * `config.softwareConfig.airflowConfigOverrides`
+            #         * Replace all Apache Airflow config overrides. If a replacement config
+            #           overrides map is not included in `environment`, all config overrides
+            #           are cleared.
+            #           It is an error to provide both this mask and a mask specifying one or
+            #           more individual config overrides.
+            #     * `config.softwareConfig.airflowConfigOverrides.`section-name
+            #         * Override the Apache Airflow config property *name* in the
+            #           section named *section*, preserving other properties. To
+            #           delete the property override, include it in `updateMask` and omit its
+            #           mapping in
+            #           `environment.config.softwareConfig.airflowConfigOverrides`.
+            #           It is an error to provide both a mask of this form and the
+            #           `config.softwareConfig.airflowConfigOverrides` mask.
+            #     * `config.softwareConfig.envVariables`
+            #         * Replace all environment variables. If a replacement environment
+            #           variable map is not included in `environment`, all custom environment
+            #           variables  are cleared.
+            #           It is an error to provide both this mask and a mask specifying one or
+            #           more individual environment variables.
+            class UpdateEnvironmentRequest
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+
+            # Configuration information for an environment.
+            # @!attribute [rw] gke_cluster
+            #   @return [::String]
+            #     Output only. The Kubernetes Engine cluster used to run this environment.
+            # @!attribute [rw] dag_gcs_prefix
+            #   @return [::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.
+            # @!attribute [rw] node_count
+            #   @return [::Integer]
+            #     The number of nodes in the Kubernetes Engine cluster that will be
+            #     used to run this environment.
+            # @!attribute [rw] software_config
+            #   @return [::Google::Cloud::Orchestration::Airflow::Service::V1::SoftwareConfig]
+            #     The configuration settings for software inside the environment.
+            # @!attribute [rw] node_config
+            #   @return [::Google::Cloud::Orchestration::Airflow::Service::V1::NodeConfig]
+            #     The configuration used for the Kubernetes Engine cluster.
+            # @!attribute [rw] private_environment_config
+            #   @return [::Google::Cloud::Orchestration::Airflow::Service::V1::PrivateEnvironmentConfig]
+            #     The configuration used for the Private IP Cloud Composer environment.
+            # @!attribute [rw] web_server_network_access_control
+            #   @return [::Google::Cloud::Orchestration::Airflow::Service::V1::WebServerNetworkAccessControl]
+            #     Optional. The network-level access control policy for the Airflow web server. If
+            #     unspecified, no network-level access restrictions will be applied.
+            # @!attribute [rw] database_config
+            #   @return [::Google::Cloud::Orchestration::Airflow::Service::V1::DatabaseConfig]
+            #     Optional. The configuration settings for Cloud SQL instance used internally by Apache
+            #     Airflow software.
+            # @!attribute [rw] web_server_config
+            #   @return [::Google::Cloud::Orchestration::Airflow::Service::V1::WebServerConfig]
+            #     Optional. The configuration settings for the Airflow web server App Engine instance.
+            # @!attribute [rw] encryption_config
+            #   @return [::Google::Cloud::Orchestration::Airflow::Service::V1::EncryptionConfig]
+            #     Optional. The encryption options for the Cloud Composer environment
+            #     and its dependencies. Cannot be updated.
+            # @!attribute [rw] airflow_uri
+            #   @return [::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)).
+            class EnvironmentConfig
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+
+            # Network-level access control policy for the Airflow web server.
+            # @!attribute [rw] allowed_ip_ranges
+            #   @return [::Array<::Google::Cloud::Orchestration::Airflow::Service::V1::WebServerNetworkAccessControl::AllowedIpRange>]
+            #     A collection of allowed IP ranges with descriptions.
+            class WebServerNetworkAccessControl
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+
+              # Allowed IP range with user-provided description.
+              # @!attribute [rw] value
+              #   @return [::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`.
+              #
+              #     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`.
+              # @!attribute [rw] description
+              #   @return [::String]
+              #     Optional. User-provided description. It must contain at most 300 characters.
+              class AllowedIpRange
+                include ::Google::Protobuf::MessageExts
+                extend ::Google::Protobuf::MessageExts::ClassMethods
+              end
+            end
+
+            # The configuration of Cloud SQL instance that is used by the Apache Airflow
+            # software.
+            # @!attribute [rw] machine_type
+            #   @return [::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.
+            class DatabaseConfig
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+
+            # The configuration settings for the Airflow web server App Engine instance.
+            # @!attribute [rw] machine_type
+            #   @return [::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.
+            class WebServerConfig
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+
+            # The encryption options for the Cloud Composer environment
+            # and its dependencies.
+            # @!attribute [rw] kms_key_name
+            #   @return [::String]
+            #     Optional. Customer-managed Encryption Key available through Google's Key Management
+            #     Service. Cannot be updated.
+            #     If not specified, Google-managed key will be used.
+            class EncryptionConfig
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+
+            # Specifies the selection and configuration of software inside the environment.
+            # @!attribute [rw] image_version
+            #   @return [::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 *airflow-* 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).
+            # @!attribute [rw] airflow_config_overrides
+            #   @return [::Google::Protobuf::Map{::String => ::String}]
+            #     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
+            #     [blocked](/composer/docs/concepts/airflow-configurations),
+            #     and cannot be overridden.
+            # @!attribute [rw] pypi_packages
+            #   @return [::Google::Protobuf::Map{::String => ::String}]
+            #     Optional. Custom Python Package Index (PyPI) packages to be installed in
+            #     the environment.
+            #
+            #     Keys refer to the lowercase package name such as "numpy"
+            #     and values are the lowercase extras and version specifier such as
+            #     "==1.12.0", "[devel,gcp_api]", or "[devel]>=1.8.2, <1.9.2". To specify a
+            #     package without pinning it to a version specifier, use the empty string as
+            #     the value.
+            # @!attribute [rw] env_variables
+            #   @return [::Google::Protobuf::Map{::String => ::String}]
+            #     Optional. Additional environment variables to provide to the Apache Airflow
+            #     scheduler, worker, and webserver processes.
+            #
+            #     Environment variable names must match the regular expression
+            #     `[a-zA-Z_][a-zA-Z0-9_]*`. They cannot specify Apache Airflow
+            #     software configuration overrides (they cannot match the regular expression
+            #     `AIRFLOW__[A-Z0-9_]+__[A-Z0-9_]+`), and they cannot match any of the
+            #     following reserved names:
+            #
+            #     * `AIRFLOW_HOME`
+            #     * `C_FORCE_ROOT`
+            #     * `CONTAINER_NAME`
+            #     * `DAGS_FOLDER`
+            #     * `GCP_PROJECT`
+            #     * `GCS_BUCKET`
+            #     * `GKE_CLUSTER_NAME`
+            #     * `SQL_DATABASE`
+            #     * `SQL_INSTANCE`
+            #     * `SQL_PASSWORD`
+            #     * `SQL_PROJECT`
+            #     * `SQL_REGION`
+            #     * `SQL_USER`
+            # @!attribute [rw] python_version
+            #   @return [::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 '3'. Cannot be
+            #     updated.
+            class SoftwareConfig
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+
+              # @!attribute [rw] key
+              #   @return [::String]
+              # @!attribute [rw] value
+              #   @return [::String]
+              class AirflowConfigOverridesEntry
+                include ::Google::Protobuf::MessageExts
+                extend ::Google::Protobuf::MessageExts::ClassMethods
+              end
+
+              # @!attribute [rw] key
+              #   @return [::String]
+              # @!attribute [rw] value
+              #   @return [::String]
+              class PypiPackagesEntry
+                include ::Google::Protobuf::MessageExts
+                extend ::Google::Protobuf::MessageExts::ClassMethods
+              end
+
+              # @!attribute [rw] key
+              #   @return [::String]
+              # @!attribute [rw] value
+              #   @return [::String]
+              class EnvVariablesEntry
+                include ::Google::Protobuf::MessageExts
+                extend ::Google::Protobuf::MessageExts::ClassMethods
+              end
+            end
+
+            # Configuration for controlling how IPs are allocated in the
+            # GKE cluster running the Apache Airflow software.
+            # @!attribute [rw] use_ip_aliases
+            #   @return [::Boolean]
+            #     Optional. Whether or not to enable Alias IPs in the GKE cluster.
+            #     If `true`, a VPC-native cluster is created.
+            # @!attribute [rw] cluster_secondary_range_name
+            #   @return [::String]
+            #     Optional. The name of the GKE cluster's secondary range used to allocate
+            #     IP addresses to pods.
+            #
+            #     This field is applicable only when `use_ip_aliases` is true.
+            # @!attribute [rw] cluster_ipv4_cidr_block
+            #   @return [::String]
+            #     Optional. The IP address range used to allocate IP addresses to pods in
+            #     the GKE cluster.
+            #
+            #     This field is applicable only when `use_ip_aliases` is true.
+            #
+            #     Set to blank to have GKE choose a range with the default size.
+            #
+            #     Set to /netmask (e.g. `/14`) to have GKE choose a range with a specific
+            #     netmask.
+            #
+            #     Set to a
+            #     [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)
+            #     notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.
+            #     `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range
+            #     to use.
+            # @!attribute [rw] services_secondary_range_name
+            #   @return [::String]
+            #     Optional. The name of the services' secondary range used to allocate
+            #     IP addresses to the GKE cluster.
+            #
+            #     This field is applicable only when `use_ip_aliases` is true.
+            # @!attribute [rw] services_ipv4_cidr_block
+            #   @return [::String]
+            #     Optional. The IP address range of the services IP addresses in this
+            #     GKE cluster.
+            #
+            #     This field is applicable only when `use_ip_aliases` is true.
+            #
+            #     Set to blank to have GKE choose a range with the default size.
+            #
+            #     Set to /netmask (e.g. `/14`) to have GKE choose a range with a specific
+            #     netmask.
+            #
+            #     Set to a
+            #     [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)
+            #     notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.
+            #     `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range
+            #     to use.
+            class IPAllocationPolicy
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+
+            # The configuration information for the Kubernetes Engine nodes running
+            # the Apache Airflow software.
+            # @!attribute [rw] location
+            #   @return [::String]
+            #     Optional. The Compute Engine [zone](/compute/docs/regions-zones) in which
+            #     to deploy the VMs used to run the Apache Airflow software, specified as a
+            #     [relative resource
+            #     name](/apis/design/resource_names#relative_resource_name). For example:
+            #     "projects/\\{projectId}/zones/\\{zoneId}".
+            #
+            #     This `location` must belong to the enclosing environment's project and
+            #     location. If both this field and `nodeConfig.machineType` are specified,
+            #     `nodeConfig.machineType` must belong to this `location`; if both are
+            #     unspecified, the service will pick a zone in the Compute Engine region
+            #     corresponding to the Cloud Composer location, and propagate that choice to
+            #     both fields. If only one field (`location` or `nodeConfig.machineType`) is
+            #     specified, the location information from the specified field will be
+            #     propagated to the unspecified field.
+            # @!attribute [rw] machine_type
+            #   @return [::String]
+            #     Optional. The Compute Engine
+            #     [machine type](/compute/docs/machine-types) used for cluster instances,
+            #     specified as a
+            #     [relative resource
+            #     name](/apis/design/resource_names#relative_resource_name). For example:
+            #     "projects/\\{projectId}/zones/\\{zoneId}/machineTypes/\\{machineTypeId}".
+            #
+            #     The `machineType` must belong to the enclosing environment's project and
+            #     location. If both this field and `nodeConfig.location` are specified,
+            #     this `machineType` must belong to the `nodeConfig.location`; if both are
+            #     unspecified, the service will pick a zone in the Compute Engine region
+            #     corresponding to the Cloud Composer location, and propagate that choice to
+            #     both fields. If exactly one of this field and `nodeConfig.location` is
+            #     specified, the location information from the specified field will be
+            #     propagated to the unspecified field.
+            #
+            #     The `machineTypeId` must not be a [shared-core machine
+            #     type](/compute/docs/machine-types#sharedcore).
+            #
+            #     If this field is unspecified, the `machineTypeId` defaults
+            #     to "n1-standard-1".
+            # @!attribute [rw] network
+            #   @return [::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 ID 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`.
+            # @!attribute [rw] subnetwork
+            #   @return [::String]
+            #     Optional. The Compute Engine subnetwork to be used for machine
+            #     communications, specified as a
+            #     [relative resource
+            #     name](/apis/design/resource_names#relative_resource_name). For example:
+            #     "projects/\\{projectId}/regions/\\{regionId}/subnetworks/\\{subnetworkId}"
+            #
+            #     If a subnetwork is provided, `nodeConfig.network` must also be provided,
+            #     and the subnetwork must belong to the enclosing environment's project and
+            #     location.
+            # @!attribute [rw] disk_size_gb
+            #   @return [::Integer]
+            #     Optional. The disk size in GB used for node VMs. Minimum size is 20GB.
+            #     If unspecified, defaults to 100GB. Cannot be updated.
+            # @!attribute [rw] oauth_scopes
+            #   @return [::Array<::String>]
+            #     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.
+            # @!attribute [rw] service_account
+            #   @return [::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.
+            # @!attribute [rw] tags
+            #   @return [::Array<::String>]
+            #     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.
+            # @!attribute [rw] ip_allocation_policy
+            #   @return [::Google::Cloud::Orchestration::Airflow::Service::V1::IPAllocationPolicy]
+            #     Optional. The configuration for controlling how IPs are allocated in the GKE cluster.
+            class NodeConfig
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+
+            # Configuration options for the private GKE cluster in a Cloud Composer
+            # environment.
+            # @!attribute [rw] enable_private_endpoint
+            #   @return [::Boolean]
+            #     Optional. If `true`, access to the public endpoint of the GKE cluster is
+            #     denied.
+            # @!attribute [rw] master_ipv4_cidr_block
+            #   @return [::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.
+            # @!attribute [r] master_ipv4_reserved_range
+            #   @return [::String]
+            #     Output only. The IP range in CIDR notation to use for the hosted master network. This
+            #     range is used for assigning internal IP addresses to the GKE cluster
+            #     master or set of masters and to the internal load balancer virtual IP.
+            #     This range must not overlap with any other ranges in use
+            #     within the cluster's network.
+            class PrivateClusterConfig
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+
+            # The configuration information for configuring a Private IP Cloud Composer
+            # environment.
+            # @!attribute [rw] enable_private_environment
+            #   @return [::Boolean]
+            #     Optional. If `true`, a Private IP Cloud Composer environment is created.
+            #     If this field is set to true, `IPAllocationPolicy.use_ip_aliases` must be
+            #     set to true.
+            # @!attribute [rw] private_cluster_config
+            #   @return [::Google::Cloud::Orchestration::Airflow::Service::V1::PrivateClusterConfig]
+            #     Optional. Configuration for the private GKE cluster for a Private IP
+            #     Cloud Composer environment.
+            # @!attribute [rw] web_server_ipv4_cidr_block
+            #   @return [::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`.
+            # @!attribute [rw] cloud_sql_ipv4_cidr_block
+            #   @return [::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`.
+            # @!attribute [r] web_server_ipv4_reserved_range
+            #   @return [::String]
+            #     Output only. The IP range reserved for the tenant project's App Engine VMs.
+            class PrivateEnvironmentConfig
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+
+            # An environment for running orchestration tasks.
+            # @!attribute [rw] name
+            #   @return [::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.
+            # @!attribute [rw] config
+            #   @return [::Google::Cloud::Orchestration::Airflow::Service::V1::EnvironmentConfig]
+            #     Configuration parameters for this environment.
+            # @!attribute [rw] uuid
+            #   @return [::String]
+            #     Output only. The UUID (Universally Unique IDentifier) associated with this environment.
+            #     This value is generated when the environment is created.
+            # @!attribute [rw] state
+            #   @return [::Google::Cloud::Orchestration::Airflow::Service::V1::Environment::State]
+            #     The current state of the environment.
+            # @!attribute [rw] create_time
+            #   @return [::Google::Protobuf::Timestamp]
+            #     Output only. The time at which this environment was created.
+            # @!attribute [rw] update_time
+            #   @return [::Google::Protobuf::Timestamp]
+            #     Output only. The time at which this environment was last modified.
+            # @!attribute [rw] labels
+            #   @return [::Google::Protobuf::Map{::String => ::String}]
+            #     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}][\p\\{Ll}\p\\{Lo}\p\\{N}_-]\\{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.
+            class Environment
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+
+              # @!attribute [rw] key
+              #   @return [::String]
+              # @!attribute [rw] value
+              #   @return [::String]
+              class LabelsEntry
+                include ::Google::Protobuf::MessageExts
+                extend ::Google::Protobuf::MessageExts::ClassMethods
+              end
+
+              # State of the environment.
+              module State
+                # The state of the environment is unknown.
+                STATE_UNSPECIFIED = 0
+
+                # The environment is in the process of being created.
+                CREATING = 1
+
+                # The environment is currently running and healthy. It is ready for use.
+                RUNNING = 2
+
+                # The environment is being updated. It remains usable but cannot receive
+                # additional update requests or be deleted at this time.
+                UPDATING = 3
+
+                # The environment is undergoing deletion. It cannot be used.
+                DELETING = 4
+
+                # The environment has encountered an error and cannot be used.
+                ERROR = 5
+              end
+            end
+
+            # Message containing information about the result of an upgrade check
+            # operation.
+            # @!attribute [r] build_log_uri
+            #   @return [::String]
+            #     Output only. Url for a docker build log of an upgraded image.
+            # @!attribute [r] contains_pypi_modules_conflict
+            #   @return [::Google::Cloud::Orchestration::Airflow::Service::V1::CheckUpgradeResponse::ConflictResult]
+            #     Output only. Whether build has succeeded or failed on modules conflicts.
+            # @!attribute [r] pypi_conflict_build_log_extract
+            #   @return [::String]
+            #     Output only. Extract from a docker image build log containing information about pypi
+            #     modules conflicts.
+            # @!attribute [rw] image_version
+            #   @return [::String]
+            #     Composer image for which the build was happening.
+            # @!attribute [rw] pypi_dependencies
+            #   @return [::Google::Protobuf::Map{::String => ::String}]
+            #     Pypi dependencies specified in the environment configuration, at the time
+            #     when the build was triggered.
+            class CheckUpgradeResponse
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+
+              # @!attribute [rw] key
+              #   @return [::String]
+              # @!attribute [rw] value
+              #   @return [::String]
+              class PypiDependenciesEntry
+                include ::Google::Protobuf::MessageExts
+                extend ::Google::Protobuf::MessageExts::ClassMethods
+              end
+
+              # Whether there were python modules conflict during image build.
+              module ConflictResult
+                # It is unknown whether build had conflicts or not.
+                CONFLICT_RESULT_UNSPECIFIED = 0
+
+                # There were python packages conflicts.
+                CONFLICT = 1
+
+                # There were no python packages conflicts.
+                NO_CONFLICT = 2
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end