Interface NodeConfigOrBuilder (1.46.0)

public interface NodeConfigOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getComposerInternalIpv4CidrBlock()

public abstract String getComposerInternalIpv4CidrBlock()

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.

string composer_internal_ipv4_cidr_block = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`String`	The composerInternalIpv4CidrBlock.

getComposerInternalIpv4CidrBlockBytes()

public abstract ByteString getComposerInternalIpv4CidrBlockBytes()

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

string composer_internal_ipv4_cidr_block = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ByteString`	The bytes for composerInternalIpv4CidrBlock.

getComposerNetworkAttachment()

public abstract String getComposerNetworkAttachment()

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.

string composer_network_attachment = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`String`	The composerNetworkAttachment.

getComposerNetworkAttachmentBytes()

public abstract ByteString getComposerNetworkAttachmentBytes()

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

string composer_network_attachment = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ByteString`	The bytes for composerNetworkAttachment.

getDiskSizeGb()

public abstract int 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-..*.

int32 disk_size_gb = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`int`	The diskSizeGb.

getEnableIpMasqAgent()

public abstract boolean 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 enable_ip_masq_agent = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	The enableIpMasqAgent.

getIpAllocationPolicy()

public abstract IPAllocationPolicy getIpAllocationPolicy()

Optional. The IPAllocationPolicy fields for the GKE cluster.

.google.cloud.orchestration.airflow.service.v1beta1.IPAllocationPolicy ip_allocation_policy = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`IPAllocationPolicy`	The ipAllocationPolicy.

getIpAllocationPolicyOrBuilder()

public abstract IPAllocationPolicyOrBuilder getIpAllocationPolicyOrBuilder()

Optional. The IPAllocationPolicy fields for the GKE cluster.

.google.cloud.orchestration.airflow.service.v1beta1.IPAllocationPolicy ip_allocation_policy = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`IPAllocationPolicyOrBuilder`

getLocation()

public abstract String 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 location = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`String`	The location.

getLocationBytes()

public abstract ByteString getLocationBytes()

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 field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.

string location = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ByteString`	The bytes for location.

getMachineType()

public abstract String 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 machine_type = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`String`	The machineType.

getMachineTypeBytes()

public abstract ByteString getMachineTypeBytes()

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 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 machine_type = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ByteString`	The bytes for machineType.

getMaxPodsPerNode()

public abstract int getMaxPodsPerNode()

Optional. The maximum number of pods per node in the Cloud Composer GKE cluster. The value must be between 8 and 110 and it can be set only if the environment is VPC-native. The default value is 32. Values of this field will be propagated both to the default-pool node pool of the newly created GKE cluster, and to the default "Maximum Pods per Node" value which is used for newly created node pools if their value is not explicitly set during node pool creation. For more information, see Optimizing IP address allocation. Cannot be updated.

This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.

int32 max_pods_per_node = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`int`	The maxPodsPerNode.

getNetwork()

public abstract String 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 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 network = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`String`	The network.

getNetworkBytes()

public abstract ByteString getNetworkBytes()

Optional. The Compute Engine network to be used for machine communications, specified as a relative resource name. For example: "projects/{projectId}/global/networks/{networkId}".

string network = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ByteString`	The bytes for network.

getOauthScopes(int index)

public abstract String getOauthScopes(int index)

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

repeated string oauth_scopes = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`index`	`int` The index of the element to return.

Returns
Type	Description
`String`	The oauthScopes at the given index.

getOauthScopesBytes(int index)

public abstract ByteString getOauthScopesBytes(int index)

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

repeated string oauth_scopes = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`index`	`int` The index of the value to return.

Returns
Type	Description
`ByteString`	The bytes of the oauthScopes at the given index.

getOauthScopesCount()

public abstract int getOauthScopesCount()

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

repeated string oauth_scopes = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`int`	The count of oauthScopes.

getOauthScopesList()

public abstract List<String> getOauthScopesList()

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

repeated string oauth_scopes = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`List<String>`	A list containing the oauthScopes.

getServiceAccount()

public abstract String getServiceAccount()

Optional. The Google Cloud Platform Service Account to be used by the workloads. If a service account is not specified, the "default" Compute Engine service account is used. Cannot be updated.

string service_account = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`String`	The serviceAccount.

getServiceAccountBytes()

public abstract ByteString getServiceAccountBytes()

Optional. The Google Cloud Platform Service Account to be used by the workloads. If a service account is not specified, the "default" Compute Engine service account is used. Cannot be updated.

string service_account = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ByteString`	The bytes for serviceAccount.

getSubnetwork()

public abstract String 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 subnetwork = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`String`	The subnetwork.

getSubnetworkBytes()

public abstract ByteString getSubnetworkBytes()

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 subnetwork = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ByteString`	The bytes for subnetwork.

getTags(int index)

public abstract String getTags(int index)

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.

repeated string tags = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`index`	`int` The index of the element to return.

Returns
Type	Description
`String`	The tags at the given index.

getTagsBytes(int index)

public abstract ByteString getTagsBytes(int index)

repeated string tags = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`index`	`int` The index of the value to return.

Returns
Type	Description
`ByteString`	The bytes of the tags at the given index.

getTagsCount()

public abstract int getTagsCount()

repeated string tags = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`int`	The count of tags.

getTagsList()

public abstract List<String> getTagsList()

repeated string tags = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`List<String>`	A list containing the tags.

hasIpAllocationPolicy()

public abstract boolean hasIpAllocationPolicy()

Optional. The IPAllocationPolicy fields for the GKE cluster.

.google.cloud.orchestration.airflow.service.v1beta1.IPAllocationPolicy ip_allocation_policy = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	Whether the ipAllocationPolicy field is set.