Class: Google::Apis::ComposerV1beta1::SoftwareConfig

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
generated/google/apis/composer_v1beta1/classes.rb,
generated/google/apis/composer_v1beta1/representations.rb,
generated/google/apis/composer_v1beta1/representations.rb

Overview

Specifies the selection and config of software inside the environment.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Google::Apis::Core::JsonObjectSupport

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ SoftwareConfig

Returns a new instance of SoftwareConfig



557
558
559
 
# File 'generated/google/apis/composer_v1beta1/classes.rb', line 557

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 name, separated by a hyphen, for example core-dags_are_paused_at_creation. Sections must not contain hyphens ("-"), opening square brackets ("["), or closing square brackets ("]"). The name must be non-empty and must not contain an equals sign ("=") or semicolon (";"). The section as well as the name must not contain a period ("."). Apache Airflow configuration property names must be written in snake_case. Property values can contain any character and 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

Returns:

  • (Hash<String,String>) 


506
507
508
 
# File 'generated/google/apis/composer_v1beta1/classes.rb', line 506

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_*. Furthermore, they cannot specify Apache Airflow software configuration overrides (i.e., match the regular expression AIRFLOW__[A-Z0-9_]+__[A-Z0-9_]+); nor can they take any of the following reserved values:

  • 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 property envVariables

Returns:

  • (Hash<String,String>) 


530
531
532
 
# File 'generated/google/apis/composer_v1beta1/classes.rb', line 530

def env_variables
  @env_variables
end

#image_version ⇒ String

Output only. 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]+)?-airflow-[0-9]+\.[0-9]+(\.[0-9]+.*)?. The Cloud Composer portion of the version is a semantic version. The portion of the image version following airflow- is an official Apache Airflow repository release name. See also Release Notes. Corresponds to the JSON property imageVersion

Returns:

  • (String) 


544
545
546
 
# File 'generated/google/apis/composer_v1beta1/classes.rb', line 544

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

Returns:

  • (Hash<String,String>) 


555
556
557
 
# File 'generated/google/apis/composer_v1beta1/classes.rb', line 555

def pypi_packages
  @pypi_packages
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



562
563
564
565
566
567
 
# File 'generated/google/apis/composer_v1beta1/classes.rb', line 562

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)
end