clone_jobs

Creates, updates, deletes, gets or lists a clone_jobs resource.

Overview

Name	clone_jobs
Type	Resource
Id	google.vmmigration.clone_jobs

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	Output only. The name of the clone.
computeEngineDisksTargetDetails	object	Output only. Details of the target Persistent Disks in Compute Engine. (id: ComputeEngineDisksTargetDetails)
computeEngineTargetDetails	object	Output only. Details of the target VM in Compute Engine. (id: ComputeEngineTargetDetails)
createTime	string (google-datetime)	Output only. The time the clone job was created (as an API call, not when it was actually created in the target).
endTime	string (google-datetime)	Output only. The time the clone job was ended.
error	object	Output only. Provides details for the errors that led to the Clone Job's state. (id: Status)
state	string	Output only. State of the clone job. (STATE_UNSPECIFIED, PENDING, ACTIVE, FAILED, SUCCEEDED, CANCELLED, CANCELLING, ADAPTING_OS)
stateTime	string (google-datetime)	Output only. The time the state was last updated.
steps	array	Output only. The clone steps list representing its progress.

list

Name	Datatype	Description
name	string	Output only. The name of the clone.
computeEngineDisksTargetDetails	object	Output only. Details of the target Persistent Disks in Compute Engine. (id: ComputeEngineDisksTargetDetails)
computeEngineTargetDetails	object	Output only. Details of the target VM in Compute Engine. (id: ComputeEngineTargetDetails)
createTime	string (google-datetime)	Output only. The time the clone job was created (as an API call, not when it was actually created in the target).
endTime	string (google-datetime)	Output only. The time the clone job was ended.
error	object	Output only. Provides details for the errors that led to the Clone Job's state. (id: Status)
state	string	Output only. State of the clone job. (STATE_UNSPECIFIED, PENDING, ACTIVE, FAILED, SUCCEEDED, CANCELLED, CANCELLING, ADAPTING_OS)
stateTime	string (google-datetime)	Output only. The time the state was last updated.
steps	array	Output only. The clone steps list representing its progress.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, sourcesId, migratingVmsId, cloneJobsId		Gets details of a single CloneJob.
list	select	projectsId, locationsId, sourcesId, migratingVmsId	filter, orderBy, pageSize, pageToken	Lists the CloneJobs of a migrating VM. Only 25 most recent CloneJobs are listed.
create	insert	projectsId, locationsId, sourcesId, migratingVmsId	cloneJobId, requestId	Initiates a Clone of a specific migrating VM.
cancel	exec	projectsId, locationsId, sourcesId, migratingVmsId, cloneJobsId		Initiates the cancellation of a running clone job.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
cloneJobsId	string
locationsId	string
migratingVmsId	string
projectsId	string
sourcesId	string
cloneJobId	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string
requestId	string

SELECT examples

get

Gets details of a single CloneJob.

SELECT
name,
computeEngineDisksTargetDetails,
computeEngineTargetDetails,
createTime,
endTime,
error,
state,
stateTime,
steps
FROM google.vmmigration.clone_jobs
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND sourcesId = '{{ sourcesId }}' -- required
AND migratingVmsId = '{{ migratingVmsId }}' -- required
AND cloneJobsId = '{{ cloneJobsId }}' -- required
;

list

Lists the CloneJobs of a migrating VM. Only 25 most recent CloneJobs are listed.

SELECT
name,
computeEngineDisksTargetDetails,
computeEngineTargetDetails,
createTime,
endTime,
error,
state,
stateTime,
steps
FROM google.vmmigration.clone_jobs
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND sourcesId = '{{ sourcesId }}' -- required
AND migratingVmsId = '{{ migratingVmsId }}' -- required
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}'
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
;

INSERT examples

create

Initiates a Clone of a specific migrating VM.

INSERT INTO google.vmmigration.clone_jobs (
projectsId,
locationsId,
sourcesId,
migratingVmsId,
cloneJobId,
requestId
)
SELECT 
'{{ projectsId }}',
'{{ locationsId }}',
'{{ sourcesId }}',
'{{ migratingVmsId }}',
'{{ cloneJobId }}',
'{{ requestId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: clone_jobs
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the clone_jobs resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the clone_jobs resource.
  - name: sourcesId
    value: "{{ sourcesId }}"
    description: Required parameter for the clone_jobs resource.
  - name: migratingVmsId
    value: "{{ migratingVmsId }}"
    description: Required parameter for the clone_jobs resource.
  - name: cloneJobId
    value: "{{ cloneJobId }}"
  - name: requestId
    value: "{{ requestId }}"

Lifecycle Methods

cancel

Initiates the cancellation of a running clone job.

EXEC google.vmmigration.clone_jobs.cancel 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@sourcesId='{{ sourcesId }}' --required, 
@migratingVmsId='{{ migratingVmsId }}' --required, 
@cloneJobsId='{{ cloneJobsId }}' --required
;