Reference documentation and code samples for the Google Cloud Dataplex V1 Client class SparkTaskConfig.
User-specified config for running a Spark task.
Generated from protobuf messagegoogle.cloud.dataplex.v1.Task.SparkTaskConfig
Namespace
Google \ Cloud \ Dataplex \ V1 \ Task
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ main_jar_file_uri
string
The Cloud Storage URI of the jar file that contains the main class. The execution args are passed in as a sequence of named process arguments (--key=value).
↳ 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 injar_file_uris. The execution args are passed in as a sequence of named process arguments (--key=value).
↳ python_script_file
string
The Gcloud Storage URI of the main Python file to use as the driver. Must be a .py file. The execution args are passed in as a sequence of named process arguments (--key=value).
↳ sql_script_file
string
A reference to a query file. This should be the Cloud Storage URI of the query file. The execution args are used to declare a set of script variables (set key="value";).
↳ sql_script
string
The query text. The execution args are used to declare a set of script variables (set key="value";).
↳ file_uris
array
Optional. Cloud Storage URIs of files to be placed in the working directory of each executor.
↳ archive_uris
array
Optional. Cloud Storage URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.
Optional. Infrastructure specification for the execution.
getMainJarFileUri
The Cloud Storage URI of the jar file that contains the main class.
The execution args are passed in as a sequence of named process
arguments (--key=value).
Returns
Type
Description
string
hasMainJarFileUri
setMainJarFileUri
The Cloud Storage URI of the jar file that contains the main class.
The execution args are passed in as a sequence of named process
arguments (--key=value).
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 injar_file_uris.
The execution args are passed in as a sequence of named process
arguments (--key=value).
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 injar_file_uris.
The execution args are passed in as a sequence of named process
arguments (--key=value).
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getPythonScriptFile
The Gcloud Storage URI of the main Python file to use as the driver.
Must be a .py file. The execution args are passed in as a sequence of
named process arguments (--key=value).
Returns
Type
Description
string
hasPythonScriptFile
setPythonScriptFile
The Gcloud Storage URI of the main Python file to use as the driver.
Must be a .py file. The execution args are passed in as a sequence of
named process arguments (--key=value).
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getSqlScriptFile
A reference to a query file. This should be the Cloud Storage URI of
the query file. The execution args are used to declare a set of script
variables (set key="value";).
Returns
Type
Description
string
hasSqlScriptFile
setSqlScriptFile
A reference to a query file. This should be the Cloud Storage URI of
the query file. The execution args are used to declare a set of script
variables (set key="value";).
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getSqlScript
The query text.
The execution args are used to declare a set of script variables
(set key="value";).
Returns
Type
Description
string
hasSqlScript
setSqlScript
The query text.
The execution args are used to declare a set of script variables
(set key="value";).
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getFileUris
Optional. Cloud Storage URIs of files to be placed in the working
directory of each executor.
Optional. Cloud Storage URIs of files to be placed in the working
directory of each executor.
Parameter
Name
Description
var
string[]
Returns
Type
Description
$this
getArchiveUris
Optional. Cloud Storage URIs of archives to be extracted into the working
directory of each executor. Supported file types: .jar, .tar, .tar.gz,
.tgz, and .zip.
Optional. Cloud Storage URIs of archives to be extracted into the working
directory of each executor. Supported file types: .jar, .tar, .tar.gz,
.tgz, and .zip.
Parameter
Name
Description
var
string[]
Returns
Type
Description
$this
getInfrastructureSpec
Optional. Infrastructure specification for the execution.
[[["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 Dataplex V1 Client - Class SparkTaskConfig (1.7.1)\n\nVersion latestkeyboard_arrow_down\n\n- [1.7.1 (latest)](/php/docs/reference/cloud-dataplex/latest/V1.Task.SparkTaskConfig)\n- [1.7.0](/php/docs/reference/cloud-dataplex/1.7.0/V1.Task.SparkTaskConfig)\n- [1.6.1](/php/docs/reference/cloud-dataplex/1.6.1/V1.Task.SparkTaskConfig)\n- [1.4.0](/php/docs/reference/cloud-dataplex/1.4.0/V1.Task.SparkTaskConfig)\n- [1.3.0](/php/docs/reference/cloud-dataplex/1.3.0/V1.Task.SparkTaskConfig)\n- [1.2.1](/php/docs/reference/cloud-dataplex/1.2.1/V1.Task.SparkTaskConfig)\n- [1.1.1](/php/docs/reference/cloud-dataplex/1.1.1/V1.Task.SparkTaskConfig)\n- [1.0.1](/php/docs/reference/cloud-dataplex/1.0.1/V1.Task.SparkTaskConfig)\n- [0.16.1](/php/docs/reference/cloud-dataplex/0.16.1/V1.Task.SparkTaskConfig)\n- [0.15.1](/php/docs/reference/cloud-dataplex/0.15.1/V1.Task.SparkTaskConfig)\n- [0.14.0](/php/docs/reference/cloud-dataplex/0.14.0/V1.Task.SparkTaskConfig)\n- [0.13.0](/php/docs/reference/cloud-dataplex/0.13.0/V1.Task.SparkTaskConfig)\n- [0.12.0](/php/docs/reference/cloud-dataplex/0.12.0/V1.Task.SparkTaskConfig)\n- [0.11.1](/php/docs/reference/cloud-dataplex/0.11.1/V1.Task.SparkTaskConfig)\n- [0.10.0](/php/docs/reference/cloud-dataplex/0.10.0/V1.Task.SparkTaskConfig)\n- [0.9.0](/php/docs/reference/cloud-dataplex/0.9.0/V1.Task.SparkTaskConfig)\n- [0.8.0](/php/docs/reference/cloud-dataplex/0.8.0/V1.Task.SparkTaskConfig)\n- [0.7.0](/php/docs/reference/cloud-dataplex/0.7.0/V1.Task.SparkTaskConfig)\n- [0.6.0](/php/docs/reference/cloud-dataplex/0.6.0/V1.Task.SparkTaskConfig)\n- [0.5.1](/php/docs/reference/cloud-dataplex/0.5.1/V1.Task.SparkTaskConfig)\n- [0.4.0](/php/docs/reference/cloud-dataplex/0.4.0/V1.Task.SparkTaskConfig)\n- [0.3.0](/php/docs/reference/cloud-dataplex/0.3.0/V1.Task.SparkTaskConfig)\n- [0.2.3](/php/docs/reference/cloud-dataplex/0.2.3/V1.Task.SparkTaskConfig)\n- [0.1.6](/php/docs/reference/cloud-dataplex/0.1.6/V1.Task.SparkTaskConfig) \nReference documentation and code samples for the Google Cloud Dataplex V1 Client class SparkTaskConfig.\n\nUser-specified config for running a Spark task.\n\nGenerated from protobuf message `google.cloud.dataplex.v1.Task.SparkTaskConfig`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Dataplex \\\\ V1 \\\\ Task\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getMainJarFileUri\n\nThe Cloud Storage URI of the jar file that contains the main class.\n\nThe execution args are passed in as a sequence of named process\narguments (`--key=value`).\n\n### hasMainJarFileUri\n\n### setMainJarFileUri\n\nThe Cloud Storage URI of the jar file that contains the main class.\n\nThe execution args are passed in as a sequence of named process\narguments (`--key=value`).\n\n### getMainClass\n\nThe name of the driver's main class. The jar file that contains the\nclass must be in the default CLASSPATH or specified in\n`jar_file_uris`.\n\nThe execution args are passed in as a sequence of named process\narguments (`--key=value`).\n\n### hasMainClass\n\n### setMainClass\n\nThe name of the driver's main class. The jar file that contains the\nclass must be in the default CLASSPATH or specified in\n`jar_file_uris`.\n\nThe execution args are passed in as a sequence of named process\narguments (`--key=value`).\n\n### getPythonScriptFile\n\nThe Gcloud Storage URI of the main Python file to use as the driver.\n\nMust be a .py file. The execution args are passed in as a sequence of\nnamed process arguments (`--key=value`).\n\n### hasPythonScriptFile\n\n### setPythonScriptFile\n\nThe Gcloud Storage URI of the main Python file to use as the driver.\n\nMust be a .py file. The execution args are passed in as a sequence of\nnamed process arguments (`--key=value`).\n\n### getSqlScriptFile\n\nA reference to a query file. This should be the Cloud Storage URI of\nthe query file. The execution args are used to declare a set of script\nvariables (`set key=\"value\";`).\n\n### hasSqlScriptFile\n\n### setSqlScriptFile\n\nA reference to a query file. This should be the Cloud Storage URI of\nthe query file. The execution args are used to declare a set of script\nvariables (`set key=\"value\";`).\n\n### getSqlScript\n\nThe query text.\n\nThe execution args are used to declare a set of script variables\n(`set key=\"value\";`).\n\n### hasSqlScript\n\n### setSqlScript\n\nThe query text.\n\nThe execution args are used to declare a set of script variables\n(`set key=\"value\";`).\n\n### getFileUris\n\nOptional. Cloud Storage URIs of files to be placed in the working\ndirectory of each executor.\n\n### setFileUris\n\nOptional. Cloud Storage URIs of files to be placed in the working\ndirectory of each executor.\n\n### getArchiveUris\n\nOptional. Cloud Storage URIs of archives to be extracted into the working\ndirectory of each executor. Supported file types: .jar, .tar, .tar.gz,\n.tgz, and .zip.\n\n### setArchiveUris\n\nOptional. Cloud Storage URIs of archives to be extracted into the working\ndirectory of each executor. Supported file types: .jar, .tar, .tar.gz,\n.tgz, and .zip.\n\n### getInfrastructureSpec\n\nOptional. Infrastructure specification for the execution.\n\n### hasInfrastructureSpec\n\n### clearInfrastructureSpec\n\n### setInfrastructureSpec\n\nOptional. Infrastructure specification for the execution.\n\n### getDriver"]]
