- 1.55.0 (latest)
- 1.54.0
- 1.53.0
- 1.52.0
- 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 static final class SoftwareConfig.Builder extends GeneratedMessageV3.Builder<SoftwareConfig.Builder> implements SoftwareConfigOrBuilderSpecifies the selection and configuration of software inside the environment.
Protobuf type google.cloud.orchestration.airflow.service.v1beta1.SoftwareConfig
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > SoftwareConfig.BuilderImplements
SoftwareConfigOrBuilderStatic 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 |
|
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 |
|
clearAirflowConfigOverrides()
public SoftwareConfig.Builder clearAirflowConfigOverrides()| Returns | |
|---|---|
| Type | Description |
SoftwareConfig.Builder |
|
clearCloudDataLineageIntegration()
public SoftwareConfig.Builder clearCloudDataLineageIntegration()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 |
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 |
|
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 |
|
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 [(.google.api.field_behavior) = OPTIONAL];
| 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 |
|
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_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 |
| 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 |
|
getAirflowConfigOverrides()
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 [(.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. |
getCloudDataLineageIntegrationBuilder()
public CloudDataLineageIntegration.Builder getCloudDataLineageIntegrationBuilder()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.Builder |
|
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 |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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_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];
| 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_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];
| 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_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 |
| 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()
public Map<String,String> getMutableAirflowConfigOverrides()Use alternate mutation accessors instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getMutableEnvVariables()
public Map<String,String> getMutableEnvVariables()Use alternate mutation accessors instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getMutablePypiPackages()
public Map<String,String> getMutablePypiPackages()Use alternate mutation accessors instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
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. |
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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
internalGetMapField(int number)
protected MapField internalGetMapField(int number)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
MapField |
|
internalGetMutableMapField(int number)
protected MapField internalGetMutableMapField(int number)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
MapField |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeCloudDataLineageIntegration(CloudDataLineageIntegration value)
public SoftwareConfig.Builder mergeCloudDataLineageIntegration(CloudDataLineageIntegration value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
CloudDataLineageIntegration |
| Returns | |
|---|---|
| Type | Description |
SoftwareConfig.Builder |
|
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 |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public SoftwareConfig.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
SoftwareConfig.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final SoftwareConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
SoftwareConfig.Builder |
|
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 [(.google.api.field_behavior) = OPTIONAL];
| 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 [(.google.api.field_behavior) = OPTIONAL];
| 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_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 |
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 [(.google.api.field_behavior) = OPTIONAL];
| 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_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];
| 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 [(.google.api.field_behavior) = OPTIONAL];
| 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 [(.google.api.field_behavior) = OPTIONAL];
| 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_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 |
| 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 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
SoftwareConfig.Builder |
|
setCloudDataLineageIntegration(CloudDataLineageIntegration value)
public SoftwareConfig.Builder setCloudDataLineageIntegration(CloudDataLineageIntegration value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
CloudDataLineageIntegration |
| Returns | |
|---|---|
| Type | Description |
SoftwareConfig.Builder |
|
setCloudDataLineageIntegration(CloudDataLineageIntegration.Builder builderForValue)
public SoftwareConfig.Builder setCloudDataLineageIntegration(CloudDataLineageIntegration.Builder builderForValue)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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
CloudDataLineageIntegration.Builder |
| 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 |
|
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 |
StringThe 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 |
ByteStringThe 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 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe 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 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe 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 |
|
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 |
intThe 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 |
|