Class SoftwareConfig

Specifies the selection and configuration of software inside the environment.

Inheritance

object

SoftwareConfig

Implements

IDirectResponseSchema

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.CloudComposer.v1.Data

Assembly: Google.Apis.CloudComposer.v1.dll

Syntax

public class SoftwareConfig : IDirectResponseSchema

Properties

AirflowConfigOverrides

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 blocked, and cannot be overridden.

Declaration

[JsonProperty("airflowConfigOverrides")]
public virtual IDictionary<string, string> AirflowConfigOverrides { get; set; }

Property Value

Type	Description
IDictionary<string, string>

CloudDataLineageIntegration

Optional. The configuration for Cloud Data Lineage integration.

Declaration

[JsonProperty("cloudDataLineageIntegration")]
public virtual CloudDataLineageIntegration CloudDataLineageIntegration { get; set; }

Property Value

Type	Description
CloudDataLineageIntegration

ETag

The ETag of the item.

Declaration

public virtual string ETag { get; set; }

Property Value

Type	Description
string

EnvVariables

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

Declaration

[JsonProperty("envVariables")]
public virtual IDictionary<string, string> EnvVariables { get; set; }

Property Value

Type	Description
IDictionary<string, string>

ImageVersion

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, 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 and versioning overview.

Declaration

[JsonProperty("imageVersion")]
public virtual string ImageVersion { get; set; }

Property Value

Type	Description
string

PypiPackages

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.

Declaration

[JsonProperty("pypiPackages")]
public virtual IDictionary<string, string> PypiPackages { get; set; }

Property Value

Type	Description
IDictionary<string, string>

PythonVersion

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.

Declaration

[JsonProperty("pythonVersion")]
public virtual string PythonVersion { get; set; }

Property Value

Type	Description
string

SchedulerCount

Optional. The number of schedulers for Airflow. This field is supported for Cloud Composer environments in versions composer-1..-airflow-2...

Declaration

[JsonProperty("schedulerCount")]
public virtual int? SchedulerCount { get; set; }

Property Value

Type	Description
int?

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.

Declaration

[JsonProperty("webServerPluginsMode")]
public virtual string WebServerPluginsMode { get; set; }

Property Value

Type	Description
string

Implements

IDirectResponseSchema