HEX
Server: Apache/2.4.65 (Ubuntu)
System: Linux ielts-store-v2 6.8.0-1036-gcp #38~22.04.1-Ubuntu SMP Thu Aug 14 01:19:18 UTC 2025 x86_64
User: root (0)
PHP: 7.2.34-54+ubuntu20.04.1+deb.sury.org+1
Disabled: pcntl_alarm,pcntl_fork,pcntl_waitpid,pcntl_wait,pcntl_wifexited,pcntl_wifstopped,pcntl_wifsignaled,pcntl_wifcontinued,pcntl_wexitstatus,pcntl_wtermsig,pcntl_wstopsig,pcntl_signal,pcntl_signal_get_handler,pcntl_signal_dispatch,pcntl_get_last_error,pcntl_strerror,pcntl_sigprocmask,pcntl_sigwaitinfo,pcntl_sigtimedwait,pcntl_exec,pcntl_getpriority,pcntl_setpriority,pcntl_async_signals,
Upload Files
File: //snap/google-cloud-cli/394/help/man/man1/gcloud_beta_datapipelines_pipeline_create.1
.TH "GCLOUD_BETA_DATAPIPELINES_PIPELINE_CREATE" 1



.SH "NAME"
.HP
gcloud beta datapipelines pipeline create \- creates Data Pipelines Pipeline



.SH "SYNOPSIS"
.HP
\f5gcloud beta datapipelines pipeline create\fR (\fIPIPELINE\fR\ :\ \fB\-\-region\fR=\fIREGION\fR) \fB\-\-pipeline\-type\fR=\fIPIPELINE_TYPE\fR [\fB\-\-additional\-experiments\fR=[\fIADDITIONAL_EXPERIMENTS\fR,...]] [\fB\-\-additional\-user\-labels\fR=[\fIADDITIONAL_USER_LABELS\fR,...]] [\fB\-\-dataflow\-kms\-key\fR=\fIDATAFLOW_KMS_KEY\fR] [\fB\-\-dataflow\-service\-account\-email\fR=\fIDATAFLOW_SERVICE_ACCOUNT_EMAIL\fR] [\fB\-\-disable\-public\-ips\fR] [\fB\-\-display\-name\fR=\fIDISPLAY_NAME\fR] [\fB\-\-enable\-streaming\-engine\fR] [\fB\-\-flexrs\-goal\fR=\fIFLEXRS_GOAL\fR] [\fB\-\-max\-workers\fR=\fIMAX_WORKERS\fR] [\fB\-\-network\fR=\fINETWORK\fR] [\fB\-\-num\-workers\fR=\fINUM_WORKERS\fR] [\fB\-\-parameters\fR=[\fIPARAMETERS\fR,...]] [\fB\-\-schedule\fR=\fISCHEDULE\fR] [\fB\-\-scheduler\-service\-account\-email\fR=\fISCHEDULER_SERVICE_ACCOUNT_EMAIL\fR] [\fB\-\-subnetwork\fR=\fISUBNETWORK\fR] [\fB\-\-temp\-location\fR=\fITEMP_LOCATION\fR] [\fB\-\-template\-file\-gcs\-location\fR=\fITEMPLATE_FILE_GCS_LOCATION\fR] [\fB\-\-template\-type\fR=\fITEMPLATE_TYPE\fR;\ default="FLEX"] [\fB\-\-time\-zone\fR=\fITIME_ZONE\fR] [\fB\-\-worker\-machine\-type\fR=\fIWORKER_MACHINE_TYPE\fR] [\fB\-\-transform\-name\-mappings\fR=[\fITRANSFORM_NAME_MAPPINGS\fR,...]\ \fB\-\-[no\-]update\fR] [\fB\-\-worker\-region\fR=\fIWORKER_REGION\fR\ |\ \fB\-\-worker\-zone\fR=\fIWORKER_ZONE\fR] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

\fB(BETA)\fR Creates Data Pipelines Pipeline.



.SH "EXAMPLES"

To create a BATCH Data Pipeline \f5\fIPIPELINE_NAME\fR\fR in project
\f5\fIexample\fR\fR in region \f5\fIus\-central1\fR\fR, run:

.RS 2m
$ gcloud beta datapipelines pipeline create PIPELINE_NAME \e
     \-\-project=example \-\-region=us\-central1 \-\-pipeline\-type=BATCH \e
     \-\-template\-file\-gcs\-location='gs://path_to_template_file' \e
     \-\-parameters=inputFile="gs://path_to_input_file",\e
 output="gs://path_to_output_file" \-\-schedule="0 * * * *" \e
     \-\-temp\-location="gs://path_to_temp_location"
.RE



.SH "POSITIONAL ARGUMENTS"

.RS 2m
.TP 2m

Pipeline resource \- Name for the Data Pipelines Pipeline. The arguments 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 in other ways.

To set the \f5project\fR attribute:
.RS 2m
.IP "\(em" 2m
provide the argument \f5pipeline\fR on the command line with a fully specified
name;
.IP "\(em" 2m
provide the argument \f5\-\-project\fR on the command line;
.IP "\(em" 2m
set the property \f5core/project\fR.
.RE
.sp

This must be specified.


.RS 2m
.TP 2m
\fIPIPELINE\fR

ID of the pipeline or fully qualified identifier for the pipeline.

To set the \f5pipeline\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5pipeline\fR on the command line.
.RE
.sp

This positional argument must be specified if any of the other arguments in this
group are specified.

.TP 2m
\fB\-\-region\fR=\fIREGION\fR

The Cloud region for the pipeline.

To set the \f5region\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5pipeline\fR on the command line with a fully specified
name;
.IP "\(bu" 2m
provide the argument \f5\-\-region\fR on the command line.
.RE
.sp


.RE
.RE
.sp

.SH "REQUIRED FLAGS"

.RS 2m
.TP 2m
\fB\-\-pipeline\-type\fR=\fIPIPELINE_TYPE\fR

Type of the pipeline. One of 'BATCH' or 'STREAMING'. \fIPIPELINE_TYPE\fR must be
one of:

.RS 2m
.TP 2m
\fBbatch\fR
Specifies a Batch pipeline.
.TP 2m
\fBstreaming\fR
Specifies a Streaming pipeline.
.RE
.sp



.RE
.sp

.SH "OPTIONAL FLAGS"

.RS 2m
.TP 2m
\fB\-\-additional\-experiments\fR=[\fIADDITIONAL_EXPERIMENTS\fR,...]

Default experiment flags for the job.

.TP 2m
\fB\-\-additional\-user\-labels\fR=[\fIADDITIONAL_USER_LABELS\fR,...]

Default user labels to be specified for the job. Keys and values must follow the
restrictions specified in
https://cloud.google.com/compute/docs/labeling\-resources#restrictions.

.TP 2m
\fB\-\-dataflow\-kms\-key\fR=\fIDATAFLOW_KMS_KEY\fR

Default Cloud KMS key to protect the job resources. The key must be in same
location as the job.

.TP 2m
\fB\-\-dataflow\-service\-account\-email\fR=\fIDATAFLOW_SERVICE_ACCOUNT_EMAIL\fR

Default service account to run the dataflow workers as.

.TP 2m
\fB\-\-disable\-public\-ips\fR

Specifies that Cloud Dataflow workers must not use public IP addresses by
default. Overrides the default \fBdatapipelines/disable_public_ips\fR property
value for this command invocation.

.TP 2m
\fB\-\-display\-name\fR=\fIDISPLAY_NAME\fR

Display name of the Data Pipelines pipeline.

.TP 2m
\fB\-\-enable\-streaming\-engine\fR

Specifies that enabling Streaming Engine for the job by default. Overrides the
default \fBdatapipelines/enable_streaming_engine\fR property value for this
command invocation.

.TP 2m
\fB\-\-flexrs\-goal\fR=\fIFLEXRS_GOAL\fR

FlexRS goal for the flex template job. \fIFLEXRS_GOAL\fR must be one of:
\fBCOST_OPTIMIZED\fR, \fBSPEED_OPTIMIZED\fR.

.TP 2m
\fB\-\-max\-workers\fR=\fIMAX_WORKERS\fR

Maximum number of workers to run by default. Must be between 1 and 1000.

.TP 2m
\fB\-\-network\fR=\fINETWORK\fR

Default Compute Engine network for launching instances to run your pipeline. If
not specified here, defaults to the network 'default'.

.TP 2m
\fB\-\-num\-workers\fR=\fINUM_WORKERS\fR

Initial number of workers to run by default. Must be between 1 and 1000. If not
specified here, defaults to server\-specified value.

.TP 2m
\fB\-\-parameters\fR=[\fIPARAMETERS\fR,...]

User defined parameters for the template.

.TP 2m
\fB\-\-schedule\fR=\fISCHEDULE\fR

Unix\-cron format of the schedule for scheduling recurrent jobs.

.TP 2m
\fB\-\-scheduler\-service\-account\-email\fR=\fISCHEDULER_SERVICE_ACCOUNT_EMAIL\fR

Default service account used by the Cloud Scheduler job for launching jobs.

.TP 2m
\fB\-\-subnetwork\fR=\fISUBNETWORK\fR

Default Compute Engine subnetwork for launching instances to run your pipeline.

.TP 2m
\fB\-\-temp\-location\fR=\fITEMP_LOCATION\fR

Default Google Cloud Storage location to stage temporary files. If not set,
defaults to the value for staging\-location (Must be a URL beginning with
\'gs://'.)

.TP 2m
\fB\-\-template\-file\-gcs\-location\fR=\fITEMPLATE_FILE_GCS_LOCATION\fR

Location of the template file or container spec file in Google Cloud Storage.

.TP 2m
\fB\-\-template\-type\fR=\fITEMPLATE_TYPE\fR; default="FLEX"

Type of the template. Defaults to flex template. One of 'FLEX' or 'CLASSIC'.
\fITEMPLATE_TYPE\fR must be one of:

.RS 2m
.TP 2m
\fBclassic\fR
Specifies a Classic template
.TP 2m
\fBflex\fR
Specifies a Flex template.
.RE
.sp


.TP 2m
\fB\-\-time\-zone\fR=\fITIME_ZONE\fR

Timezone ID. This matches the timezone IDs used by the Cloud Scheduler API.

.TP 2m
\fB\-\-worker\-machine\-type\fR=\fIWORKER_MACHINE_TYPE\fR

Default type of machine to use for workers. If not specified here, defaults to
server\-specified value.

.TP 2m
\fB\-\-transform\-name\-mappings\fR=[\fITRANSFORM_NAME_MAPPINGS\fR,...]

Transform name mappings for the streaming update job.

.TP 2m
\fB\-\-[no\-]update\fR

Set this to true for streaming update jobs. Use \fB\-\-update\fR to enable and
\fB\-\-no\-update\fR to disable.

.TP 2m

At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-worker\-region\fR=\fIWORKER_REGION\fR

Default Compute Engine region in which worker processing will occur.

.TP 2m
\fB\-\-worker\-zone\fR=\fIWORKER_ZONE\fR

Default Compute Engine zone in which worker processing will occur.


.RE
.RE
.sp

.SH "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 \fB$ gcloud help\fR for details.



.SH "NOTES"

This command is currently in beta and might change without notice.