Reference documentation and code samples for the Google Cloud Dataproc V1 Client class HadoopJob.
A Dataproc job for running Apache Hadoop MapReduce jobs on Apache Hadoop YARN.
Generated from protobuf message google.cloud.dataproc.v1.HadoopJob
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 containing the main class. Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar' |
↳ main_class |
string
The name of the driver's main class. The jar file containing the class must be in the default CLASSPATH or specified in |
↳ args |
array
Optional. The arguments to pass to the driver. Do not include arguments, such as |
↳ jar_file_uris |
array
Optional. Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks. |
↳ file_uris |
array
Optional. HCFS (Hadoop Compatible Filesystem) URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks. |
↳ archive_uris |
array
Optional. HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip. |
↳ properties |
array|Google\Protobuf\Internal\MapField
Optional. A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site 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 containing the main class.
Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar'
Generated from protobuf field string main_jar_file_uri = 1;
| Returns | |
|---|---|
| Type | Description |
string |
|
hasMainJarFileUri
setMainJarFileUri
The HCFS URI of the jar file containing the main class.
Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar'
Generated from protobuf field string main_jar_file_uri = 1;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMainClass
The name of the driver's main class. The jar file containing the class
must be in the default CLASSPATH or specified in jar_file_uris.
Generated from protobuf field string main_class = 2;
| Returns | |
|---|---|
| Type | Description |
string |
|
hasMainClass
setMainClass
The name of the driver's main class. The jar file containing the class
must be in the default CLASSPATH or specified in jar_file_uris.
Generated from protobuf field string main_class = 2;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getArgs
Optional. The arguments to pass to the driver. Do not
include arguments, such as -libjars or -Dfoo=bar, that can be set as
job properties, since a collision may occur that causes an incorrect job
submission.
Generated from protobuf field repeated string args = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setArgs
Optional. The arguments to pass to the driver. Do not
include arguments, such as -libjars or -Dfoo=bar, that can be set as
job properties, since a collision may occur that causes an incorrect job
submission.
Generated from protobuf field repeated string args = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getJarFileUris
Optional. Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
Generated from protobuf field repeated string jar_file_uris = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setJarFileUris
Optional. Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
Generated from protobuf field repeated string jar_file_uris = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFileUris
Optional. HCFS (Hadoop Compatible Filesystem) URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.
Generated from protobuf field repeated string file_uris = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setFileUris
Optional. HCFS (Hadoop Compatible Filesystem) URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.
Generated from protobuf field repeated string file_uris = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getArchiveUris
Optional. HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip.
Generated from protobuf field repeated string archive_uris = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setArchiveUris
Optional. HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip.
Generated from protobuf field repeated string archive_uris = 6 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getProperties
Optional. A mapping of property names to values, used to configure Hadoop.
Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.
Generated from protobuf field map<string, string> properties = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField |
|
setProperties
Optional. A mapping of property names to values, used to configure Hadoop.
Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.
Generated from protobuf field map<string, string> properties = 7 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLoggingConfig
Optional. The runtime log config for job execution.
Generated from protobuf field .google.cloud.dataproc.v1.LoggingConfig logging_config = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dataproc\V1\LoggingConfig|null |
|
hasLoggingConfig
clearLoggingConfig
setLoggingConfig
Optional. The runtime log config for job execution.
Generated from protobuf field .google.cloud.dataproc.v1.LoggingConfig logging_config = 8 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Dataproc\V1\LoggingConfig
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDriver
| Returns | |
|---|---|
| Type | Description |
string |
|