Google Cloud Dataproc V1 Client - Class FlinkJob (2.2.0)

Reference documentation and code samples for the Google Cloud Dataproc V1 Client class FlinkJob.

A Dataproc job for running Apache Flink applications on YARN.

Generated from protobuf message google.cloud.dataproc.v1.FlinkJob

Namespace

Google \ Cloud \ Dataproc \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ main_jar_file_uri string

The HCFS URI of the jar file that contains the main class.

↳ main_class string

The name of the driver's main class. The jar file that contains the class must be in the default CLASSPATH or specified in jarFileUris.

↳ args array

Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision might occur that causes an incorrect job submission.

↳ jar_file_uris array

Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Flink driver and tasks.

↳ savepoint_uri string

Optional. HCFS URI of the savepoint, which contains the last saved progress for starting the current job.

↳ properties array|Google\Protobuf\Internal\MapField

Optional. A mapping of property names to values, used to configure Flink. Properties that conflict with values set by the Dataproc API might be overwritten. Can include properties set in /etc/flink/conf/flink-defaults.conf and classes in user code.

↳ logging_config Google\Cloud\Dataproc\V1\LoggingConfig

Optional. The runtime log config for job execution.

getMainJarFileUri

The HCFS URI of the jar file that contains the main class.

Returns
Type Description
string

hasMainJarFileUri

setMainJarFileUri

The HCFS URI of the jar file that contains the main class.

Parameter
Name Description
var string
Returns
Type Description
$this

getMainClass

The name of the driver's main class. The jar file that contains the class must be in the default CLASSPATH or specified in jarFileUris.

Returns
Type Description
string

hasMainClass

setMainClass

The name of the driver's main class. The jar file that contains the class must be in the default CLASSPATH or specified in jarFileUris.

Parameter
Name Description
var string
Returns
Type Description
$this

getArgs

Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision might occur that causes an incorrect job submission.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setArgs

Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision might occur that causes an incorrect job submission.

Parameter
Name Description
var string[]
Returns
Type Description
$this

getJarFileUris

Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Flink driver and tasks.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setJarFileUris

Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Flink driver and tasks.

Parameter
Name Description
var string[]
Returns
Type Description
$this

getSavepointUri

Optional. HCFS URI of the savepoint, which contains the last saved progress for starting the current job.

Returns
Type Description
string

setSavepointUri

Optional. HCFS URI of the savepoint, which contains the last saved progress for starting the current job.

Parameter
Name Description
var string
Returns
Type Description
$this

getProperties

Optional. A mapping of property names to values, used to configure Flink.

Properties that conflict with values set by the Dataproc API might be overwritten. Can include properties set in /etc/flink/conf/flink-defaults.conf and classes in user code.

Returns
Type Description
Google\Protobuf\Internal\MapField

setProperties

Optional. A mapping of property names to values, used to configure Flink.

Properties that conflict with values set by the Dataproc API might be overwritten. Can include properties set in /etc/flink/conf/flink-defaults.conf and classes in user code.

Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this

getLoggingConfig

Optional. The runtime log config for job execution.

Returns
Type Description
Google\Cloud\Dataproc\V1\LoggingConfig|null

hasLoggingConfig

clearLoggingConfig

setLoggingConfig

Optional. The runtime log config for job execution.

Parameter
Name Description
var Google\Cloud\Dataproc\V1\LoggingConfig
Returns
Type Description
$this

getDriver

Returns
Type Description
string