Google Cloud Dataplex V1 Client - Class JobEvent (0.2.3)

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
NameDescription
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
TypeDescription
string

setMessage

The log message.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getJobId

The unique id identifying the job.

Returns
TypeDescription
string

setJobId

The unique id identifying the job.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getStartTime

The time when the job started running.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasStartTime

clearStartTime

setStartTime

The time when the job started running.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getEndTime

The time when the job ended running.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasEndTime

clearEndTime

setEndTime

The time when the job ended running.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getState

The job state on completion.

Returns
TypeDescription
int

setState

The job state on completion.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getRetries

The number of retries.

Returns
TypeDescription
int

setRetries

The number of retries.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getType

The type of the job.

Returns
TypeDescription
int

setType

The type of the job.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getService

The service used to execute the job.

Returns
TypeDescription
int

setService

The service used to execute the job.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getServiceJob

The reference to the job within the service.

Returns
TypeDescription
string

setServiceJob

The reference to the job within the service.

Parameter
NameDescription
var string
Returns
TypeDescription
$this