Google Cloud Orchestration Airflow V1 Client - Class IPAllocationPolicy (2.1.0)

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

Configuration for controlling how IPs are allocated in the GKE cluster running the Apache Airflow software.

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

Namespace

Google \ Cloud \ Orchestration \ Airflow \ Service \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

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

Optional. Whether or not to enable Alias IPs in the GKE cluster. If true, a VPC-native cluster is created. This field is only supported for Cloud Composer environments in versions composer-1..-airflow-..*. Environments in newer versions always use VPC-native GKE clusters.
↳ cluster_secondary_range_name string

Optional. The name of the GKE cluster's secondary range used to allocate IP addresses to pods. For Cloud Composer environments in versions composer-1..-airflow-..*, this field is applicable only when use_ip_aliases is true.
↳ cluster_ipv4_cidr_block string

Optional. The IP address range used to allocate IP addresses to pods in the GKE cluster. For Cloud Composer environments in versions composer-1..-airflow-..*, this field is applicable only when use_ip_aliases is true. Set to blank to have GKE choose a range with the default size. Set to /netmask (e.g. /14) to have GKE choose a range with a specific netmask. Set to a CIDR notation (e.g. 10.96.0.0/14) from the RFC-1918 private networks (e.g. 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16) to pick a specific range to use.
↳ services_secondary_range_name string

Optional. The name of the services' secondary range used to allocate IP addresses to the GKE cluster. For Cloud Composer environments in versions composer-1..-airflow-..*, this field is applicable only when use_ip_aliases is true.
↳ services_ipv4_cidr_block string

Optional. The IP address range of the services IP addresses in this GKE cluster. For Cloud Composer environments in versions composer-1..-airflow-..*, this field is applicable only when use_ip_aliases is true. Set to blank to have GKE choose a range with the default size. Set to /netmask (e.g. /14) to have GKE choose a range with a specific netmask. Set to a CIDR notation (e.g. 10.96.0.0/14) from the RFC-1918 private networks (e.g. 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16) to pick a specific range to use.

getUseIpAliases

Optional. Whether or not to enable Alias IPs in the GKE cluster.

If true, a VPC-native cluster is created. This field is only supported for Cloud Composer environments in versions composer-1..-airflow-..*. Environments in newer versions always use VPC-native GKE clusters.

Returns
Type Description
bool

setUseIpAliases

Optional. Whether or not to enable Alias IPs in the GKE cluster.

If true, a VPC-native cluster is created. This field is only supported for Cloud Composer environments in versions composer-1..-airflow-..*. Environments in newer versions always use VPC-native GKE clusters.

Parameter
Name Description
var bool
Returns
Type Description
$this

getClusterSecondaryRangeName

Optional. The name of the GKE cluster's secondary range used to allocate IP addresses to pods.

For Cloud Composer environments in versions composer-1..-airflow-..*, this field is applicable only when use_ip_aliases is true.

Returns
Type Description
string

hasClusterSecondaryRangeName

setClusterSecondaryRangeName

Optional. The name of the GKE cluster's secondary range used to allocate IP addresses to pods.

For Cloud Composer environments in versions composer-1..-airflow-..*, this field is applicable only when use_ip_aliases is true.

Parameter
Name Description
var string
Returns
Type Description
$this

getClusterIpv4CidrBlock

Optional. The IP address range used to allocate IP addresses to pods in the GKE cluster.

For Cloud Composer environments in versions composer-1..-airflow-..*, this field is applicable only when use_ip_aliases is true. Set to blank to have GKE choose a range with the default size. Set to /netmask (e.g. /14) to have GKE choose a range with a specific netmask. Set to a CIDR notation (e.g. 10.96.0.0/14) from the RFC-1918 private networks (e.g. 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16) to pick a specific range to use.

Returns
Type Description
string

hasClusterIpv4CidrBlock

setClusterIpv4CidrBlock

Optional. The IP address range used to allocate IP addresses to pods in the GKE cluster.

For Cloud Composer environments in versions composer-1..-airflow-..*, this field is applicable only when use_ip_aliases is true. Set to blank to have GKE choose a range with the default size. Set to /netmask (e.g. /14) to have GKE choose a range with a specific netmask. Set to a CIDR notation (e.g. 10.96.0.0/14) from the RFC-1918 private networks (e.g. 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16) to pick a specific range to use.

Parameter
Name Description
var string
Returns
Type Description
$this

getServicesSecondaryRangeName

Optional. The name of the services' secondary range used to allocate IP addresses to the GKE cluster.

For Cloud Composer environments in versions composer-1..-airflow-..*, this field is applicable only when use_ip_aliases is true.

Returns
Type Description
string

hasServicesSecondaryRangeName

setServicesSecondaryRangeName

Optional. The name of the services' secondary range used to allocate IP addresses to the GKE cluster.

For Cloud Composer environments in versions composer-1..-airflow-..*, this field is applicable only when use_ip_aliases is true.

Parameter
Name Description
var string
Returns
Type Description
$this

getServicesIpv4CidrBlock

Optional. The IP address range of the services IP addresses in this GKE cluster.

For Cloud Composer environments in versions composer-1..-airflow-..*, this field is applicable only when use_ip_aliases is true. Set to blank to have GKE choose a range with the default size. Set to /netmask (e.g. /14) to have GKE choose a range with a specific netmask. Set to a CIDR notation (e.g. 10.96.0.0/14) from the RFC-1918 private networks (e.g. 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16) to pick a specific range to use.

Returns
Type Description
string

hasServicesIpv4CidrBlock

setServicesIpv4CidrBlock

Optional. The IP address range of the services IP addresses in this GKE cluster.

For Cloud Composer environments in versions composer-1..-airflow-..*, this field is applicable only when use_ip_aliases is true. Set to blank to have GKE choose a range with the default size. Set to /netmask (e.g. /14) to have GKE choose a range with a specific netmask. Set to a CIDR notation (e.g. 10.96.0.0/14) from the RFC-1918 private networks (e.g. 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16) to pick a specific range to use.

Parameter
Name Description
var string
Returns
Type Description
$this

getClusterIpAllocation

Returns
Type Description
string

getServicesIpAllocation

Returns
Type Description
string