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
↳ 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.
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];
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];
$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];
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];
$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];
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];
$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];
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];
$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];
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];
$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];
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];
$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];
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];
$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];
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];
$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];
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];
$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];
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];
$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];
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];
$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];
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];
$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.
Generated from protobuf field repeated .google.cloud.dataproc.v1.YarnApplication yarn_applications = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
Google\Protobuf\Internal\RepeatedField
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.
Generated from protobuf field repeated .google.cloud.dataproc.v1.YarnApplication yarn_applications = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
$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];
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];
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
.
Generated from protobuf field string driver_control_files_uri = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
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];
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.
Generated from protobuf field map<string, string> labels = 18 [(.google.api.field_behavior) = OPTIONAL];
Google\Protobuf\Internal\MapField
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.
Generated from protobuf field map<string, string> labels = 18 [(.google.api.field_behavior) = OPTIONAL];
var
array|Google\Protobuf\Internal\MapField
$this
getScheduling
Optional. Job scheduling configuration.
Generated from protobuf field .google.cloud.dataproc.v1.JobScheduling scheduling = 20 [(.google.api.field_behavior) = OPTIONAL];
hasScheduling
clearScheduling
setScheduling
Optional. Job scheduling configuration.
Generated from protobuf field .google.cloud.dataproc.v1.JobScheduling scheduling = 20 [(.google.api.field_behavior) = OPTIONAL];
$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];
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];
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.
Generated from protobuf field bool done = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];
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];
var
bool
$this
getTypeJob
string
