google.cloud.orchestration.airflow.service.v1.SoftwareConfig */ class SoftwareConfig extends \Google\Protobuf\Internal\Message { /** * 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://cloud.google.com/composer/docs/concepts/versioning/composer-versions) and [versioning * overview](https://cloud.google.com/composer/docs/concepts/versioning/composer-versioning-overview). * * Generated from protobuf field string image_version = 1; */ private $image_version = ''; /** * 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://cloud.google.com/composer/docs/concepts/airflow-configurations), * and cannot be overridden. * * Generated from protobuf field map airflow_config_overrides = 2; */ private $airflow_config_overrides; /** * 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. * * Generated from protobuf field map pypi_packages = 3; */ private $pypi_packages; /** * 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` * * Generated from protobuf field map env_variables = 4; */ private $env_variables; /** * 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. * * Generated from protobuf field string python_version = 6; */ private $python_version = ''; /** * Optional. The number of schedulers for Airflow. * This field is supported for Cloud Composer environments in versions * composer-1.*.*-airflow-2.*.*. * * Generated from protobuf field int32 scheduler_count = 7 [(.google.api.field_behavior) = OPTIONAL]; */ private $scheduler_count = 0; /** * Constructor. * * @param array $data { * Optional. Data for populating the Message object. * * @type string $image_version * 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://cloud.google.com/composer/docs/concepts/versioning/composer-versions) and [versioning * overview](https://cloud.google.com/composer/docs/concepts/versioning/composer-versioning-overview). * @type array|\Google\Protobuf\Internal\MapField $airflow_config_overrides * 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://cloud.google.com/composer/docs/concepts/airflow-configurations), * and cannot be overridden. * @type array|\Google\Protobuf\Internal\MapField $pypi_packages * 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. * @type array|\Google\Protobuf\Internal\MapField $env_variables * 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` * @type string $python_version * 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. * @type int $scheduler_count * Optional. The number of schedulers for Airflow. * This field is supported for Cloud Composer environments in versions * composer-1.*.*-airflow-2.*.*. * } */ public function __construct($data = NULL) { \GPBMetadata\Google\Cloud\Orchestration\Airflow\Service\V1\Environments::initOnce(); parent::__construct($data); } /** * 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://cloud.google.com/composer/docs/concepts/versioning/composer-versions) and [versioning * overview](https://cloud.google.com/composer/docs/concepts/versioning/composer-versioning-overview). * * Generated from protobuf field string image_version = 1; * @return string */ public function getImageVersion() { return $this->image_version; } /** * 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://cloud.google.com/composer/docs/concepts/versioning/composer-versions) and [versioning * overview](https://cloud.google.com/composer/docs/concepts/versioning/composer-versioning-overview). * * Generated from protobuf field string image_version = 1; * @param string $var * @return $this */ public function setImageVersion($var) { GPBUtil::checkString($var, True); $this->image_version = $var; return $this; } /** * 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://cloud.google.com/composer/docs/concepts/airflow-configurations), * and cannot be overridden. * * Generated from protobuf field map airflow_config_overrides = 2; * @return \Google\Protobuf\Internal\MapField */ public function getAirflowConfigOverrides() { return $this->airflow_config_overrides; } /** * 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://cloud.google.com/composer/docs/concepts/airflow-configurations), * and cannot be overridden. * * Generated from protobuf field map airflow_config_overrides = 2; * @param array|\Google\Protobuf\Internal\MapField $var * @return $this */ public function setAirflowConfigOverrides($var) { $arr = GPBUtil::checkMapField($var, \Google\Protobuf\Internal\GPBType::STRING, \Google\Protobuf\Internal\GPBType::STRING); $this->airflow_config_overrides = $arr; return $this; } /** * 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. * * Generated from protobuf field map pypi_packages = 3; * @return \Google\Protobuf\Internal\MapField */ public function getPypiPackages() { return $this->pypi_packages; } /** * 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. * * Generated from protobuf field map pypi_packages = 3; * @param array|\Google\Protobuf\Internal\MapField $var * @return $this */ public function setPypiPackages($var) { $arr = GPBUtil::checkMapField($var, \Google\Protobuf\Internal\GPBType::STRING, \Google\Protobuf\Internal\GPBType::STRING); $this->pypi_packages = $arr; return $this; } /** * 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` * * Generated from protobuf field map env_variables = 4; * @return \Google\Protobuf\Internal\MapField */ public function getEnvVariables() { return $this->env_variables; } /** * 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` * * Generated from protobuf field map env_variables = 4; * @param array|\Google\Protobuf\Internal\MapField $var * @return $this */ public function setEnvVariables($var) { $arr = GPBUtil::checkMapField($var, \Google\Protobuf\Internal\GPBType::STRING, \Google\Protobuf\Internal\GPBType::STRING); $this->env_variables = $arr; return $this; } /** * 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. * * Generated from protobuf field string python_version = 6; * @return string */ public function getPythonVersion() { return $this->python_version; } /** * 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. * * Generated from protobuf field string python_version = 6; * @param string $var * @return $this */ public function setPythonVersion($var) { GPBUtil::checkString($var, True); $this->python_version = $var; return $this; } /** * Optional. The number of schedulers for Airflow. * This field is supported for Cloud Composer environments in versions * composer-1.*.*-airflow-2.*.*. * * Generated from protobuf field int32 scheduler_count = 7 [(.google.api.field_behavior) = OPTIONAL]; * @return int */ public function getSchedulerCount() { return $this->scheduler_count; } /** * Optional. The number of schedulers for Airflow. * This field is supported for Cloud Composer environments in versions * composer-1.*.*-airflow-2.*.*. * * Generated from protobuf field int32 scheduler_count = 7 [(.google.api.field_behavior) = OPTIONAL]; * @param int $var * @return $this */ public function setSchedulerCount($var) { GPBUtil::checkInt32($var); $this->scheduler_count = $var; return $this; } }