Reference documentation and code samples for the Google Cloud Dataplex V1 Client class JobEvent.
The payload associated with Job logs that contains events describing jobs that have run within a Lake.
Generated from protobuf message google.cloud.dataplex.v1.JobEvent
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ message |
string
The log message. |
↳ job_id |
string
The unique id identifying the job. |
↳ start_time |
Google\Protobuf\Timestamp
The time when the job started running. |
↳ end_time |
Google\Protobuf\Timestamp
The time when the job ended running. |
↳ state |
int
The job state on completion. |
↳ retries |
int
The number of retries. |
↳ type |
int
The type of the job. |
↳ service |
int
The service used to execute the job. |
↳ service_job |
string
The reference to the job within the service. |
getMessage
The log message.
| Returns | |
|---|---|
| Type | Description |
string | |
setMessage
The log message.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getJobId
The unique id identifying the job.
| Returns | |
|---|---|
| Type | Description |
string | |
setJobId
The unique id identifying the job.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getStartTime
The time when the job started running.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasStartTime
clearStartTime
setStartTime
The time when the job started running.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getEndTime
The time when the job ended running.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasEndTime
clearEndTime
setEndTime
The time when the job ended running.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getState
The job state on completion.
| Returns | |
|---|---|
| Type | Description |
int | |
setState
The job state on completion.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getRetries
The number of retries.
| Returns | |
|---|---|
| Type | Description |
int | |
setRetries
The number of retries.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getType
The type of the job.
| Returns | |
|---|---|
| Type | Description |
int | |
setType
The type of the job.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getService
The service used to execute the job.
| Returns | |
|---|---|
| Type | Description |
int | |
setService
The service used to execute the job.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getServiceJob
The reference to the job within the service.
| Returns | |
|---|---|
| Type | Description |
string | |
setServiceJob
The reference to the job within the service.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |