Google Cloud Dataplex V1 Client - Class JobEvent (0.1.6)

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.

Generated from protobuf field string message = 1;

Returns
Type	Description
`string`

setMessage

The log message.

Generated from protobuf field string message = 1;

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getJobId

The unique id identifying the job.

Generated from protobuf field string job_id = 2;

Returns
Type	Description
`string`

setJobId

The unique id identifying the job.

Generated from protobuf field string job_id = 2;

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getStartTime

The time when the job started running.

Generated from protobuf field .google.protobuf.Timestamp start_time = 3;

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasStartTime

clearStartTime

setStartTime

The time when the job started running.

Generated from protobuf field .google.protobuf.Timestamp start_time = 3;

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getEndTime

The time when the job ended running.

Generated from protobuf field .google.protobuf.Timestamp end_time = 4;

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasEndTime

clearEndTime

setEndTime

The time when the job ended running.

Generated from protobuf field .google.protobuf.Timestamp end_time = 4;

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getState

The job state on completion.

Generated from protobuf field .google.cloud.dataplex.v1.JobEvent.State state = 5;

Returns
Type	Description
`int`

setState

The job state on completion.

Generated from protobuf field .google.cloud.dataplex.v1.JobEvent.State state = 5;

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getRetries

The number of retries.

Generated from protobuf field int32 retries = 6;

Returns
Type	Description
`int`

setRetries