# Cloud Composer V1 API - Class Google::Cloud::Orchestration::Airflow::Service::V1::SoftwareConfig (v1.9.0)

1.9.0 (latest) 1.8.0 1.7.0 1.6.1 1.5.0 1.4.0 1.3.4 1.2.0 1.1.0 1.0.1 0.11.0 0.10.0 0.9.2 0.8.0 0.7.0 0.6.1 0.5.0 0.4.0 0.3.1 0.2.0 0.1.2 Reference documentation and code samples for the Cloud Composer V1 API class Google::Cloud::Orchestration::Airflow::Service::V1::SoftwareConfig.

Specifies the selection and configuration of software inside the environment.

## Inherits

- Object

## Extended By

- Google::Protobuf::MessageExts::ClassMethods

## Includes

- Google::Protobuf::MessageExts

## Methods

### #airflow_config_overrides

    def airflow_config_overrides() -> ::Google::Protobuf::Map{::String => ::String}

**Returns**

- (::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](https://docs.cloud.google.com/composer/docs/concepts/airflow-configurations),
  and cannot be overridden.

### #airflow_config_overrides=

    def airflow_config_overrides=(value) -> ::Google::Protobuf::Map{::String => ::String}

**Parameter**

- **value** (::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](https://docs.cloud.google.com/composer/docs/concepts/airflow-configurations),
  and cannot be overridden.
**Returns**

- (::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](https://docs.cloud.google.com/composer/docs/concepts/airflow-configurations),
  and cannot be overridden.

### #cloud_data_lineage_integration

    def cloud_data_lineage_integration() -> ::Google::Cloud::Orchestration::Airflow::Service::V1::CloudDataLineageIntegration

**Returns**

- ([::Google::Cloud::Orchestration::Airflow::Service::V1::CloudDataLineageIntegration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-orchestration-airflow-service-v1/latest/Google-Cloud-Orchestration-Airflow-Service-V1-CloudDataLineageIntegration)) --- Optional. The configuration for Cloud Data Lineage integration.

### #cloud_data_lineage_integration=

    def cloud_data_lineage_integration=(value) -> ::Google::Cloud::Orchestration::Airflow::Service::V1::CloudDataLineageIntegration

**Parameter**

- **value** ([::Google::Cloud::Orchestration::Airflow::Service::V1::CloudDataLineageIntegration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-orchestration-airflow-service-v1/latest/Google-Cloud-Orchestration-Airflow-Service-V1-CloudDataLineageIntegration)) --- Optional. The configuration for Cloud Data Lineage integration.
**Returns**

- ([::Google::Cloud::Orchestration::Airflow::Service::V1::CloudDataLineageIntegration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-orchestration-airflow-service-v1/latest/Google-Cloud-Orchestration-Airflow-Service-V1-CloudDataLineageIntegration)) --- Optional. The configuration for Cloud Data Lineage integration.

### #env_variables

    def env_variables() -> ::Google::Protobuf::Map{::String => ::String}

**Returns**

- (::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`

### #env_variables=

    def env_variables=(value) -> ::Google::Protobuf::Map{::String => ::String}

**Parameter**

- **value** (::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`
**Returns**

- (::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`

### #image_version

    def image_version() -> ::String

**Returns**

- (::String) --- Optional. 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]+(-preview\.[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 image version is a full
  [semantic version](https://semver.org), or an alias in the form of major
  version number or `latest`. When an alias is provided, the server replaces
  it with the current Cloud Composer version that satisfies the alias.

  The Apache Airflow portion of the image version is a full semantic version
  that points to one of the supported Apache Airflow versions, or an alias in
  the form of only major or major.minor versions specified. When an alias is
  provided, the server replaces it with the latest Apache Airflow version
  that satisfies the alias and is supported in the given Cloud Composer
  version.

  In all cases, the resolved image version is stored in the same field.

  See also [version
  list](https://docs.cloud.google.com/composer/docs/concepts/versioning/composer-versions) and [versioning
  overview](https://docs.cloud.google.com/composer/docs/concepts/versioning/composer-versioning-overview).

### #image_version=

    def image_version=(value) -> ::String

**Parameter**

- **value** (::String) --- Optional. 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]+(-preview\.[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 image version is a full
  [semantic version](https://semver.org), or an alias in the form of major
  version number or `latest`. When an alias is provided, the server replaces
  it with the current Cloud Composer version that satisfies the alias.

  The Apache Airflow portion of the image version is a full semantic version
  that points to one of the supported Apache Airflow versions, or an alias in
  the form of only major or major.minor versions specified. When an alias is
  provided, the server replaces it with the latest Apache Airflow version
  that satisfies the alias and is supported in the given Cloud Composer
  version.

  In all cases, the resolved image version is stored in the same field.

  See also [version
  list](https://docs.cloud.google.com/composer/docs/concepts/versioning/composer-versions) and [versioning
  overview](https://docs.cloud.google.com/composer/docs/concepts/versioning/composer-versioning-overview).
**Returns**

- (::String) --- Optional. 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]+(-preview\.[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 image version is a full
  [semantic version](https://semver.org), or an alias in the form of major
  version number or `latest`. When an alias is provided, the server replaces
  it with the current Cloud Composer version that satisfies the alias.

  The Apache Airflow portion of the image version is a full semantic version
  that points to one of the supported Apache Airflow versions, or an alias in
  the form of only major or major.minor versions specified. When an alias is
  provided, the server replaces it with the latest Apache Airflow version
  that satisfies the alias and is supported in the given Cloud Composer
  version.

  In all cases, the resolved image version is stored in the same field.

  See also [version
  list](https://docs.cloud.google.com/composer/docs/concepts/versioning/composer-versions) and [versioning
  overview](https://docs.cloud.google.com/composer/docs/concepts/versioning/composer-versioning-overview).

### #pypi_packages

    def pypi_packages() -> ::Google::Protobuf::Map{::String => ::String}

**Returns**

- (::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.

### #pypi_packages=

    def pypi_packages=(value) -> ::Google::Protobuf::Map{::String => ::String}

**Parameter**

- **value** (::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.
**Returns**

- (::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.

### #python_version

    def python_version() -> ::String

**Returns**

- (::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.

  This field is only supported for Cloud Composer environments in versions
  composer-1.*.* -airflow-*.*.\*. Environments in newer versions always use
  Python major version 3.

### #python_version=

    def python_version=(value) -> ::String

**Parameter**

- **value** (::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.

  This field is only supported for Cloud Composer environments in versions
  composer-1.*.* -airflow-*.*.\*. Environments in newer versions always use
  Python major version 3.
**Returns**

- (::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.

  This field is only supported for Cloud Composer environments in versions
  composer-1.*.* -airflow-*.*.\*. Environments in newer versions always use
  Python major version 3.

### #scheduler_count

    def scheduler_count() -> ::Integer

**Returns**

- (::Integer) --- Optional. The number of schedulers for Airflow.

  This field is supported for Cloud Composer environments in versions
  composer-1.*.* -airflow-2.*.*.

### #scheduler_count=

    def scheduler_count=(value) -> ::Integer

**Parameter**

- **value** (::Integer) --- Optional. The number of schedulers for Airflow.


  This field is supported for Cloud Composer environments in versions
  composer-1.*.* -airflow-2.*.*.
**Returns**

- (::Integer) --- Optional. The number of schedulers for Airflow.

  This field is supported for Cloud Composer environments in versions
  composer-1.*.* -airflow-2.*.*.

### #web_server_plugins_mode

    def web_server_plugins_mode() -> ::Google::Cloud::Orchestration::Airflow::Service::V1::SoftwareConfig::WebServerPluginsMode

**Returns**

- ([::Google::Cloud::Orchestration::Airflow::Service::V1::SoftwareConfig::WebServerPluginsMode](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-orchestration-airflow-service-v1/latest/Google-Cloud-Orchestration-Airflow-Service-V1-SoftwareConfig-WebServerPluginsMode)) --- Optional. Whether or not the web server uses custom plugins. If unspecified, the field defaults to `PLUGINS_ENABLED`.


  This field is supported for Cloud Composer environments in versions
  composer-3-airflow-*.* .*-build.* and newer.

### #web_server_plugins_mode=

    def web_server_plugins_mode=(value) -> ::Google::Cloud::Orchestration::Airflow::Service::V1::SoftwareConfig::WebServerPluginsMode

**Parameter**

- **value** ([::Google::Cloud::Orchestration::Airflow::Service::V1::SoftwareConfig::WebServerPluginsMode](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-orchestration-airflow-service-v1/latest/Google-Cloud-Orchestration-Airflow-Service-V1-SoftwareConfig-WebServerPluginsMode)) --- Optional. Whether or not the web server uses custom plugins. If unspecified, the field defaults to `PLUGINS_ENABLED`.


  This field is supported for Cloud Composer environments in versions
  composer-3-airflow-*.* .*-build.* and newer.
**Returns**

- ([::Google::Cloud::Orchestration::Airflow::Service::V1::SoftwareConfig::WebServerPluginsMode](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-orchestration-airflow-service-v1/latest/Google-Cloud-Orchestration-Airflow-Service-V1-SoftwareConfig-WebServerPluginsMode)) --- Optional. Whether or not the web server uses custom plugins. If unspecified, the field defaults to `PLUGINS_ENABLED`.


  This field is supported for Cloud Composer environments in versions
  composer-3-airflow-*.* .*-build.* and newer.