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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
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 | |
WEB_SERVER_PLUGINS_MODE_FIELD_NUMBER
public static final int WEB_SERVER_PLUGINS_MODE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static SoftwareConfig getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static SoftwareConfig.Builder newBuilder()
newBuilder(SoftwareConfig prototype)
public static SoftwareConfig.Builder newBuilder(SoftwareConfig prototype)
public static SoftwareConfig parseDelimitedFrom(InputStream input)
public static SoftwareConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static SoftwareConfig parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static SoftwareConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static SoftwareConfig parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SoftwareConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SoftwareConfig parseFrom(CodedInputStream input)
public static SoftwareConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static SoftwareConfig parseFrom(InputStream input)
public static SoftwareConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static SoftwareConfig parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static SoftwareConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<SoftwareConfig> parser()
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
|
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_HOMEC_FORCE_ROOTCONTAINER_NAMEDAGS_FOLDERGCP_PROJECTGCS_BUCKETGKE_CLUSTER_NAMESQL_DATABASESQL_INSTANCESQL_PASSWORDSQL_PROJECTSQL_REGIONSQL_USER
map<string, string> env_variables = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
|---|
| Name | Description |
key | String
|
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
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
getAirflowConfigOverrides() (deprecated)
public Map<String,String> getAirflowConfigOverrides()
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];
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];
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
|
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];
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];
getDefaultInstanceForType()
public SoftwareConfig getDefaultInstanceForType()
getEnvVariables() (deprecated)
public Map<String,String> getEnvVariables()
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_HOMEC_FORCE_ROOTCONTAINER_NAMEDAGS_FOLDERGCP_PROJECTGCS_BUCKETGKE_CLUSTER_NAMESQL_DATABASESQL_INSTANCESQL_PASSWORDSQL_PROJECTSQL_REGIONSQL_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_HOMEC_FORCE_ROOTCONTAINER_NAMEDAGS_FOLDERGCP_PROJECTGCS_BUCKETGKE_CLUSTER_NAMESQL_DATABASESQL_INSTANCESQL_PASSWORDSQL_PROJECTSQL_REGIONSQL_USER
map<string, string> env_variables = 4 [(.google.api.field_behavior) = OPTIONAL];
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_HOMEC_FORCE_ROOTCONTAINER_NAMEDAGS_FOLDERGCP_PROJECTGCS_BUCKETGKE_CLUSTER_NAMESQL_DATABASESQL_INSTANCESQL_PASSWORDSQL_PROJECTSQL_REGIONSQL_USER
map<string, string> env_variables = 4 [(.google.api.field_behavior) = OPTIONAL];
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_HOMEC_FORCE_ROOTCONTAINER_NAMEDAGS_FOLDERGCP_PROJECTGCS_BUCKETGKE_CLUSTER_NAMESQL_DATABASESQL_INSTANCESQL_PASSWORDSQL_PROJECTSQL_REGIONSQL_USER
map<string, string> env_variables = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
|---|
| Name | Description |
key | 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()
Overrides
getPypiPackages() (deprecated)
public Map<String,String> getPypiPackages()
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];
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];
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
|
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
getWebServerPluginsMode()
public 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.v1beta1.SoftwareConfig.WebServerPluginsMode web_server_plugins_mode = 10 [(.google.api.field_behavior) = OPTIONAL];
getWebServerPluginsModeValue()
public 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.v1beta1.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 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()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
| Parameter |
|---|
| Name | Description |
number | int
|
| Returns |
|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor | |
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public SoftwareConfig.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected SoftwareConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public SoftwareConfig.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
