Google Cloud Dataproc V1 Client - Class Job (3.2.2)

Version 3.2.2

• 3.14.0 (latest)
• 3.13.4
• 3.12.0
• 3.11.0
• 3.10.1
• 3.9.0
• 3.8.1
• 3.7.1
• 3.6.1
• 3.5.1
• 3.4.0
• 3.3.0
• 3.2.2
• 2.1.0
• 2.0.0

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

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ reference	Google\Cloud\Dataproc\V1\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 job_id.
↳ placement	Google\Cloud\Dataproc\V1\JobPlacement Required. Job information, including how, when, and where to run the job.
↳ hadoop_job	Google\Cloud\Dataproc\V1\HadoopJob Optional. Job is a Hadoop job.
↳ spark_job	Google\Cloud\Dataproc\V1\SparkJob Optional. Job is a Spark job.
↳ pyspark_job	Google\Cloud\Dataproc\V1\PySparkJob Optional. Job is a PySpark job.
↳ hive_job	Google\Cloud\Dataproc\V1\HiveJob Optional. Job is a Hive job.
↳ pig_job	Google\Cloud\Dataproc\V1\PigJob Optional. Job is a Pig job.
↳ spark_r_job	Google\Cloud\Dataproc\V1\SparkRJob Optional. Job is a SparkR job.
↳ spark_sql_job	Google\Cloud\Dataproc\V1\SparkSqlJob Optional. Job is a SparkSql job.
↳ presto_job	Google\Cloud\Dataproc\V1\PrestoJob Optional. Job is a Presto job.
↳ status	Google\Cloud\Dataproc\V1\JobStatus Output only. The job status. Additional application-specific status information may be contained in the type_job and yarn_applications fields.
↳ status_history	array<Google\Cloud\Dataproc\V1\JobStatus> Output only. The previous job status.
↳ yarn_applications	array<Google\Cloud\Dataproc\V1\YarnApplication> Output only. The collection of YARN applications spun up by this job. Beta Feature: This report is available for testing purposes only. It may 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 may be used as part of job setup and handling. If not present, control files may be placed in the same location as driver_output_uri.
↳ 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 may 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	Google\Cloud\Dataproc\V1\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 may be reused over time.
↳ done	bool 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.

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.

Generated from protobuf field .google.cloud.dataproc.v1.JobReference reference = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Google\Cloud\Dataproc\V1\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.

Generated from protobuf field .google.cloud.dataproc.v1.JobReference reference = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
var	Google\Cloud\Dataproc\V1\JobReference

Returns
Type	Description
$this

getPlacement

Required. Job information, including how, when, and where to run the job.

Generated from protobuf field .google.cloud.dataproc.v1.JobPlacement placement = 2 [(.google.api.field_behavior) = REQUIRED];

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

hasPlacement

clearPlacement

setPlacement

Required. Job information, including how, when, and where to run the job.

Generated from protobuf field .google.cloud.dataproc.v1.JobPlacement placement = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
var	Google\Cloud\Dataproc\V1\JobPlacement

Returns
Type	Description
$this

getHadoopJob

Optional. Job is a Hadoop job.

Generated from protobuf field .google.cloud.dataproc.v1.HadoopJob hadoop_job = 3 [(.google.api.field_behavior) = OPTIONAL];

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

hasHadoopJob

setHadoopJob

Optional. Job is a Hadoop job.

Generated from protobuf field .google.cloud.dataproc.v1.HadoopJob hadoop_job = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
var	Google\Cloud\Dataproc\V1\HadoopJob

Returns
Type	Description
$this

getSparkJob

Optional. Job is a Spark job.

Generated from protobuf field .google.cloud.dataproc.v1.SparkJob spark_job = 4 [(.google.api.field_behavior) = OPTIONAL];

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

hasSparkJob

setSparkJob

Optional. Job is a Spark job.

Generated from protobuf field .google.cloud.dataproc.v1.SparkJob spark_job = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
var	Google\Cloud\Dataproc\V1\SparkJob

Returns
Type	Description
$this

getPysparkJob

Optional. Job is a PySpark job.

Generated from protobuf field .google.cloud.dataproc.v1.PySparkJob pyspark_job = 5 [(.google.api.field_behavior) = OPTIONAL];

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

hasPysparkJob

setPysparkJob

Optional. Job is a PySpark job.

Generated from protobuf field .google.cloud.dataproc.v1.PySparkJob pyspark_job = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
var	Google\Cloud\Dataproc\V1\PySparkJob

Returns
Type	Description
$this

getHiveJob

Optional. Job is a Hive job.

Generated from protobuf field .google.cloud.dataproc.v1.HiveJob hive_job = 6 [(.google.api.field_behavior) = OPTIONAL];

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

hasHiveJob

setHiveJob

Optional. Job is a Hive job.

Generated from protobuf field .google.cloud.dataproc.v1.HiveJob hive_job = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
var	Google\Cloud\Dataproc\V1\HiveJob

Returns
Type	Description
$this

getPigJob

Optional. Job is a Pig job.

Generated from protobuf field .google.cloud.dataproc.v1.PigJob pig_job = 7 [(.google.api.field_behavior) = OPTIONAL];

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

hasPigJob

setPigJob

Optional. Job is a Pig job.

Generated from protobuf field .google.cloud.dataproc.v1.PigJob pig_job = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
var	Google\Cloud\Dataproc\V1\PigJob

Returns
Type	Description
$this

getSparkRJob

Optional. Job is a SparkR job.

Generated from protobuf field .google.cloud.dataproc.v1.SparkRJob spark_r_job = 21 [(.google.api.field_behavior) = OPTIONAL];

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

hasSparkRJob

setSparkRJob

Optional. Job is a SparkR job.

Generated from protobuf field .google.cloud.dataproc.v1.SparkRJob spark_r_job = 21 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
var	Google\Cloud\Dataproc\V1\SparkRJob

Returns
Type	Description
$this

getSparkSqlJob

Optional. Job is a SparkSql job.

Generated from protobuf field .google.cloud.dataproc.v1.SparkSqlJob spark_sql_job = 12 [(.google.api.field_behavior) = OPTIONAL];

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

hasSparkSqlJob

setSparkSqlJob

Optional. Job is a SparkSql job.

Generated from protobuf field .google.cloud.dataproc.v1.SparkSqlJob spark_sql_job = 12 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
var	Google\Cloud\Dataproc\V1\SparkSqlJob

Returns
Type	Description
$this

getPrestoJob

Optional. Job is a Presto job.

Generated from protobuf field .google.cloud.dataproc.v1.PrestoJob presto_job = 23 [(.google.api.field_behavior) = OPTIONAL];

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

hasPrestoJob

setPrestoJob

Optional. Job is a Presto job.

Generated from protobuf field .google.cloud.dataproc.v1.PrestoJob presto_job = 23 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
var	Google\Cloud\Dataproc\V1\PrestoJob

Returns
Type	Description
$this

getStatus

Output only. The job status. Additional application-specific status information may be contained in the type_job and yarn_applications fields.

Generated from protobuf field .google.cloud.dataproc.v1.JobStatus status = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

hasStatus

clearStatus

setStatus

Output only. The job status. Additional application-specific status information may be contained in the type_job and yarn_applications fields.

Generated from protobuf field .google.cloud.dataproc.v1.JobStatus status = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
var	Google\Cloud\Dataproc\V1\JobStatus

Returns
Type	Description
$this

getStatusHistory

Output only. The previous job status.

Generated from protobuf field repeated .google.cloud.dataproc.v1.JobStatus status_history = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setStatusHistory

Output only. The previous job status.

Generated from protobuf field repeated .google.cloud.dataproc.v1.JobStatus status_history = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
var	array<Google\Cloud\Dataproc\V1\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 may be changed before final release.

Generated from protobuf field repeated .google.cloud.dataproc.v1.YarnApplication yarn_applications = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

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 may be changed before final release.

Generated from protobuf field repeated .google.cloud.dataproc.v1.YarnApplication yarn_applications = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
var	array<Google\Cloud\Dataproc\V1\YarnApplication>

Returns
Type	Description
$this

getDriverOutputResourceUri

Output only. A URI pointing to the location of the stdout of the job's driver program.

Generated from protobuf field string driver_output_resource_uri = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
string

setDriverOutputResourceUri

Output only. A URI pointing to the location of the stdout of the job's driver program.

Generated from protobuf field string driver_output_resource_uri = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getDriverControlFilesUri

Output only. If present, the location of miscellaneous control files which may be used as part of job setup and handling. If not present, control files may be placed in the same location as driver_output_uri.

Generated from protobuf field string driver_control_files_uri = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
string

setDriverControlFilesUri

Output only. If present, the location of miscellaneous control files which may be used as part of job setup and handling. If not present, control files may be placed in the same location as driver_output_uri.

Generated from protobuf field string driver_control_files_uri = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

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 may 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.

Generated from protobuf field map<string, string> labels = 18 [(.google.api.field_behavior) = OPTIONAL];

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 may 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.

Generated from protobuf field map<string, string> labels = 18 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
var	array|Google\Protobuf\Internal\MapField

Returns
Type	Description
$this

getScheduling

Optional. Job scheduling configuration.

Generated from protobuf field .google.cloud.dataproc.v1.JobScheduling scheduling = 20 [(.google.api.field_behavior) = OPTIONAL];

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

hasScheduling

clearScheduling

setScheduling

Optional. Job scheduling configuration.

Generated from protobuf field .google.cloud.dataproc.v1.JobScheduling scheduling = 20 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
var	Google\Cloud\Dataproc\V1\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 may be reused over time.

Generated from protobuf field string job_uuid = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];

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 may be reused over time.

Generated from protobuf field string job_uuid = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];

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.

Generated from protobuf field bool done = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];

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.

Generated from protobuf field bool done = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
var	bool

Returns
Type	Description
$this

getTypeJob

Returns
Type	Description
string