Class SoftwareConfig.Builder (1.31.0) 

public static final class SoftwareConfig.Builder extends GeneratedMessageV3.Builder<SoftwareConfig.Builder> implements SoftwareConfigOrBuilder

Specifies the selection and configuration of software inside the environment.

Protobuf type google.cloud.orchestration.airflow.service.v1.SoftwareConfig

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > SoftwareConfig.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public SoftwareConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
SoftwareConfig.Builder
Overrides

build()

public SoftwareConfig build()
Returns
Type Description
SoftwareConfig

buildPartial()

public SoftwareConfig buildPartial()
Returns
Type Description
SoftwareConfig

clear()

public SoftwareConfig.Builder clear()
Returns
Type Description
SoftwareConfig.Builder
Overrides

clearAirflowConfigOverrides()

public SoftwareConfig.Builder clearAirflowConfigOverrides()
Returns
Type Description
SoftwareConfig.Builder

clearEnvVariables()

public SoftwareConfig.Builder clearEnvVariables()
Returns
Type Description
SoftwareConfig.Builder

clearField(Descriptors.FieldDescriptor field)

public SoftwareConfig.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
SoftwareConfig.Builder
Overrides

clearImageVersion()

public SoftwareConfig.Builder clearImageVersion()

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.

string image_version = 1;

Returns
Type Description
SoftwareConfig.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public SoftwareConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
SoftwareConfig.Builder
Overrides

clearPypiPackages()

public SoftwareConfig.Builder clearPypiPackages()
Returns
Type Description
SoftwareConfig.Builder

clearPythonVersion()

public SoftwareConfig.Builder clearPythonVersion()

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.

string python_version = 6;

Returns
Type Description
SoftwareConfig.Builder

This builder for chaining.

clearSchedulerCount()

public SoftwareConfig.Builder clearSchedulerCount()

Optional. The number of schedulers for Airflow.

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

int32 scheduler_count = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SoftwareConfig.Builder

This builder for chaining.

clone()

public SoftwareConfig.Builder clone()
Returns
Type Description
SoftwareConfig.Builder
Overrides

containsAirflowConfigOverrides(String key)

public boolean containsAirflowConfigOverrides(String key)

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.

map<string, string> airflow_config_overrides = 2;

Parameter
Name Description
key String
Returns
Type Description
boolean

containsEnvVariables(String key)

public boolean containsEnvVariables(String key)

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

map<string, string> env_variables = 4;

Parameter
Name Description
key String
Returns
Type Description
boolean

containsPypiPackages(String key)

public boolean containsPypiPackages(String key)

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.

map<string, string> pypi_packages = 3;

Parameter
Name Description
key String
Returns
Type Description
boolean

getAirflowConfigOverrides() (deprecated)

public Map<String,String> getAirflowConfigOverrides()

Use #getAirflowConfigOverridesMap() instead.

Returns
Type Description
Map<String,String>

getAirflowConfigOverridesCount()

public int getAirflowConfigOverridesCount()

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.

map<string, string> airflow_config_overrides = 2;

Returns
Type Description
int

getAirflowConfigOverridesMap()

public Map<String,String> getAirflowConfigOverridesMap()

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.

map<string, string> airflow_config_overrides = 2;

Returns
Type Description
Map<String,String>

getAirflowConfigOverridesOrDefault(String key, String defaultValue)

public String getAirflowConfigOverridesOrDefault(String key, String defaultValue)

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.

map<string, string> airflow_config_overrides = 2;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getAirflowConfigOverridesOrThrow(String key)

public String getAirflowConfigOverridesOrThrow(String key)

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.

map<string, string> airflow_config_overrides = 2;

Parameter
Name Description
key String
Returns
Type Description
String

getDefaultInstanceForType()

public SoftwareConfig getDefaultInstanceForType()
Returns
Type Description
SoftwareConfig

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getEnvVariables() (deprecated)

public Map<String,String> getEnvVariables()

Use #getEnvVariablesMap() instead.

Returns
Type Description
Map<String,String>

getEnvVariablesCount()

public int getEnvVariablesCount()

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

map<string, string> env_variables = 4;

Returns
Type Description
int

getEnvVariablesMap()

public Map<String,String> getEnvVariablesMap()

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

map<string, string> env_variables = 4;

Returns
Type Description
Map<String,String>

getEnvVariablesOrDefault(String key, String defaultValue)

public String getEnvVariablesOrDefault(String key, String defaultValue)

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

map<string, string> env_variables = 4;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getEnvVariablesOrThrow(String key)

public String getEnvVariablesOrThrow(String key)

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

map<string, string> env_variables = 4;

Parameter
Name Description
key String
Returns
Type Description
String

getImageVersion()

public String getImageVersion()

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.

string image_version = 1;

Returns
Type Description
String

The imageVersion.

getImageVersionBytes()

public ByteString getImageVersionBytes()

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.

string image_version = 1;

Returns
Type Description
ByteString

The bytes for imageVersion.

getMutableAirflowConfigOverrides() (deprecated)

public Map<String,String> getMutableAirflowConfigOverrides()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getMutableEnvVariables() (deprecated)

public Map<String,String> getMutableEnvVariables()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getMutablePypiPackages() (deprecated)

public Map<String,String> getMutablePypiPackages()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getPypiPackages() (deprecated)

public Map<String,String> getPypiPackages()

Use #getPypiPackagesMap() instead.

Returns
Type Description
Map<String,String>

getPypiPackagesCount()

public int getPypiPackagesCount()

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.

map<string, string> pypi_packages = 3;

Returns
Type Description
int

getPypiPackagesMap()

public Map<String,String> getPypiPackagesMap()

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.

map<string, string> pypi_packages = 3;

Returns
Type Description
Map<String,String>

getPypiPackagesOrDefault(String key, String defaultValue)

public String getPypiPackagesOrDefault(String key, String defaultValue)

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.

map<string, string> pypi_packages = 3;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getPypiPackagesOrThrow(String key)

public String getPypiPackagesOrThrow(String key)

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.

map<string, string> pypi_packages = 3;

Parameter
Name Description
key String
Returns
Type Description
String

getPythonVersion()

public String getPythonVersion()

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.

string python_version = 6;

Returns
Type Description
String

The pythonVersion.

getPythonVersionBytes()

public ByteString getPythonVersionBytes()

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.

string python_version = 6;

Returns
Type Description
ByteString

The bytes for pythonVersion.

getSchedulerCount()

public int getSchedulerCount()

Optional. The number of schedulers for Airflow.

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

int32 scheduler_count = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The schedulerCount.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
Name Description
number int
Returns
Type Description
MapField
Overrides

internalGetMutableMapField(int number)

protected MapField internalGetMutableMapField(int number)
Parameter
Name Description
number int
Returns
Type Description
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(SoftwareConfig other)

public SoftwareConfig.Builder mergeFrom(SoftwareConfig other)
Parameter
Name Description
other SoftwareConfig
Returns
Type Description
SoftwareConfig.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SoftwareConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SoftwareConfig.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public SoftwareConfig.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
SoftwareConfig.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SoftwareConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
SoftwareConfig.Builder
Overrides

putAirflowConfigOverrides(String key, String value)

public SoftwareConfig.Builder putAirflowConfigOverrides(String key, String value)

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.

map<string, string> airflow_config_overrides = 2;

Parameters
Name Description
key String
value String
Returns
Type Description
SoftwareConfig.Builder

putAllAirflowConfigOverrides(Map<String,String> values)

public SoftwareConfig.Builder putAllAirflowConfigOverrides(Map<String,String> values)

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.

map<string, string> airflow_config_overrides = 2;

Parameter
Name Description
values Map<String,String>
Returns
Type Description
SoftwareConfig.Builder

putAllEnvVariables(Map<String,String> values)

public SoftwareConfig.Builder putAllEnvVariables(Map<String,String> values)

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

map<string, string> env_variables = 4;

Parameter
Name Description
values Map<String,String>
Returns
Type Description
SoftwareConfig.Builder

putAllPypiPackages(Map<String,String> values)

public SoftwareConfig.Builder putAllPypiPackages(Map<String,String> values)

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.

map<string, string> pypi_packages = 3;

Parameter
Name Description
values Map<String,String>
Returns
Type Description
SoftwareConfig.Builder

putEnvVariables(String key, String value)

public SoftwareConfig.Builder putEnvVariables(String key, String value)

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

map<string, string> env_variables = 4;

Parameters
Name Description
key String
value String
Returns
Type Description
SoftwareConfig.Builder

putPypiPackages(String key, String value)

public SoftwareConfig.Builder putPypiPackages(String key, String value)

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.

map<string, string> pypi_packages = 3;

Parameters
Name Description
key String
value String
Returns
Type Description
SoftwareConfig.Builder

removeAirflowConfigOverrides(String key)

public SoftwareConfig.Builder removeAirflowConfigOverrides(String key)

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.

map<string, string> airflow_config_overrides = 2;

Parameter
Name Description
key String
Returns
Type Description
SoftwareConfig.Builder

removeEnvVariables(String key)

public SoftwareConfig.Builder removeEnvVariables(String key)

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

map<string, string> env_variables = 4;

Parameter
Name Description
key String
Returns
Type Description
SoftwareConfig.Builder

removePypiPackages(String key)

public SoftwareConfig.Builder removePypiPackages(String key)

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.

map<string, string> pypi_packages = 3;

Parameter
Name Description
key String
Returns
Type Description
SoftwareConfig.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public SoftwareConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
SoftwareConfig.Builder
Overrides

setImageVersion(String value)

public SoftwareConfig.Builder setImageVersion(String value)

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.

string image_version = 1;

Parameter
Name Description
value String

The imageVersion to set.
Returns
Type Description
SoftwareConfig.Builder

This builder for chaining.

setImageVersionBytes(ByteString value)

public SoftwareConfig.Builder setImageVersionBytes(ByteString value)

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.

string image_version = 1;

Parameter
Name Description
value ByteString

The bytes for imageVersion to set.
Returns
Type Description
SoftwareConfig.Builder

This builder for chaining.

setPythonVersion(String value)

public SoftwareConfig.Builder setPythonVersion(String value)

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.

string python_version = 6;

Parameter
Name Description
value String

The pythonVersion to set.
Returns
Type Description
SoftwareConfig.Builder

This builder for chaining.

setPythonVersionBytes(ByteString value)

public SoftwareConfig.Builder setPythonVersionBytes(ByteString value)

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.

string python_version = 6;

Parameter
Name Description
value ByteString

The bytes for pythonVersion to set.
Returns
Type Description
SoftwareConfig.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public SoftwareConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
SoftwareConfig.Builder
Overrides

setSchedulerCount(int value)

public SoftwareConfig.Builder setSchedulerCount(int value)

Optional. The number of schedulers for Airflow.

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

int32 scheduler_count = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value int

The schedulerCount to set.
Returns
Type Description
SoftwareConfig.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final SoftwareConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
SoftwareConfig.Builder
Overrides