Show / Hide Table of Contents

Class ProjectsResource.LocationsResource.MigrationJobsResource

The "migrationJobs" collection of methods.

Inheritance
object
ProjectsResource.LocationsResource.MigrationJobsResource
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.DatabaseMigrationService.v1
Assembly: Google.Apis.DatabaseMigrationService.v1.dll
Syntax
public class ProjectsResource.LocationsResource.MigrationJobsResource

Constructors

MigrationJobsResource(IClientService)

Constructs a new resource.

Declaration
public MigrationJobsResource(IClientService service)
Parameters
Type Name Description
IClientService service

Properties

Objects

Gets the Objects resource.

Declaration
public virtual ProjectsResource.LocationsResource.MigrationJobsResource.ObjectsResource Objects { get; }
Property Value
Type Description
ProjectsResource.LocationsResource.MigrationJobsResource.ObjectsResource

Methods

Create(MigrationJob, string)

Creates a new migration job in a given project and location.

Declaration
public virtual ProjectsResource.LocationsResource.MigrationJobsResource.CreateRequest Create(MigrationJob body, string parent)
Parameters
Type Name Description
MigrationJob body

The body of the request.

string parent

Required. The parent which owns this collection of migration jobs.

Returns
Type Description
ProjectsResource.LocationsResource.MigrationJobsResource.CreateRequest

Delete(string)

Deletes a single migration job.

Declaration
public virtual ProjectsResource.LocationsResource.MigrationJobsResource.DeleteRequest Delete(string name)
Parameters
Type Name Description
string name

Required. Name of the migration job resource to delete.

Returns
Type Description
ProjectsResource.LocationsResource.MigrationJobsResource.DeleteRequest

DemoteDestination(DemoteDestinationRequest, string)

Demotes the destination database to become a read replica of the source. This is applicable for the following migrations: 1. MySQL to Cloud SQL for MySQL 2. PostgreSQL to Cloud SQL for PostgreSQL 3. PostgreSQL to AlloyDB for PostgreSQL.

Declaration
public virtual ProjectsResource.LocationsResource.MigrationJobsResource.DemoteDestinationRequest DemoteDestination(DemoteDestinationRequest body, string name)
Parameters
Type Name Description
DemoteDestinationRequest body

The body of the request.

string name

Name of the migration job resource to demote its destination.

Returns
Type Description
ProjectsResource.LocationsResource.MigrationJobsResource.DemoteDestinationRequest

FetchSourceObjects(string)

Retrieves objects from the source database that can be selected for data migration. This is applicable for the following migrations: 1. PostgreSQL to Cloud SQL for PostgreSQL 2. PostgreSQL to AlloyDB for PostgreSQL.

Declaration
public virtual ProjectsResource.LocationsResource.MigrationJobsResource.FetchSourceObjectsRequest FetchSourceObjects(string name)
Parameters
Type Name Description
string name

Required. The resource name for the migration job for which source objects should be returned.

Returns
Type Description
ProjectsResource.LocationsResource.MigrationJobsResource.FetchSourceObjectsRequest

GenerateSshScript(GenerateSshScriptRequest, string)

Generate a SSH configuration script to configure the reverse SSH connectivity.

Declaration
public virtual ProjectsResource.LocationsResource.MigrationJobsResource.GenerateSshScriptRequest GenerateSshScript(GenerateSshScriptRequest body, string migrationJob)
Parameters
Type Name Description
GenerateSshScriptRequest body

The body of the request.

string migrationJob

Name of the migration job resource to generate the SSH script.

Returns
Type Description
ProjectsResource.LocationsResource.MigrationJobsResource.GenerateSshScriptRequest

GenerateTcpProxyScript(GenerateTcpProxyScriptRequest, string)

Generate a TCP Proxy configuration script to configure a cloud-hosted VM running a TCP Proxy.

Declaration
public virtual ProjectsResource.LocationsResource.MigrationJobsResource.GenerateTcpProxyScriptRequest GenerateTcpProxyScript(GenerateTcpProxyScriptRequest body, string migrationJob)
Parameters
Type Name Description
GenerateTcpProxyScriptRequest body

The body of the request.

string migrationJob

Name of the migration job resource to generate the TCP Proxy script.

Returns
Type Description
ProjectsResource.LocationsResource.MigrationJobsResource.GenerateTcpProxyScriptRequest

Get(string)

Gets details of a single migration job.

Declaration
public virtual ProjectsResource.LocationsResource.MigrationJobsResource.GetRequest Get(string name)
Parameters
Type Name Description
string name

Required. Name of the migration job resource to get.

Returns
Type Description
ProjectsResource.LocationsResource.MigrationJobsResource.GetRequest

GetIamPolicy(string)

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Declaration
public virtual ProjectsResource.LocationsResource.MigrationJobsResource.GetIamPolicyRequest GetIamPolicy(string resource)
Parameters
Type Name Description
string resource

REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

Returns
Type Description
ProjectsResource.LocationsResource.MigrationJobsResource.GetIamPolicyRequest

List(string)

Lists migration jobs in a given project and location.

Declaration
public virtual ProjectsResource.LocationsResource.MigrationJobsResource.ListRequest List(string parent)
Parameters
Type Name Description
string parent

Required. The parent which owns this collection of migrationJobs.

Returns
Type Description
ProjectsResource.LocationsResource.MigrationJobsResource.ListRequest

Patch(MigrationJob, string)

Updates the parameters of a single migration job.

Declaration
public virtual ProjectsResource.LocationsResource.MigrationJobsResource.PatchRequest Patch(MigrationJob body, string name)
Parameters
Type Name Description
MigrationJob body

The body of the request.

string name

The name (URI) of this migration job resource, in the form of: projects/{project}/locations/{location}/migrationJobs/{migrationJob}.

Returns
Type Description
ProjectsResource.LocationsResource.MigrationJobsResource.PatchRequest

Promote(PromoteMigrationJobRequest, string)

Promote a migration job, stopping replication to the destination and promoting the destination to be a standalone database.

Declaration
public virtual ProjectsResource.LocationsResource.MigrationJobsResource.PromoteRequest Promote(PromoteMigrationJobRequest body, string name)
Parameters
Type Name Description
PromoteMigrationJobRequest body

The body of the request.

string name

Name of the migration job resource to promote.

Returns
Type Description
ProjectsResource.LocationsResource.MigrationJobsResource.PromoteRequest

Restart(RestartMigrationJobRequest, string)

Restart a stopped or failed migration job, resetting the destination instance to its original state and starting the migration process from scratch.

Declaration
public virtual ProjectsResource.LocationsResource.MigrationJobsResource.RestartRequest Restart(RestartMigrationJobRequest body, string name)
Parameters
Type Name Description
RestartMigrationJobRequest body

The body of the request.

string name

Name of the migration job resource to restart.

Returns
Type Description
ProjectsResource.LocationsResource.MigrationJobsResource.RestartRequest

Resume(ResumeMigrationJobRequest, string)

Resume a migration job that is currently stopped and is resumable (was stopped during CDC phase).

Declaration
public virtual ProjectsResource.LocationsResource.MigrationJobsResource.ResumeRequest Resume(ResumeMigrationJobRequest body, string name)
Parameters
Type Name Description
ResumeMigrationJobRequest body

The body of the request.

string name

Name of the migration job resource to resume.

Returns
Type Description
ProjectsResource.LocationsResource.MigrationJobsResource.ResumeRequest

SetIamPolicy(SetIamPolicyRequest, string)

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

Declaration
public virtual ProjectsResource.LocationsResource.MigrationJobsResource.SetIamPolicyRequest SetIamPolicy(SetIamPolicyRequest body, string resource)
Parameters
Type Name Description
SetIamPolicyRequest body

The body of the request.

string resource

REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

Returns
Type Description
ProjectsResource.LocationsResource.MigrationJobsResource.SetIamPolicyRequest

Start(StartMigrationJobRequest, string)

Start an already created migration job.

Declaration
public virtual ProjectsResource.LocationsResource.MigrationJobsResource.StartRequest Start(StartMigrationJobRequest body, string name)
Parameters
Type Name Description
StartMigrationJobRequest body

The body of the request.

string name

Name of the migration job resource to start.

Returns
Type Description
ProjectsResource.LocationsResource.MigrationJobsResource.StartRequest

Stop(StopMigrationJobRequest, string)

Stops a running migration job.

Declaration
public virtual ProjectsResource.LocationsResource.MigrationJobsResource.StopRequest Stop(StopMigrationJobRequest body, string name)
Parameters
Type Name Description
StopMigrationJobRequest body

The body of the request.

string name

Name of the migration job resource to stop.

Returns
Type Description
ProjectsResource.LocationsResource.MigrationJobsResource.StopRequest

TestIamPermissions(TestIamPermissionsRequest, string)

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Declaration
public virtual ProjectsResource.LocationsResource.MigrationJobsResource.TestIamPermissionsRequest TestIamPermissions(TestIamPermissionsRequest body, string resource)
Parameters
Type Name Description
TestIamPermissionsRequest body

The body of the request.

string resource

REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

Returns
Type Description
ProjectsResource.LocationsResource.MigrationJobsResource.TestIamPermissionsRequest

Verify(VerifyMigrationJobRequest, string)

Verify a migration job, making sure the destination can reach the source and that all configuration and prerequisites are met.

Declaration
public virtual ProjectsResource.LocationsResource.MigrationJobsResource.VerifyRequest Verify(VerifyMigrationJobRequest body, string name)
Parameters
Type Name Description
VerifyMigrationJobRequest body

The body of the request.

string name

Name of the migration job resource to verify.

Returns
Type Description
ProjectsResource.LocationsResource.MigrationJobsResource.VerifyRequest
In this article
Back to top Generated by DocFX