Cloud Composer V1 API - Class Google::Cloud::Orchestration::Airflow::Service::V1::EnvironmentConfig (v1.1.0)

Reference documentation and code samples for the Cloud Composer V1 API class Google::Cloud::Orchestration::Airflow::Service::V1::EnvironmentConfig.

Configuration information for an environment.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#airflow_byoid_uri

def airflow_byoid_uri() -> ::String
Returns
  • (::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).

#airflow_uri

def airflow_uri() -> ::String
Returns
  • (::String) — Output only. The URI of the Apache Airflow Web UI hosted within this environment (see Airflow web interface).

#airflow_uri=

def airflow_uri=(value) -> ::String
Parameter
  • value (::String) — Output only. The URI of the Apache Airflow Web UI hosted within this environment (see Airflow web interface).
Returns
  • (::String) — Output only. The URI of the Apache Airflow Web UI hosted within this environment (see Airflow web interface).

#dag_gcs_prefix

def dag_gcs_prefix() -> ::String
Returns
  • (::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.

#dag_gcs_prefix=

def dag_gcs_prefix=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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.

#data_retention_config

def data_retention_config() -> ::Google::Cloud::Orchestration::Airflow::Service::V1::DataRetentionConfig
Returns

#data_retention_config=

def data_retention_config=(value) -> ::Google::Cloud::Orchestration::Airflow::Service::V1::DataRetentionConfig
Parameter
Returns

#database_config

def database_config() -> ::Google::Cloud::Orchestration::Airflow::Service::V1::DatabaseConfig
Returns

#database_config=

def database_config=(value) -> ::Google::Cloud::Orchestration::Airflow::Service::V1::DatabaseConfig
Parameter
Returns

#encryption_config

def encryption_config() -> ::Google::Cloud::Orchestration::Airflow::Service::V1::EncryptionConfig
Returns

#encryption_config=

def encryption_config=(value) -> ::Google::Cloud::Orchestration::Airflow::Service::V1::EncryptionConfig
Parameter
Returns

#environment_size

def environment_size() -> ::Google::Cloud::Orchestration::Airflow::Service::V1::EnvironmentConfig::EnvironmentSize
Returns

#environment_size=

def environment_size=(value) -> ::Google::Cloud::Orchestration::Airflow::Service::V1::EnvironmentConfig::EnvironmentSize
Parameter
Returns

#gke_cluster

def gke_cluster() -> ::String
Returns
  • (::String) — Output only. The Kubernetes Engine cluster used to run this environment.

#gke_cluster=

def gke_cluster=(value) -> ::String
Parameter
  • value (::String) — Output only. The Kubernetes Engine cluster used to run this environment.
Returns
  • (::String) — Output only. The Kubernetes Engine cluster used to run this environment.

#maintenance_window

def maintenance_window() -> ::Google::Cloud::Orchestration::Airflow::Service::V1::MaintenanceWindow
Returns
  • (::Google::Cloud::Orchestration::Airflow::Service::V1::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.

#maintenance_window=

def maintenance_window=(value) -> ::Google::Cloud::Orchestration::Airflow::Service::V1::MaintenanceWindow
Parameter
  • value (::Google::Cloud::Orchestration::Airflow::Service::V1::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.

Returns
  • (::Google::Cloud::Orchestration::Airflow::Service::V1::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.

#master_authorized_networks_config

def master_authorized_networks_config() -> ::Google::Cloud::Orchestration::Airflow::Service::V1::MasterAuthorizedNetworksConfig
Returns

#master_authorized_networks_config=

def master_authorized_networks_config=(value) -> ::Google::Cloud::Orchestration::Airflow::Service::V1::MasterAuthorizedNetworksConfig
Parameter
Returns

#node_config

def node_config() -> ::Google::Cloud::Orchestration::Airflow::Service::V1::NodeConfig
Returns

#node_config=

def node_config=(value) -> ::Google::Cloud::Orchestration::Airflow::Service::V1::NodeConfig
Parameter
Returns

#node_count

def node_count() -> ::Integer
Returns
  • (::Integer) — 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-..*.

#node_count=

def node_count=(value) -> ::Integer
Parameter
  • value (::Integer) — 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-..*.

Returns
  • (::Integer) — 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-..*.

#private_environment_config

def private_environment_config() -> ::Google::Cloud::Orchestration::Airflow::Service::V1::PrivateEnvironmentConfig
Returns

#private_environment_config=

def private_environment_config=(value) -> ::Google::Cloud::Orchestration::Airflow::Service::V1::PrivateEnvironmentConfig
Parameter
Returns

#recovery_config

def recovery_config() -> ::Google::Cloud::Orchestration::Airflow::Service::V1::RecoveryConfig
Returns

#recovery_config=

def recovery_config=(value) -> ::Google::Cloud::Orchestration::Airflow::Service::V1::RecoveryConfig
Parameter
Returns

#resilience_mode

def resilience_mode() -> ::Google::Cloud::Orchestration::Airflow::Service::V1::EnvironmentConfig::ResilienceMode
Returns

#resilience_mode=

def resilience_mode=(value) -> ::Google::Cloud::Orchestration::Airflow::Service::V1::EnvironmentConfig::ResilienceMode
Parameter
Returns

#software_config

def software_config() -> ::Google::Cloud::Orchestration::Airflow::Service::V1::SoftwareConfig
Returns

#software_config=

def software_config=(value) -> ::Google::Cloud::Orchestration::Airflow::Service::V1::SoftwareConfig
Parameter
Returns

#web_server_config

def web_server_config() -> ::Google::Cloud::Orchestration::Airflow::Service::V1::WebServerConfig
Returns

#web_server_config=

def web_server_config=(value) -> ::Google::Cloud::Orchestration::Airflow::Service::V1::WebServerConfig
Parameter
Returns

#web_server_network_access_control

def web_server_network_access_control() -> ::Google::Cloud::Orchestration::Airflow::Service::V1::WebServerNetworkAccessControl
Returns

#web_server_network_access_control=

def web_server_network_access_control=(value) -> ::Google::Cloud::Orchestration::Airflow::Service::V1::WebServerNetworkAccessControl
Parameter
Returns

#workloads_config

def workloads_config() -> ::Google::Cloud::Orchestration::Airflow::Service::V1::WorkloadsConfig
Returns
  • (::Google::Cloud::Orchestration::Airflow::Service::V1::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.

#workloads_config=

def workloads_config=(value) -> ::Google::Cloud::Orchestration::Airflow::Service::V1::WorkloadsConfig
Parameter
  • value (::Google::Cloud::Orchestration::Airflow::Service::V1::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.

Returns
  • (::Google::Cloud::Orchestration::Airflow::Service::V1::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.