Cloud Composer V1 API - Class Google::Cloud::Orchestration::Airflow::Service::V1::PrivateEnvironmentConfig (v0.11.0)

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

The configuration information for configuring a Private IP Cloud Composer environment.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#cloud_composer_connection_subnetwork

def cloud_composer_connection_subnetwork() -> ::String

Returns

(::String) — Optional. When specified, the environment will use Private Service Connect instead of VPC peerings to connect to Cloud SQL in the Tenant Project, and the PSC endpoint in the Customer Project will use an IP address from this subnetwork.

#cloud_composer_connection_subnetwork=

def cloud_composer_connection_subnetwork=(value) -> ::String

Parameter

value (::String) — Optional. When specified, the environment will use Private Service Connect instead of VPC peerings to connect to Cloud SQL in the Tenant Project, and the PSC endpoint in the Customer Project will use an IP address from this subnetwork.

Returns

(::String) — Optional. When specified, the environment will use Private Service Connect instead of VPC peerings to connect to Cloud SQL in the Tenant Project, and the PSC endpoint in the Customer Project will use an IP address from this subnetwork.

#cloud_composer_network_ipv4_cidr_block

def cloud_composer_network_ipv4_cidr_block() -> ::String

Returns

(::String) — Optional. The CIDR block from which IP range for Cloud Composer Network in tenant project will be reserved. Needs to be disjoint from private_cluster_config.master_ipv4_cidr_block and cloud_sql_ipv4_cidr_block.

This field is supported for Cloud Composer environments in versions composer-2..-airflow-..* and newer.

#cloud_composer_network_ipv4_cidr_block=

def cloud_composer_network_ipv4_cidr_block=(value) -> ::String

Parameter

value (::String) — Optional. The CIDR block from which IP range for Cloud Composer Network in tenant project will be reserved. Needs to be disjoint from private_cluster_config.master_ipv4_cidr_block and cloud_sql_ipv4_cidr_block.

This field is supported for Cloud Composer environments in versions composer-2..-airflow-..* and newer.

Returns

(::String) — Optional. The CIDR block from which IP range for Cloud Composer Network in tenant project will be reserved. Needs to be disjoint from private_cluster_config.master_ipv4_cidr_block and cloud_sql_ipv4_cidr_block.

This field is supported for Cloud Composer environments in versions composer-2..-airflow-..* and newer.

#cloud_composer_network_ipv4_reserved_range

def cloud_composer_network_ipv4_reserved_range() -> ::String

Returns

(::String) — Output only. The IP range reserved for the tenant project's Cloud Composer network.

This field is supported for Cloud Composer environments in versions composer-2..-airflow-..* and newer.

#cloud_sql_ipv4_cidr_block

def cloud_sql_ipv4_cidr_block() -> ::String

Returns

(::String) — Optional. The CIDR block from which IP range in tenant project will be reserved for Cloud SQL. Needs to be disjoint from web_server_ipv4_cidr_block.

#cloud_sql_ipv4_cidr_block=

def cloud_sql_ipv4_cidr_block=(value) -> ::String

Parameter

value (::String) — Optional. The CIDR block from which IP range in tenant project will be reserved for Cloud SQL. Needs to be disjoint from web_server_ipv4_cidr_block.

Returns

(::String) — Optional. The CIDR block from which IP range in tenant project will be reserved for Cloud SQL. Needs to be disjoint from web_server_ipv4_cidr_block.

#enable_private_builds_only

def enable_private_builds_only() -> ::Boolean

Returns

(::Boolean) — Optional. If true, builds performed during operations that install Python packages have only private connectivity to Google services (including Artifact Registry) and VPC network (if either NodeConfig.network and NodeConfig.subnetwork fields or NodeConfig.composer_network_attachment field are specified). If false, the builds also have access to the internet.

This field is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.

#enable_private_builds_only=

def enable_private_builds_only=(value) -> ::Boolean

Parameter

value (::Boolean) — Optional. If true, builds performed during operations that install Python packages have only private connectivity to Google services (including Artifact Registry) and VPC network (if either NodeConfig.network and NodeConfig.subnetwork fields or NodeConfig.composer_network_attachment field are specified). If false, the builds also have access to the internet.

This field is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.

Returns

(::Boolean) — Optional. If true, builds performed during operations that install Python packages have only private connectivity to Google services (including Artifact Registry) and VPC network (if either NodeConfig.network and NodeConfig.subnetwork fields or NodeConfig.composer_network_attachment field are specified). If false, the builds also have access to the internet.

This field is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.

#enable_private_environment

def enable_private_environment() -> ::Boolean

Returns

(::Boolean) — Optional. If true, a Private IP Cloud Composer environment is created. If this field is set to true, IPAllocationPolicy.use_ip_aliases must be set to true for Cloud Composer environments in versions composer-1..-airflow-..*.

#enable_private_environment=

def enable_private_environment=(value) -> ::Boolean

Parameter

value (::Boolean) — Optional. If true, a Private IP Cloud Composer environment is created. If this field is set to true, IPAllocationPolicy.use_ip_aliases must be set to true for Cloud Composer environments in versions composer-1..-airflow-..*.

Returns

(::Boolean) — Optional. If true, a Private IP Cloud Composer environment is created. If this field is set to true, IPAllocationPolicy.use_ip_aliases must be set to true for Cloud Composer environments in versions composer-1..-airflow-..*.

#enable_privately_used_public_ips

def enable_privately_used_public_ips() -> ::Boolean

Returns

(::Boolean) — Optional. When enabled, IPs from public (non-RFC1918) ranges can be used for IPAllocationPolicy.cluster_ipv4_cidr_block and IPAllocationPolicy.service_ipv4_cidr_block.

#enable_privately_used_public_ips=

def enable_privately_used_public_ips=(value) -> ::Boolean

Parameter

value (::Boolean) — Optional. When enabled, IPs from public (non-RFC1918) ranges can be used for IPAllocationPolicy.cluster_ipv4_cidr_block and IPAllocationPolicy.service_ipv4_cidr_block.

Returns

(::Boolean) — Optional. When enabled, IPs from public (non-RFC1918) ranges can be used for IPAllocationPolicy.cluster_ipv4_cidr_block and IPAllocationPolicy.service_ipv4_cidr_block.

#networking_config

def networking_config() -> ::Google::Cloud::Orchestration::Airflow::Service::V1::NetworkingConfig

Returns

(::Google::Cloud::Orchestration::Airflow::Service::V1::NetworkingConfig) — Optional. Configuration for the network connections configuration in the environment.

#networking_config=

def networking_config=(value) -> ::Google::Cloud::Orchestration::Airflow::Service::V1::NetworkingConfig

Parameter

value (::Google::Cloud::Orchestration::Airflow::Service::V1::NetworkingConfig) — Optional. Configuration for the network connections configuration in the environment.

Returns

(::Google::Cloud::Orchestration::Airflow::Service::V1::NetworkingConfig) — Optional. Configuration for the network connections configuration in the environment.

#private_cluster_config

def private_cluster_config() -> ::Google::Cloud::Orchestration::Airflow::Service::V1::PrivateClusterConfig

Returns

(::Google::Cloud::Orchestration::Airflow::Service::V1::PrivateClusterConfig) — Optional. Configuration for the private GKE cluster for a Private IP Cloud Composer environment.

#private_cluster_config=

def private_cluster_config=(value) -> ::Google::Cloud::Orchestration::Airflow::Service::V1::PrivateClusterConfig

Parameter

value (::Google::Cloud::Orchestration::Airflow::Service::V1::PrivateClusterConfig) — Optional. Configuration for the private GKE cluster for a Private IP Cloud Composer environment.

Returns

(::Google::Cloud::Orchestration::Airflow::Service::V1::PrivateClusterConfig) — Optional. Configuration for the private GKE cluster for a Private IP Cloud Composer environment.

#web_server_ipv4_cidr_block

def web_server_ipv4_cidr_block() -> ::String

Returns

(::String) — Optional. The CIDR block from which IP range for web server will be reserved. Needs to be disjoint from private_cluster_config.master_ipv4_cidr_block and cloud_sql_ipv4_cidr_block.

This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.

#web_server_ipv4_cidr_block=

def web_server_ipv4_cidr_block=(value) -> ::String

Parameter

value (::String) — Optional. The CIDR block from which IP range for web server will be reserved. Needs to be disjoint from private_cluster_config.master_ipv4_cidr_block and cloud_sql_ipv4_cidr_block.

This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.

Returns

(::String) — Optional. The CIDR block from which IP range for web server will be reserved. Needs to be disjoint from private_cluster_config.master_ipv4_cidr_block and cloud_sql_ipv4_cidr_block.

This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.

#web_server_ipv4_reserved_range

def web_server_ipv4_reserved_range() -> ::String

Returns

(::String) — Output only. The IP range reserved for the tenant project's App Engine VMs.

This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.