Reference documentation and code samples for the Google Cloud Dataproc V1 Client class Job.
A Dataproc job resource.
Generated from protobuf message google.cloud.dataproc.v1.Job
Namespace
Google \ Cloud \ Dataproc \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ reference |
JobReference
Optional. The fully qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a |
↳ placement |
JobPlacement
Required. Job information, including how, when, and where to run the job. |
↳ hadoop_job |
HadoopJob
Optional. Job is a Hadoop job. |
↳ spark_job |
SparkJob
Optional. Job is a Spark job. |
↳ pyspark_job |
PySparkJob
Optional. Job is a PySpark job. |
↳ hive_job |
HiveJob
Optional. Job is a Hive job. |
↳ pig_job |
PigJob
Optional. Job is a Pig job. |
↳ spark_r_job |
SparkRJob
Optional. Job is a SparkR job. |
↳ spark_sql_job |
SparkSqlJob
Optional. Job is a SparkSql job. |
↳ presto_job |
PrestoJob
Optional. Job is a Presto job. |
↳ trino_job |
TrinoJob
Optional. Job is a Trino job. |
↳ flink_job |
FlinkJob
Optional. Job is a Flink job. |
↳ status |
JobStatus
Output only. The job status. Additional application-specific status information might be contained in the |
↳ status_history |
array<JobStatus>
Output only. The previous job status. |
↳ yarn_applications |
array<YarnApplication>
Output only. The collection of YARN applications spun up by this job. Beta Feature: This report is available for testing purposes only. It might be changed before final release. |
↳ driver_output_resource_uri |
string
Output only. A URI pointing to the location of the stdout of the job's driver program. |
↳ driver_control_files_uri |
string
Output only. If present, the location of miscellaneous control files which can be used as part of job setup and handling. If not present, control files might be placed in the same location as |
↳ labels |
array|Google\Protobuf\Internal\MapField
Optional. The labels to associate with this job. Label keys must contain 1 to 63 characters, and must conform to RFC 1035. Label values can be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035. No more than 32 labels can be associated with a job. |
↳ scheduling |
JobScheduling
Optional. Job scheduling configuration. |
↳ job_uuid |
string
Output only. A UUID that uniquely identifies a job within the project over time. This is in contrast to a user-settable reference.job_id that might be reused over time. |
↳ done |
bool
Output only. Indicates whether the job is completed. If the value is |
↳ driver_scheduling_config |
DriverSchedulingConfig
Optional. Driver scheduling configuration. |
getReference
Optional. The fully qualified reference to the job, which can be used to
obtain the equivalent REST path of the job resource. If this property
is not specified when a job is created, the server generates a
job_id.
| Returns | |
|---|---|
| Type | Description |
JobReference|null |
|
hasReference
clearReference
setReference
Optional. The fully qualified reference to the job, which can be used to
obtain the equivalent REST path of the job resource. If this property
is not specified when a job is created, the server generates a
job_id.
| Parameter | |
|---|---|
| Name | Description |
var |
JobReference
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPlacement
Required. Job information, including how, when, and where to run the job.
| Returns | |
|---|---|
| Type | Description |
JobPlacement|null |
|
hasPlacement
clearPlacement
setPlacement
Required. Job information, including how, when, and where to run the job.
| Parameter | |
|---|---|
| Name | Description |
var |
JobPlacement
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getHadoopJob
Optional. Job is a Hadoop job.
| Returns | |
|---|---|
| Type | Description |
HadoopJob|null |
|
hasHadoopJob
setHadoopJob
Optional. Job is a Hadoop job.
| Parameter | |
|---|---|
| Name | Description |
var |
HadoopJob
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSparkJob
Optional. Job is a Spark job.
| Returns | |
|---|---|
| Type | Description |
SparkJob|null |
|
hasSparkJob
setSparkJob
Optional. Job is a Spark job.
| Parameter | |
|---|---|
| Name | Description |
var |
SparkJob
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPysparkJob
Optional. Job is a PySpark job.
| Returns | |
|---|---|
| Type | Description |
PySparkJob|null |
|
hasPysparkJob
setPysparkJob
Optional. Job is a PySpark job.
| Parameter | |
|---|---|
| Name | Description |
var |
PySparkJob
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getHiveJob
Optional. Job is a Hive job.
| Returns | |
|---|---|
| Type | Description |
HiveJob|null |
|
hasHiveJob
setHiveJob
Optional. Job is a Hive job.
| Parameter | |
|---|---|
| Name | Description |
var |
HiveJob
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPigJob
Optional. Job is a Pig job.
| Returns | |
|---|---|
| Type | Description |
PigJob|null |
|
hasPigJob
setPigJob
Optional. Job is a Pig job.
| Parameter | |
|---|---|
| Name | Description |
var |
PigJob
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSparkRJob
Optional. Job is a SparkR job.
| Returns | |
|---|---|
| Type | Description |
SparkRJob|null |
|
hasSparkRJob
setSparkRJob
Optional. Job is a SparkR job.
| Parameter | |
|---|---|
| Name | Description |
var |
SparkRJob
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSparkSqlJob
Optional. Job is a SparkSql job.
| Returns | |
|---|---|
| Type | Description |
SparkSqlJob|null |
|
hasSparkSqlJob
setSparkSqlJob
Optional. Job is a SparkSql job.
| Parameter | |
|---|---|
| Name | Description |
var |
SparkSqlJob
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPrestoJob
Optional. Job is a Presto job.
| Returns | |
|---|---|
| Type | Description |
PrestoJob|null |
|
hasPrestoJob
setPrestoJob
Optional. Job is a Presto job.
| Parameter | |
|---|---|
| Name | Description |
var |
PrestoJob
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTrinoJob
Optional. Job is a Trino job.
| Returns | |
|---|---|
| Type | Description |
TrinoJob|null |
|
hasTrinoJob
setTrinoJob
Optional. Job is a Trino job.
| Parameter | |
|---|---|
| Name | Description |
var |
TrinoJob
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFlinkJob
Optional. Job is a Flink job.
| Returns | |
|---|---|
| Type | Description |
FlinkJob|null |
|
hasFlinkJob
setFlinkJob
Optional. Job is a Flink job.
| Parameter | |
|---|---|
| Name | Description |
var |
FlinkJob
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getStatus
Output only. The job status. Additional application-specific
status information might be contained in the type_job
and yarn_applications fields.
| Returns | |
|---|---|
| Type | Description |
JobStatus|null |
|
hasStatus
clearStatus
setStatus
Output only. The job status. Additional application-specific
status information might be contained in the type_job
and yarn_applications fields.
| Parameter | |
|---|---|
| Name | Description |
var |
JobStatus
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getStatusHistory
Output only. The previous job status.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setStatusHistory
Output only. The previous job status.
| Parameter | |
|---|---|
| Name | Description |
var |
array<JobStatus>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getYarnApplications
Output only. The collection of YARN applications spun up by this job.
Beta Feature: This report is available for testing purposes only. It might be changed before final release.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setYarnApplications
Output only. The collection of YARN applications spun up by this job.
Beta Feature: This report is available for testing purposes only. It might be changed before final release.
| Parameter | |
|---|---|
| Name | Description |
var |
array<YarnApplication>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDriverOutputResourceUri
Output only. A URI pointing to the location of the stdout of the job's driver program.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDriverOutputResourceUri
Output only. A URI pointing to the location of the stdout of the job's driver program.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDriverControlFilesUri
Output only. If present, the location of miscellaneous control files
which can be used as part of job setup and handling. If not present,
control files might be placed in the same location as driver_output_uri.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDriverControlFilesUri
Output only. If present, the location of miscellaneous control files
which can be used as part of job setup and handling. If not present,
control files might be placed in the same location as driver_output_uri.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLabels
Optional. The labels to associate with this job.
Label keys must contain 1 to 63 characters, and must conform to RFC 1035. Label values can be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035. No more than 32 labels can be associated with a job.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField |
|
setLabels
Optional. The labels to associate with this job.
Label keys must contain 1 to 63 characters, and must conform to RFC 1035. Label values can be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035. No more than 32 labels can be associated with a job.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getScheduling
Optional. Job scheduling configuration.
| Returns | |
|---|---|
| Type | Description |
JobScheduling|null |
|
hasScheduling
clearScheduling
setScheduling
Optional. Job scheduling configuration.
| Parameter | |
|---|---|
| Name | Description |
var |
JobScheduling
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getJobUuid
Output only. A UUID that uniquely identifies a job within the project over time. This is in contrast to a user-settable reference.job_id that might be reused over time.
| Returns | |
|---|---|
| Type | Description |
string |
|
setJobUuid
Output only. A UUID that uniquely identifies a job within the project over time. This is in contrast to a user-settable reference.job_id that might be reused over time.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDone
Output only. Indicates whether the job is completed. If the value is
false, the job is still in progress. If true, the job is completed, and
status.state field will indicate if it was successful, failed,
or cancelled.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setDone
Output only. Indicates whether the job is completed. If the value is
false, the job is still in progress. If true, the job is completed, and
status.state field will indicate if it was successful, failed,
or cancelled.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDriverSchedulingConfig
Optional. Driver scheduling configuration.
| Returns | |
|---|---|
| Type | Description |
DriverSchedulingConfig|null |
|
hasDriverSchedulingConfig
clearDriverSchedulingConfig
setDriverSchedulingConfig
Optional. Driver scheduling configuration.
| Parameter | |
|---|---|
| Name | Description |
var |
DriverSchedulingConfig
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTypeJob
| Returns | |
|---|---|
| Type | Description |
string |
|