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
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
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
Job completion state, i.e. the final state after the job completed. |
↳ completion_comment |
string
Job completion comment, such as how many entities were seeded, how many warnings were found during conversion, and similar information. |
↳ request_autocommit |
bool
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
Seed job details. |
↳ import_rules_job_details |
Google\Cloud\CloudDms\V1\BackgroundJobLogEntry\ImportRulesJobDetails
Import rules job details. |
↳ convert_job_details |
Google\Cloud\CloudDms\V1\BackgroundJobLogEntry\ConvertJobDetails
Convert job details. |
↳ apply_job_details |
Google\Cloud\CloudDms\V1\BackgroundJobLogEntry\ApplyJobDetails
Apply job details. |
getId
The background job log entry ID.
| Returns | |
|---|---|
| Type | Description |
string | |
setId
The background job log entry ID.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getJobType
The type of job that was executed.
| Returns | |
|---|---|
| Type | Description |
int | |
setJobType
The type of job that was executed.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getStartTime
The timestamp when the background job was started.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasStartTime
clearStartTime
setStartTime
The timestamp when the background job was started.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getFinishTime
The timestamp when the background job was finished.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasFinishTime
clearFinishTime
setFinishTime
The timestamp when the background job was finished.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCompletionState
Job completion state, i.e. the final state after the job completed.
| Returns | |
|---|---|
| Type | Description |
int | |
setCompletionState
Job completion state, i.e. the final state after the job completed.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCompletionComment
Job completion comment, such as how many entities were seeded, how many warnings were found during conversion, and similar information.
| Returns | |
|---|---|
| Type | Description |
string | |
setCompletionComment
Job completion comment, such as how many entities were seeded, how many warnings were found during conversion, and similar information.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getRequestAutocommit
Whether the client requested the conversion workspace to be committed after a successful completion of the job.
| Returns | |
|---|---|
| Type | Description |
bool | |
setRequestAutocommit
Whether the client requested the conversion workspace to be committed after a successful completion of the job.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSeedJobDetails
Seed job details.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\CloudDms\V1\BackgroundJobLogEntry\SeedJobDetails|null | |
hasSeedJobDetails
setSeedJobDetails
Seed job details.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\CloudDms\V1\BackgroundJobLogEntry\SeedJobDetails
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getImportRulesJobDetails
Import rules job details.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\CloudDms\V1\BackgroundJobLogEntry\ImportRulesJobDetails|null | |
hasImportRulesJobDetails
setImportRulesJobDetails
Import rules job details.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\CloudDms\V1\BackgroundJobLogEntry\ImportRulesJobDetails
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getConvertJobDetails
Convert job details.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\CloudDms\V1\BackgroundJobLogEntry\ConvertJobDetails|null | |
hasConvertJobDetails
setConvertJobDetails
Convert job details.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\CloudDms\V1\BackgroundJobLogEntry\ConvertJobDetails
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getApplyJobDetails
Apply job details.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\CloudDms\V1\BackgroundJobLogEntry\ApplyJobDetails|null | |
hasApplyJobDetails
setApplyJobDetails
Apply job details.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\CloudDms\V1\BackgroundJobLogEntry\ApplyJobDetails
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getJobDetails
| Returns | |
|---|---|
| Type | Description |
string | |