Reference documentation and code samples for the Google Cloud Dataproc V1 Client class Role.
Role specifies the tasks that will run on the node pool. Roles can be
specific to workloads. Exactly one
GkeNodePoolTarget within the
virtual cluster must have the DEFAULT role, which is used to run all
workloads that are not associated with a node pool.
Protobuf type google.cloud.dataproc.v1.GkeNodePoolTarget.Role
Namespace
Google \ Cloud \ Dataproc \ V1 \ GkeNodePoolTarget
Methods
static::name
Parameter
Name
Description
value
mixed
static::value
Parameter
Name
Description
name
mixed
Constants
ROLE_UNSPECIFIED
Value: 0
Role is unspecified.
Generated from protobuf enum ROLE_UNSPECIFIED = 0;
PBDEFAULT
Value: 1
At least one node pool must have the DEFAULT role.
Work assigned to a role that is not associated with a node pool
is assigned to the node pool with the DEFAULT role. For example,
work assigned to the CONTROLLER role will be assigned to the node pool
with the DEFAULT role if no node pool has the CONTROLLER role.
Generated from protobuf enum DEFAULT = 1;
CONTROLLER
Value: 2
Run work associated with the Dataproc control plane (for example,
controllers and webhooks). Very low resource requirements.
Generated from protobuf enum CONTROLLER = 2;
SPARK_DRIVER
Value: 3
Run work associated with a Spark driver of a job.
Generated from protobuf enum SPARK_DRIVER = 3;
SPARK_EXECUTOR
Value: 4
Run work associated with a Spark executor of a job.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Dataproc V1 Client - Class Role (3.14.0)\n\nVersion latestkeyboard_arrow_down\n\n- [3.14.0 (latest)](/php/docs/reference/cloud-dataproc/latest/V1.GkeNodePoolTarget.Role)\n- [3.13.4](/php/docs/reference/cloud-dataproc/3.13.4/V1.GkeNodePoolTarget.Role)\n- [3.12.0](/php/docs/reference/cloud-dataproc/3.12.0/V1.GkeNodePoolTarget.Role)\n- [3.11.0](/php/docs/reference/cloud-dataproc/3.11.0/V1.GkeNodePoolTarget.Role)\n- [3.10.1](/php/docs/reference/cloud-dataproc/3.10.1/V1.GkeNodePoolTarget.Role)\n- [3.9.0](/php/docs/reference/cloud-dataproc/3.9.0/V1.GkeNodePoolTarget.Role)\n- [3.8.1](/php/docs/reference/cloud-dataproc/3.8.1/V1.GkeNodePoolTarget.Role)\n- [3.7.1](/php/docs/reference/cloud-dataproc/3.7.1/V1.GkeNodePoolTarget.Role)\n- [3.6.1](/php/docs/reference/cloud-dataproc/3.6.1/V1.GkeNodePoolTarget.Role)\n- [3.5.1](/php/docs/reference/cloud-dataproc/3.5.1/V1.GkeNodePoolTarget.Role)\n- [3.4.0](/php/docs/reference/cloud-dataproc/3.4.0/V1.GkeNodePoolTarget.Role)\n- [3.3.0](/php/docs/reference/cloud-dataproc/3.3.0/V1.GkeNodePoolTarget.Role)\n- [3.2.2](/php/docs/reference/cloud-dataproc/3.2.2/V1.GkeNodePoolTarget.Role)\n- [2.6.1](/php/docs/reference/cloud-dataproc/2.6.1/V1.GkeNodePoolTarget.Role)\n- [2.5.0](/php/docs/reference/cloud-dataproc/2.5.0/V1.GkeNodePoolTarget.Role)\n- [2.3.0](/php/docs/reference/cloud-dataproc/2.3.0/V1.GkeNodePoolTarget.Role)\n- [2.2.3](/php/docs/reference/cloud-dataproc/2.2.3/V1.GkeNodePoolTarget.Role)\n- [2.1.0](/php/docs/reference/cloud-dataproc/2.1.0/V1.GkeNodePoolTarget.Role)\n- [2.0.0](/php/docs/reference/cloud-dataproc/2.0.0/V1.GkeNodePoolTarget.Role) \nReference documentation and code samples for the Google Cloud Dataproc V1 Client class Role.\n\n`Role` specifies the tasks that will run on the node pool. Roles can be\nspecific to workloads. Exactly one\n[GkeNodePoolTarget](/php/docs/reference/cloud-dataproc/latest/V1.GkeNodePoolTarget) within the\nvirtual cluster must have the `DEFAULT` role, which is used to run all\nworkloads that are not associated with a node pool.\n\nProtobuf type `google.cloud.dataproc.v1.GkeNodePoolTarget.Role`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Dataproc \\\\ V1 \\\\ GkeNodePoolTarget\n\nMethods\n-------\n\n### static::name\n\n### static::value\n\nConstants\n---------\n\n### ROLE_UNSPECIFIED\n\n Value: 0\n\nRole is unspecified.\n\nGenerated from protobuf enum `ROLE_UNSPECIFIED = 0;`\n\n### PBDEFAULT\n\n Value: 1\n\nAt least one node pool must have the `DEFAULT` role.\n\nWork assigned to a role that is not associated with a node pool\nis assigned to the node pool with the `DEFAULT` role. For example,\nwork assigned to the `CONTROLLER` role will be assigned to the node pool\nwith the `DEFAULT` role if no node pool has the `CONTROLLER` role.\n\nGenerated from protobuf enum `DEFAULT = 1;`\n\n### CONTROLLER\n\n Value: 2\n\nRun work associated with the Dataproc control plane (for example,\ncontrollers and webhooks). Very low resource requirements.\n\nGenerated from protobuf enum `CONTROLLER = 2;`\n\n### SPARK_DRIVER\n\n Value: 3\n\nRun work associated with a Spark driver of a job.\n\nGenerated from protobuf enum `SPARK_DRIVER = 3;`\n\n### SPARK_EXECUTOR\n\n Value: 4\n\nRun work associated with a Spark executor of a job.\n\nGenerated from protobuf enum `SPARK_EXECUTOR = 4;`"]]