gcloud alpha dataproc workflow-templates add-job hadoop Stay organized with collections Save and categorize content based on your preferences.
- NAME
- gcloud alpha dataproc workflow-templates add-job hadoop - add a hadoop job to the workflow template
- SYNOPSIS
gcloud alpha dataproc workflow-templates add-job hadoop--step-id=STEP_ID(--class=MAIN_CLASS|--jar=MAIN_JAR)(--workflow-template=WORKFLOW_TEMPLATE:--region=REGION)[--archives=[ARCHIVE,…]][--driver-log-levels=[PACKAGE=LEVEL,…]][--files=[FILE,…]][--jars=[JAR,…]][--labels=[KEY=VALUE,…]][--properties=[PROPERTY=VALUE,…]][--properties-file=PROPERTIES_FILE][--start-after=STEP_ID,[STEP_ID,…]][GCLOUD_WIDE_FLAG …][--JOB_ARGS…]
- DESCRIPTION
(ALPHA)Add a hadoop job to the workflow template.- EXAMPLES
- To add a Hadoop job executing 'my-jar' jar driver with 'my-class' containing themain method to a the workflow template 'my-workflow-template' in region'us-central1' with step-id 'my-step-id' , run:
gcloudalphadataprocworkflow-templatesadd-jobhadoop--step-id=my-step_id--class=my-class--jar=my-jar.jar--workflow-template=my-workflow-template--region=us-central1 - POSITIONAL ARGUMENTS
- [--
JOB_ARGS…] - The arguments to pass to the driver.
The '--' argument must be specified between gcloud specific args on the left andJOB_ARGS on the right.
- [--
- REQUIRED FLAGS
--step-id=STEP_ID- The step ID of the job in the workflow template.
- Exactly one of these must be specified:
--class=MAIN_CLASS- The class containing the main method of the driver. Must be in a provided jar orjar that is already on the classpath
--jar=MAIN_JAR- The HCFS URI of jar file containing the driver jar.
- Template resource - The name of the workflow template to add job to. Thearguments in this group can be used to specify the attributes of this resource.(NOTE) Some attributes are not given arguments in this group but can be set inother ways.
To set the
projectattribute:- provide the argument
--workflow-templateon the command line with afully specified name; - provide the argument
--projecton the command line; - set the property
core/project.
This must be specified.
--workflow-template=WORKFLOW_TEMPLATE- ID of the template or fully qualified identifier for the template.
To set the
templateattribute:- provide the argument
--workflow-templateon the command line.
This flag argument must be specified if any of the other arguments in this groupare specified.
- provide the argument
--region=REGION- Dataproc region for the template. Each Dataproc region constitutes anindependent resource namespace constrained to deploying instances into ComputeEngine zones inside the region. Overrides the default
dataproc/regionproperty value for this command invocation.To set the
regionattribute:- provide the argument
--workflow-templateon the command line with afully specified name; - provide the argument
--regionon the command line; - set the property
dataproc/region.
- provide the argument
- provide the argument
- OPTIONAL FLAGS
--archives=[ARCHIVE,…]- Comma separated list of archives to be provided to the job. must be one of thefollowing file formats: .zip, .tar, .tar.gz, or .tgz.
--driver-log-levels=[PACKAGE=LEVEL,…]- A list of package to log4j log level pairs to configure driver logging. Forexample: root=FATAL,com.example=INFO
--files=[FILE,…]- Comma separated list of file paths to be provided to the job. A file path caneither be a path to a local file or a path to a file already in a Cloud Storagebucket.
--jars=[JAR,…]- Comma separated list of jar files to be provided to the MR and driverclasspaths.
--labels=[KEY=VALUE,…]- List of label KEY=VALUE pairs to add.
Keys must start with a lowercase character and contain only hyphens(
-), underscores (_), lowercase characters, andnumbers. Values must contain only hyphens (-), underscores(_), lowercase characters, and numbers. --properties=[PROPERTY=VALUE,…]- A list of key value pairs to configure Hadoop.
--properties-file=PROPERTIES_FILE- Path to a local file or a file in a Cloud Storage bucket containingconfiguration properties for the job. The client machine running this commandmust have read permission to the file.
Specify properties in the form of property=value in the text file. For example:
# Properties to set for the job:key1=value1key2=value2# Comment out properties not used.# key3=value3
If a property is set in both
--propertiesand--properties-file, the value defined in--propertiestakes precedence. --start-after=STEP_ID,[STEP_ID,…]- (Optional) List of step IDs to start this job after.
- GCLOUD WIDE FLAGS
- These flags are available to all commands:
--access-token-file,--account,--billing-project,--configuration,--flags-file,--flatten,--format,--help,--impersonate-service-account,--log-http,--project,--quiet,--trace-token,--user-output-enabled,--verbosity.Run
$gcloud helpfor details. - NOTES
- This command is currently in alpha and might change without notice. If thiscommand fails with API permission errors despite specifying the correct project,you might be trying to access an API with an invitation-only early accessallowlist. These variants are also available:
gclouddataprocworkflow-templatesadd-jobhadoopgcloudbetadataprocworkflow-templatesadd-jobhadoop
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-07-22 UTC.