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.
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
↳ spark_job
↳ pyspark_job
↳ hive_job
↳ pig_job
↳ spark_r_job
↳ spark_sql_job
↳ presto_job
↳ trino_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
↳ yarn_applications
array< Google\Cloud\Dataproc\V1\YarnApplication
>
Output only. The collection of YARN applications spun up by this job. BetaFeature: 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 keysmust contain 1 to 63 characters, and must conform to RFC 1035 . Label valuesmay 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
↳ 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.
↳ driver_scheduling_config
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
.
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
.
$this
getPlacement
Required. Job information, including how, when, and where to run the job.
hasPlacement
clearPlacement
setPlacement
Required. Job information, including how, when, and where to run the job.
$this
getHadoopJob
Optional. Job is a Hadoop job.
hasHadoopJob
setHadoopJob
Optional. Job is a Hadoop job.
$this
getSparkJob
Optional. Job is a Spark job.
hasSparkJob
setSparkJob
Optional. Job is a Spark job.
$this
getPysparkJob
Optional. Job is a PySpark job.
hasPysparkJob
setPysparkJob
Optional. Job is a PySpark job.
$this
getHiveJob
Optional. Job is a Hive job.
hasHiveJob
setHiveJob
Optional. Job is a Hive job.
$this
getPigJob
Optional. Job is a Pig job.
hasPigJob
setPigJob
Optional. Job is a Pig job.
$this
getSparkRJob
Optional. Job is a SparkR job.
hasSparkRJob
setSparkRJob
Optional. Job is a SparkR job.
$this
getSparkSqlJob
Optional. Job is a SparkSql job.
hasSparkSqlJob
setSparkSqlJob
Optional. Job is a SparkSql job.
$this
getPrestoJob
Optional. Job is a Presto job.
hasPrestoJob
setPrestoJob
Optional. Job is a Presto job.
$this
getTrinoJob
Optional. Job is a Trino job.
hasTrinoJob
setTrinoJob
Optional. Job is a Trino job.
$this
getStatus
Output only. The job status. Additional application-specific
status information may be contained in the type_job
and yarn_applications
fields.
hasStatus
clearStatus
setStatus
Output only. The job status. Additional application-specific
status information may be contained in the type_job
and yarn_applications
fields.
$this
getStatusHistory
Output only. The previous job status.
setStatusHistory
Output only. The previous job status.
$this
getYarnApplications
Output only. The collection of YARN applications spun up by this job.
BetaFeature: This report is available for testing purposes only. It may be changed before final release.
setYarnApplications
Output only. The collection of YARN applications spun up by this job.
BetaFeature: This report is available for testing purposes only. It may be changed before final release.
$this
getDriverOutputResourceUri
Output only. A URI pointing to the location of the stdout of the job's driver program.
string
setDriverOutputResourceUri
Output only. A URI pointing to the location of the stdout of the job's driver program.
var
string
$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
.
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
.
var
string
$this
getLabels
Optional. The labels to associate with this job.
Label keysmust contain 1 to 63 characters, and must conform to RFC 1035 . Label valuesmay 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.
setLabels
Optional. The labels to associate with this job.
Label keysmust contain 1 to 63 characters, and must conform to RFC 1035 . Label valuesmay 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.
$this
getScheduling
Optional. Job scheduling configuration.
hasScheduling
clearScheduling
setScheduling
Optional. Job scheduling configuration.
$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.
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.
var
string
$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.
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.
var
bool
$this
getDriverSchedulingConfig
Optional. Driver scheduling configuration.
hasDriverSchedulingConfig
clearDriverSchedulingConfig
setDriverSchedulingConfig
Optional. Driver scheduling configuration.
$this
getTypeJob
string
