Google Cloud Dms V1 Client - Class BackgroundJobLogEntry (1.4.2)

Reference documentation and code samples for the Google Cloud Dms V1 Client class BackgroundJobLogEntry.

Execution log of a background job.

Generated from protobuf message google.cloud.clouddms.v1.BackgroundJobLogEntry

Namespace

Google \ Cloud \ CloudDms \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ id string

The background job log entry ID.

↳ job_type int

The type of job that was executed.

↳ start_time Google\Protobuf\Timestamp

The timestamp when the background job was started.

↳ finish_time Google\Protobuf\Timestamp

The timestamp when the background job was finished.

↳ completion_state int

Output only. Job completion state, i.e. the final state after the job completed.

↳ completion_comment string

Output only. Job completion comment, such as how many entities were seeded, how many warnings were found during conversion, and similar information.

↳ request_autocommit bool

Output only. Whether the client requested the conversion workspace to be committed after a successful completion of the job.

↳ seed_job_details Google\Cloud\CloudDms\V1\BackgroundJobLogEntry\SeedJobDetails

Output only. Seed job details.

↳ import_rules_job_details Google\Cloud\CloudDms\V1\BackgroundJobLogEntry\ImportRulesJobDetails

Output only. Import rules job details.

↳ convert_job_details Google\Cloud\CloudDms\V1\BackgroundJobLogEntry\ConvertJobDetails

Output only. Convert job details.

↳ apply_job_details Google\Cloud\CloudDms\V1\BackgroundJobLogEntry\ApplyJobDetails

Output only. Apply job details.

getId

The background job log entry ID.

Returns
TypeDescription
string

setId

The background job log entry ID.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getJobType

The type of job that was executed.

Returns
TypeDescription
int

setJobType

The type of job that was executed.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getStartTime

The timestamp when the background job was started.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasStartTime

clearStartTime

setStartTime

The timestamp when the background job was started.

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

getFinishTime

The timestamp when the background job was finished.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasFinishTime

clearFinishTime

setFinishTime

The timestamp when the background job was finished.

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

getCompletionState

Output only. Job completion state, i.e. the final state after the job completed.

Returns
TypeDescription
int

setCompletionState

Output only. Job completion state, i.e. the final state after the job completed.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getCompletionComment

Output only. Job completion comment, such as how many entities were seeded, how many warnings were found during conversion, and similar information.

Returns
TypeDescription
string

setCompletionComment

Output only. Job completion comment, such as how many entities were seeded, how many warnings were found during conversion, and similar information.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getRequestAutocommit

Output only. Whether the client requested the conversion workspace to be committed after a successful completion of the job.

Returns
TypeDescription
bool

setRequestAutocommit

Output only. Whether the client requested the conversion workspace to be committed after a successful completion of the job.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getSeedJobDetails

Output only. Seed job details.

Returns
TypeDescription
Google\Cloud\CloudDms\V1\BackgroundJobLogEntry\SeedJobDetails|null

hasSeedJobDetails

setSeedJobDetails

Output only. Seed job details.

Parameter
NameDescription
var Google\Cloud\CloudDms\V1\BackgroundJobLogEntry\SeedJobDetails
Returns
TypeDescription
$this

getImportRulesJobDetails

Output only. Import rules job details.

Returns
TypeDescription
Google\Cloud\CloudDms\V1\BackgroundJobLogEntry\ImportRulesJobDetails|null

hasImportRulesJobDetails

setImportRulesJobDetails

Output only. Import rules job details.

Parameter
NameDescription
var Google\Cloud\CloudDms\V1\BackgroundJobLogEntry\ImportRulesJobDetails
Returns
TypeDescription
$this

getConvertJobDetails

Output only. Convert job details.

Returns
TypeDescription
Google\Cloud\CloudDms\V1\BackgroundJobLogEntry\ConvertJobDetails|null

hasConvertJobDetails

setConvertJobDetails

Output only. Convert job details.

Parameter
NameDescription
var Google\Cloud\CloudDms\V1\BackgroundJobLogEntry\ConvertJobDetails
Returns
TypeDescription
$this

getApplyJobDetails

Output only. Apply job details.

Returns
TypeDescription
Google\Cloud\CloudDms\V1\BackgroundJobLogEntry\ApplyJobDetails|null

hasApplyJobDetails

setApplyJobDetails

Output only. Apply job details.

Parameter
NameDescription
var Google\Cloud\CloudDms\V1\BackgroundJobLogEntry\ApplyJobDetails
Returns
TypeDescription
$this

getJobDetails

Returns
TypeDescription
string