Google Cloud Dataplex V1 Client - Class Job (0.1.6)

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

Methods

__construct

Constructor.

Parameters
Name	Description
`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.

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

Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = {

Returns
Type	Description
`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}.

Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = {

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getUid

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

Generated from protobuf field string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`string`

setUid

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

Generated from protobuf field string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getStartTime

Output only. The time when the job was started.

Generated from protobuf field .google.protobuf.Timestamp start_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

hasStartTime

clearStartTime

setStartTime

Output only. The time when the job was started.

Generated from protobuf field .google.protobuf.Timestamp start_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

Returns
Type	Description
`$this`

getEndTime

Output only. The time when the job ended.

Generated from protobuf field .google.protobuf.Timestamp end_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

hasEndTime

clearEndTime

setEndTime

Output only. The time when the job ended.

Generated from protobuf field .google.protobuf.Timestamp end_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

Returns
Type	Description
`$this`

getState

Output only. Execution state for the job.

Generated from protobuf field .google.cloud.dataplex.v1.Job.State state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`int`

setState

Output only. Execution state for the job.

Generated from protobuf field .google.cloud.dataplex.v1.Job.State state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getRetryCount

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

Generated from protobuf field uint32 retry_count = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`int`

setRetryCount

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

Generated from protobuf field uint32 retry_count = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getService

Output only. The underlying service running a job.

Generated from protobuf field .google.cloud.dataplex.v1.Job.Service service = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`int`

setService

Output only. The underlying service running a job.

Generated from protobuf field .google.cloud.dataplex.v1.Job.Service service = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getServiceJob

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

Generated from protobuf field string service_job = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`string`

setServiceJob

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

Generated from protobuf field string service_job = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getMessage

Output only. Additional information about the current state.

Generated from protobuf field string message = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`string`

setMessage

Output only. Additional information about the current state.

Generated from protobuf field string message = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`