Migration Center API (migrationcenter:v1alpha1)

2023-03-16

1 new method | 1 updated method | 19 removed methods

Additions

    Methods
  • migrationcenter.projects.locations.assets.create

      Path : v1alpha1/{+parent}/assets

      Parameter Order : parent

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

      Description : Creates a new asset in a given project and location. Deprecated: Use ReportAssetFrames instead.

      HTTP Method : POST

      Flat Path : v1alpha1/projects/{projectsId}/locations/{locationsId}/assets

      Parameters :

        assetId

          Location : query

          Type : string

        requestId

          Description : Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

          Type : string

          Location : query

        parent

          Type : string

          Location : path

          Description : Required. Value for parent.

          Required : Yes

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

Updates

    Methods
  • migrationcenter.projects.locations.importJobs.delete

      Parameters :

        force

          Type : boolean

          Location : query

          Description : Optional. If set to `true`, any `ImportDataFiles` of this job will also be deleted If set to `false`, the request only works if the job has no data files.

Deletions

    Methods
  • migrationcenter.projects.locations.assets.batchDelete

      Parameters :

        parent

          Location : path

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

          Type : string

          Required : Yes

          Description : Required. Parent value for batch asset delete.

      Parameter Order : parent

      Path : v1alpha1/{+parent}/assets:batchDelete

      HTTP Method : POST

      Description : Deletes list of Assets.

      Flat Path : v1alpha1/projects/{projectsId}/locations/{locationsId}/assets:batchDelete

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

  • migrationcenter.projects.locations.preferenceSets.get

      Flat Path : v1alpha1/projects/{projectsId}/locations/{locationsId}/preferenceSets/{preferenceSetsId}

      HTTP Method : GET

      Path : v1alpha1/{+name}

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

      Parameters :

        name

          Description : Required. Name of the resource.

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

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

      Description : Gets the details of a preference set.

  • migrationcenter.projects.locations.preferenceSets.list

      HTTP Method : GET

      Parameters :

        pageToken

          Description : A token identifying a page of results the server should return.

          Type : string

          Location : query

        pageSize

          Type : integer

          Location : query

          Format : int32

          Description : Requested page size. Server may return fewer items than requested. If unspecified, at most 500 preference sets will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

        parent

          Required : Yes

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

          Description : Required. Parent value for `ListPreferenceSetsRequest`.

          Type : string

          Location : path

        orderBy

          Location : query

          Description : Field to sort by. See https://google.aip.dev/132#ordering for more details.

          Type : string

      Parameter Order : parent

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

      Description : Lists all the preference sets in a given project and location.

      Path : v1alpha1/{+parent}/preferenceSets

      Flat Path : v1alpha1/projects/{projectsId}/locations/{locationsId}/preferenceSets

  • migrationcenter.projects.locations.preferenceSets.patch

      Parameters :

        updateMask

          Format : google-fieldmask

          Type : string

          Description : Required. Field mask is used to specify the fields to be overwritten in the `PreferenceSet` resource by the update. The values specified in the `update_mask` field are relative to the resource, not the full request. A field will be overwritten if it is in the mask. A single * value in the mask lets you to overwrite all fields.

          Location : query

        requestId

          Description : Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

          Location : query

          Type : string

        name

          Required : Yes

          Type : string

          Description : Output only. Name of the preference set.

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

          Location : path

      HTTP Method : PATCH

      Flat Path : v1alpha1/projects/{projectsId}/locations/{locationsId}/preferenceSets/{preferenceSetsId}

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

      Parameter Order : name

      Path : v1alpha1/{+name}

      Description : Updates the parameters of a preference set.

  • migrationcenter.projects.locations.preferenceSets.create

      Parameters :

        parent

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

          Description : Required. Value for parent.

          Type : string

          Required : Yes

          Location : path

        preferenceSetId

          Type : string

          Location : query

        requestId

          Description : Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

          Type : string

          Location : query

      Parameter Order : parent

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

      Flat Path : v1alpha1/projects/{projectsId}/locations/{locationsId}/preferenceSets

      Path : v1alpha1/{+parent}/preferenceSets

      Description : Creates a new preference set in a given project and location.

      HTTP Method : POST

  • migrationcenter.projects.locations.preferenceSets.delete

      Flat Path : v1alpha1/projects/{projectsId}/locations/{locationsId}/preferenceSets/{preferenceSetsId}

      HTTP Method : DELETE

      Parameters :

        name

          Type : string

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

          Description : Required. Name of the group resource.

          Location : path

          Required : Yes

        requestId

          Type : string

          Location : query

          Description : Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

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

      Path : v1alpha1/{+name}

      Parameter Order : name

      Description : Deletes a preference set.

  • migrationcenter.projects.locations.groups.get

      Parameters :

        name

          Type : string

          Description : Required. Name of the resource.

          Location : path

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

          Required : Yes

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

      Description : Gets the details of a group.

      Path : v1alpha1/{+name}

      Parameter Order : name

      Flat Path : v1alpha1/projects/{projectsId}/locations/{locationsId}/groups/{groupsId}

      HTTP Method : GET

  • migrationcenter.projects.locations.groups.patch

      Flat Path : v1alpha1/projects/{projectsId}/locations/{locationsId}/groups/{groupsId}

      HTTP Method : PATCH

      Path : v1alpha1/{+name}

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

      Parameter Order : name

      Description : Updates the parameters of a group.

      Parameters :

        requestId

          Description : Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

          Location : query

          Type : string

        name

          Required : Yes

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

          Description : Output only. The name of the group.

          Type : string

          Location : path

        updateMask

          Description : Required. Field mask is used to specify the fields to be overwritten in the `Group` resource by the update. The values specified in the `update_mask` are relative to the resource, not the full request. A field will be overwritten if it is in the mask. A single * value in the mask lets you to overwrite all fields.

          Format : google-fieldmask

          Location : query

          Type : string

  • migrationcenter.projects.locations.groups.create

      Flat Path : v1alpha1/projects/{projectsId}/locations/{locationsId}/groups

      HTTP Method : POST

      Path : v1alpha1/{+parent}/groups

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

      Parameter Order : parent

      Parameters :

        requestId

          Type : string

          Description : Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

          Location : query

        groupId

          Type : string

          Location : query

          Description : Required. User specified ID for the group. It will become the last component of the group name. The ID must be unique within the project, must conform with RFC-1034, is restricted to lower-cased letters, and has a maximum length of 63 characters. The ID must match the regular expression: `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`.

        parent

          Location : path

          Required : Yes

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

          Type : string

          Description : Required. Value for parent.

      Description : Creates a new group in a given project and location.

  • migrationcenter.projects.locations.groups.delete

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

      Path : v1alpha1/{+name}

      HTTP Method : DELETE

      Description : Deletes a group.

      Parameter Order : name

      Parameters :

        requestId

          Location : query

          Description : Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

          Type : string

        name

          Type : string

          Description : Required. Name of the group resource.

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

          Location : path

          Required : Yes

      Flat Path : v1alpha1/projects/{projectsId}/locations/{locationsId}/groups/{groupsId}

  • migrationcenter.projects.locations.groups.removeAssets

      HTTP Method : POST

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

      Path : v1alpha1/{+group}:removeAssets

      Description : Removes assets from a group.

      Flat Path : v1alpha1/projects/{projectsId}/locations/{locationsId}/groups/{groupsId}:removeAssets

      Parameter Order : group

      Parameters :

        group

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

          Type : string

          Required : Yes

          Location : path

          Description : Required. Group reference.

  • migrationcenter.projects.locations.groups.addAssets

      Path : v1alpha1/{+group}:addAssets

      Parameter Order : group

      Parameters :

        group

          Type : string

          Required : Yes

          Description : Required. Group reference.

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

          Location : path

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

      HTTP Method : POST

      Description : Adds assets to a group.

      Flat Path : v1alpha1/projects/{projectsId}/locations/{locationsId}/groups/{groupsId}:addAssets

  • migrationcenter.projects.locations.groups.list

      HTTP Method : GET

      Description : Lists all groups in a given project and location.

      Parameter Order : parent

      Parameters :

        pageToken

          Type : string

          Description : A token identifying a page of results the server should return.

          Location : query

        pageSize

          Description : Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

          Type : integer

          Location : query

          Format : int32

        filter

          Type : string

          Description : Filtering results.

          Location : query

        parent

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

          Type : string

          Required : Yes

          Location : path

          Description : Required. Parent value for `ListGroupsRequest`.

        orderBy

          Location : query

          Type : string

          Description : Field to sort by. See https://google.aip.dev/132#ordering for more details.

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

      Flat Path : v1alpha1/projects/{projectsId}/locations/{locationsId}/groups

      Path : v1alpha1/{+parent}/groups

  • migrationcenter.projects.locations.importJobs.importDataFiles.delete

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

      Description : Delete an import data file.

      Parameters :

        requestId

          Description : Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

          Type : string

          Location : query

        name

          Location : path

          Description : Required. Name of the ImportDataFile to delete.

          Pattern : ^projects/[^/]+/locations/[^/]+/importJobs/[^/]+/importDataFiles/[^/]+$

          Required : Yes

          Type : string

      Path : v1alpha1/{+name}

      Flat Path : v1alpha1/projects/{projectsId}/locations/{locationsId}/importJobs/{importJobsId}/importDataFiles/{importDataFilesId}

      HTTP Method : DELETE

      Parameter Order : name

  • migrationcenter.projects.locations.importJobs.importDataFiles.get

      Parameter Order : name

      Parameters :

        name

          Type : string

          Required : Yes

          Pattern : ^projects/[^/]+/locations/[^/]+/importJobs/[^/]+/importDataFiles/[^/]+$

          Location : path

          Description : Required. Name of the ImportDataFile.

      Flat Path : v1alpha1/projects/{projectsId}/locations/{locationsId}/importJobs/{importJobsId}/importDataFiles/{importDataFilesId}

      Path : v1alpha1/{+name}

      Description : Gets an import data file.

      HTTP Method : GET

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

  • migrationcenter.projects.locations.importJobs.importDataFiles.create

      Flat Path : v1alpha1/projects/{projectsId}/locations/{locationsId}/importJobs/{importJobsId}/importDataFiles

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

      Path : v1alpha1/{+parent}/importDataFiles

      Parameters :

        importDataFileId

          Type : string

          Description : Required. The ID of the new data file.

          Location : query

        parent

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

          Required : Yes

          Description : Required. Name of the parent of the ImportDataFile.

          Type : string

          Location : path

        requestId

          Location : query

          Description : Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

          Type : string

      HTTP Method : POST

      Description : Creates an import data file.

      Parameter Order : parent

  • migrationcenter.projects.locations.importJobs.importDataFiles.list

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

      Flat Path : v1alpha1/projects/{projectsId}/locations/{locationsId}/importJobs/{importJobsId}/importDataFiles

      Description : List import data files.

      Path : v1alpha1/{+parent}/importDataFiles

      HTTP Method : GET

      Parameters :

        orderBy

          Type : string

          Description : Field to sort by. See https://google.aip.dev/132#ordering for more details.

          Location : query

        parent

          Required : Yes

          Type : string

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

          Location : path

          Description : Required. Name of the parent of the `ImportDataFiles` resource.

        pageSize

          Type : integer

          Location : query

          Format : int32

          Description : The maximum number of data files to return. The service may return fewer than this value. If unspecified, at most 500 data files will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

        pageToken

          Type : string

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

          Location : query

        filter

          Description : Filtering results.

          Location : query

          Type : string

      Parameter Order : parent

  • migrationcenter.projects.locations.getSettings

      HTTP Method : GET

      Parameter Order : name

      Path : v1alpha1/{+name}

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

      Parameters :

        name

          Description : Required. Name of the resource.

          Location : path

          Required : Yes

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

          Type : string

      Description : Gets the details of regional settings.

      Flat Path : v1alpha1/projects/{projectsId}/locations/{locationsId}/settings

  • migrationcenter.projects.locations.updateSettings

      Description : Updates the regional-level project settings.

      Parameters :

        requestId

          Description : Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

          Type : string

          Location : query

        updateMask

          Format : google-fieldmask

          Type : string

          Description : Required. Field mask is used to specify the fields to be overwritten in the `Settings` resource by the update. The values specified in the `update_mask` field are relative to the resource, not the full request. A field will be overwritten if it is in the mask. A single * value in the mask lets you to overwrite all fields.

          Location : query

        name

          Type : string

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

          Required : Yes

          Location : path

          Description : Output only. The name of the resource.

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

      Path : v1alpha1/{+name}

      HTTP Method : PATCH

      Flat Path : v1alpha1/projects/{projectsId}/locations/{locationsId}/settings

      Parameter Order : name