Reference documentation and code samples for the Google Cloud Dataplex V1 Client class Job.
A job represents an instance of a task.
Generated from protobuf message google.cloud.dataplex.v1.Job
Namespace
Google \ Cloud \ Dataplex \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Output only. The relative resource name of the job, of the form: |
↳ uid |
string
Output only. System generated globally unique ID for the job. |
↳ start_time |
Google\Protobuf\Timestamp
Output only. The time when the job was started. |
↳ end_time |
Google\Protobuf\Timestamp
Output only. The time when the job ended. |
↳ state |
int
Output only. Execution state for the job. |
↳ retry_count |
int
Output only. The number of times the job has been retried (excluding the initial attempt). |
↳ service |
int
Output only. The underlying service running a job. |
↳ service_job |
string
Output only. The full resource name for the job run under a particular service. |
↳ message |
string
Output only. Additional information about the current state. |
↳ labels |
array|Google\Protobuf\Internal\MapField
Output only. User-defined labels for the task. |
↳ trigger |
int
Output only. Job execution trigger. |
↳ execution_spec |
Google\Cloud\Dataplex\V1\Task\ExecutionSpec
Output only. Spec related to how a task is executed. |
getName
Output only. The relative resource name of the job, of the form:
projects/{project_number}/locations/{location_id}/lakes/{lake_id}/tasks/{task_id}/jobs/{job_id}.
| Returns | |
|---|---|
| Type | Description |
string | |
setName
Output only. The relative resource name of the job, of the form:
projects/{project_number}/locations/{location_id}/lakes/{lake_id}/tasks/{task_id}/jobs/{job_id}.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUid
Output only. System generated globally unique ID for the job.
| Returns | |
|---|---|
| Type | Description |
string | |
setUid
Output only. System generated globally unique ID for the job.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getStartTime
Output only. The time when the job was started.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasStartTime
clearStartTime
setStartTime
Output only. The time when the job was started.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getEndTime
Output only. The time when the job ended.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasEndTime
clearEndTime
setEndTime
Output only. The time when the job ended.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getState
Output only. Execution state for the job.
| Returns | |
|---|---|
| Type | Description |
int | |
setState
Output only. Execution state for the job.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getRetryCount
Output only. The number of times the job has been retried (excluding the initial attempt).
| Returns | |
|---|---|
| Type | Description |
int | |
setRetryCount
Output only. The number of times the job has been retried (excluding the initial attempt).
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getService
Output only. The underlying service running a job.
| Returns | |
|---|---|
| Type | Description |
int | |
setService
Output only. The underlying service running a job.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getServiceJob
Output only. The full resource name for the job run under a particular service.
| Returns | |
|---|---|
| Type | Description |
string | |
setServiceJob
Output only. The full resource name for the job run under a particular service.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getMessage
Output only. Additional information about the current state.
| Returns | |
|---|---|
| Type | Description |
string | |
setMessage
Output only. Additional information about the current state.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getLabels
Output only. User-defined labels for the task.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField | |
setLabels
Output only. User-defined labels for the task.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getTrigger
Output only. Job execution trigger.
| Returns | |
|---|---|
| Type | Description |
int | |
setTrigger
Output only. Job execution trigger.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getExecutionSpec
Output only. Spec related to how a task is executed.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dataplex\V1\Task\ExecutionSpec|null | |
hasExecutionSpec
clearExecutionSpec
setExecutionSpec
Output only. Spec related to how a task is executed.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Dataplex\V1\Task\ExecutionSpec
|
| Returns | |
|---|---|
| Type | Description |
$this | |