Database Migration API (datamigration:v1)

2024-12-09

4 new methods

Additions

    Methods
  • datamigration.projects.locations.migrationJobs.fetchSourceObjects

      Path : v1/{+name}:fetchSourceObjects

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/migrationJobs/{migrationJobsId}:fetchSourceObjects

      HTTP Method : GET

      Parameters :

        name

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

          Pattern : ^projects/[^/]+/locations/[^/]+/migrationJobs/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Description : 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.

  • datamigration.projects.locations.migrationJobs.objects.get

      Path : v1/{+name}

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/migrationJobs/{migrationJobsId}/objects/{objectsId}

      HTTP Method : GET

      Parameters :

        name

          Description : Required. The name of the migration job object resource to get.

          Pattern : ^projects/[^/]+/locations/[^/]+/migrationJobs/[^/]+/objects/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Description : Use this method to get details about a migration job object.

  • datamigration.projects.locations.migrationJobs.objects.lookup

      Path : v1/{+parent}/objects:lookup

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/migrationJobs/{migrationJobsId}/objects:lookup

      HTTP Method : POST

      Parameters :

        parent

          Description : Required. The parent migration job that owns the collection of objects.

          Pattern : ^projects/[^/]+/locations/[^/]+/migrationJobs/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : parent

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Description : Use this method to look up a migration job object by its source object identifier.

  • datamigration.projects.locations.migrationJobs.objects.list

      Path : v1/{+parent}/objects

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/migrationJobs/{migrationJobsId}/objects

      HTTP Method : GET

      Parameters :

        parent

          Description : Required. The parent migration job that owns the collection of objects.

          Pattern : ^projects/[^/]+/locations/[^/]+/migrationJobs/[^/]+$

          Location : path

          Required : Yes

          Type : string

        pageSize

          Description : Maximum number of objects to return. Default is 50. The maximum value is 1000; values above 1000 will be coerced to 1000.

          Location : query

          Type : integer

          Format : int32

        pageToken

          Description : Page token received from a previous `ListMigrationJObObjectsRequest` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListMigrationJobObjectsRequest` must match the call that provided the page token.

          Location : query

          Type : string

      Parameter Order : parent

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Description : Use this method to list the objects of a specific migration job.