Package com.google.cloud.orchestration.airflow.service.v1

Interface SoftwareConfigOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    SoftwareConfig, SoftwareConfig.Builder
    public interface SoftwareConfigOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getImageVersion

        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](https://semver.org), 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](/composer/docs/concepts/versioning/composer-versions) and [versioning
 overview](/composer/docs/concepts/versioning/composer-versioning-overview).
        string image_version = 1;
        Returns:
        The imageVersion.

      • getImageVersionBytes

        com.google.protobuf.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](https://semver.org), 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](/composer/docs/concepts/versioning/composer-versions) and [versioning
 overview](/composer/docs/concepts/versioning/composer-versioning-overview).
        string image_version = 1;
        Returns:
        The bytes for imageVersion.

      • getAirflowConfigOverridesCount

        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](https://en.wikipedia.org/wiki/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](/composer/docs/concepts/airflow-configurations),
 and cannot be overridden.
        map<string, string> airflow_config_overrides = 2;

      • containsAirflowConfigOverrides

        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](https://en.wikipedia.org/wiki/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](/composer/docs/concepts/airflow-configurations),
 and cannot be overridden.
        map<string, string> airflow_config_overrides = 2;

      • getAirflowConfigOverridesMap

        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](https://en.wikipedia.org/wiki/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](/composer/docs/concepts/airflow-configurations),
 and cannot be overridden.
        map<string, string> airflow_config_overrides = 2;

      • getAirflowConfigOverridesOrDefault

        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](https://en.wikipedia.org/wiki/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](/composer/docs/concepts/airflow-configurations),
 and cannot be overridden.
        map<string, string> airflow_config_overrides = 2;

      • getAirflowConfigOverridesOrThrow

        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](https://en.wikipedia.org/wiki/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](/composer/docs/concepts/airflow-configurations),
 and cannot be overridden.
        map<string, string> airflow_config_overrides = 2;

      • getPypiPackagesCount

        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;

      • containsPypiPackages

        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;

      • getPypiPackagesMap

        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;

      • getPypiPackagesOrDefault

        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;

      • getPypiPackagesOrThrow

        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;

      • getEnvVariablesCount

        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_][a-zA-Z0-9_]*`. 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;

      • containsEnvVariables

        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_][a-zA-Z0-9_]*`. 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;

      • getEnvVariablesMap

        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_][a-zA-Z0-9_]*`. 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;

      • getEnvVariablesOrDefault

        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_][a-zA-Z0-9_]*`. 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;

      • getEnvVariablesOrThrow

        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_][a-zA-Z0-9_]*`. 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;

      • getPythonVersion

        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:
        The pythonVersion.

      • getPythonVersionBytes

        com.google.protobuf.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:
        The bytes for pythonVersion.

      • getSchedulerCount

        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:
        The schedulerCount.