Class: Google::Apis::ComposerV1::SoftwareConfig
- Inherits:
-
Object
- Object
- Google::Apis::ComposerV1::SoftwareConfig
- Defined in:
- generated/google/apis/composer_v1/classes.rb,
generated/google/apis/composer_v1/representations.rb,
generated/google/apis/composer_v1/representations.rb
Overview
Specifies the selection and configuration of software inside the environment.
Instance Attribute Summary collapse
-
#airflow_config_overrides ⇒ Hash<String,String>
Optional.
-
#env_variables ⇒ Hash<String,String>
Optional.
-
#image_version ⇒ String
The version of the software running in the environment.
-
#pypi_packages ⇒ Hash<String,String>
Optional.
-
#python_version ⇒ String
Optional.
Instance Method Summary collapse
-
#initialize(**args) ⇒ SoftwareConfig
constructor
A new instance of SoftwareConfig.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Google::Apis::Core::JsonObjectSupport
Methods included from Google::Apis::Core::Hashable
Constructor Details
#initialize(**args) ⇒ SoftwareConfig
Returns a new instance of SoftwareConfig.
593 594 595 |
# File 'generated/google/apis/composer_v1/classes.rb', line 593 def initialize(**args) update!(**args) end |
Instance Attribute Details
#airflow_config_overrides ⇒ Hash<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. Property values can
contain any character, and can be written in any lower/upper case format.
Certain Apache Airflow configuration property values are
blacklisted,
and cannot be overridden.
Corresponds to the JSON property airflowConfigOverrides
527 528 529 |
# File 'generated/google/apis/composer_v1/classes.rb', line 527 def airflow_config_overrides @airflow_config_overrides end |
#env_variables ⇒ Hash<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_*
. 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
Corresponds to the JSON propertyenvVariables
551 552 553 |
# File 'generated/google/apis/composer_v1/classes.rb', line 551 def env_variables @env_variables end |
#image_version ⇒ 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 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.
See also Version
List.
Corresponds to the JSON property imageVersion
572 573 574 |
# File 'generated/google/apis/composer_v1/classes.rb', line 572 def image_version @image_version end |
#pypi_packages ⇒ Hash<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.
Corresponds to the JSON property pypiPackages
583 584 585 |
# File 'generated/google/apis/composer_v1/classes.rb', line 583 def pypi_packages @pypi_packages end |
#python_version ⇒ String
Optional. The major version of Python used to run the Apache Airflow
scheduler, worker, and webserver processes.
Can be set to '2' or '3'. If not specified, the default is '2'. Cannot be
updated.
Corresponds to the JSON property pythonVersion
591 592 593 |
# File 'generated/google/apis/composer_v1/classes.rb', line 591 def python_version @python_version end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
598 599 600 601 602 603 604 |
# File 'generated/google/apis/composer_v1/classes.rb', line 598 def update!(**args) @airflow_config_overrides = args[:airflow_config_overrides] if args.key?(:airflow_config_overrides) @env_variables = args[:env_variables] if args.key?(:env_variables) @image_version = args[:image_version] if args.key?(:image_version) @pypi_packages = args[:pypi_packages] if args.key?(:pypi_packages) @python_version = args[:python_version] if args.key?(:python_version) end |