Method: projects.locations.conversionWorkspaces.searchBackgroundJobs

Searches/lists the background jobs for a specific conversion workspace.

The background jobs are not resources like conversion workspaces or mapping rules, and they can't be created, updated or deleted. Instead, they are a way to expose the data plane jobs log.

HTTP request

GET https://datamigration.googleapis.com/v1/{conversionWorkspace}:searchBackgroundJobs

Path parameters

Parameters
conversionWorkspace

string

Required. Name of the conversion workspace resource whose jobs are listed, in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversionWorkspace}.

Query parameters

Parameters
returnMostRecentPerJobType

boolean

Optional. Whether or not to return just the most recent job per job type,
maxSize

integer

Optional. The maximum number of jobs to return. The service may return fewer than this value. If unspecified, at most 100 jobs are returned. The maximum value is 100; values above 100 are coerced to 100.
completedUntilTime

string (Timestamp format)

Optional. If provided, only returns jobs that completed until (not including) the given timestamp.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

Request body

The request body must be empty.

Response body

Response message for 'conversionWorkspaces.searchBackgroundJobs' request.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "jobs": [
    {
      object (BackgroundJobLogEntry)
    }
  ]
}
Fields
jobs[]

object (BackgroundJobLogEntry)

The list of conversion workspace mapping rules.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

BackgroundJobLogEntry

Execution log of a background job.

JSON representation 
{
  "id": string,
  "jobType": enum (BackgroundJobType),
  "startTime": string,
  "finishTime": string,
  "completionState": enum (JobCompletionState),
  "completionComment": string,
  "requestAutocommit": boolean,

  // Union field job_details can be only one of the following:
  "seedJobDetails": {
    object (SeedJobDetails)
  },
  "importRulesJobDetails": {
    object (ImportRulesJobDetails)
  },
  "convertJobDetails": {
    object (ConvertJobDetails)
  },
  "applyJobDetails": {
    object (ApplyJobDetails)
  }
  // End of list of possible types for union field job_details.
}
Fields
id

string

The background job log entry ID.
jobType

enum (BackgroundJobType)

The type of job that was executed.
startTime

string (Timestamp format)

The timestamp when the background job was started.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
finishTime

string (Timestamp format)

The timestamp when the background job was finished.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
completionState

enum (JobCompletionState)

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

string

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

boolean

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

Union field job_details.

job_details can be only one of the following:
seedJobDetails

object (SeedJobDetails)

Output only. Seed job details.
importRulesJobDetails

object (ImportRulesJobDetails)

Output only. Import rules job details.
convertJobDetails

object (ConvertJobDetails)

Output only. Convert job details.
applyJobDetails

object (ApplyJobDetails)

Output only. Apply job details.

BackgroundJobType

The types of jobs that can be executed in the background.

Enums
BACKGROUND_JOB_TYPE_UNSPECIFIED Unspecified background job type.
BACKGROUND_JOB_TYPE_SOURCE_SEED Job to seed from the source database.
BACKGROUND_JOB_TYPE_CONVERT Job to convert the source database into a draft of the destination database.
BACKGROUND_JOB_TYPE_APPLY_DESTINATION Job to apply the draft tree onto the destination.
BACKGROUND_JOB_TYPE_IMPORT_RULES_FILE Job to import and convert mapping rules from an external source such as an ora2pg config file.

JobCompletionState

Final state after a job completes.

Enums
JOB_COMPLETION_STATE_UNSPECIFIED The status is not specified. This state is used when job is not yet finished.
SUCCEEDED Success.
FAILED Error.

SeedJobDetails

Details regarding a Seed background job.

JSON representation 
{
  "connectionProfile": string
}
Fields
connectionProfile

string

Output only. The connection profile which was used for the seed job.

ImportRulesJobDetails

Details regarding an Import Rules background job.

JSON representation 
{
  "files": [
    string
  ],
  "fileFormat": enum (ImportRulesFileFormat)
}
Fields
files[]

string

Output only. File names used for the import rules job.
fileFormat

enum (ImportRulesFileFormat)

Output only. The requested file format.

ConvertJobDetails

Details regarding a Convert background job.

JSON representation 
{
  "filter": string
}
Fields
filter

string

Output only. AIP-160 based filter used to specify the entities to convert

ApplyJobDetails

Details regarding an Apply background job.

JSON representation 
{
  "connectionProfile": string,
  "filter": string
}
Fields
connectionProfile

string

Output only. The connection profile which was used for the apply job.
filter

string

Output only. AIP-160 based filter used to specify the entities to apply