Google Cloud Dataplex V1 Client - Class JobEvent (1.7.1)
Stay organized with collections
Save and categorize content based on your preferences.
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
Namespace
Google \ Cloud \ Dataplex \ V1Methods
__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. |
↳ execution_trigger |
int
Job execution trigger. |
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 |
Enum of type State. |
setState
The job state on completion.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type State. |
| 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 |
Enum of type Type. |
setType
The type of the job.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type Type. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getService
The service used to execute the job.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type Service. |
setService
The service used to execute the job.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type Service. |
| 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 |
|
getExecutionTrigger
Job execution trigger.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type ExecutionTrigger. |
setExecutionTrigger
Job execution trigger.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type ExecutionTrigger. |
| Returns | |
|---|---|
| Type | Description |
$this |
|