target.apidocs.com.google.api.services.datamigration.v1.DatabaseMigrationService.Projects.Locations.MigrationJobs.html Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of google-api-services-datamigration Show documentation

There is a newer version: v1-rev20241211-2.0.0

Show newest version







DatabaseMigrationService.Projects.Locations.MigrationJobs (Database Migration API v1-rev20240902-2.0.0)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.datamigration.v1
Class DatabaseMigrationService.Projects.Locations.MigrationJobs



java.lang.Object


com.google.api.services.datamigration.v1.DatabaseMigrationService.Projects.Locations.MigrationJobs







Enclosing class:
DatabaseMigrationService.Projects.Locations




public class DatabaseMigrationService.Projects.Locations.MigrationJobs
extends Object
The "migrationJobs" collection of methods.











Nested Class Summary

Nested Classes 

Modifier and Type
Class and Description


class 
DatabaseMigrationService.Projects.Locations.MigrationJobs.Create 


class 
DatabaseMigrationService.Projects.Locations.MigrationJobs.Delete 


class 
DatabaseMigrationService.Projects.Locations.MigrationJobs.DemoteDestination 


class 
DatabaseMigrationService.Projects.Locations.MigrationJobs.GenerateSshScript 


class 
DatabaseMigrationService.Projects.Locations.MigrationJobs.GenerateTcpProxyScript 


class 
DatabaseMigrationService.Projects.Locations.MigrationJobs.Get 


class 
DatabaseMigrationService.Projects.Locations.MigrationJobs.GetIamPolicy 


class 
DatabaseMigrationService.Projects.Locations.MigrationJobs.List 


class 
DatabaseMigrationService.Projects.Locations.MigrationJobs.Objects
The "objects" collection of methods.



class 
DatabaseMigrationService.Projects.Locations.MigrationJobs.Patch 


class 
DatabaseMigrationService.Projects.Locations.MigrationJobs.Promote 


class 
DatabaseMigrationService.Projects.Locations.MigrationJobs.Restart 


class 
DatabaseMigrationService.Projects.Locations.MigrationJobs.Resume 


class 
DatabaseMigrationService.Projects.Locations.MigrationJobs.SetIamPolicy 


class 
DatabaseMigrationService.Projects.Locations.MigrationJobs.Start 


class 
DatabaseMigrationService.Projects.Locations.MigrationJobs.Stop 


class 
DatabaseMigrationService.Projects.Locations.MigrationJobs.TestIamPermissions 


class 
DatabaseMigrationService.Projects.Locations.MigrationJobs.Verify 









Constructor Summary

Constructors 

Constructor and Description


MigrationJobs() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


DatabaseMigrationService.Projects.Locations.MigrationJobs.Create
create(String parent,
      MigrationJob content)
Creates a new migration job in a given project and location.



DatabaseMigrationService.Projects.Locations.MigrationJobs.Delete
delete(String name)
Deletes a single migration job.



DatabaseMigrationService.Projects.Locations.MigrationJobs.DemoteDestination
demoteDestination(String name,
                 DemoteDestinationRequest content)
Demotes the destination database to become a read replica of the source.



DatabaseMigrationService.Projects.Locations.MigrationJobs.GenerateSshScript
generateSshScript(String migrationJob,
                 GenerateSshScriptRequest content)
Generate a SSH configuration script to configure the reverse SSH connectivity.



DatabaseMigrationService.Projects.Locations.MigrationJobs.GenerateTcpProxyScript
generateTcpProxyScript(String migrationJob,
                      GenerateTcpProxyScriptRequest content)
Generate a TCP Proxy configuration script to configure a cloud-hosted VM running a TCP Proxy.



DatabaseMigrationService.Projects.Locations.MigrationJobs.Get
get(String name)
Gets details of a single migration job.



DatabaseMigrationService.Projects.Locations.MigrationJobs.GetIamPolicy
getIamPolicy(String resource)
Gets the access control policy for a resource.



DatabaseMigrationService.Projects.Locations.MigrationJobs.List
list(String parent)
Lists migration jobs in a given project and location.



DatabaseMigrationService.Projects.Locations.MigrationJobs.Objects
objects()
An accessor for creating requests from the Objects collection.



DatabaseMigrationService.Projects.Locations.MigrationJobs.Patch
patch(String name,
     MigrationJob content)
Updates the parameters of a single migration job.



DatabaseMigrationService.Projects.Locations.MigrationJobs.Promote
promote(String name,
       PromoteMigrationJobRequest content)
Promote a migration job, stopping replication to the destination and promoting the destination to
 be a standalone database.



DatabaseMigrationService.Projects.Locations.MigrationJobs.Restart
restart(String name,
       RestartMigrationJobRequest content)
Restart a stopped or failed migration job, resetting the destination instance to its original
 state and starting the migration process from scratch.



DatabaseMigrationService.Projects.Locations.MigrationJobs.Resume
resume(String name,
      ResumeMigrationJobRequest content)
Resume a migration job that is currently stopped and is resumable (was stopped during CDC phase).



DatabaseMigrationService.Projects.Locations.MigrationJobs.SetIamPolicy
setIamPolicy(String resource,
            SetIamPolicyRequest content)
Sets the access control policy on the specified resource.



DatabaseMigrationService.Projects.Locations.MigrationJobs.Start
start(String name,
     StartMigrationJobRequest content)
Start an already created migration job.



DatabaseMigrationService.Projects.Locations.MigrationJobs.Stop
stop(String name,
    StopMigrationJobRequest content)
Stops a running migration job.



DatabaseMigrationService.Projects.Locations.MigrationJobs.TestIamPermissions
testIamPermissions(String resource,
                  TestIamPermissionsRequest content)
Returns permissions that a caller has on the specified resource.



DatabaseMigrationService.Projects.Locations.MigrationJobs.Verify
verify(String name,
      VerifyMigrationJobRequest content)
Verify a migration job, making sure the destination can reach the source and that all
 configuration and prerequisites are met.







Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait














Constructor Detail





MigrationJobs
public MigrationJobs()









Method Detail





create
public DatabaseMigrationService.Projects.Locations.MigrationJobs.Create create(String parent,
                                                                               MigrationJob content)
                                                                        throws IOException
Creates a new migration job in a given project and location.

 Create a request for the method "migrationJobs.create".

 This request holds the parameters needed by the datamigration server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
parent - Required. The parent which owns this collection of migration jobs.
content - the MigrationJob
Returns:
the request
Throws:
IOException








delete
public DatabaseMigrationService.Projects.Locations.MigrationJobs.Delete delete(String name)
                                                                        throws IOException
Deletes a single migration job.

 Create a request for the method "migrationJobs.delete".

 This request holds the parameters needed by the datamigration server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
name - Required. Name of the migration job resource to delete.
Returns:
the request
Throws:
IOException








demoteDestination
public DatabaseMigrationService.Projects.Locations.MigrationJobs.DemoteDestination demoteDestination(String name,
                                                                                                     DemoteDestinationRequest content)
                                                                                              throws IOException
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.

 Create a request for the method "migrationJobs.demoteDestination".

 This request holds the parameters needed by the datamigration server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
name - Name of the migration job resource to demote its destination.
content - the DemoteDestinationRequest
Returns:
the request
Throws:
IOException








generateSshScript
public DatabaseMigrationService.Projects.Locations.MigrationJobs.GenerateSshScript generateSshScript(String migrationJob,
                                                                                                     GenerateSshScriptRequest content)
                                                                                              throws IOException
Generate a SSH configuration script to configure the reverse SSH connectivity.

 Create a request for the method "migrationJobs.generateSshScript".

 This request holds the parameters needed by the datamigration server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
migrationJob - Name of the migration job resource to generate the SSH script.
content - the GenerateSshScriptRequest
Returns:
the request
Throws:
IOException








generateTcpProxyScript
public DatabaseMigrationService.Projects.Locations.MigrationJobs.GenerateTcpProxyScript generateTcpProxyScript(String migrationJob,
                                                                                                               GenerateTcpProxyScriptRequest content)
                                                                                                        throws IOException
Generate a TCP Proxy configuration script to configure a cloud-hosted VM running a TCP Proxy.

 Create a request for the method "migrationJobs.generateTcpProxyScript".

 This request holds the parameters needed by the datamigration server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote
 operation.

Parameters:
migrationJob - Name of the migration job resource to generate the TCP Proxy script.
content - the GenerateTcpProxyScriptRequest
Returns:
the request
Throws:
IOException








get
public DatabaseMigrationService.Projects.Locations.MigrationJobs.Get get(String name)
                                                                  throws IOException
Gets details of a single migration job.

 Create a request for the method "migrationJobs.get".

 This request holds the parameters needed by the datamigration server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
name - Required. Name of the migration job resource to get.
Returns:
the request
Throws:
IOException








getIamPolicy
public DatabaseMigrationService.Projects.Locations.MigrationJobs.GetIamPolicy getIamPolicy(String resource)
                                                                                    throws IOException
Gets the access control policy for a resource. Returns an empty policy if the resource exists and
 does not have a policy set.

 Create a request for the method "migrationJobs.getIamPolicy".

 This request holds the parameters needed by the datamigration server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
resource - REQUIRED: The resource for which the policy is being requested. See [Resource
        names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for
        this field.
Returns:
the request
Throws:
IOException








list
public DatabaseMigrationService.Projects.Locations.MigrationJobs.List list(String parent)
                                                                    throws IOException
Lists migration jobs in a given project and location.

 Create a request for the method "migrationJobs.list".

 This request holds the parameters needed by the datamigration server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
parent - Required. The parent which owns this collection of migrationJobs.
Returns:
the request
Throws:
IOException








patch
public DatabaseMigrationService.Projects.Locations.MigrationJobs.Patch patch(String name,
                                                                             MigrationJob content)
                                                                      throws IOException
Updates the parameters of a single migration job.

 Create a request for the method "migrationJobs.patch".

 This request holds the parameters needed by the datamigration server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
name - The name (URI) of this migration job resource, in the form of:
        projects/{project}/locations/{location}/migrationJobs/{migrationJob}.
content - the MigrationJob
Returns:
the request
Throws:
IOException








promote
public DatabaseMigrationService.Projects.Locations.MigrationJobs.Promote promote(String name,
                                                                                 PromoteMigrationJobRequest content)
                                                                          throws IOException
Promote a migration job, stopping replication to the destination and promoting the destination to
 be a standalone database.

 Create a request for the method "migrationJobs.promote".

 This request holds the parameters needed by the datamigration server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
name - Name of the migration job resource to promote.
content - the PromoteMigrationJobRequest
Returns:
the request
Throws:
IOException








restart
public DatabaseMigrationService.Projects.Locations.MigrationJobs.Restart restart(String name,
                                                                                 RestartMigrationJobRequest content)
                                                                          throws IOException
Restart a stopped or failed migration job, resetting the destination instance to its original
 state and starting the migration process from scratch.

 Create a request for the method "migrationJobs.restart".

 This request holds the parameters needed by the datamigration server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
name - Name of the migration job resource to restart.
content - the RestartMigrationJobRequest
Returns:
the request
Throws:
IOException








resume
public DatabaseMigrationService.Projects.Locations.MigrationJobs.Resume resume(String name,
                                                                               ResumeMigrationJobRequest content)
                                                                        throws IOException
Resume a migration job that is currently stopped and is resumable (was stopped during CDC phase).

 Create a request for the method "migrationJobs.resume".

 This request holds the parameters needed by the datamigration server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
name - Name of the migration job resource to resume.
content - the ResumeMigrationJobRequest
Returns:
the request
Throws:
IOException








setIamPolicy
public DatabaseMigrationService.Projects.Locations.MigrationJobs.SetIamPolicy setIamPolicy(String resource,
                                                                                           SetIamPolicyRequest content)
                                                                                    throws IOException
Sets the access control policy on the specified resource. Replaces any existing policy. Can
 return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.

 Create a request for the method "migrationJobs.setIamPolicy".

 This request holds the parameters needed by the datamigration server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
resource - REQUIRED: The resource for which the policy is being specified. See [Resource
        names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for
        this field.
content - the SetIamPolicyRequest
Returns:
the request
Throws:
IOException








start
public DatabaseMigrationService.Projects.Locations.MigrationJobs.Start start(String name,
                                                                             StartMigrationJobRequest content)
                                                                      throws IOException
Start an already created migration job.

 Create a request for the method "migrationJobs.start".

 This request holds the parameters needed by the datamigration server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
name - Name of the migration job resource to start.
content - the StartMigrationJobRequest
Returns:
the request
Throws:
IOException








stop
public DatabaseMigrationService.Projects.Locations.MigrationJobs.Stop stop(String name,
                                                                           StopMigrationJobRequest content)
                                                                    throws IOException
Stops a running migration job.

 Create a request for the method "migrationJobs.stop".

 This request holds the parameters needed by the datamigration server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
name - Name of the migration job resource to stop.
content - the StopMigrationJobRequest
Returns:
the request
Throws:
IOException








testIamPermissions
public DatabaseMigrationService.Projects.Locations.MigrationJobs.TestIamPermissions testIamPermissions(String resource,
                                                                                                       TestIamPermissionsRequest content)
                                                                                                throws IOException
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.

 Create a request for the method "migrationJobs.testIamPermissions".

 This request holds the parameters needed by the datamigration server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
resource - REQUIRED: The resource for which the policy detail is being requested. See [Resource
        names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for
        this field.
content - the TestIamPermissionsRequest
Returns:
the request
Throws:
IOException








verify
public DatabaseMigrationService.Projects.Locations.MigrationJobs.Verify verify(String name,
                                                                               VerifyMigrationJobRequest content)
                                                                        throws IOException
Verify a migration job, making sure the destination can reach the source and that all
 configuration and prerequisites are met.

 Create a request for the method "migrationJobs.verify".

 This request holds the parameters needed by the datamigration server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
name - Name of the migration job resource to verify.
content - the VerifyMigrationJobRequest
Returns:
the request
Throws:
IOException








objects
public DatabaseMigrationService.Projects.Locations.MigrationJobs.Objects objects()
An accessor for creating requests from the Objects collection.

 The typical use is:
     DatabaseMigrationService datamigration = new DatabaseMigrationService(...);
    DatabaseMigrationService.Objects.List request = datamigration.objects().list(parameters ...)
 

Returns:
the resource collection














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2024 Google. All rights reserved.

Modifier and Type	Class and Description
`class`	`DatabaseMigrationService.Projects.Locations.MigrationJobs.Create`
`class`	`DatabaseMigrationService.Projects.Locations.MigrationJobs.Delete`
`class`	`DatabaseMigrationService.Projects.Locations.MigrationJobs.DemoteDestination`
`class`	`DatabaseMigrationService.Projects.Locations.MigrationJobs.GenerateSshScript`
`class`	`DatabaseMigrationService.Projects.Locations.MigrationJobs.GenerateTcpProxyScript`
`class`	`DatabaseMigrationService.Projects.Locations.MigrationJobs.Get`
`class`	`DatabaseMigrationService.Projects.Locations.MigrationJobs.GetIamPolicy`
`class`	`DatabaseMigrationService.Projects.Locations.MigrationJobs.List`
`class`	`DatabaseMigrationService.Projects.Locations.MigrationJobs.Objects` The "objects" collection of methods.
`class`	`DatabaseMigrationService.Projects.Locations.MigrationJobs.Patch`
`class`	`DatabaseMigrationService.Projects.Locations.MigrationJobs.Promote`
`class`	`DatabaseMigrationService.Projects.Locations.MigrationJobs.Restart`
`class`	`DatabaseMigrationService.Projects.Locations.MigrationJobs.Resume`
`class`	`DatabaseMigrationService.Projects.Locations.MigrationJobs.SetIamPolicy`
`class`	`DatabaseMigrationService.Projects.Locations.MigrationJobs.Start`
`class`	`DatabaseMigrationService.Projects.Locations.MigrationJobs.Stop`
`class`	`DatabaseMigrationService.Projects.Locations.MigrationJobs.TestIamPermissions`
`class`	`DatabaseMigrationService.Projects.Locations.MigrationJobs.Verify`

Modifier and Type	Method and Description
`DatabaseMigrationService.Projects.Locations.MigrationJobs.Create`	`create(String parent, MigrationJob content)` Creates a new migration job in a given project and location.
`DatabaseMigrationService.Projects.Locations.MigrationJobs.Delete`	`delete(String name)` Deletes a single migration job.
`DatabaseMigrationService.Projects.Locations.MigrationJobs.DemoteDestination`	`demoteDestination(String name, DemoteDestinationRequest content)` Demotes the destination database to become a read replica of the source.
`DatabaseMigrationService.Projects.Locations.MigrationJobs.GenerateSshScript`	`generateSshScript(String migrationJob, GenerateSshScriptRequest content)` Generate a SSH configuration script to configure the reverse SSH connectivity.
`DatabaseMigrationService.Projects.Locations.MigrationJobs.GenerateTcpProxyScript`	`generateTcpProxyScript(String migrationJob, GenerateTcpProxyScriptRequest content)` Generate a TCP Proxy configuration script to configure a cloud-hosted VM running a TCP Proxy.
`DatabaseMigrationService.Projects.Locations.MigrationJobs.Get`	`get(String name)` Gets details of a single migration job.
`DatabaseMigrationService.Projects.Locations.MigrationJobs.GetIamPolicy`	`getIamPolicy(String resource)` Gets the access control policy for a resource.
`DatabaseMigrationService.Projects.Locations.MigrationJobs.List`	`list(String parent)` Lists migration jobs in a given project and location.
`DatabaseMigrationService.Projects.Locations.MigrationJobs.Objects`	`objects()` An accessor for creating requests from the Objects collection.
`DatabaseMigrationService.Projects.Locations.MigrationJobs.Patch`	`patch(String name, MigrationJob content)` Updates the parameters of a single migration job.
`DatabaseMigrationService.Projects.Locations.MigrationJobs.Promote`	`promote(String name, PromoteMigrationJobRequest content)` Promote a migration job, stopping replication to the destination and promoting the destination to be a standalone database.
`DatabaseMigrationService.Projects.Locations.MigrationJobs.Restart`	`restart(String name, RestartMigrationJobRequest content)` Restart a stopped or failed migration job, resetting the destination instance to its original state and starting the migration process from scratch.
`DatabaseMigrationService.Projects.Locations.MigrationJobs.Resume`	`resume(String name, ResumeMigrationJobRequest content)` Resume a migration job that is currently stopped and is resumable (was stopped during CDC phase).
`DatabaseMigrationService.Projects.Locations.MigrationJobs.SetIamPolicy`	`setIamPolicy(String resource, SetIamPolicyRequest content)` Sets the access control policy on the specified resource.
`DatabaseMigrationService.Projects.Locations.MigrationJobs.Start`	`start(String name, StartMigrationJobRequest content)` Start an already created migration job.
`DatabaseMigrationService.Projects.Locations.MigrationJobs.Stop`	`stop(String name, StopMigrationJobRequest content)` Stops a running migration job.
`DatabaseMigrationService.Projects.Locations.MigrationJobs.TestIamPermissions`	`testIamPermissions(String resource, TestIamPermissionsRequest content)` Returns permissions that a caller has on the specified resource.
`DatabaseMigrationService.Projects.Locations.MigrationJobs.Verify`	`verify(String name, VerifyMigrationJobRequest content)` Verify a migration job, making sure the destination can reach the source and that all configuration and prerequisites are met.