disk_migration_jobs

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

Overview

Name	disk_migration_jobs
Type	Resource
Id	google.vmmigration.disk_migration_jobs

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	Output only. Identifier. The identifier of the DiskMigrationJob.
awsSourceDiskDetails	object	Details of the unattached AWS source disk. (id: AwsSourceDiskDetails)
createTime	string (google-datetime)	Output only. The time the DiskMigrationJob resource was created.
errors	array	Output only. Provides details on the errors that led to the disk migration job's state in case of an error.
state	string	Output only. State of the DiskMigrationJob.
steps	array	Output only. The disk migration steps list representing its progress.
targetDetails	object	Required. Details of the target Disk in Compute Engine. (id: DiskMigrationJobTargetDetails)
updateTime	string (google-datetime)	Output only. The last time the DiskMigrationJob resource was updated.

list

Name	Datatype	Description
name	string	Output only. Identifier. The identifier of the DiskMigrationJob.
awsSourceDiskDetails	object	Details of the unattached AWS source disk. (id: AwsSourceDiskDetails)
createTime	string (google-datetime)	Output only. The time the DiskMigrationJob resource was created.
errors	array	Output only. Provides details on the errors that led to the disk migration job's state in case of an error.
state	string	Output only. State of the DiskMigrationJob.
steps	array	Output only. The disk migration steps list representing its progress.
targetDetails	object	Required. Details of the target Disk in Compute Engine. (id: DiskMigrationJobTargetDetails)
updateTime	string (google-datetime)	Output only. The last time the DiskMigrationJob resource was updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, sourcesId, diskMigrationJobsId		Gets details of a single DiskMigrationJob.
list	select	projectsId, locationsId, sourcesId	pageSize, pageToken, filter, orderBy	Lists DiskMigrationJobs in a given Source.
create	insert	projectsId, locationsId, sourcesId	diskMigrationJobId, requestId	Creates a new disk migration job in a given Source.
patch	update	projectsId, locationsId, sourcesId, diskMigrationJobsId	updateMask, requestId	Updates the parameters of a single DiskMigrationJob.
delete	delete	projectsId, locationsId, sourcesId, diskMigrationJobsId		Deletes a single DiskMigrationJob.
run	exec	projectsId, locationsId, sourcesId, diskMigrationJobsId		Runs the disk migration job.
cancel	exec	projectsId, locationsId, sourcesId, diskMigrationJobsId		Cancels the disk migration 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
diskMigrationJobsId	string
locationsId	string
projectsId	string
sourcesId	string
diskMigrationJobId	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string
requestId	string
updateMask	string (google-fieldmask)

SELECT examples

get

Gets details of a single DiskMigrationJob.

SELECT
name,
awsSourceDiskDetails,
createTime,
errors,
state,
steps,
targetDetails,
updateTime
FROM google.vmmigration.disk_migration_jobs
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND sourcesId = '{{ sourcesId }}' -- required
AND diskMigrationJobsId = '{{ diskMigrationJobsId }}' -- required
;

list

Lists DiskMigrationJobs in a given Source.

SELECT
name,
awsSourceDiskDetails,
createTime,
errors,
state,
steps,
targetDetails,
updateTime
FROM google.vmmigration.disk_migration_jobs
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND sourcesId = '{{ sourcesId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}'
;

INSERT examples

create

Creates a new disk migration job in a given Source.

INSERT INTO google.vmmigration.disk_migration_jobs (
data__awsSourceDiskDetails,
data__targetDetails,
projectsId,
locationsId,
sourcesId,
diskMigrationJobId,
requestId
)
SELECT 
'{{ awsSourceDiskDetails }}',
'{{ targetDetails }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ sourcesId }}',
'{{ diskMigrationJobId }}',
'{{ requestId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: disk_migration_jobs
  props:
    - name: projectsId
      value: string
      description: Required parameter for the disk_migration_jobs resource.
    - name: locationsId
      value: string
      description: Required parameter for the disk_migration_jobs resource.
    - name: sourcesId
      value: string
      description: Required parameter for the disk_migration_jobs resource.
    - name: awsSourceDiskDetails
      value: object
      description: >
        Details of the unattached AWS source disk.
        
    - name: targetDetails
      value: object
      description: >
        Required. Details of the target Disk in Compute Engine.
        
    - name: diskMigrationJobId
      value: string
    - name: requestId
      value: string

UPDATE examples

patch

Updates the parameters of a single DiskMigrationJob.

UPDATE google.vmmigration.disk_migration_jobs
SET 
data__awsSourceDiskDetails = '{{ awsSourceDiskDetails }}',
data__targetDetails = '{{ targetDetails }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND sourcesId = '{{ sourcesId }}' --required
AND diskMigrationJobsId = '{{ diskMigrationJobsId }}' --required
AND updateMask = '{{ updateMask}}'
AND requestId = '{{ requestId}}'
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

delete

Deletes a single DiskMigrationJob.

DELETE FROM google.vmmigration.disk_migration_jobs
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND sourcesId = '{{ sourcesId }}' --required
AND diskMigrationJobsId = '{{ diskMigrationJobsId }}' --required
;

Lifecycle Methods

run

Runs the disk migration job.

EXEC google.vmmigration.disk_migration_jobs.run 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@sourcesId='{{ sourcesId }}' --required, 
@diskMigrationJobsId='{{ diskMigrationJobsId }}' --required
;

cancel

Cancels the disk migration job.

EXEC google.vmmigration.disk_migration_jobs.cancel 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@sourcesId='{{ sourcesId }}' --required, 
@diskMigrationJobsId='{{ diskMigrationJobsId }}' --required
;