- 1.52.0 (latest)
- 1.51.0
- 1.49.0
- 1.48.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.40.0
- 1.39.0
- 1.37.0
- 1.36.0
- 1.35.0
- 1.34.0
- 1.33.0
- 1.32.0
- 1.31.0
- 1.30.0
- 1.29.0
- 1.28.0
- 1.27.0
- 1.24.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.0
- 1.12.0
- 1.11.0
- 1.9.0
- 1.8.0
- 1.7.0
- 1.6.0
- 1.5.0
- 1.4.0
public interface SoftwareConfigOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
containsAirflowConfigOverrides(String key)
public abstract 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 abstract 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_HOMEC_FORCE_ROOTCONTAINER_NAMEDAGS_FOLDERGCP_PROJECTGCS_BUCKETGKE_CLUSTER_NAMESQL_DATABASESQL_INSTANCESQL_PASSWORDSQL_PROJECTSQL_REGIONSQL_USER
map<string, string> env_variables = 4;
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
containsPypiPackages(String key)
public abstract 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 abstract Map<String,String> getAirflowConfigOverrides()Use #getAirflowConfigOverridesMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getAirflowConfigOverridesCount()
public abstract 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 abstract 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 abstract 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 abstract 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 |
|
getCloudDataLineageIntegration()
public abstract CloudDataLineageIntegration getCloudDataLineageIntegration()Optional. The configuration for Cloud Data Lineage integration.
.google.cloud.orchestration.airflow.service.v1.CloudDataLineageIntegration cloud_data_lineage_integration = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
CloudDataLineageIntegration |
The cloudDataLineageIntegration. |
getCloudDataLineageIntegrationOrBuilder()
public abstract CloudDataLineageIntegrationOrBuilder getCloudDataLineageIntegrationOrBuilder()Optional. The configuration for Cloud Data Lineage integration.
.google.cloud.orchestration.airflow.service.v1.CloudDataLineageIntegration cloud_data_lineage_integration = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
CloudDataLineageIntegrationOrBuilder |
|
getEnvVariables() (deprecated)
public abstract Map<String,String> getEnvVariables()Use #getEnvVariablesMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getEnvVariablesCount()
public abstract 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_HOMEC_FORCE_ROOTCONTAINER_NAMEDAGS_FOLDERGCP_PROJECTGCS_BUCKETGKE_CLUSTER_NAMESQL_DATABASESQL_INSTANCESQL_PASSWORDSQL_PROJECTSQL_REGIONSQL_USER
map<string, string> env_variables = 4;
| Returns | |
|---|---|
| Type | Description |
int |
|
getEnvVariablesMap()
public abstract 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_HOMEC_FORCE_ROOTCONTAINER_NAMEDAGS_FOLDERGCP_PROJECTGCS_BUCKETGKE_CLUSTER_NAMESQL_DATABASESQL_INSTANCESQL_PASSWORDSQL_PROJECTSQL_REGIONSQL_USER
map<string, string> env_variables = 4;
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getEnvVariablesOrDefault(String key, String defaultValue)
public abstract 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_HOMEC_FORCE_ROOTCONTAINER_NAMEDAGS_FOLDERGCP_PROJECTGCS_BUCKETGKE_CLUSTER_NAMESQL_DATABASESQL_INSTANCESQL_PASSWORDSQL_PROJECTSQL_REGIONSQL_USER
map<string, string> env_variables = 4;
| Parameters | |
|---|---|
| Name | Description |
key |
String |
defaultValue |
String |
| Returns | |
|---|---|
| Type | Description |
String |
|
getEnvVariablesOrThrow(String key)
public abstract 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_HOMEC_FORCE_ROOTCONTAINER_NAMEDAGS_FOLDERGCP_PROJECTGCS_BUCKETGKE_CLUSTER_NAMESQL_DATABASESQL_INSTANCESQL_PASSWORDSQL_PROJECTSQL_REGIONSQL_USER
map<string, string> env_variables = 4;
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
String |
|
getImageVersion()
public abstract 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 abstract 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. |
getPypiPackages() (deprecated)
public abstract Map<String,String> getPypiPackages()Use #getPypiPackagesMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getPypiPackagesCount()
public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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. |
getWebServerPluginsMode()
public abstract SoftwareConfig.WebServerPluginsMode getWebServerPluginsMode() 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-..* and newer.
.google.cloud.orchestration.airflow.service.v1.SoftwareConfig.WebServerPluginsMode web_server_plugins_mode = 10 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
SoftwareConfig.WebServerPluginsMode |
The webServerPluginsMode. |
getWebServerPluginsModeValue()
public abstract int getWebServerPluginsModeValue() 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-..* and newer.
.google.cloud.orchestration.airflow.service.v1.SoftwareConfig.WebServerPluginsMode web_server_plugins_mode = 10 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for webServerPluginsMode. |
hasCloudDataLineageIntegration()
public abstract boolean hasCloudDataLineageIntegration()Optional. The configuration for Cloud Data Lineage integration.
.google.cloud.orchestration.airflow.service.v1.CloudDataLineageIntegration cloud_data_lineage_integration = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the cloudDataLineageIntegration field is set. |