Interface NodeConfigOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
NodeConfig, NodeConfig.Builder

@Generated public interface NodeConfigOrBuilder extends com.google.protobuf.MessageOrBuilder
  • Method Details

    • getLocation

      String getLocation()
       Optional. The Compute Engine [zone](/compute/docs/regions-zones) in which
       to deploy the VMs used to run the Apache Airflow software, specified as a
       [relative resource
       name](/apis/design/resource_names#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:
      The location.
    • getLocationBytes

      com.google.protobuf.ByteString getLocationBytes()
       Optional. The Compute Engine [zone](/compute/docs/regions-zones) in which
       to deploy the VMs used to run the Apache Airflow software, specified as a
       [relative resource
       name](/apis/design/resource_names#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:
      The bytes for location.
    • getMachineType

      String getMachineType()
       Optional. The Compute Engine
       [machine type](/compute/docs/machine-types) used for cluster instances,
       specified as a
       [relative resource
       name](/apis/design/resource_names#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](/compute/docs/machine-types#sharedcore).
      
       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:
      The machineType.
    • getMachineTypeBytes

      com.google.protobuf.ByteString getMachineTypeBytes()
       Optional. The Compute Engine
       [machine type](/compute/docs/machine-types) used for cluster instances,
       specified as a
       [relative resource
       name](/apis/design/resource_names#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](/compute/docs/machine-types#sharedcore).
      
       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:
      The bytes for machineType.
    • getNetwork

      String getNetwork()
       Optional. The Compute Engine network to be used for machine
       communications, specified as a
       [relative resource
       name](/apis/design/resource_names#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](/vpc/docs/vpc#vpc_networks_and_subnets)
       is provided, `nodeConfig.subnetwork` must also be provided. For
       [Shared VPC](/vpc/docs/shared-vpc) subnetwork requirements, see
       `nodeConfig.subnetwork`.
       
      string network = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The network.
    • getNetworkBytes

      com.google.protobuf.ByteString getNetworkBytes()
       Optional. The Compute Engine network to be used for machine
       communications, specified as a
       [relative resource
       name](/apis/design/resource_names#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](/vpc/docs/vpc#vpc_networks_and_subnets)
       is provided, `nodeConfig.subnetwork` must also be provided. For
       [Shared VPC](/vpc/docs/shared-vpc) subnetwork requirements, see
       `nodeConfig.subnetwork`.
       
      string network = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for network.
    • getSubnetwork

      String getSubnetwork()
       Optional. The Compute Engine subnetwork to be used for machine
       communications, specified as a
       [relative resource
       name](/apis/design/resource_names#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:
      The subnetwork.
    • getSubnetworkBytes

      com.google.protobuf.ByteString getSubnetworkBytes()
       Optional. The Compute Engine subnetwork to be used for machine
       communications, specified as a
       [relative resource
       name](/apis/design/resource_names#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:
      The bytes for subnetwork.
    • getDiskSizeGb

      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:
      The diskSizeGb.
    • getOauthScopesList

      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:
      A list containing the oauthScopes.
    • getOauthScopesCount

      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:
      The count of oauthScopes.
    • getOauthScopes

      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];
      Parameters:
      index - The index of the element to return.
      Returns:
      The oauthScopes at the given index.
    • getOauthScopesBytes

      com.google.protobuf.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];
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the oauthScopes at the given index.
    • getServiceAccount

      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:
      The serviceAccount.
    • getServiceAccountBytes

      com.google.protobuf.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:
      The bytes for serviceAccount.
    • getTagsList

      List<String> 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](https://www.ietf.org/rfc/rfc1035.txt).
       Cannot be updated.
       
      repeated string tags = 8 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      A list containing the tags.
    • getTagsCount

      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](https://www.ietf.org/rfc/rfc1035.txt).
       Cannot be updated.
       
      repeated string tags = 8 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The count of tags.
    • getTags

      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](https://www.ietf.org/rfc/rfc1035.txt).
       Cannot be updated.
       
      repeated string tags = 8 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      index - The index of the element to return.
      Returns:
      The tags at the given index.
    • getTagsBytes

      com.google.protobuf.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](https://www.ietf.org/rfc/rfc1035.txt).
       Cannot be updated.
       
      repeated string tags = 8 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the tags at the given index.
    • hasIpAllocationPolicy

      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:
      Whether the ipAllocationPolicy field is set.
    • getIpAllocationPolicy

      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:
      The ipAllocationPolicy.
    • getIpAllocationPolicyOrBuilder

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

      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]
       (https://cloud.google.com/kubernetes-engine/docs/how-to/flexible-pod-cidr).
       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:
      The maxPodsPerNode.
    • getEnableIpMasqAgent

      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:
      The enableIpMasqAgent.
    • getComposerNetworkAttachment

      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-*.*.*-build.* and newer.
       
      string composer_network_attachment = 12 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The composerNetworkAttachment.
    • getComposerNetworkAttachmentBytes

      com.google.protobuf.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-*.*.*-build.* and newer.
       
      string composer_network_attachment = 12 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for composerNetworkAttachment.
    • getComposerInternalIpv4CidrBlock

      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-*.*.*-build.* and newer.
       
      string composer_internal_ipv4_cidr_block = 13 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The composerInternalIpv4CidrBlock.
    • getComposerInternalIpv4CidrBlockBytes

      com.google.protobuf.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-*.*.*-build.* and newer.
       
      string composer_internal_ipv4_cidr_block = 13 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for composerInternalIpv4CidrBlock.