Google Cloud Dataplex V1 Client - Class Job (0.11.1)

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 \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

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}.

↳ 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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$this

getUid

Output only. System generated globally unique ID for the job.

Returns
TypeDescription
string

setUid

Output only. System generated globally unique ID for the job.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getStartTime

Output only. The time when the job was started.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasStartTime

clearStartTime

setStartTime

Output only. The time when the job was started.

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

getEndTime

Output only. The time when the job ended.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasEndTime

clearEndTime

setEndTime

Output only. The time when the job ended.

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

getState

Output only. Execution state for the job.

Returns
TypeDescription
int

setState

Output only. Execution state for the job.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getRetryCount

Output only. The number of times the job has been retried (excluding the initial attempt).

Returns
TypeDescription
int

setRetryCount

Output only. The number of times the job has been retried (excluding the initial attempt).

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getService

Output only. The underlying service running a job.

Returns
TypeDescription
int

setService

Output only. The underlying service running a job.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getServiceJob

Output only. The full resource name for the job run under a particular service.

Returns
TypeDescription
string

setServiceJob

Output only. The full resource name for the job run under a particular service.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getMessage

Output only. Additional information about the current state.

Returns
TypeDescription
string

setMessage

Output only. Additional information about the current state.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getLabels

Output only. User-defined labels for the task.

Returns
TypeDescription
Google\Protobuf\Internal\MapField

setLabels

Output only. User-defined labels for the task.

Parameter
NameDescription
var array|Google\Protobuf\Internal\MapField
Returns
TypeDescription
$this

getTrigger

Output only. Job execution trigger.

Returns
TypeDescription
int

setTrigger

Output only. Job execution trigger.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getExecutionSpec

Output only. Spec related to how a task is executed.

Returns
TypeDescription
Google\Cloud\Dataplex\V1\Task\ExecutionSpec|null

hasExecutionSpec

clearExecutionSpec

setExecutionSpec

Output only. Spec related to how a task is executed.

Parameter
NameDescription
var Google\Cloud\Dataplex\V1\Task\ExecutionSpec
Returns
TypeDescription
$this