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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[],[],null,["# Google Cloud Orchestration Airflow V1 Client - Class IPAllocationPolicy (2.1.8)\n\nVersion latestkeyboard_arrow_down\n\n- [2.1.8 (latest)](/php/docs/reference/cloud-orchestration-airflow/latest/V1.IPAllocationPolicy)\n- [2.1.7](/php/docs/reference/cloud-orchestration-airflow/2.1.7/V1.IPAllocationPolicy)\n- [2.0.1](/php/docs/reference/cloud-orchestration-airflow/2.0.1/V1.IPAllocationPolicy)\n- [1.6.4](/php/docs/reference/cloud-orchestration-airflow/1.6.4/V1.IPAllocationPolicy)\n- [1.5.0](/php/docs/reference/cloud-orchestration-airflow/1.5.0/V1.IPAllocationPolicy)\n- [1.4.2](/php/docs/reference/cloud-orchestration-airflow/1.4.2/V1.IPAllocationPolicy)\n- [1.3.0](/php/docs/reference/cloud-orchestration-airflow/1.3.0/V1.IPAllocationPolicy)\n- [1.2.0](/php/docs/reference/cloud-orchestration-airflow/1.2.0/V1.IPAllocationPolicy)\n- [1.1.0](/php/docs/reference/cloud-orchestration-airflow/1.1.0/V1.IPAllocationPolicy)\n- [1.0.4](/php/docs/reference/cloud-orchestration-airflow/1.0.4/V1.IPAllocationPolicy) \nReference documentation and code samples for the Google Cloud Orchestration Airflow V1 Client class IPAllocationPolicy.\n\nConfiguration for controlling how IPs are allocated in the\nGKE cluster running the Apache Airflow software.\n\nGenerated from protobuf message `google.cloud.orchestration.airflow.service.v1.IPAllocationPolicy`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Orchestration \\\\ Airflow \\\\ Service \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getUseIpAliases\n\nOptional. Whether or not to enable Alias IPs in the GKE cluster.\n\nIf `true`, a VPC-native cluster is created.\nThis field is only supported for Cloud Composer environments in versions\ncomposer-1.*.* -airflow-*.*.\\*. Environments in newer versions always use\nVPC-native GKE clusters.\n\n### setUseIpAliases\n\nOptional. Whether or not to enable Alias IPs in the GKE cluster.\n\nIf `true`, a VPC-native cluster is created.\nThis field is only supported for Cloud Composer environments in versions\ncomposer-1.*.* -airflow-*.*.\\*. Environments in newer versions always use\nVPC-native GKE clusters.\n\n### getClusterSecondaryRangeName\n\nOptional. The name of the GKE cluster's secondary range used to allocate\nIP addresses to pods.\n\nFor Cloud Composer environments in versions composer-1.*.* -airflow-*.* .\\*,\nthis field is applicable only when `use_ip_aliases` is true.\n\n### hasClusterSecondaryRangeName\n\n### setClusterSecondaryRangeName\n\nOptional. The name of the GKE cluster's secondary range used to allocate\nIP addresses to pods.\n\nFor Cloud Composer environments in versions composer-1.*.* -airflow-*.* .\\*,\nthis field is applicable only when `use_ip_aliases` is true.\n\n### getClusterIpv4CidrBlock\n\nOptional. The IP address range used to allocate IP addresses to pods in\nthe GKE cluster.\n\nFor Cloud Composer environments in versions composer-1.*.* -airflow-*.* .\\*,\nthis field is applicable only when `use_ip_aliases` is true.\nSet to blank to have GKE choose a range with the default size.\nSet to /netmask (e.g. `/14`) to have GKE choose a range with a specific\nnetmask.\nSet to a\n[CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)\nnotation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.\n`10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range\nto use.\n\n### hasClusterIpv4CidrBlock\n\n### setClusterIpv4CidrBlock\n\nOptional. The IP address range used to allocate IP addresses to pods in\nthe GKE cluster.\n\nFor Cloud Composer environments in versions composer-1.*.* -airflow-*.* .\\*,\nthis field is applicable only when `use_ip_aliases` is true.\nSet to blank to have GKE choose a range with the default size.\nSet to /netmask (e.g. `/14`) to have GKE choose a range with a specific\nnetmask.\nSet to a\n[CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)\nnotation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.\n`10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range\nto use.\n\n### getServicesSecondaryRangeName\n\nOptional. The name of the services' secondary range used to allocate\nIP addresses to the GKE cluster.\n\nFor Cloud Composer environments in versions composer-1.*.* -airflow-*.* .\\*,\nthis field is applicable only when `use_ip_aliases` is true.\n\n### hasServicesSecondaryRangeName\n\n### setServicesSecondaryRangeName\n\nOptional. The name of the services' secondary range used to allocate\nIP addresses to the GKE cluster.\n\nFor Cloud Composer environments in versions composer-1.*.* -airflow-*.* .\\*,\nthis field is applicable only when `use_ip_aliases` is true.\n\n### getServicesIpv4CidrBlock\n\nOptional. The IP address range of the services IP addresses in this\nGKE cluster.\n\nFor Cloud Composer environments in versions composer-1.*.* -airflow-*.* .\\*,\nthis field is applicable only when `use_ip_aliases` is true.\nSet to blank to have GKE choose a range with the default size.\nSet to /netmask (e.g. `/14`) to have GKE choose a range with a specific\nnetmask.\nSet to a\n[CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)\nnotation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.\n`10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range\nto use.\n\n### hasServicesIpv4CidrBlock\n\n### setServicesIpv4CidrBlock\n\nOptional. The IP address range of the services IP addresses in this\nGKE cluster.\n\nFor Cloud Composer environments in versions composer-1.*.* -airflow-*.* .\\*,\nthis field is applicable only when `use_ip_aliases` is true.\nSet to blank to have GKE choose a range with the default size.\nSet to /netmask (e.g. `/14`) to have GKE choose a range with a specific\nnetmask.\nSet to a\n[CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)\nnotation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.\n`10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range\nto use.\n\n### getClusterIpAllocation\n\n### getServicesIpAllocation"]]
