VMMigration

import { VMMigration } from "https://googleapis.deno.dev/v1/vmmigration:v1.ts";

Use the Migrate to Virtual Machines API to programmatically migrate workloads.

class VMMigration {

constructor(client?: CredentialsClient, baseUrl?: string);

async projectsLocationsGet(name: string): Promise<Location>;

async projectsLocationsGroupsAddGroupMigration(group: string, req: AddGroupMigrationRequest): Promise<Operation>;

async projectsLocationsGroupsCreate(

parent: string,

req: Group,

opts?: ProjectsLocationsGroupsCreateOptions,

): Promise<Operation>;

async projectsLocationsGroupsDelete(name: string, opts?: ProjectsLocationsGroupsDeleteOptions): Promise<Operation>;

async projectsLocationsGroupsGet(name: string): Promise<Group>;

async projectsLocationsGroupsList(parent: string, opts?: ProjectsLocationsGroupsListOptions): Promise<ListGroupsResponse>;

async projectsLocationsGroupsPatch(

req: Group,

opts?: ProjectsLocationsGroupsPatchOptions,

): Promise<Operation>;

async projectsLocationsGroupsRemoveGroupMigration(group: string, req: RemoveGroupMigrationRequest): Promise<Operation>;

async projectsLocationsImageImportsCreate(

parent: string,

req: ImageImport,

opts?: ProjectsLocationsImageImportsCreateOptions,

): Promise<Operation>;

async projectsLocationsImageImportsDelete(name: string, opts?: ProjectsLocationsImageImportsDeleteOptions): Promise<Operation>;

async projectsLocationsImageImportsGet(name: string): Promise<ImageImport>;

async projectsLocationsImageImportsImageImportJobsCancel(name: string, req: CancelImageImportJobRequest): Promise<Operation>;

async projectsLocationsImageImportsImageImportJobsGet(name: string): Promise<ImageImportJob>;

async projectsLocationsImageImportsImageImportJobsList(parent: string, opts?: ProjectsLocationsImageImportsImageImportJobsListOptions): Promise<ListImageImportJobsResponse>;

async projectsLocationsImageImportsList(parent: string, opts?: ProjectsLocationsImageImportsListOptions): Promise<ListImageImportsResponse>;

async projectsLocationsList(name: string, opts?: ProjectsLocationsListOptions): Promise<ListLocationsResponse>;

async projectsLocationsOperationsCancel(name: string, req: CancelOperationRequest): Promise<Empty>;

async projectsLocationsOperationsDelete(name: string): Promise<Empty>;

async projectsLocationsOperationsGet(name: string): Promise<Operation>;

async projectsLocationsOperationsList(name: string, opts?: ProjectsLocationsOperationsListOptions): Promise<ListOperationsResponse>;

async projectsLocationsSourcesCreate(

parent: string,

req: Source,

opts?: ProjectsLocationsSourcesCreateOptions,

): Promise<Operation>;

async projectsLocationsSourcesDatacenterConnectorsCreate(

parent: string,

req: DatacenterConnector,

opts?: ProjectsLocationsSourcesDatacenterConnectorsCreateOptions,

): Promise<Operation>;

async projectsLocationsSourcesDatacenterConnectorsDelete(name: string, opts?: ProjectsLocationsSourcesDatacenterConnectorsDeleteOptions): Promise<Operation>;

async projectsLocationsSourcesDatacenterConnectorsGet(name: string): Promise<DatacenterConnector>;

async projectsLocationsSourcesDatacenterConnectorsList(parent: string, opts?: ProjectsLocationsSourcesDatacenterConnectorsListOptions): Promise<ListDatacenterConnectorsResponse>;

async projectsLocationsSourcesDatacenterConnectorsUpgradeAppliance(datacenterConnector: string, req: UpgradeApplianceRequest): Promise<Operation>;

async projectsLocationsSourcesDelete(name: string, opts?: ProjectsLocationsSourcesDeleteOptions): Promise<Operation>;

async projectsLocationsSourcesFetchInventory(source: string, opts?: ProjectsLocationsSourcesFetchInventoryOptions): Promise<FetchInventoryResponse>;

async projectsLocationsSourcesGet(name: string): Promise<Source>;

async projectsLocationsSourcesList(parent: string, opts?: ProjectsLocationsSourcesListOptions): Promise<ListSourcesResponse>;

async projectsLocationsSourcesMigratingVmsCloneJobsCancel(name: string, req: CancelCloneJobRequest): Promise<Operation>;

async projectsLocationsSourcesMigratingVmsCloneJobsCreate(

parent: string,

req: CloneJob,

opts?: ProjectsLocationsSourcesMigratingVmsCloneJobsCreateOptions,

): Promise<Operation>;

async projectsLocationsSourcesMigratingVmsCloneJobsGet(name: string): Promise<CloneJob>;

async projectsLocationsSourcesMigratingVmsCloneJobsList(parent: string, opts?: ProjectsLocationsSourcesMigratingVmsCloneJobsListOptions): Promise<ListCloneJobsResponse>;

async projectsLocationsSourcesMigratingVmsCreate(

parent: string,

req: MigratingVm,

opts?: ProjectsLocationsSourcesMigratingVmsCreateOptions,

): Promise<Operation>;

async projectsLocationsSourcesMigratingVmsCutoverJobsCancel(name: string, req: CancelCutoverJobRequest): Promise<Operation>;

async projectsLocationsSourcesMigratingVmsCutoverJobsCreate(

parent: string,

req: CutoverJob,

opts?: ProjectsLocationsSourcesMigratingVmsCutoverJobsCreateOptions,

): Promise<Operation>;

async projectsLocationsSourcesMigratingVmsCutoverJobsGet(name: string): Promise<CutoverJob>;

async projectsLocationsSourcesMigratingVmsCutoverJobsList(parent: string, opts?: ProjectsLocationsSourcesMigratingVmsCutoverJobsListOptions): Promise<ListCutoverJobsResponse>;

async projectsLocationsSourcesMigratingVmsDelete(name: string): Promise<Operation>;

async projectsLocationsSourcesMigratingVmsFinalizeMigration(migratingVm: string, req: FinalizeMigrationRequest): Promise<Operation>;

async projectsLocationsSourcesMigratingVmsGet(name: string, opts?: ProjectsLocationsSourcesMigratingVmsGetOptions): Promise<MigratingVm>;

async projectsLocationsSourcesMigratingVmsList(parent: string, opts?: ProjectsLocationsSourcesMigratingVmsListOptions): Promise<ListMigratingVmsResponse>;

async projectsLocationsSourcesMigratingVmsPatch(

req: MigratingVm,

opts?: ProjectsLocationsSourcesMigratingVmsPatchOptions,

): Promise<Operation>;

async projectsLocationsSourcesMigratingVmsPauseMigration(migratingVm: string, req: PauseMigrationRequest): Promise<Operation>;

async projectsLocationsSourcesMigratingVmsReplicationCyclesGet(name: string): Promise<ReplicationCycle>;

async projectsLocationsSourcesMigratingVmsReplicationCyclesList(parent: string, opts?: ProjectsLocationsSourcesMigratingVmsReplicationCyclesListOptions): Promise<ListReplicationCyclesResponse>;

async projectsLocationsSourcesMigratingVmsResumeMigration(migratingVm: string, req: ResumeMigrationRequest): Promise<Operation>;

async projectsLocationsSourcesMigratingVmsStartMigration(migratingVm: string, req: StartMigrationRequest): Promise<Operation>;

async projectsLocationsSourcesPatch(

req: Source,

opts?: ProjectsLocationsSourcesPatchOptions,

): Promise<Operation>;

async projectsLocationsSourcesUtilizationReportsCreate(

parent: string,

req: UtilizationReport,

opts?: ProjectsLocationsSourcesUtilizationReportsCreateOptions,

): Promise<Operation>;

async projectsLocationsSourcesUtilizationReportsDelete(name: string, opts?: ProjectsLocationsSourcesUtilizationReportsDeleteOptions): Promise<Operation>;

async projectsLocationsSourcesUtilizationReportsGet(name: string, opts?: ProjectsLocationsSourcesUtilizationReportsGetOptions): Promise<UtilizationReport>;

async projectsLocationsSourcesUtilizationReportsList(parent: string, opts?: ProjectsLocationsSourcesUtilizationReportsListOptions): Promise<ListUtilizationReportsResponse>;

async projectsLocationsTargetProjectsCreate(

parent: string,

req: TargetProject,

opts?: ProjectsLocationsTargetProjectsCreateOptions,

): Promise<Operation>;

async projectsLocationsTargetProjectsDelete(name: string, opts?: ProjectsLocationsTargetProjectsDeleteOptions): Promise<Operation>;

async projectsLocationsTargetProjectsGet(name: string): Promise<TargetProject>;

async projectsLocationsTargetProjectsList(parent: string, opts?: ProjectsLocationsTargetProjectsListOptions): Promise<ListTargetProjectsResponse>;

async projectsLocationsTargetProjectsPatch(

req: TargetProject,

opts?: ProjectsLocationsTargetProjectsPatchOptions,

): Promise<Operation>;

}

§Constructors

new VMMigration(client?: CredentialsClient, baseUrl?: string)

[src]

§Methods

projectsLocationsGet(name: string): Promise<Location>

[src]

Gets information about a location.

@param name

Resource name for the location.

projectsLocationsGroupsAddGroupMigration(group: string, req: AddGroupMigrationRequest): Promise<Operation>

[src]

Adds a MigratingVm to a Group.

@param group

Required. The full path name of the Group to add to.

projectsLocationsGroupsCreate(parent: string, req: Group, opts?: ProjectsLocationsGroupsCreateOptions): Promise<Operation>

[src]

Creates a new Group in a given project and location.

@param parent

Required. The Group's parent.

projectsLocationsGroupsDelete(name: string, opts?: ProjectsLocationsGroupsDeleteOptions): Promise<Operation>

[src]

Deletes a single Group.

@param name

Required. The Group name.

projectsLocationsGroupsGet(name: string): Promise<Group>

[src]

Gets details of a single Group.

@param name

Required. The group name.

projectsLocationsGroupsList(parent: string, opts?: ProjectsLocationsGroupsListOptions): Promise<ListGroupsResponse>

[src]

Lists Groups in a given project and location.

@param parent

Required. The parent, which owns this collection of groups.

projectsLocationsGroupsPatch(name: string, req: Group, opts?: ProjectsLocationsGroupsPatchOptions): Promise<Operation>

[src]

Updates the parameters of a single Group.

@param name

Output only. The Group name.

projectsLocationsGroupsRemoveGroupMigration(group: string, req: RemoveGroupMigrationRequest): Promise<Operation>

[src]

Removes a MigratingVm from a Group.

@param group

Required. The name of the Group.

projectsLocationsImageImportsCreate(parent: string, req: ImageImport, opts?: ProjectsLocationsImageImportsCreateOptions): Promise<Operation>

[src]

Creates a new ImageImport in a given project.

@param parent

Required. The ImageImport's parent.

projectsLocationsImageImportsDelete(name: string, opts?: ProjectsLocationsImageImportsDeleteOptions): Promise<Operation>

[src]

Deletes a single ImageImport.

@param name

Required. The ImageImport name.

projectsLocationsImageImportsGet(name: string): Promise<ImageImport>

[src]

Gets details of a single ImageImport.

@param name

Required. The ImageImport name.

projectsLocationsImageImportsImageImportJobsCancel(name: string, req: CancelImageImportJobRequest): Promise<Operation>

[src]

Initiates the cancellation of a running clone job.

@param name

Required. The image import job id.

projectsLocationsImageImportsImageImportJobsGet(name: string): Promise<ImageImportJob>

[src]

Gets details of a single ImageImportJob.

@param name

Required. The ImageImportJob name.

projectsLocationsImageImportsImageImportJobsList(parent: string, opts?: ProjectsLocationsImageImportsImageImportJobsListOptions): Promise<ListImageImportJobsResponse>

[src]

Lists ImageImportJobs in a given project.

@param parent

Required. The parent, which owns this collection of targets.

projectsLocationsImageImportsList(parent: string, opts?: ProjectsLocationsImageImportsListOptions): Promise<ListImageImportsResponse>

[src]

Lists ImageImports in a given project.

@param parent

Required. The parent, which owns this collection of targets.

projectsLocationsList(name: string, opts?: ProjectsLocationsListOptions): Promise<ListLocationsResponse>

[src]

Lists information about the supported locations for this service.

@param name

The resource that owns the locations collection, if applicable.

projectsLocationsOperationsCancel(name: string, req: CancelOperationRequest): Promise<Empty>

[src]

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

@param name

The name of the operation resource to be cancelled.

projectsLocationsOperationsDelete(name: string): Promise<Empty>

[src]

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

@param name

The name of the operation resource to be deleted.

projectsLocationsOperationsGet(name: string): Promise<Operation>

[src]

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

@param name

The name of the operation resource.

projectsLocationsOperationsList(name: string, opts?: ProjectsLocationsOperationsListOptions): Promise<ListOperationsResponse>

[src]

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

@param name

The name of the operation's parent resource.

projectsLocationsSourcesCreate(parent: string, req: Source, opts?: ProjectsLocationsSourcesCreateOptions): Promise<Operation>

[src]

Creates a new Source in a given project and location.

@param parent

Required. The Source's parent.

projectsLocationsSourcesDatacenterConnectorsCreate(parent: string, req: DatacenterConnector, opts?: ProjectsLocationsSourcesDatacenterConnectorsCreateOptions): Promise<Operation>

[src]

Creates a new DatacenterConnector in a given Source.

@param parent

Required. The DatacenterConnector's parent. Required. The Source in where the new DatacenterConnector will be created. For example: projects/my-project/locations/us-central1/sources/my-source

projectsLocationsSourcesDatacenterConnectorsDelete(name: string, opts?: ProjectsLocationsSourcesDatacenterConnectorsDeleteOptions): Promise<Operation>

[src]

Deletes a single DatacenterConnector.

@param name

Required. The DatacenterConnector name.

projectsLocationsSourcesDatacenterConnectorsGet(name: string): Promise<DatacenterConnector>

[src]

Gets details of a single DatacenterConnector.

@param name

Required. The name of the DatacenterConnector.

projectsLocationsSourcesDatacenterConnectorsList(parent: string, opts?: ProjectsLocationsSourcesDatacenterConnectorsListOptions): Promise<ListDatacenterConnectorsResponse>

[src]

Lists DatacenterConnectors in a given Source.

@param parent

Required. The parent, which owns this collection of connectors.

projectsLocationsSourcesDatacenterConnectorsUpgradeAppliance(datacenterConnector: string, req: UpgradeApplianceRequest): Promise<Operation>

[src]

Upgrades the appliance relate to this DatacenterConnector to the in-place updateable version.

@param datacenterConnector

Required. The DatacenterConnector name.

projectsLocationsSourcesDelete(name: string, opts?: ProjectsLocationsSourcesDeleteOptions): Promise<Operation>

[src]

Deletes a single Source.

@param name

Required. The Source name.

projectsLocationsSourcesFetchInventory(source: string, opts?: ProjectsLocationsSourcesFetchInventoryOptions): Promise<FetchInventoryResponse>

[src]

List remote source's inventory of VMs. The remote source is the onprem vCenter (remote in the sense it's not in Compute Engine). The inventory describes the list of existing VMs in that source. Note that this operation lists the VMs on the remote source, as opposed to listing the MigratingVms resources in the vmmigration service.

@param source

Required. The name of the Source.

projectsLocationsSourcesGet(name: string): Promise<Source>

[src]

Gets details of a single Source.

@param name

Required. The Source name.

projectsLocationsSourcesList(parent: string, opts?: ProjectsLocationsSourcesListOptions): Promise<ListSourcesResponse>

[src]

Lists Sources in a given project and location.

@param parent

Required. The parent, which owns this collection of sources.

projectsLocationsSourcesMigratingVmsCloneJobsCancel(name: string, req: CancelCloneJobRequest): Promise<Operation>

[src]

Initiates the cancellation of a running clone job.

@param name

Required. The clone job id

projectsLocationsSourcesMigratingVmsCloneJobsCreate(parent: string, req: CloneJob, opts?: ProjectsLocationsSourcesMigratingVmsCloneJobsCreateOptions): Promise<Operation>

[src]

Initiates a Clone of a specific migrating VM.

@param parent

Required. The Clone's parent.

projectsLocationsSourcesMigratingVmsCloneJobsGet(name: string): Promise<CloneJob>

[src]

Gets details of a single CloneJob.

@param name

Required. The name of the CloneJob.

projectsLocationsSourcesMigratingVmsCloneJobsList(parent: string, opts?: ProjectsLocationsSourcesMigratingVmsCloneJobsListOptions): Promise<ListCloneJobsResponse>

[src]

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

@param parent

Required. The parent, which owns this collection of source VMs.

projectsLocationsSourcesMigratingVmsCreate(parent: string, req: MigratingVm, opts?: ProjectsLocationsSourcesMigratingVmsCreateOptions): Promise<Operation>

[src]

Creates a new MigratingVm in a given Source.

@param parent

Required. The MigratingVm's parent.

projectsLocationsSourcesMigratingVmsCutoverJobsCancel(name: string, req: CancelCutoverJobRequest): Promise<Operation>

[src]

Initiates the cancellation of a running cutover job.

@param name

Required. The cutover job id

projectsLocationsSourcesMigratingVmsCutoverJobsCreate(parent: string, req: CutoverJob, opts?: ProjectsLocationsSourcesMigratingVmsCutoverJobsCreateOptions): Promise<Operation>

[src]

Initiates a Cutover of a specific migrating VM. The returned LRO is completed when the cutover job resource is created and the job is initiated.

@param parent

Required. The Cutover's parent.

projectsLocationsSourcesMigratingVmsCutoverJobsGet(name: string): Promise<CutoverJob>

[src]

Gets details of a single CutoverJob.

@param name

Required. The name of the CutoverJob.

projectsLocationsSourcesMigratingVmsCutoverJobsList(parent: string, opts?: ProjectsLocationsSourcesMigratingVmsCutoverJobsListOptions): Promise<ListCutoverJobsResponse>

[src]

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

@param parent

Required. The parent, which owns this collection of migrating VMs.

projectsLocationsSourcesMigratingVmsDelete(name: string): Promise<Operation>

[src]

Deletes a single MigratingVm.

@param name

Required. The name of the MigratingVm.

projectsLocationsSourcesMigratingVmsFinalizeMigration(migratingVm: string, req: FinalizeMigrationRequest): Promise<Operation>

[src]

Marks a migration as completed, deleting migration resources that are no longer being used. Only applicable after cutover is done.

@param migratingVm

Required. The name of the MigratingVm.

projectsLocationsSourcesMigratingVmsGet(name: string, opts?: ProjectsLocationsSourcesMigratingVmsGetOptions): Promise<MigratingVm>

[src]

Gets details of a single MigratingVm.

@param name

Required. The name of the MigratingVm.

projectsLocationsSourcesMigratingVmsList(parent: string, opts?: ProjectsLocationsSourcesMigratingVmsListOptions): Promise<ListMigratingVmsResponse>

[src]

Lists MigratingVms in a given Source.

@param parent

Required. The parent, which owns this collection of MigratingVms.

projectsLocationsSourcesMigratingVmsPatch(name: string, req: MigratingVm, opts?: ProjectsLocationsSourcesMigratingVmsPatchOptions): Promise<Operation>

[src]

Updates the parameters of a single MigratingVm.

@param name

Output only. The identifier of the MigratingVm.

projectsLocationsSourcesMigratingVmsPauseMigration(migratingVm: string, req: PauseMigrationRequest): Promise<Operation>

[src]

Pauses a migration for a VM. If cycle tasks are running they will be cancelled, preserving source task data. Further replication cycles will not be triggered while the VM is paused.

@param migratingVm

Required. The name of the MigratingVm.

projectsLocationsSourcesMigratingVmsReplicationCyclesGet(name: string): Promise<ReplicationCycle>

[src]

Gets details of a single ReplicationCycle.

@param name

Required. The name of the ReplicationCycle.

projectsLocationsSourcesMigratingVmsReplicationCyclesList(parent: string, opts?: ProjectsLocationsSourcesMigratingVmsReplicationCyclesListOptions): Promise<ListReplicationCyclesResponse>

[src]

Lists ReplicationCycles in a given MigratingVM.

@param parent

Required. The parent, which owns this collection of ReplicationCycles.

projectsLocationsSourcesMigratingVmsResumeMigration(migratingVm: string, req: ResumeMigrationRequest): Promise<Operation>

[src]

Resumes a migration for a VM. When called on a paused migration, will start the process of uploading data and creating snapshots; when called on a completed cut-over migration, will update the migration to active state and start the process of uploading data and creating snapshots.

@param migratingVm

Required. The name of the MigratingVm.

projectsLocationsSourcesMigratingVmsStartMigration(migratingVm: string, req: StartMigrationRequest): Promise<Operation>

[src]

Starts migration for a VM. Starts the process of uploading data and creating snapshots, in replication cycles scheduled by the policy.

@param migratingVm

Required. The name of the MigratingVm.

projectsLocationsSourcesPatch(name: string, req: Source, opts?: ProjectsLocationsSourcesPatchOptions): Promise<Operation>

[src]

Updates the parameters of a single Source.

@param name

Output only. The Source name.

projectsLocationsSourcesUtilizationReportsCreate(parent: string, req: UtilizationReport, opts?: ProjectsLocationsSourcesUtilizationReportsCreateOptions): Promise<Operation>

[src]

Creates a new UtilizationReport.

@param parent

Required. The Utilization Report's parent.

projectsLocationsSourcesUtilizationReportsDelete(name: string, opts?: ProjectsLocationsSourcesUtilizationReportsDeleteOptions): Promise<Operation>

[src]

Deletes a single Utilization Report.

@param name

Required. The Utilization Report name.

projectsLocationsSourcesUtilizationReportsGet(name: string, opts?: ProjectsLocationsSourcesUtilizationReportsGetOptions): Promise<UtilizationReport>

[src]

Gets a single Utilization Report.

@param name

Required. The Utilization Report name.

projectsLocationsSourcesUtilizationReportsList(parent: string, opts?: ProjectsLocationsSourcesUtilizationReportsListOptions): Promise<ListUtilizationReportsResponse>

[src]

Lists Utilization Reports of the given Source.

@param parent

Required. The Utilization Reports parent.

projectsLocationsTargetProjectsCreate(parent: string, req: TargetProject, opts?: ProjectsLocationsTargetProjectsCreateOptions): Promise<Operation>

[src]

Creates a new TargetProject in a given project. NOTE: TargetProject is a global resource; hence the only supported value for location is global.

@param parent

Required. The TargetProject's parent.

projectsLocationsTargetProjectsDelete(name: string, opts?: ProjectsLocationsTargetProjectsDeleteOptions): Promise<Operation>

[src]

Deletes a single TargetProject. NOTE: TargetProject is a global resource; hence the only supported value for location is global.

@param name

Required. The TargetProject name.

projectsLocationsTargetProjectsGet(name: string): Promise<TargetProject>

[src]

Gets details of a single TargetProject. NOTE: TargetProject is a global resource; hence the only supported value for location is global.

@param name

Required. The TargetProject name.

projectsLocationsTargetProjectsList(parent: string, opts?: ProjectsLocationsTargetProjectsListOptions): Promise<ListTargetProjectsResponse>

[src]

Lists TargetProjects in a given project. NOTE: TargetProject is a global resource; hence the only supported value for location is global.

@param parent

Required. The parent, which owns this collection of targets.

projectsLocationsTargetProjectsPatch(name: string, req: TargetProject, opts?: ProjectsLocationsTargetProjectsPatchOptions): Promise<Operation>

[src]

Updates the parameters of a single TargetProject. NOTE: TargetProject is a global resource; hence the only supported value for location is global.

@param name

Output only. The name of the target project.