Google Cloud Orchestration Airflow V1 Client - Class PrivateEnvironmentConfig (2.0.0)

Reference documentation and code samples for the Google Cloud Orchestration Airflow V1 Client class PrivateEnvironmentConfig.

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

Generated from protobuf message google.cloud.orchestration.airflow.service.v1.PrivateEnvironmentConfig

Namespace

Google \ Cloud \ Orchestration \ Airflow \ Service \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ enable_private_environment bool

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_builds_only bool

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.
↳ private_cluster_config 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 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-..*.
↳ cloud_sql_ipv4_cidr_block 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.
↳ web_server_ipv4_reserved_range 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-..*.
↳ cloud_composer_network_ipv4_cidr_block 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 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.
↳ enable_privately_used_public_ips bool

Optional. When enabled, IPs from public (non-RFC1918) ranges can be used for IPAllocationPolicy.cluster_ipv4_cidr_block and IPAllocationPolicy.service_ipv4_cidr_block.
↳ cloud_composer_connection_subnetwork 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.
↳ networking_config Google\Cloud\Orchestration\Airflow\Service\V1\NetworkingConfig

Optional. Configuration for the network connections configuration in the environment.

getEnablePrivateEnvironment

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
Type Description
bool

setEnablePrivateEnvironment

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-..*.

Parameter
Name Description
var bool
Returns
Type Description
$this

getEnablePrivateBuildsOnly

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
Type Description
bool

setEnablePrivateBuildsOnly

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.

Parameter
Name Description
var bool
Returns
Type Description
$this

getPrivateClusterConfig

Optional. Configuration for the private GKE cluster for a Private IP Cloud Composer environment.

Returns
Type Description
Google\Cloud\Orchestration\Airflow\Service\V1\PrivateClusterConfig|null

hasPrivateClusterConfig

clearPrivateClusterConfig

setPrivateClusterConfig

Optional. Configuration for the private GKE cluster for a Private IP Cloud Composer environment.

Parameter
Name Description
var Google\Cloud\Orchestration\Airflow\Service\V1\PrivateClusterConfig
Returns
Type Description
$this

getWebServerIpv4CidrBlock

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
Type Description
string

setWebServerIpv4CidrBlock

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-..*.

Parameter
Name Description
var string
Returns
Type Description
$this

getCloudSqlIpv4CidrBlock

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
Type Description
string

setCloudSqlIpv4CidrBlock

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.

Parameter
Name Description
var string
Returns
Type Description
$this

getWebServerIpv4ReservedRange

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-..*.

Returns
Type Description
string

setWebServerIpv4ReservedRange

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-..*.

Parameter
Name Description
var string
Returns
Type Description
$this

getCloudComposerNetworkIpv4CidrBlock

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
Type Description
string

setCloudComposerNetworkIpv4CidrBlock

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.

Parameter
Name Description
var string
Returns
Type Description
$this

getCloudComposerNetworkIpv4ReservedRange

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.

Returns
Type Description
string

setCloudComposerNetworkIpv4ReservedRange

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.

Parameter
Name Description
var string
Returns
Type Description
$this

getEnablePrivatelyUsedPublicIps

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
Type Description
bool

setEnablePrivatelyUsedPublicIps

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

Parameter
Name Description
var bool
Returns
Type Description
$this

getCloudComposerConnectionSubnetwork

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
Type Description
string

setCloudComposerConnectionSubnetwork

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.

Parameter
Name Description
var string
Returns
Type Description
$this

getNetworkingConfig

Optional. Configuration for the network connections configuration in the environment.

Returns
Type Description
Google\Cloud\Orchestration\Airflow\Service\V1\NetworkingConfig|null

hasNetworkingConfig

clearNetworkingConfig

setNetworkingConfig

Optional. Configuration for the network connections configuration in the environment.

Parameter
Name Description
var Google\Cloud\Orchestration\Airflow\Service\V1\NetworkingConfig
Returns
Type Description
$this