Reference documentation and code samples for the Google Cloud Dataproc V1 Client class OrderedJob.
A job executed by the workflow.
Generated from protobuf message google.cloud.dataproc.v1.OrderedJob
Namespace
Google \ Cloud \ Dataproc \ V1Methods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ step_id |
string
Required. The step id. The id must be unique among all jobs within the template. The step id is used as prefix for job id, as 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. |
↳ trino_job |
Google\Cloud\Dataproc\V1\TrinoJob
Optional. Job is a Trino job. |
↳ flink_job |
Google\Cloud\Dataproc\V1\FlinkJob
Optional. Job is a Flink job. |
↳ labels |
array|Google\Protobuf\Internal\MapField
Optional. The labels to associate with this job. Label keys must be between 1 and 63 characters long, and must conform to the following regular expression: [\p{Ll}\p{Lo}][\p{Ll}\p{Lo}\p{N}-]{0,62} Label values must be between 1 and 63 characters long, and must conform to the following regular expression: [\p{Ll}\p{Lo}\p{N}-]{0,63} No more than 32 labels can be associated with a given job. |
↳ scheduling |
Google\Cloud\Dataproc\V1\JobScheduling
Optional. Job scheduling configuration. |
↳ prerequisite_step_ids |
array
Optional. The optional list of prerequisite job step_ids. If not specified, the job will start at the beginning of workflow. |
getStepId
Required. The step id. The id must be unique among all jobs within the template.
The step id is used as prefix for job id, as job
goog-dataproc-workflow-step-id
label, and in
prerequisiteStepIds
field from other steps.
The id must contain only letters (a-z, A-Z), numbers (0-9),
underscores (_), and hyphens (-). Cannot begin or end with underscore
or hyphen. Must consist of between 3 and 50 characters.
Returns | |
---|---|
Type | Description |
string |
setStepId
Required. The step id. The id must be unique among all jobs within the template.
The step id is used as prefix for job id, as job
goog-dataproc-workflow-step-id
label, and in
prerequisiteStepIds
field from other steps.
The id must contain only letters (a-z, A-Z), numbers (0-9),
underscores (_), and hyphens (-). Cannot begin or end with underscore
or hyphen. Must consist of between 3 and 50 characters.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getHadoopJob
Optional. Job is a Hadoop job.
Returns | |
---|---|
Type | Description |
Google\Cloud\Dataproc\V1\HadoopJob|null |
hasHadoopJob
setHadoopJob
Optional. Job is a Hadoop job.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\Dataproc\V1\HadoopJob
|
Returns | |
---|---|
Type | Description |
$this |
getSparkJob
Optional. Job is a Spark job.
Returns | |
---|---|
Type | Description |
Google\Cloud\Dataproc\V1\SparkJob|null |
hasSparkJob
setSparkJob
Optional. Job is a Spark job.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\Dataproc\V1\SparkJob
|
Returns | |
---|---|
Type | Description |
$this |
getPysparkJob
Optional. Job is a PySpark job.
Returns | |
---|---|
Type | Description |
Google\Cloud\Dataproc\V1\PySparkJob|null |
hasPysparkJob
setPysparkJob
Optional. Job is a PySpark job.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\Dataproc\V1\PySparkJob
|
Returns | |
---|---|
Type | Description |
$this |
getHiveJob
Optional. Job is a Hive job.
Returns | |
---|---|
Type | Description |
Google\Cloud\Dataproc\V1\HiveJob|null |
hasHiveJob
setHiveJob
Optional. Job is a Hive job.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\Dataproc\V1\HiveJob
|
Returns | |
---|---|
Type | Description |
$this |
getPigJob
Optional. Job is a Pig job.
Returns | |
---|---|
Type | Description |
Google\Cloud\Dataproc\V1\PigJob|null |
hasPigJob
setPigJob
Optional. Job is a Pig job.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\Dataproc\V1\PigJob
|
Returns | |
---|---|
Type | Description |
$this |
getSparkRJob
Optional. Job is a SparkR job.
Returns | |
---|---|
Type | Description |
Google\Cloud\Dataproc\V1\SparkRJob|null |
hasSparkRJob
setSparkRJob
Optional. Job is a SparkR job.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\Dataproc\V1\SparkRJob
|
Returns | |
---|---|
Type | Description |
$this |
getSparkSqlJob
Optional. Job is a SparkSql job.
Returns | |
---|---|
Type | Description |
Google\Cloud\Dataproc\V1\SparkSqlJob|null |
hasSparkSqlJob
setSparkSqlJob
Optional. Job is a SparkSql job.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\Dataproc\V1\SparkSqlJob
|
Returns | |
---|---|
Type | Description |
$this |
getPrestoJob
Optional. Job is a Presto job.
Returns | |
---|---|
Type | Description |
Google\Cloud\Dataproc\V1\PrestoJob|null |
hasPrestoJob
setPrestoJob
Optional. Job is a Presto job.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\Dataproc\V1\PrestoJob
|
Returns | |
---|---|
Type | Description |
$this |
getTrinoJob
Optional. Job is a Trino job.
Returns | |
---|---|
Type | Description |
Google\Cloud\Dataproc\V1\TrinoJob|null |
hasTrinoJob
setTrinoJob
Optional. Job is a Trino job.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\Dataproc\V1\TrinoJob
|
Returns | |
---|---|
Type | Description |
$this |
getFlinkJob
Optional. Job is a Flink job.
Returns | |
---|---|
Type | Description |
Google\Cloud\Dataproc\V1\FlinkJob|null |
hasFlinkJob
setFlinkJob
Optional. Job is a Flink job.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\Dataproc\V1\FlinkJob
|
Returns | |
---|---|
Type | Description |
$this |
getLabels
Optional. The labels to associate with this job.
Label keys must be between 1 and 63 characters long, and must conform to the following regular expression: [\p{Ll}\p{Lo}][\p{Ll}\p{Lo}\p{N}-]{0,62} Label values must be between 1 and 63 characters long, and must conform to the following regular expression: [\p{Ll}\p{Lo}\p{N}-]{0,63} No more than 32 labels can be associated with a given job.
Returns | |
---|---|
Type | Description |
Google\Protobuf\Internal\MapField |
setLabels
Optional. The labels to associate with this job.
Label keys must be between 1 and 63 characters long, and must conform to the following regular expression: [\p{Ll}\p{Lo}][\p{Ll}\p{Lo}\p{N}-]{0,62} Label values must be between 1 and 63 characters long, and must conform to the following regular expression: [\p{Ll}\p{Lo}\p{N}-]{0,63} No more than 32 labels can be associated with a given job.
Parameter | |
---|---|
Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
Returns | |
---|---|
Type | Description |
$this |
getScheduling
Optional. Job scheduling configuration.
Returns | |
---|---|
Type | Description |
Google\Cloud\Dataproc\V1\JobScheduling|null |
hasScheduling
clearScheduling
setScheduling
Optional. Job scheduling configuration.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\Dataproc\V1\JobScheduling
|
Returns | |
---|---|
Type | Description |
$this |
getPrerequisiteStepIds
Optional. The optional list of prerequisite job step_ids.
If not specified, the job will start at the beginning of workflow.
Returns | |
---|---|
Type | Description |
Google\Protobuf\Internal\RepeatedField |
setPrerequisiteStepIds
Optional. The optional list of prerequisite job step_ids.
If not specified, the job will start at the beginning of workflow.
Parameter | |
---|---|
Name | Description |
var |
string[]
|
Returns | |
---|---|
Type | Description |
$this |
getJobType
Returns | |
---|---|
Type | Description |
string |