Class SoftwareConfig (1.20.0)

public final class SoftwareConfig extends GeneratedMessageV3 implements SoftwareConfigOrBuilder

Specifies the selection and configuration of software inside the environment.

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

Static Fields

AIRFLOW_CONFIG_OVERRIDES_FIELD_NUMBER

public static final int AIRFLOW_CONFIG_OVERRIDES_FIELD_NUMBER
Field Value
Type Description
int

CLOUD_DATA_LINEAGE_INTEGRATION_FIELD_NUMBER

public static final int CLOUD_DATA_LINEAGE_INTEGRATION_FIELD_NUMBER
Field Value
Type Description
int

ENV_VARIABLES_FIELD_NUMBER

public static final int ENV_VARIABLES_FIELD_NUMBER
Field Value
Type Description
int

IMAGE_VERSION_FIELD_NUMBER

public static final int IMAGE_VERSION_FIELD_NUMBER
Field Value
Type Description
int

PYPI_PACKAGES_FIELD_NUMBER

public static final int PYPI_PACKAGES_FIELD_NUMBER
Field Value
Type Description
int

PYTHON_VERSION_FIELD_NUMBER

public static final int PYTHON_VERSION_FIELD_NUMBER
Field Value
Type Description
int

SCHEDULER_COUNT_FIELD_NUMBER

public static final int SCHEDULER_COUNT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SoftwareConfig getDefaultInstance()
Returns
Type Description
SoftwareConfig

getDescriptor()

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

newBuilder()

public static SoftwareConfig.Builder newBuilder()
Returns
Type Description
SoftwareConfig.Builder

newBuilder(SoftwareConfig prototype)

public static SoftwareConfig.Builder newBuilder(SoftwareConfig prototype)
Parameter
Name Description
prototype SoftwareConfig
Returns
Type Description
SoftwareConfig.Builder

parseDelimitedFrom(InputStream input)

public static SoftwareConfig parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SoftwareConfig
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SoftwareConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SoftwareConfig
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static SoftwareConfig parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
SoftwareConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SoftwareConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SoftwareConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SoftwareConfig parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
SoftwareConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SoftwareConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SoftwareConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SoftwareConfig parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
SoftwareConfig
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SoftwareConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SoftwareConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static SoftwareConfig parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SoftwareConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SoftwareConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SoftwareConfig
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static SoftwareConfig parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
SoftwareConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SoftwareConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SoftwareConfig
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<SoftwareConfig> parser()
Returns
Type Description
Parser<SoftwareConfig>

Methods

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 [(.google.api.field_behavior) = OPTIONAL];

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 [(.google.api.field_behavior) = OPTIONAL];

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 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAirflowConfigOverrides()

public Map<String,String> getAirflowConfigOverrides()
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 [(.google.api.field_behavior) = OPTIONAL];

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 [(.google.api.field_behavior) = OPTIONAL];

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 [(.google.api.field_behavior) = OPTIONAL];

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 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
String

getCloudDataLineageIntegration()

public CloudDataLineageIntegration getCloudDataLineageIntegration()

Optional. The configuration for Cloud Data Lineage integration.

.google.cloud.orchestration.airflow.service.v1beta1.CloudDataLineageIntegration cloud_data_lineage_integration = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
CloudDataLineageIntegration

The cloudDataLineageIntegration.

getCloudDataLineageIntegrationOrBuilder()

public CloudDataLineageIntegrationOrBuilder getCloudDataLineageIntegrationOrBuilder()

Optional. The configuration for Cloud Data Lineage integration.

.google.cloud.orchestration.airflow.service.v1beta1.CloudDataLineageIntegration cloud_data_lineage_integration = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
CloudDataLineageIntegrationOrBuilder

getDefaultInstanceForType()

public SoftwareConfig getDefaultInstanceForType()
Returns
Type Description
SoftwareConfig

getEnvVariables()

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 [(.google.api.field_behavior) = OPTIONAL];

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 [(.google.api.field_behavior) = OPTIONAL];

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 [(.google.api.field_behavior) = OPTIONAL];

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 [(.google.api.field_behavior) = OPTIONAL];

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.

getParserForType()

public Parser<SoftwareConfig> getParserForType()
Returns
Type Description
Parser<SoftwareConfig>
Overrides

getPypiPackages()

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 [(.google.api.field_behavior) = OPTIONAL];

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 [(.google.api.field_behavior) = OPTIONAL];

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 [(.google.api.field_behavior) = OPTIONAL];

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 [(.google.api.field_behavior) = OPTIONAL];

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 [(.google.api.field_behavior) = OPTIONAL];

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 [(.google.api.field_behavior) = OPTIONAL];

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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasCloudDataLineageIntegration()

public boolean hasCloudDataLineageIntegration()

Optional. The configuration for Cloud Data Lineage integration.

.google.cloud.orchestration.airflow.service.v1beta1.CloudDataLineageIntegration cloud_data_lineage_integration = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the cloudDataLineageIntegration field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SoftwareConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
SoftwareConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException