Class NodeConfig.Builder (1.46.0) 

public static final class NodeConfig.Builder extends GeneratedMessageV3.Builder<NodeConfig.Builder> implements NodeConfigOrBuilder

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

Protobuf type google.cloud.orchestration.airflow.service.v1beta1.NodeConfig

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > NodeConfig.Builder

Implements

NodeConfigOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllOauthScopes(Iterable<String> values)

public NodeConfig.Builder addAllOauthScopes(Iterable<String> values)

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
values Iterable<String>

The oauthScopes to add.
Returns
Type Description
NodeConfig.Builder

This builder for chaining.

addAllTags(Iterable<String> values)

public NodeConfig.Builder addAllTags(Iterable<String> values)

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
values Iterable<String>

The tags to add.
Returns
Type Description
NodeConfig.Builder

This builder for chaining.

addOauthScopes(String value)

public NodeConfig.Builder addOauthScopes(String value)

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
value String

The oauthScopes to add.
Returns
Type Description
NodeConfig.Builder

This builder for chaining.

addOauthScopesBytes(ByteString value)

public NodeConfig.Builder addOauthScopesBytes(ByteString value)

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
value ByteString

The bytes of the oauthScopes to add.
Returns
Type Description
NodeConfig.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public NodeConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
NodeConfig.Builder
Overrides

addTags(String value)

public NodeConfig.Builder addTags(String value)

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
value String

The tags to add.
Returns
Type Description
NodeConfig.Builder

This builder for chaining.

addTagsBytes(ByteString value)

public NodeConfig.Builder addTagsBytes(ByteString value)

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
value ByteString

The bytes of the tags to add.
Returns
Type Description
NodeConfig.Builder

This builder for chaining.

build()

public NodeConfig build()
Returns
Type Description
NodeConfig

buildPartial()

public NodeConfig buildPartial()
Returns
Type Description
NodeConfig

clear()

public NodeConfig.Builder clear()
Returns
Type Description
NodeConfig.Builder
Overrides

clearComposerInternalIpv4CidrBlock()

public NodeConfig.Builder clearComposerInternalIpv4CidrBlock()

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
NodeConfig.Builder

This builder for chaining.

clearComposerNetworkAttachment()

public NodeConfig.Builder clearComposerNetworkAttachment()

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
NodeConfig.Builder

This builder for chaining.

clearDiskSizeGb()

public NodeConfig.Builder clearDiskSizeGb()

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
NodeConfig.Builder

This builder for chaining.

clearEnableIpMasqAgent()

public NodeConfig.Builder clearEnableIpMasqAgent()

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
NodeConfig.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public NodeConfig.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
NodeConfig.Builder
Overrides

clearIpAllocationPolicy()

public NodeConfig.Builder clearIpAllocationPolicy()

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
NodeConfig.Builder

clearLocation()

public NodeConfig.Builder clearLocation()

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
NodeConfig.Builder

This builder for chaining.

clearMachineType()

public NodeConfig.Builder clearMachineType()

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
NodeConfig.Builder

This builder for chaining.

clearMaxPodsPerNode()

public NodeConfig.Builder clearMaxPodsPerNode()

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
NodeConfig.Builder

This builder for chaining.

clearNetwork()

public NodeConfig.Builder clearNetwork()

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
NodeConfig.Builder

This builder for chaining.

clearOauthScopes()

public NodeConfig.Builder clearOauthScopes()

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
NodeConfig.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public NodeConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
NodeConfig.Builder
Overrides

clearServiceAccount()

public NodeConfig.Builder clearServiceAccount()

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
NodeConfig.Builder

This builder for chaining.

clearSubnetwork()

public NodeConfig.Builder clearSubnetwork()

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
NodeConfig.Builder

This builder for chaining.

clearTags()

public NodeConfig.Builder clearTags()

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];

Returns
Type Description
NodeConfig.Builder

This builder for chaining.

clone()

public NodeConfig.Builder clone()
Returns
Type Description
NodeConfig.Builder
Overrides

getComposerInternalIpv4CidrBlock()

public 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 ByteString getComposerInternalIpv4CidrBlockBytes()

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
ByteString

The bytes for composerInternalIpv4CidrBlock.

getComposerNetworkAttachment()

public 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 ByteString getComposerNetworkAttachmentBytes()

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
ByteString

The bytes for composerNetworkAttachment.

getDefaultInstanceForType()

public NodeConfig getDefaultInstanceForType()
Returns
Type Description
NodeConfig

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDiskSizeGb()

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

getIpAllocationPolicyBuilder()

public IPAllocationPolicy.Builder getIpAllocationPolicyBuilder()

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

getIpAllocationPolicyOrBuilder()

public 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 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 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 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
ByteString

The bytes for location.

getMachineType()

public 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 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 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
ByteString

The bytes for machineType.

getMaxPodsPerNode()

public 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 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 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}".

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
ByteString

The bytes for network.

getOauthScopes(int index)

public 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 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 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 ProtocolStringList 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
ProtocolStringList

A list containing the oauthScopes.

getServiceAccount()

public 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 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 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 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 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 ByteString getTagsBytes(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 value to return.
Returns
Type Description
ByteString

The bytes of the tags at the given index.

getTagsCount()

public int getTagsCount()

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];

Returns
Type Description
int

The count of tags.

getTagsList()

public ProtocolStringList getTagsList()

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];

Returns
Type Description
ProtocolStringList

A list containing the tags.

hasIpAllocationPolicy()

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

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(NodeConfig other)

public NodeConfig.Builder mergeFrom(NodeConfig other)
Parameter
Name Description
other NodeConfig
Returns
Type Description
NodeConfig.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public NodeConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
NodeConfig.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public NodeConfig.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
NodeConfig.Builder
Overrides

mergeIpAllocationPolicy(IPAllocationPolicy value)

public NodeConfig.Builder mergeIpAllocationPolicy(IPAllocationPolicy value)

Optional. The IPAllocationPolicy fields for the GKE cluster.

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

Parameter
Name Description
value IPAllocationPolicy
Returns
Type Description
NodeConfig.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final NodeConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
NodeConfig.Builder
Overrides

setComposerInternalIpv4CidrBlock(String value)

public NodeConfig.Builder setComposerInternalIpv4CidrBlock(String value)

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];

Parameter
Name Description
value String

The composerInternalIpv4CidrBlock to set.
Returns
Type Description
NodeConfig.Builder

This builder for chaining.

setComposerInternalIpv4CidrBlockBytes(ByteString value)

public NodeConfig.Builder setComposerInternalIpv4CidrBlockBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for composerInternalIpv4CidrBlock to set.
Returns
Type Description
NodeConfig.Builder

This builder for chaining.

setComposerNetworkAttachment(String value)

public NodeConfig.Builder setComposerNetworkAttachment(String value)

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];

Parameter
Name Description
value String

The composerNetworkAttachment to set.
Returns
Type Description
NodeConfig.Builder

This builder for chaining.

setComposerNetworkAttachmentBytes(ByteString value)

public NodeConfig.Builder setComposerNetworkAttachmentBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for composerNetworkAttachment to set.
Returns
Type Description
NodeConfig.Builder

This builder for chaining.

setDiskSizeGb(int value)

public NodeConfig.Builder setDiskSizeGb(int value)

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];

Parameter
Name Description
value int

The diskSizeGb to set.
Returns
Type Description
NodeConfig.Builder

This builder for chaining.

setEnableIpMasqAgent(boolean value)

public NodeConfig.Builder setEnableIpMasqAgent(boolean value)

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];

Parameter
Name Description
value boolean

The enableIpMasqAgent to set.
Returns
Type Description
NodeConfig.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public NodeConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
NodeConfig.Builder
Overrides

setIpAllocationPolicy(IPAllocationPolicy value)

public NodeConfig.Builder setIpAllocationPolicy(IPAllocationPolicy value)

Optional. The IPAllocationPolicy fields for the GKE cluster.

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

Parameter
Name Description
value IPAllocationPolicy
Returns
Type Description
NodeConfig.Builder

setIpAllocationPolicy(IPAllocationPolicy.Builder builderForValue)

public NodeConfig.Builder setIpAllocationPolicy(IPAllocationPolicy.Builder builderForValue)

Optional. The IPAllocationPolicy fields for the GKE cluster.

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

Parameter
Name Description
builderForValue IPAllocationPolicy.Builder
Returns
Type Description
NodeConfig.Builder

setLocation(String value)

public NodeConfig.Builder setLocation(String value)

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];

Parameter
Name Description
value String

The location to set.
Returns
Type Description
NodeConfig.Builder

This builder for chaining.

setLocationBytes(ByteString value)

public NodeConfig.Builder setLocationBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for location to set.
Returns
Type Description
NodeConfig.Builder

This builder for chaining.

setMachineType(String value)

public NodeConfig.Builder setMachineType(String value)

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];

Parameter
Name Description
value String

The machineType to set.
Returns
Type Description
NodeConfig.Builder

This builder for chaining.

setMachineTypeBytes(ByteString value)

public NodeConfig.Builder setMachineTypeBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for machineType to set.
Returns
Type Description
NodeConfig.Builder

This builder for chaining.

setMaxPodsPerNode(int value)

public NodeConfig.Builder setMaxPodsPerNode(int value)

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];

Parameter
Name Description
value int

The maxPodsPerNode to set.
Returns
Type Description
NodeConfig.Builder

This builder for chaining.

setNetwork(String value)

public NodeConfig.Builder setNetwork(String value)

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];

Parameter
Name Description
value String

The network to set.
Returns
Type Description
NodeConfig.Builder

This builder for chaining.

setNetworkBytes(ByteString value)

public NodeConfig.Builder setNetworkBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for network to set.
Returns
Type Description
NodeConfig.Builder

This builder for chaining.

setOauthScopes(int index, String value)

public NodeConfig.Builder setOauthScopes(int index, String value)

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];

Parameters
Name Description
index int

The index to set the value at.
value String

The oauthScopes to set.
Returns
Type Description
NodeConfig.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public NodeConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
NodeConfig.Builder
Overrides

setServiceAccount(String value)

public NodeConfig.Builder setServiceAccount(String value)

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];

Parameter
Name Description
value String

The serviceAccount to set.
Returns
Type Description
NodeConfig.Builder

This builder for chaining.

setServiceAccountBytes(ByteString value)

public NodeConfig.Builder setServiceAccountBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for serviceAccount to set.
Returns
Type Description
NodeConfig.Builder

This builder for chaining.

setSubnetwork(String value)

public NodeConfig.Builder setSubnetwork(String value)

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];

Parameter
Name Description
value String

The subnetwork to set.
Returns
Type Description
NodeConfig.Builder

This builder for chaining.

setSubnetworkBytes(ByteString value)

public NodeConfig.Builder setSubnetworkBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for subnetwork to set.
Returns
Type Description
NodeConfig.Builder

This builder for chaining.

setTags(int index, String value)

public NodeConfig.Builder setTags(int index, String value)

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];

Parameters
Name Description
index int

The index to set the value at.
value String

The tags to set.
Returns
Type Description
NodeConfig.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final NodeConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
NodeConfig.Builder
Overrides