Reference documentation and code samples for the Google Cloud Orchestration Airflow V1 Client class EnvironmentConfig.
Configuration information for an environment.
Generated from protobuf message google.cloud.orchestration.airflow.service.v1.EnvironmentConfig
Namespace
Google \ Cloud \ Orchestration \ Airflow \ Service \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ gke_cluster
string
Output only. The Kubernetes Engine cluster used to run this environment.
↳ dag_gcs_prefix
string
Output only. The Cloud Storage prefix of the DAGs for this environment. Although Cloud Storage objects reside in a flat namespace, a hierarchical file tree can be simulated using "/"-delimited object name prefixes. DAG objects for this environment reside in a simulated directory with the given prefix.
↳ node_count
int
The number of nodes in the Kubernetes Engine cluster that will be used to run this environment. This field is supported for Cloud Composer environments in versions composer-1. . -airflow- . .*.
↳ software_config
↳ node_config
↳ private_environment_config
PrivateEnvironmentConfig
Optional. The configuration used for the Private IP Cloud Composer environment.
↳ web_server_network_access_control
WebServerNetworkAccessControl
Optional. The network-level access control policy for the Airflow web server. If unspecified, no network-level access restrictions will be applied.
↳ database_config
DatabaseConfig
Optional. The configuration settings for Cloud SQL instance used internally by Apache Airflow software.
↳ web_server_config
WebServerConfig
Optional. The configuration settings for the Airflow web server App Engine instance.
↳ encryption_config
EncryptionConfig
Optional. The encryption options for the Cloud Composer environment and its dependencies. Cannot be updated.
↳ maintenance_window
MaintenanceWindow
Optional. The maintenance window is the period when Cloud Composer components may undergo maintenance. It is defined so that maintenance is not executed during peak hours or critical time periods. The system will not be under maintenance for every occurrence of this window, but when maintenance is planned, it will be scheduled during the window. The maintenance window period must encompass at least 12 hours per week. This may be split into multiple chunks, each with a size of at least 4 hours. If this value is omitted, the default value for maintenance window is applied. By default, maintenance windows are from 00:00:00 to 04:00:00 (GMT) on Friday, Saturday, and Sunday every week.
↳ workloads_config
WorkloadsConfig
Optional. The workloads configuration settings for the GKE cluster associated with the Cloud Composer environment. The GKE cluster runs Airflow scheduler, web server and workers workloads. This field is supported for Cloud Composer environments in versions composer-2. . -airflow- . .* and newer.
↳ environment_size
int
Optional. The size of the Cloud Composer environment. This field is supported for Cloud Composer environments in versions composer-2. . -airflow- . .* and newer.
↳ airflow_uri
string
Output only. The URI of the Apache Airflow Web UI hosted within this environment (see Airflow web interface ).
↳ airflow_byoid_uri
string
Output only. The 'bring your own identity' variant of the URI of the Apache Airflow Web UI hosted within this environment, to be accessed with external identities using workforce identity federation (see Access environments with workforce identity federation ).
↳ master_authorized_networks_config
MasterAuthorizedNetworksConfig
Optional. The configuration options for GKE cluster master authorized networks. By default master authorized networks feature is: - in case of private environment: enabled with no external networks allowlisted. - in case of public environment: disabled.
↳ recovery_config
RecoveryConfig
Optional. The Recovery settings configuration of an environment. This field is supported for Cloud Composer environments in versions composer-2. . -airflow- . .* and newer.
↳ resilience_mode
int
Optional. Resilience mode of the Cloud Composer Environment. This field is supported for Cloud Composer environments in versions composer-2.2.0-airflow- . .* and newer.
↳ data_retention_config
DataRetentionConfig
Optional. The configuration setting for Airflow database data retention mechanism.
getGkeCluster
Output only. The Kubernetes Engine cluster used to run this environment.
string
setGkeCluster
Output only. The Kubernetes Engine cluster used to run this environment.
var
string
$this
getDagGcsPrefix
Output only. The Cloud Storage prefix of the DAGs for this environment.
Although Cloud Storage objects reside in a flat namespace, a hierarchical file tree can be simulated using "/"-delimited object name prefixes. DAG objects for this environment reside in a simulated directory with the given prefix.
string
setDagGcsPrefix
Output only. The Cloud Storage prefix of the DAGs for this environment.
Although Cloud Storage objects reside in a flat namespace, a hierarchical file tree can be simulated using "/"-delimited object name prefixes. DAG objects for this environment reside in a simulated directory with the given prefix.
var
string
$this
getNodeCount
The number of nodes in the Kubernetes Engine cluster that will be used to run this environment.
This field is supported for Cloud Composer environments in versions composer-1. . -airflow- . .*.
int
setNodeCount
The number of nodes in the Kubernetes Engine cluster that will be used to run this environment.
This field is supported for Cloud Composer environments in versions composer-1. . -airflow- . .*.
var
int
$this
getSoftwareConfig
Optional. The configuration settings for software inside the environment.
hasSoftwareConfig
clearSoftwareConfig
setSoftwareConfig
Optional. The configuration settings for software inside the environment.
$this
getNodeConfig
Optional. The configuration used for the Kubernetes Engine cluster.
hasNodeConfig
clearNodeConfig
setNodeConfig
Optional. The configuration used for the Kubernetes Engine cluster.
$this
getPrivateEnvironmentConfig
Optional. The configuration used for the Private IP Cloud Composer environment.
hasPrivateEnvironmentConfig
clearPrivateEnvironmentConfig
setPrivateEnvironmentConfig
Optional. The configuration used for the Private IP Cloud Composer environment.
$this
getWebServerNetworkAccessControl
Optional. The network-level access control policy for the Airflow web server. If unspecified, no network-level access restrictions will be applied.
hasWebServerNetworkAccessControl
clearWebServerNetworkAccessControl
setWebServerNetworkAccessControl
Optional. The network-level access control policy for the Airflow web server. If unspecified, no network-level access restrictions will be applied.
$this
getDatabaseConfig
Optional. The configuration settings for Cloud SQL instance used internally by Apache Airflow software.
hasDatabaseConfig
clearDatabaseConfig
setDatabaseConfig
Optional. The configuration settings for Cloud SQL instance used internally by Apache Airflow software.
$this
getWebServerConfig
Optional. The configuration settings for the Airflow web server App Engine instance.
hasWebServerConfig
clearWebServerConfig
setWebServerConfig
Optional. The configuration settings for the Airflow web server App Engine instance.
$this
getEncryptionConfig
Optional. The encryption options for the Cloud Composer environment and its dependencies. Cannot be updated.
hasEncryptionConfig
clearEncryptionConfig
setEncryptionConfig
Optional. The encryption options for the Cloud Composer environment and its dependencies. Cannot be updated.
$this
getMaintenanceWindow
Optional. The maintenance window is the period when Cloud Composer components may undergo maintenance. It is defined so that maintenance is not executed during peak hours or critical time periods.
The system will not be under maintenance for every occurrence of this window, but when maintenance is planned, it will be scheduled during the window. The maintenance window period must encompass at least 12 hours per week. This may be split into multiple chunks, each with a size of at least 4 hours. If this value is omitted, the default value for maintenance window is applied. By default, maintenance windows are from 00:00:00 to 04:00:00 (GMT) on Friday, Saturday, and Sunday every week.
hasMaintenanceWindow
clearMaintenanceWindow
setMaintenanceWindow
Optional. The maintenance window is the period when Cloud Composer components may undergo maintenance. It is defined so that maintenance is not executed during peak hours or critical time periods.
The system will not be under maintenance for every occurrence of this window, but when maintenance is planned, it will be scheduled during the window. The maintenance window period must encompass at least 12 hours per week. This may be split into multiple chunks, each with a size of at least 4 hours. If this value is omitted, the default value for maintenance window is applied. By default, maintenance windows are from 00:00:00 to 04:00:00 (GMT) on Friday, Saturday, and Sunday every week.
$this
getWorkloadsConfig
Optional. The workloads configuration settings for the GKE cluster associated with the Cloud Composer environment. The GKE cluster runs Airflow scheduler, web server and workers workloads.
This field is supported for Cloud Composer environments in versions composer-2. . -airflow- . .* and newer.
hasWorkloadsConfig
clearWorkloadsConfig
setWorkloadsConfig
Optional. The workloads configuration settings for the GKE cluster associated with the Cloud Composer environment. The GKE cluster runs Airflow scheduler, web server and workers workloads.
This field is supported for Cloud Composer environments in versions composer-2. . -airflow- . .* and newer.
$this
getEnvironmentSize
Optional. The size of the Cloud Composer environment.
This field is supported for Cloud Composer environments in versions composer-2. . -airflow- . .* and newer.
int
setEnvironmentSize
Optional. The size of the Cloud Composer environment.
This field is supported for Cloud Composer environments in versions composer-2. . -airflow- . .* and newer.
var
int
$this
getAirflowUri
Output only. The URI of the Apache Airflow Web UI hosted within this environment (see Airflow web interface ).
string
setAirflowUri
Output only. The URI of the Apache Airflow Web UI hosted within this environment (see Airflow web interface ).
var
string
$this
getAirflowByoidUri
Output only. The 'bring your own identity' variant of the URI of the Apache Airflow Web UI hosted within this environment, to be accessed with external identities using workforce identity federation (see Access environments with workforce identity federation ).
string
setAirflowByoidUri
Output only. The 'bring your own identity' variant of the URI of the Apache Airflow Web UI hosted within this environment, to be accessed with external identities using workforce identity federation (see Access environments with workforce identity federation ).
var
string
$this
getMasterAuthorizedNetworksConfig
Optional. The configuration options for GKE cluster master authorized networks. By default master authorized networks feature is:
-
in case of private environment: enabled with no external networks allowlisted.
-
in case of public environment: disabled.
hasMasterAuthorizedNetworksConfig
clearMasterAuthorizedNetworksConfig
setMasterAuthorizedNetworksConfig
Optional. The configuration options for GKE cluster master authorized networks. By default master authorized networks feature is:
-
in case of private environment: enabled with no external networks allowlisted.
-
in case of public environment: disabled.
$this
getRecoveryConfig
Optional. The Recovery settings configuration of an environment.
This field is supported for Cloud Composer environments in versions composer-2. . -airflow- . .* and newer.
hasRecoveryConfig
clearRecoveryConfig
setRecoveryConfig
Optional. The Recovery settings configuration of an environment.
This field is supported for Cloud Composer environments in versions composer-2. . -airflow- . .* and newer.
$this
getResilienceMode
Optional. Resilience mode of the Cloud Composer Environment.
This field is supported for Cloud Composer environments in versions composer-2.2.0-airflow- . .* and newer.
int
setResilienceMode
Optional. Resilience mode of the Cloud Composer Environment.
This field is supported for Cloud Composer environments in versions composer-2.2.0-airflow- . .* and newer.
var
int
$this
getDataRetentionConfig
Optional. The configuration setting for Airflow database data retention mechanism.
hasDataRetentionConfig
clearDataRetentionConfig
setDataRetentionConfig
Optional. The configuration setting for Airflow database data retention mechanism.
$this
