.TH "GCLOUD_BETA_DATAPROC_JOBS_SUBMIT_FLINK" 1



.SH "NAME"
.HP
gcloud beta dataproc jobs submit flink \- submit a Flink job to a cluster



.SH "SYNOPSIS"
.HP
\f5gcloud beta dataproc jobs submit flink\fR  (\fB\-\-class\fR=\fIMAIN_CLASS\fR\ |\ \fB\-\-jar\fR=\fIMAIN_JAR\fR) (\fB\-\-cluster\fR=\fICLUSTER\fR\ |\ \fB\-\-cluster\-labels\fR=[\fIKEY\fR=\fIVALUE\fR,...]) [\fB\-\-async\fR] [\fB\-\-bucket\fR=\fIBUCKET\fR] [\fB\-\-driver\-log\-levels\fR=[\fIPACKAGE\fR=\fILEVEL\fR,...]] [\fB\-\-driver\-required\-memory\-mb\fR=\fIDRIVER_REQUIRED_MEMORY_MB\fR] [\fB\-\-driver\-required\-vcores\fR=\fIDRIVER_REQUIRED_VCORES\fR] [\fB\-\-jars\fR=[\fIJAR\fR,...]] [\fB\-\-labels\fR=[\fIKEY\fR=\fIVALUE\fR,...]] [\fB\-\-max\-failures\-per\-hour\fR=\fIMAX_FAILURES_PER_HOUR\fR] [\fB\-\-max\-failures\-total\fR=\fIMAX_FAILURES_TOTAL\fR] [\fB\-\-properties\fR=[\fIPROPERTY\fR=\fIVALUE\fR,...]] [\fB\-\-properties\-file\fR=\fIPROPERTIES_FILE\fR] [\fB\-\-region\fR=\fIREGION\fR] [\fB\-\-savepoint\fR=\fISAVEPOINT\fR] [\fIGCLOUD_WIDE_FLAG\ ...\fR] [\-\-\ \fIJOB_ARGS\fR\ ...]



.SH "DESCRIPTION"

\fB(BETA)\fR Submit a Flink job to a cluster.



.SH "EXAMPLES"

To submit a Flink job that runs the main class of a jar, run:

.RS 2m
$ gcloud beta dataproc jobs submit flink \-\-cluster=my\-cluster \e
    \-\-region=us\-central1 \-\-jar=my_jar.jar \-\- arg1 arg2
.RE

To submit a Flink job that runs a specific class as an entrypoint:

.RS 2m
$ gcloud beta dataproc jobs submit flink \-\-cluster=my\-cluster \e
    \-\-region=us\-central1 \-\-class=org.my.main.Class \e
    \-\-jars=my_jar.jar \-\- arg1 arg2
.RE

To submit a Flink job that runs a jar that is on the cluster, run:

.RS 2m
$ gcloud beta dataproc jobs submit flink \-\-cluster=my\-cluster \e
    \-\-region=us\-central1 \e
    \-\-jar=/usr/lib/flink/examples/streaming/TopSpeedWindowing.jar
.RE



.SH "POSITIONAL ARGUMENTS"

.RS 2m
.TP 2m
[\-\- \fIJOB_ARGS\fR ...]

The job arguments to pass.

The '\-\-' argument must be specified between gcloud specific args on the left
and JOB_ARGS on the right.


.RE
.sp

.SH "REQUIRED FLAGS"

.RS 2m
.TP 2m

Exactly one of these must be specified:


.RS 2m
.TP 2m
\fB\-\-class\fR=\fIMAIN_CLASS\fR

The class containing the main method of the driver. Must be in a provided jar or
jar that is already on the classpath

.TP 2m
\fB\-\-jar\fR=\fIMAIN_JAR\fR

The HCFS URI of jar file containing the driver jar.

.RE
.sp
.TP 2m

Exactly one of these must be specified:


.RS 2m
.TP 2m
\fB\-\-cluster\fR=\fICLUSTER\fR

The Dataproc cluster to submit the job to.

.TP 2m
\fB\-\-cluster\-labels\fR=[\fIKEY\fR=\fIVALUE\fR,...]

List of label KEY=VALUE pairs to add.

Keys must start with a lowercase character and contain only hyphens (\f5\-\fR),
underscores (\f5_\fR), lowercase characters, and numbers. Values must contain
only hyphens (\f5\-\fR), underscores (\f5_\fR), lowercase characters, and
numbers.

Labels of Dataproc cluster on which to place the job.


.RE
.RE
.sp

.SH "OPTIONAL FLAGS"

.RS 2m
.TP 2m
\fB\-\-async\fR

Return immediately, without waiting for the operation in progress to complete.

.TP 2m
\fB\-\-bucket\fR=\fIBUCKET\fR

The Cloud Storage bucket to stage files in. Defaults to the cluster's configured
bucket.

.TP 2m
\fB\-\-driver\-log\-levels\fR=[\fIPACKAGE\fR=\fILEVEL\fR,...]

List of package to log4j log level pairs to configure driver logging. For
example: root=FATAL,com.example=INFO.

.TP 2m
\fB\-\-driver\-required\-memory\-mb\fR=\fIDRIVER_REQUIRED_MEMORY_MB\fR

The memory allocation requested by the job driver in megabytes (MB) for
execution on the driver node group (it is used only by clusters with a driver
node group).

.TP 2m
\fB\-\-driver\-required\-vcores\fR=\fIDRIVER_REQUIRED_VCORES\fR

The vCPU allocation requested by the job driver for execution on the driver node
group (it is used only by clusters with a driver node group).

.TP 2m
\fB\-\-jars\fR=[\fIJAR\fR,...]

Comma\-separated list of jar files to provide to the task manager classpaths.

.TP 2m
\fB\-\-labels\fR=[\fIKEY\fR=\fIVALUE\fR,...]

List of label KEY=VALUE pairs to add.

Keys must start with a lowercase character and contain only hyphens (\f5\-\fR),
underscores (\f5_\fR), lowercase characters, and numbers. Values must contain
only hyphens (\f5\-\fR), underscores (\f5_\fR), lowercase characters, and
numbers.

.TP 2m
\fB\-\-max\-failures\-per\-hour\fR=\fIMAX_FAILURES_PER_HOUR\fR

Specifies the maximum number of times a job can be restarted per hour in event
of failure. Default is 0 (no retries after job failure).

.TP 2m
\fB\-\-max\-failures\-total\fR=\fIMAX_FAILURES_TOTAL\fR

Specifies the maximum total number of times a job can be restarted after the job
fails. Default is 0 (no retries after job failure).

.TP 2m
\fB\-\-properties\fR=[\fIPROPERTY\fR=\fIVALUE\fR,...]

List of key=value pairs to configure Flink. For a list of available properties,
see:
https://nightlies.apache.org/flink/flink\-docs\-master/docs/deployment/config/.

.TP 2m
\fB\-\-properties\-file\fR=\fIPROPERTIES_FILE\fR

Path to a local file or a file in a Cloud Storage bucket containing
configuration properties for the job. The client machine running this command
must have read permission to the file.

Specify properties in the form of property=value in the text file. For example:

.RS 2m
  # Properties to set for the job:
  key1=value1
  key2=value2
  # Comment out properties not used.
  # key3=value3
.RE

If a property is set in both \f5\-\-properties\fR and
\f5\-\-properties\-file\fR, the value defined in \f5\-\-properties\fR takes
precedence.

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

Dataproc region to use. Each Dataproc region constitutes an independent resource
namespace constrained to deploying instances into Compute Engine zones inside
the region. Overrides the default \fBdataproc/region\fR property value for this
command invocation.

.TP 2m
\fB\-\-savepoint\fR=\fISAVEPOINT\fR

HCFS URI of the savepoint that is used to refer to the state of the previously
stopped job. The new job will resume previous state from there.


.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. These
variants are also available:

.RS 2m
$ gcloud dataproc jobs submit flink
.RE

.RS 2m
$ gcloud alpha dataproc jobs submit flink
.RE