VM Migration v1 API - Class VmMigration.VmMigrationBase (2.6.0)

Version latest

• 2.6.0 (latest)
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.0.0

[BindServiceMethod(typeof(VmMigration), "BindService")]
public abstract class VmMigration.VmMigrationBase

Reference documentation and code samples for the VM Migration v1 API class VmMigration.VmMigrationBase.

Base class for server-side implementations of VmMigration

Inheritance

object > VmMigration.VmMigrationBase

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.VMMigration.V1

Assembly

Google.Cloud.VMMigration.V1.dll

Methods

AddGroupMigration(AddGroupMigrationRequest, ServerCallContext)

public virtual Task<Operation> AddGroupMigration(AddGroupMigrationRequest request, ServerCallContext context)

Adds a MigratingVm to a Group.

Parameters
Name	Description
request	AddGroupMigrationRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

CancelCloneJob(CancelCloneJobRequest, ServerCallContext)

public virtual Task<Operation> CancelCloneJob(CancelCloneJobRequest request, ServerCallContext context)

Initiates the cancellation of a running clone job.

Parameters
Name	Description
request	CancelCloneJobRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

CancelCutoverJob(CancelCutoverJobRequest, ServerCallContext)

public virtual Task<Operation> CancelCutoverJob(CancelCutoverJobRequest request, ServerCallContext context)

Initiates the cancellation of a running cutover job.

Parameters
Name	Description
request	CancelCutoverJobRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

CreateCloneJob(CreateCloneJobRequest, ServerCallContext)

public virtual Task<Operation> CreateCloneJob(CreateCloneJobRequest request, ServerCallContext context)

Initiates a Clone of a specific migrating VM.

Parameters
Name	Description
request	CreateCloneJobRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

CreateCutoverJob(CreateCutoverJobRequest, ServerCallContext)

public virtual Task<Operation> CreateCutoverJob(CreateCutoverJobRequest request, ServerCallContext context)

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.

Parameters
Name	Description
request	CreateCutoverJobRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

CreateDatacenterConnector(CreateDatacenterConnectorRequest, ServerCallContext)

public virtual Task<Operation> CreateDatacenterConnector(CreateDatacenterConnectorRequest request, ServerCallContext context)

Creates a new DatacenterConnector in a given Source.

Parameters
Name	Description
request	CreateDatacenterConnectorRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

CreateGroup(CreateGroupRequest, ServerCallContext)

public virtual Task<Operation> CreateGroup(CreateGroupRequest request, ServerCallContext context)

Creates a new Group in a given project and location.

Parameters
Name	Description
request	CreateGroupRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

CreateMigratingVm(CreateMigratingVmRequest, ServerCallContext)

public virtual Task<Operation> CreateMigratingVm(CreateMigratingVmRequest request, ServerCallContext context)

Creates a new MigratingVm in a given Source.

Parameters
Name	Description
request	CreateMigratingVmRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

CreateSource(CreateSourceRequest, ServerCallContext)

public virtual Task<Operation> CreateSource(CreateSourceRequest request, ServerCallContext context)

Creates a new Source in a given project and location.

Parameters
Name	Description
request	CreateSourceRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

CreateTargetProject(CreateTargetProjectRequest, ServerCallContext)

public virtual Task<Operation> CreateTargetProject(CreateTargetProjectRequest request, ServerCallContext context)

Creates a new TargetProject in a given project.

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

Parameters
Name	Description
request	CreateTargetProjectRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

CreateUtilizationReport(CreateUtilizationReportRequest, ServerCallContext)

public virtual Task<Operation> CreateUtilizationReport(CreateUtilizationReportRequest request, ServerCallContext context)

Creates a new UtilizationReport.

Parameters
Name	Description
request	CreateUtilizationReportRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

DeleteDatacenterConnector(DeleteDatacenterConnectorRequest, ServerCallContext)

public virtual Task<Operation> DeleteDatacenterConnector(DeleteDatacenterConnectorRequest request, ServerCallContext context)

Deletes a single DatacenterConnector.

Parameters
Name	Description
request	DeleteDatacenterConnectorRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

DeleteGroup(DeleteGroupRequest, ServerCallContext)

public virtual Task<Operation> DeleteGroup(DeleteGroupRequest request, ServerCallContext context)

Deletes a single Group.

Parameters
Name	Description
request	DeleteGroupRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

DeleteMigratingVm(DeleteMigratingVmRequest, ServerCallContext)

public virtual Task<Operation> DeleteMigratingVm(DeleteMigratingVmRequest request, ServerCallContext context)

Deletes a single MigratingVm.

Parameters
Name	Description
request	DeleteMigratingVmRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

DeleteSource(DeleteSourceRequest, ServerCallContext)

public virtual Task<Operation> DeleteSource(DeleteSourceRequest request, ServerCallContext context)

Deletes a single Source.

Parameters
Name	Description
request	DeleteSourceRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

DeleteTargetProject(DeleteTargetProjectRequest, ServerCallContext)

public virtual Task<Operation> DeleteTargetProject(DeleteTargetProjectRequest request, ServerCallContext context)

Deletes a single TargetProject.

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

Parameters
Name	Description
request	DeleteTargetProjectRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

DeleteUtilizationReport(DeleteUtilizationReportRequest, ServerCallContext)

public virtual Task<Operation> DeleteUtilizationReport(DeleteUtilizationReportRequest request, ServerCallContext context)

Deletes a single Utilization Report.

Parameters
Name	Description
request	DeleteUtilizationReportRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

FetchInventory(FetchInventoryRequest, ServerCallContext)

public virtual Task<FetchInventoryResponse> FetchInventory(FetchInventoryRequest request, ServerCallContext context)

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.

Parameters
Name	Description
request	FetchInventoryRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskFetchInventoryResponse	The response to send back to the client (wrapped by a task).

FinalizeMigration(FinalizeMigrationRequest, ServerCallContext)

public virtual Task<Operation> FinalizeMigration(FinalizeMigrationRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	FinalizeMigrationRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

GetCloneJob(GetCloneJobRequest, ServerCallContext)

public virtual Task<CloneJob> GetCloneJob(GetCloneJobRequest request, ServerCallContext context)

Gets details of a single CloneJob.

Parameters
Name	Description
request	GetCloneJobRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskCloneJob	The response to send back to the client (wrapped by a task).

GetCutoverJob(GetCutoverJobRequest, ServerCallContext)

public virtual Task<CutoverJob> GetCutoverJob(GetCutoverJobRequest request, ServerCallContext context)

Gets details of a single CutoverJob.

Parameters
Name	Description
request	GetCutoverJobRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskCutoverJob	The response to send back to the client (wrapped by a task).

GetDatacenterConnector(GetDatacenterConnectorRequest, ServerCallContext)

public virtual Task<DatacenterConnector> GetDatacenterConnector(GetDatacenterConnectorRequest request, ServerCallContext context)

Gets details of a single DatacenterConnector.

Parameters
Name	Description
request	GetDatacenterConnectorRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskDatacenterConnector	The response to send back to the client (wrapped by a task).

GetGroup(GetGroupRequest, ServerCallContext)

public virtual Task<Group> GetGroup(GetGroupRequest request, ServerCallContext context)

Gets details of a single Group.

Parameters
Name	Description
request	GetGroupRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskGroup	The response to send back to the client (wrapped by a task).

GetMigratingVm(GetMigratingVmRequest, ServerCallContext)

public virtual Task<MigratingVm> GetMigratingVm(GetMigratingVmRequest request, ServerCallContext context)

Gets details of a single MigratingVm.

Parameters
Name	Description
request	GetMigratingVmRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskMigratingVm	The response to send back to the client (wrapped by a task).

GetReplicationCycle(GetReplicationCycleRequest, ServerCallContext)

public virtual Task<ReplicationCycle> GetReplicationCycle(GetReplicationCycleRequest request, ServerCallContext context)

Gets details of a single ReplicationCycle.

Parameters
Name	Description
request	GetReplicationCycleRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskReplicationCycle	The response to send back to the client (wrapped by a task).

GetSource(GetSourceRequest, ServerCallContext)

public virtual Task<Source> GetSource(GetSourceRequest request, ServerCallContext context)

Gets details of a single Source.

Parameters
Name	Description
request	GetSourceRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskSource	The response to send back to the client (wrapped by a task).

GetTargetProject(GetTargetProjectRequest, ServerCallContext)

public virtual Task<TargetProject> GetTargetProject(GetTargetProjectRequest request, ServerCallContext context)

Gets details of a single TargetProject.

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

Parameters
Name	Description
request	GetTargetProjectRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskTargetProject	The response to send back to the client (wrapped by a task).

GetUtilizationReport(GetUtilizationReportRequest, ServerCallContext)

public virtual Task<UtilizationReport> GetUtilizationReport(GetUtilizationReportRequest request, ServerCallContext context)

Gets a single Utilization Report.

Parameters
Name	Description
request	GetUtilizationReportRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskUtilizationReport	The response to send back to the client (wrapped by a task).

ListCloneJobs(ListCloneJobsRequest, ServerCallContext)

public virtual Task<ListCloneJobsResponse> ListCloneJobs(ListCloneJobsRequest request, ServerCallContext context)

Lists CloneJobs of a given migrating VM.

Parameters
Name	Description
request	ListCloneJobsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListCloneJobsResponse	The response to send back to the client (wrapped by a task).

ListCutoverJobs(ListCutoverJobsRequest, ServerCallContext)

public virtual Task<ListCutoverJobsResponse> ListCutoverJobs(ListCutoverJobsRequest request, ServerCallContext context)

Lists CutoverJobs of a given migrating VM.

Parameters
Name	Description
request	ListCutoverJobsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListCutoverJobsResponse	The response to send back to the client (wrapped by a task).

ListDatacenterConnectors(ListDatacenterConnectorsRequest, ServerCallContext)

public virtual Task<ListDatacenterConnectorsResponse> ListDatacenterConnectors(ListDatacenterConnectorsRequest request, ServerCallContext context)

Lists DatacenterConnectors in a given Source.

Parameters
Name	Description
request	ListDatacenterConnectorsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListDatacenterConnectorsResponse	The response to send back to the client (wrapped by a task).

ListGroups(ListGroupsRequest, ServerCallContext)

public virtual Task<ListGroupsResponse> ListGroups(ListGroupsRequest request, ServerCallContext context)

Lists Groups in a given project and location.

Parameters
Name	Description
request	ListGroupsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListGroupsResponse	The response to send back to the client (wrapped by a task).

ListMigratingVms(ListMigratingVmsRequest, ServerCallContext)

public virtual Task<ListMigratingVmsResponse> ListMigratingVms(ListMigratingVmsRequest request, ServerCallContext context)

Lists MigratingVms in a given Source.

Parameters
Name	Description
request	ListMigratingVmsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListMigratingVmsResponse	The response to send back to the client (wrapped by a task).

ListReplicationCycles(ListReplicationCyclesRequest, ServerCallContext)

public virtual Task<ListReplicationCyclesResponse> ListReplicationCycles(ListReplicationCyclesRequest request, ServerCallContext context)

Lists ReplicationCycles in a given MigratingVM.

Parameters
Name	Description
request	ListReplicationCyclesRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListReplicationCyclesResponse	The response to send back to the client (wrapped by a task).

ListSources(ListSourcesRequest, ServerCallContext)

public virtual Task<ListSourcesResponse> ListSources(ListSourcesRequest request, ServerCallContext context)

Lists Sources in a given project and location.

Parameters
Name	Description
request	ListSourcesRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListSourcesResponse	The response to send back to the client (wrapped by a task).

ListTargetProjects(ListTargetProjectsRequest, ServerCallContext)

public virtual Task<ListTargetProjectsResponse> ListTargetProjects(ListTargetProjectsRequest request, ServerCallContext context)

Lists TargetProjects in a given project.

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

Parameters
Name	Description
request	ListTargetProjectsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListTargetProjectsResponse	The response to send back to the client (wrapped by a task).

ListUtilizationReports(ListUtilizationReportsRequest, ServerCallContext)

public virtual Task<ListUtilizationReportsResponse> ListUtilizationReports(ListUtilizationReportsRequest request, ServerCallContext context)

Lists Utilization Reports of the given Source.

Parameters
Name	Description
request	ListUtilizationReportsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListUtilizationReportsResponse	The response to send back to the client (wrapped by a task).

PauseMigration(PauseMigrationRequest, ServerCallContext)

public virtual Task<Operation> PauseMigration(PauseMigrationRequest request, ServerCallContext context)

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.

Parameters
Name	Description
request	PauseMigrationRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

RemoveGroupMigration(RemoveGroupMigrationRequest, ServerCallContext)

public virtual Task<Operation> RemoveGroupMigration(RemoveGroupMigrationRequest request, ServerCallContext context)

Removes a MigratingVm from a Group.

Parameters
Name	Description
request	RemoveGroupMigrationRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

ResumeMigration(ResumeMigrationRequest, ServerCallContext)

public virtual Task<Operation> ResumeMigration(ResumeMigrationRequest request, ServerCallContext context)

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.

Parameters
Name	Description
request	ResumeMigrationRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

StartMigration(StartMigrationRequest, ServerCallContext)

public virtual Task<Operation> StartMigration(StartMigrationRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	StartMigrationRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

UpdateGroup(UpdateGroupRequest, ServerCallContext)

public virtual Task<Operation> UpdateGroup(UpdateGroupRequest request, ServerCallContext context)

Updates the parameters of a single Group.

Parameters
Name	Description
request	UpdateGroupRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

UpdateMigratingVm(UpdateMigratingVmRequest, ServerCallContext)

public virtual Task<Operation> UpdateMigratingVm(UpdateMigratingVmRequest request, ServerCallContext context)

Updates the parameters of a single MigratingVm.

Parameters
Name	Description
request	UpdateMigratingVmRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

UpdateSource(UpdateSourceRequest, ServerCallContext)

public virtual Task<Operation> UpdateSource(UpdateSourceRequest request, ServerCallContext context)

Updates the parameters of a single Source.

Parameters
Name	Description
request	UpdateSourceRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

UpdateTargetProject(UpdateTargetProjectRequest, ServerCallContext)

public virtual Task<Operation> UpdateTargetProject(UpdateTargetProjectRequest request, ServerCallContext context)

Updates the parameters of a single TargetProject.

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

Parameters
Name	Description
request	UpdateTargetProjectRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

UpgradeAppliance(UpgradeApplianceRequest, ServerCallContext)

public virtual Task<Operation> UpgradeAppliance(UpgradeApplianceRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	UpgradeApplianceRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).