Reference documentation and code samples for the Google Cloud Dataproc V1 Client class TemplateParameter.
A configurable parameter that replaces one or more fields in the template.
Parameterizable fields:
Labels
File uris
Job properties
Job arguments
Script variables
Main class (in HadoopJob and SparkJob)
Zone (in ClusterSelector)
Generated from protobuf messagegoogle.cloud.dataproc.v1.TemplateParameter
Namespace
Google \ Cloud \ Dataproc \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ name
string
Required. Parameter name. The parameter name is used as the key, and paired with the parameter value, which are passed to the template when the template is instantiated. The name must contain only capital letters (A-Z), numbers (0-9), and underscores (_), and must not start with a number. The maximum length is 40 characters.
↳ fields
array
Required. Paths to all fields that the parameter replaces. A field is allowed to appear in at most one parameter's list of field paths. A field path is similar in syntax to agoogle.protobuf.FieldMask. For example, a field path that references the zone field of a workflow template's cluster selector would be specified asplacement.clusterSelector.zone. Also, field paths can reference fields using the following syntax: * Values in maps can be referenced by key: * labels['key'] * placement.clusterSelector.clusterLabels['key'] * placement.managedCluster.labels['key'] * placement.clusterSelector.clusterLabels['key'] * jobs['step-id'].labels['key'] * Jobs in the jobs list can be referenced by step-id: * jobs['step-id'].hadoopJob.mainJarFileUri * jobs['step-id'].hiveJob.queryFileUri * jobs['step-id'].pySparkJob.mainPythonFileUri * jobs['step-id'].hadoopJob.jarFileUris[0] * jobs['step-id'].hadoopJob.archiveUris[0] * jobs['step-id'].hadoopJob.fileUris[0] * jobs['step-id'].pySparkJob.pythonFileUris[0] * Items in repeated fields can be referenced by a zero-based index: * jobs['step-id'].sparkJob.args[0] * Other examples: * jobs['step-id'].hadoopJob.properties['key'] * jobs['step-id'].hadoopJob.args[0] * jobs['step-id'].hiveJob.scriptVariables['key'] * jobs['step-id'].hadoopJob.mainJarFileUri * placement.clusterSelector.zone It may not be possible to parameterize maps and repeated fields in their entirety since only individual map values and individual items in repeated fields can be referenced. For example, the following field paths are invalid: - placement.clusterSelector.clusterLabels - jobs['step-id'].sparkJob.args
↳ description
string
Optional. Brief description of the parameter. Must not exceed 1024 characters.
Optional. Validation rules to be applied to this parameter's value.
getName
Required. Parameter name.
The parameter name is used as the key, and paired with the
parameter value, which are passed to the template when the template
is instantiated.
The name must contain only capital letters (A-Z), numbers (0-9), and
underscores (_), and must not start with a number. The maximum length is
40 characters.
Returns
Type
Description
string
setName
Required. Parameter name.
The parameter name is used as the key, and paired with the
parameter value, which are passed to the template when the template
is instantiated.
The name must contain only capital letters (A-Z), numbers (0-9), and
underscores (_), and must not start with a number. The maximum length is
40 characters.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getFields
Required. Paths to all fields that the parameter replaces.
A field is allowed to appear in at most one parameter's list of field
paths.
A field path is similar in syntax to agoogle.protobuf.FieldMask. For example, a
field path that references the zone field of a workflow template's cluster
selector would be specified asplacement.clusterSelector.zone.
Also, field paths can reference fields using the following syntax:
Values in maps can be referenced by key:
labels['key']
placement.clusterSelector.clusterLabels['key']
placement.managedCluster.labels['key']
placement.clusterSelector.clusterLabels['key']
jobs['step-id'].labels['key']
Jobs in the jobs list can be referenced by step-id:
jobs['step-id'].hadoopJob.mainJarFileUri
jobs['step-id'].hiveJob.queryFileUri
jobs['step-id'].pySparkJob.mainPythonFileUri
jobs['step-id'].hadoopJob.jarFileUris[0]
jobs['step-id'].hadoopJob.archiveUris[0]
jobs['step-id'].hadoopJob.fileUris[0]
jobs['step-id'].pySparkJob.pythonFileUris[0]
Items in repeated fields can be referenced by a zero-based index:
jobs['step-id'].sparkJob.args[0]
Other examples:
jobs['step-id'].hadoopJob.properties['key']
jobs['step-id'].hadoopJob.args[0]
jobs['step-id'].hiveJob.scriptVariables['key']
jobs['step-id'].hadoopJob.mainJarFileUri
placement.clusterSelector.zone
It may not be possible to parameterize maps and repeated fields in their
entirety since only individual map values and individual items in repeated
fields can be referenced. For example, the following field paths are
invalid:
Required. Paths to all fields that the parameter replaces.
A field is allowed to appear in at most one parameter's list of field
paths.
A field path is similar in syntax to agoogle.protobuf.FieldMask. For example, a
field path that references the zone field of a workflow template's cluster
selector would be specified asplacement.clusterSelector.zone.
Also, field paths can reference fields using the following syntax:
Values in maps can be referenced by key:
labels['key']
placement.clusterSelector.clusterLabels['key']
placement.managedCluster.labels['key']
placement.clusterSelector.clusterLabels['key']
jobs['step-id'].labels['key']
Jobs in the jobs list can be referenced by step-id:
jobs['step-id'].hadoopJob.mainJarFileUri
jobs['step-id'].hiveJob.queryFileUri
jobs['step-id'].pySparkJob.mainPythonFileUri
jobs['step-id'].hadoopJob.jarFileUris[0]
jobs['step-id'].hadoopJob.archiveUris[0]
jobs['step-id'].hadoopJob.fileUris[0]
jobs['step-id'].pySparkJob.pythonFileUris[0]
Items in repeated fields can be referenced by a zero-based index:
jobs['step-id'].sparkJob.args[0]
Other examples:
jobs['step-id'].hadoopJob.properties['key']
jobs['step-id'].hadoopJob.args[0]
jobs['step-id'].hiveJob.scriptVariables['key']
jobs['step-id'].hadoopJob.mainJarFileUri
placement.clusterSelector.zone
It may not be possible to parameterize maps and repeated fields in their
entirety since only individual map values and individual items in repeated
fields can be referenced. For example, the following field paths are
invalid:
placement.clusterSelector.clusterLabels
jobs['step-id'].sparkJob.args
Parameter
Name
Description
var
string[]
Returns
Type
Description
$this
getDescription
Optional. Brief description of the parameter.
Must not exceed 1024 characters.
Returns
Type
Description
string
setDescription
Optional. Brief description of the parameter.
Must not exceed 1024 characters.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getValidation
Optional. Validation rules to be applied to this parameter's value.
[[["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 TemplateParameter (3.14.0)\n\nVersion latestkeyboard_arrow_down\n\n- [3.14.0 (latest)](/php/docs/reference/cloud-dataproc/latest/V1.TemplateParameter)\n- [3.13.4](/php/docs/reference/cloud-dataproc/3.13.4/V1.TemplateParameter)\n- [3.12.0](/php/docs/reference/cloud-dataproc/3.12.0/V1.TemplateParameter)\n- [3.11.0](/php/docs/reference/cloud-dataproc/3.11.0/V1.TemplateParameter)\n- [3.10.1](/php/docs/reference/cloud-dataproc/3.10.1/V1.TemplateParameter)\n- [3.9.0](/php/docs/reference/cloud-dataproc/3.9.0/V1.TemplateParameter)\n- [3.8.1](/php/docs/reference/cloud-dataproc/3.8.1/V1.TemplateParameter)\n- [3.7.1](/php/docs/reference/cloud-dataproc/3.7.1/V1.TemplateParameter)\n- [3.6.1](/php/docs/reference/cloud-dataproc/3.6.1/V1.TemplateParameter)\n- [3.5.1](/php/docs/reference/cloud-dataproc/3.5.1/V1.TemplateParameter)\n- [3.4.0](/php/docs/reference/cloud-dataproc/3.4.0/V1.TemplateParameter)\n- [3.3.0](/php/docs/reference/cloud-dataproc/3.3.0/V1.TemplateParameter)\n- [3.2.2](/php/docs/reference/cloud-dataproc/3.2.2/V1.TemplateParameter)\n- [2.6.1](/php/docs/reference/cloud-dataproc/2.6.1/V1.TemplateParameter)\n- [2.5.0](/php/docs/reference/cloud-dataproc/2.5.0/V1.TemplateParameter)\n- [2.3.0](/php/docs/reference/cloud-dataproc/2.3.0/V1.TemplateParameter)\n- [2.2.3](/php/docs/reference/cloud-dataproc/2.2.3/V1.TemplateParameter)\n- [2.1.0](/php/docs/reference/cloud-dataproc/2.1.0/V1.TemplateParameter)\n- [2.0.0](/php/docs/reference/cloud-dataproc/2.0.0/V1.TemplateParameter) \nReference documentation and code samples for the Google Cloud Dataproc V1 Client class TemplateParameter.\n\nA configurable parameter that replaces one or more fields in the template.\n\nParameterizable fields:\n\n- Labels\n- File uris\n- Job properties\n- Job arguments\n- Script variables\n- Main class (in HadoopJob and SparkJob)\n- Zone (in ClusterSelector)\n\nGenerated from protobuf message `google.cloud.dataproc.v1.TemplateParameter`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Dataproc \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getName\n\nRequired. Parameter name.\n\nThe parameter name is used as the key, and paired with the\nparameter value, which are passed to the template when the template\nis instantiated.\nThe name must contain only capital letters (A-Z), numbers (0-9), and\nunderscores (_), and must not start with a number. The maximum length is\n40 characters.\n\n### setName\n\nRequired. Parameter name.\n\nThe parameter name is used as the key, and paired with the\nparameter value, which are passed to the template when the template\nis instantiated.\nThe name must contain only capital letters (A-Z), numbers (0-9), and\nunderscores (_), and must not start with a number. The maximum length is\n40 characters.\n\n### getFields\n\nRequired. Paths to all fields that the parameter replaces.\n\nA field is allowed to appear in at most one parameter's list of field\npaths.\nA field path is similar in syntax to a\n[google.protobuf.FieldMask](https://protobuf.dev/reference/php/api-docs/google.protobuf.FieldMask). For example, a\nfield path that references the zone field of a workflow template's cluster\nselector would be specified as `placement.clusterSelector.zone`.\nAlso, field paths can reference fields using the following syntax:\n\n- Values in maps can be referenced by key:\n - labels\\['key'\\]\n - placement.clusterSelector.clusterLabels\\['key'\\]\n - placement.managedCluster.labels\\['key'\\]\n - placement.clusterSelector.clusterLabels\\['key'\\]\n - jobs\\['step-id'\\].labels\\['key'\\]\n- Jobs in the jobs list can be referenced by step-id:\n - jobs\\['step-id'\\].hadoopJob.mainJarFileUri\n - jobs\\['step-id'\\].hiveJob.queryFileUri\n - jobs\\['step-id'\\].pySparkJob.mainPythonFileUri\n - jobs\\['step-id'\\].hadoopJob.jarFileUris\\[0\\]\n - jobs\\['step-id'\\].hadoopJob.archiveUris\\[0\\]\n - jobs\\['step-id'\\].hadoopJob.fileUris\\[0\\]\n - jobs\\['step-id'\\].pySparkJob.pythonFileUris\\[0\\]\n- Items in repeated fields can be referenced by a zero-based index:\n - jobs\\['step-id'\\].sparkJob.args\\[0\\]\n- Other examples:\n - jobs\\['step-id'\\].hadoopJob.properties\\['key'\\]\n - jobs\\['step-id'\\].hadoopJob.args\\[0\\]\n - jobs\\['step-id'\\].hiveJob.scriptVariables\\['key'\\]\n - jobs\\['step-id'\\].hadoopJob.mainJarFileUri\n - placement.clusterSelector.zone It may not be possible to parameterize maps and repeated fields in their entirety since only individual map values and individual items in repeated fields can be referenced. For example, the following field paths are invalid:\n- placement.clusterSelector.clusterLabels\n- jobs\\['step-id'\\].sparkJob.args\n\n### setFields\n\nRequired. Paths to all fields that the parameter replaces.\n\nA field is allowed to appear in at most one parameter's list of field\npaths.\nA field path is similar in syntax to a\n[google.protobuf.FieldMask](https://protobuf.dev/reference/php/api-docs/google.protobuf.FieldMask). For example, a\nfield path that references the zone field of a workflow template's cluster\nselector would be specified as `placement.clusterSelector.zone`.\nAlso, field paths can reference fields using the following syntax:\n\n- Values in maps can be referenced by key:\n - labels\\['key'\\]\n - placement.clusterSelector.clusterLabels\\['key'\\]\n - placement.managedCluster.labels\\['key'\\]\n - placement.clusterSelector.clusterLabels\\['key'\\]\n - jobs\\['step-id'\\].labels\\['key'\\]\n- Jobs in the jobs list can be referenced by step-id:\n - jobs\\['step-id'\\].hadoopJob.mainJarFileUri\n - jobs\\['step-id'\\].hiveJob.queryFileUri\n - jobs\\['step-id'\\].pySparkJob.mainPythonFileUri\n - jobs\\['step-id'\\].hadoopJob.jarFileUris\\[0\\]\n - jobs\\['step-id'\\].hadoopJob.archiveUris\\[0\\]\n - jobs\\['step-id'\\].hadoopJob.fileUris\\[0\\]\n - jobs\\['step-id'\\].pySparkJob.pythonFileUris\\[0\\]\n- Items in repeated fields can be referenced by a zero-based index:\n - jobs\\['step-id'\\].sparkJob.args\\[0\\]\n- Other examples:\n - jobs\\['step-id'\\].hadoopJob.properties\\['key'\\]\n - jobs\\['step-id'\\].hadoopJob.args\\[0\\]\n - jobs\\['step-id'\\].hiveJob.scriptVariables\\['key'\\]\n - jobs\\['step-id'\\].hadoopJob.mainJarFileUri\n - placement.clusterSelector.zone It may not be possible to parameterize maps and repeated fields in their entirety since only individual map values and individual items in repeated fields can be referenced. For example, the following field paths are invalid:\n- placement.clusterSelector.clusterLabels\n- jobs\\['step-id'\\].sparkJob.args\n\n### getDescription\n\nOptional. Brief description of the parameter.\n\nMust not exceed 1024 characters.\n\n### setDescription\n\nOptional. Brief description of the parameter.\n\nMust not exceed 1024 characters.\n\n### getValidation\n\nOptional. Validation rules to be applied to this parameter's value.\n\n### hasValidation\n\n### clearValidation\n\n### setValidation\n\nOptional. Validation rules to be applied to this parameter's value."]]
