Reference documentation and code samples for the Google Cloud Orchestration Airflow V1 Client class NodeConfig.
The configuration information for the Kubernetes Engine nodes running the Apache Airflow software.
Generated from protobuf message google.cloud.orchestration.airflow.service.v1.NodeConfig
Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ location
string
Optional. The Compute Engine zone
in which to deploy the VMs used to run the Apache Airflow software, specified as a relative resource name
. For example: "projects/{projectId}/zones/{zoneId}". This location
must belong to the enclosing environment's project and location. If both this field and nodeConfig.machineType
are specified, nodeConfig.machineType
must belong to this location
; if both are unspecified, the service will pick a zone in the Compute Engine region corresponding to the Cloud Composer location, and propagate that choice to both fields. If only one field ( location
or nodeConfig.machineType
) is specified, the location information from the specified field will be propagated to the unspecified field. This field is supported for Cloud Composer environments in versions composer-1. .
-airflow- .
.*.
↳ machine_type
string
Optional. The Compute Engine machine type
used for cluster instances, specified as a relative resource name
. For example: "projects/{projectId}/zones/{zoneId}/machineTypes/{machineTypeId}". The machineType
must belong to the enclosing environment's project and location. If both this field and nodeConfig.location
are specified, this machineType
must belong to the nodeConfig.location
; if both are unspecified, the service will pick a zone in the Compute Engine region corresponding to the Cloud Composer location, and propagate that choice to both fields. If exactly one of this field and nodeConfig.location
is specified, the location information from the specified field will be propagated to the unspecified field. The machineTypeId
must not be a shared-core machine type
. If this field is unspecified, the machineTypeId
defaults to "n1-standard-1". This field is supported for Cloud Composer environments in versions composer-1. .
-airflow- .
.*.
↳ network
string
Optional. The Compute Engine network to be used for machine communications, specified as a relative resource name
. For example: "projects/{projectId}/global/networks/{networkId}". If unspecified, the "default" network ID in the environment's project is used. If a Custom Subnet Network
is provided, nodeConfig.subnetwork
must also be provided. For Shared VPC
subnetwork requirements, see nodeConfig.subnetwork
.
↳ subnetwork
string
Optional. The Compute Engine subnetwork to be used for machine communications, specified as a relative resource name
. For example: "projects/{projectId}/regions/{regionId}/subnetworks/{subnetworkId}" If a subnetwork is provided, nodeConfig.network
must also be provided, and the subnetwork must belong to the enclosing environment's project and location.
↳ disk_size_gb
int
Optional. The disk size in GB used for node VMs. Minimum size is 30GB. If unspecified, defaults to 100GB. Cannot be updated. This field is supported for Cloud Composer environments in versions composer-1. . -airflow- . .*.
↳ oauth_scopes
array
Optional. The set of Google API scopes to be made available on all node VMs. If oauth_scopes
is empty, defaults to [" https://www.googleapis.com/auth/cloud-platform
"]. Cannot be updated. This field is supported for Cloud Composer environments in versions composer-1. .
-airflow- .
.*.
↳ service_account
string
Optional. The Google Cloud Platform Service Account to be used by the node VMs. If a service account is not specified, the "default" Compute Engine service account is used. Cannot be updated.
↳ tags
array
Optional. The list of instance tags applied to all node VMs. Tags are used to identify valid sources or targets for network firewalls. Each tag within the list must comply with RFC1035 . Cannot be updated.
↳ ip_allocation_policy
Google\Cloud\Orchestration\Airflow\Service\V1\IPAllocationPolicy
Optional. The configuration for controlling how IPs are allocated in the GKE cluster.
↳ enable_ip_masq_agent
bool
Optional. Deploys 'ip-masq-agent' daemon set in the GKE cluster and defines nonMasqueradeCIDRs equals to pod IP range so IP masquerading is used for all destination addresses, except between pods traffic. See: https://cloud.google.com/kubernetes-engine/docs/how-to/ip-masquerade-agent
getLocation
Optional. The Compute Engine zone in which to deploy the VMs used to run the Apache Airflow software, specified as a relative resource name . For example: "projects/{projectId}/zones/{zoneId}".
This location
must belong to the enclosing environment's project and
location. If both this field and nodeConfig.machineType
are specified, nodeConfig.machineType
must belong to this location
; if both are
unspecified, the service will pick a zone in the Compute Engine region
corresponding to the Cloud Composer location, and propagate that choice to
both fields. If only one field ( location
or nodeConfig.machineType
) is
specified, the location information from the specified field will be
propagated to the unspecified field.
This field is supported for Cloud Composer environments in versions
composer-1. .
-airflow- .
.*.
string
setLocation
Optional. The Compute Engine zone in which to deploy the VMs used to run the Apache Airflow software, specified as a relative resource name . For example: "projects/{projectId}/zones/{zoneId}".
This location
must belong to the enclosing environment's project and
location. If both this field and nodeConfig.machineType
are specified, nodeConfig.machineType
must belong to this location
; if both are
unspecified, the service will pick a zone in the Compute Engine region
corresponding to the Cloud Composer location, and propagate that choice to
both fields. If only one field ( location
or nodeConfig.machineType
) is
specified, the location information from the specified field will be
propagated to the unspecified field.
This field is supported for Cloud Composer environments in versions
composer-1. .
-airflow- .
.*.
var
string
$this
getMachineType
Optional. The Compute Engine machine type used for cluster instances, specified as a relative resource name . For example: "projects/{projectId}/zones/{zoneId}/machineTypes/{machineTypeId}".
The machineType
must belong to the enclosing environment's project and
location. If both this field and nodeConfig.location
are specified,
this machineType
must belong to the nodeConfig.location
; if both are
unspecified, the service will pick a zone in the Compute Engine region
corresponding to the Cloud Composer location, and propagate that choice to
both fields. If exactly one of this field and nodeConfig.location
is
specified, the location information from the specified field will be
propagated to the unspecified field.
The machineTypeId
must not be a shared-core machine
type
.
If this field is unspecified, the machineTypeId
defaults
to "n1-standard-1".
This field is supported for Cloud Composer environments in versions
composer-1. .
-airflow- .
.*.
string
setMachineType
Optional. The Compute Engine machine type used for cluster instances, specified as a relative resource name . For example: "projects/{projectId}/zones/{zoneId}/machineTypes/{machineTypeId}".
The machineType
must belong to the enclosing environment's project and
location. If both this field and nodeConfig.location
are specified,
this machineType
must belong to the nodeConfig.location
; if both are
unspecified, the service will pick a zone in the Compute Engine region
corresponding to the Cloud Composer location, and propagate that choice to
both fields. If exactly one of this field and nodeConfig.location
is
specified, the location information from the specified field will be
propagated to the unspecified field.
The machineTypeId
must not be a shared-core machine
type
.
If this field is unspecified, the machineTypeId
defaults
to "n1-standard-1".
This field is supported for Cloud Composer environments in versions
composer-1. .
-airflow- .
.*.
var
string
$this
getNetwork
Optional. The Compute Engine network to be used for machine communications, specified as a relative resource name . For example: "projects/{projectId}/global/networks/{networkId}".
If unspecified, the "default" network ID in the environment's project is
used. If a Custom Subnet Network
is provided, nodeConfig.subnetwork
must also be provided. For Shared VPC
subnetwork requirements, see nodeConfig.subnetwork
.
string
setNetwork
Optional. The Compute Engine network to be used for machine communications, specified as a relative resource name . For example: "projects/{projectId}/global/networks/{networkId}".
If unspecified, the "default" network ID in the environment's project is
used. If a Custom Subnet Network
is provided, nodeConfig.subnetwork
must also be provided. For Shared VPC
subnetwork requirements, see nodeConfig.subnetwork
.
var
string
$this
getSubnetwork
Optional. The Compute Engine subnetwork to be used for machine
communications, specified as a relative resource
name
. For example:
"projects/{projectId}/regions/{regionId}/subnetworks/{subnetworkId}"
If a subnetwork is provided, nodeConfig.network
must also be provided,
and the subnetwork must belong to the enclosing environment's project and
location.
string
setSubnetwork
Optional. The Compute Engine subnetwork to be used for machine
communications, specified as a relative resource
name
. For example:
"projects/{projectId}/regions/{regionId}/subnetworks/{subnetworkId}"
If a subnetwork is provided, nodeConfig.network
must also be provided,
and the subnetwork must belong to the enclosing environment's project and
location.
var
string
$this
getDiskSizeGb
Optional. The disk size in GB used for node VMs. Minimum size is 30GB.
If unspecified, defaults to 100GB. Cannot be updated. This field is supported for Cloud Composer environments in versions composer-1. . -airflow- . .*.
int
setDiskSizeGb
Optional. The disk size in GB used for node VMs. Minimum size is 30GB.
If unspecified, defaults to 100GB. Cannot be updated. This field is supported for Cloud Composer environments in versions composer-1. . -airflow- . .*.
var
int
$this
getOauthScopes
Optional. The set of Google API scopes to be made available on all
node VMs. If oauth_scopes
is empty, defaults to
[" https://www.googleapis.com/auth/cloud-platform
"]. Cannot be updated.
This field is supported for Cloud Composer environments in versions composer-1. . -airflow- . .*.
setOauthScopes
Optional. The set of Google API scopes to be made available on all
node VMs. If oauth_scopes
is empty, defaults to
[" https://www.googleapis.com/auth/cloud-platform
"]. Cannot be updated.
This field is supported for Cloud Composer environments in versions composer-1. . -airflow- . .*.
var
string[]
$this
getServiceAccount
Optional. The Google Cloud Platform Service Account to be used by the node VMs. If a service account is not specified, the "default" Compute Engine service account is used. Cannot be updated.
string
setServiceAccount
Optional. The Google Cloud Platform Service Account to be used by the node VMs. If a service account is not specified, the "default" Compute Engine service account is used. Cannot be updated.
var
string
$this
getTags
Optional. The list of instance tags applied to all node VMs. Tags are used to identify valid sources or targets for network firewalls. Each tag within the list must comply with RFC1035 .
Cannot be updated.
setTags
Optional. The list of instance tags applied to all node VMs. Tags are used to identify valid sources or targets for network firewalls. Each tag within the list must comply with RFC1035 .
Cannot be updated.
var
string[]
$this
getIpAllocationPolicy
Optional. The configuration for controlling how IPs are allocated in the GKE cluster.
hasIpAllocationPolicy
clearIpAllocationPolicy
setIpAllocationPolicy
Optional. The configuration for controlling how IPs are allocated in the GKE cluster.
$this
getEnableIpMasqAgent
Optional. Deploys 'ip-masq-agent' daemon set in the GKE cluster and defines nonMasqueradeCIDRs equals to pod IP range so IP masquerading is used for all destination addresses, except between pods traffic.
See: https://cloud.google.com/kubernetes-engine/docs/how-to/ip-masquerade-agent
bool
setEnableIpMasqAgent
Optional. Deploys 'ip-masq-agent' daemon set in the GKE cluster and defines nonMasqueradeCIDRs equals to pod IP range so IP masquerading is used for all destination addresses, except between pods traffic.
See: https://cloud.google.com/kubernetes-engine/docs/how-to/ip-masquerade-agent
var
bool
$this
