Cloud Composer V1 API - Class Google::Cloud::Orchestration::Airflow::Service::V1::NodeConfig (v0.10.0)

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

The configuration information for the Kubernetes Engine nodes running the Apache Airflow software.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#composer_internal_ipv4_cidr_block

def composer_internal_ipv4_cidr_block() -> ::String
Returns
  • (::String) — Optional. The IP range in CIDR notation to use internally by Cloud Composer. IP addresses are not reserved - and the same range can be used by multiple Cloud Composer environments. In case of overlap, IPs from this range will not be accessible in the user's VPC network. Cannot be updated. If not specified, the default value of '100.64.128.0/20' is used.

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

#composer_internal_ipv4_cidr_block=

def composer_internal_ipv4_cidr_block=(value) -> ::String
Parameter
  • value (::String) — Optional. The IP range in CIDR notation to use internally by Cloud Composer. IP addresses are not reserved - and the same range can be used by multiple Cloud Composer environments. In case of overlap, IPs from this range will not be accessible in the user's VPC network. Cannot be updated. If not specified, the default value of '100.64.128.0/20' is used.

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

Returns
  • (::String) — Optional. The IP range in CIDR notation to use internally by Cloud Composer. IP addresses are not reserved - and the same range can be used by multiple Cloud Composer environments. In case of overlap, IPs from this range will not be accessible in the user's VPC network. Cannot be updated. If not specified, the default value of '100.64.128.0/20' is used.

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

#composer_network_attachment

def composer_network_attachment() -> ::String
Returns
  • (::String) — Optional. Network Attachment that Cloud Composer environment is connected to, which provides connectivity with a user's VPC network. Takes precedence over network and subnetwork settings. If not provided, but network and subnetwork are defined during environment, it will be provisioned. If not provided and network and subnetwork are also empty, then connectivity to user's VPC network is disabled. Network attachment must be provided in format projects/{project}/regions/{region}/networkAttachments/{networkAttachment}.

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

#composer_network_attachment=

def composer_network_attachment=(value) -> ::String
Parameter
  • value (::String) — Optional. Network Attachment that Cloud Composer environment is connected to, which provides connectivity with a user's VPC network. Takes precedence over network and subnetwork settings. If not provided, but network and subnetwork are defined during environment, it will be provisioned. If not provided and network and subnetwork are also empty, then connectivity to user's VPC network is disabled. Network attachment must be provided in format projects/{project}/regions/{region}/networkAttachments/{networkAttachment}.

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

Returns
  • (::String) — Optional. Network Attachment that Cloud Composer environment is connected to, which provides connectivity with a user's VPC network. Takes precedence over network and subnetwork settings. If not provided, but network and subnetwork are defined during environment, it will be provisioned. If not provided and network and subnetwork are also empty, then connectivity to user's VPC network is disabled. Network attachment must be provided in format projects/{project}/regions/{region}/networkAttachments/{networkAttachment}.

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

#disk_size_gb

def disk_size_gb() -> ::Integer
Returns
  • (::Integer) — 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-..*.

#disk_size_gb=

def disk_size_gb=(value) -> ::Integer
Parameter
  • value (::Integer) — 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-..*.

Returns
  • (::Integer) — 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-..*.

#enable_ip_masq_agent

def enable_ip_masq_agent() -> ::Boolean
Returns
  • (::Boolean) — 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

#enable_ip_masq_agent=

def enable_ip_masq_agent=(value) -> ::Boolean
Parameter
  • value (::Boolean) — 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

Returns
  • (::Boolean) — 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

#ip_allocation_policy

def ip_allocation_policy() -> ::Google::Cloud::Orchestration::Airflow::Service::V1::IPAllocationPolicy
Returns

#ip_allocation_policy=

def ip_allocation_policy=(value) -> ::Google::Cloud::Orchestration::Airflow::Service::V1::IPAllocationPolicy
Parameter
Returns

#location

def location() -> ::String
Returns
  • (::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-..*.

#location=

def location=(value) -> ::String
Parameter
  • value (::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-..*.

Returns
  • (::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

def machine_type() -> ::String
Returns
  • (::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-..*.

#machine_type=

def machine_type=(value) -> ::String
Parameter
  • value (::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-..*.

Returns
  • (::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

def network() -> ::String
Returns
  • (::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.

#network=

def network=(value) -> ::String
Parameter
  • value (::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.

Returns
  • (::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.

#oauth_scopes

def oauth_scopes() -> ::Array<::String>
Returns
  • (::Array<::String>) — 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-..*.

#oauth_scopes=

def oauth_scopes=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — 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-..*.

Returns
  • (::Array<::String>) — 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

def service_account() -> ::String
Returns
  • (::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.

#service_account=

def service_account=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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.

#subnetwork

def subnetwork() -> ::String
Returns
  • (::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.

#subnetwork=

def subnetwork=(value) -> ::String
Parameter
  • value (::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.

Returns
  • (::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.

#tags

def tags() -> ::Array<::String>
Returns
  • (::Array<::String>) — 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.

#tags=

def tags=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — 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.
Returns
  • (::Array<::String>) — 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.