Migration Center API (migrationcenter:v1alpha1)

2023-03-18

19 new methods | 1 updated method | 1 removed method

Additions

    Methods
  • migrationcenter.projects.locations.updateSettings

      Path: v1alpha1/{+name}

      HTTP Method: PATCH

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

      Description: Updates the regional-level project settings.

      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 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

        updateMask

          Format: google-fieldmask

          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

          Type: string

        name

          Required: Yes

          Description: Output only. The name of the resource.

          Type: string

          Location: path

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

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

  • migrationcenter.projects.locations.getSettings

      Path: v1alpha1/{+name}

      Parameters:

        name

          Required: Yes

          Description: Required. Name of the resource.

          Location: path

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

          Type: string

      HTTP Method: GET

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

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

      Parameter Order: name

      Description: Gets the details of regional settings.

  • migrationcenter.projects.locations.preferenceSets.patch

      Description: Updates the parameters of a preference set.

      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 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

        name

          Type: string

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

          Required: Yes

          Location: path

          Description: Output only. Name of the preference set.

        updateMask

          Type: string

          Format: google-fieldmask

          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

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

      Path: v1alpha1/{+name}

      Parameter Order: name

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

      HTTP Method: PATCH

  • migrationcenter.projects.locations.preferenceSets.delete

      Path: v1alpha1/{+name}

      Description: Deletes a preference set.

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

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

      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 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).

          Location: query

        name

          Required: Yes

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

          Type: string

          Description: Required. Name of the group resource.

          Location: path

      HTTP Method: DELETE

      Parameter Order: name

  • migrationcenter.projects.locations.preferenceSets.get

      HTTP Method: GET

      Parameters:

        name

          Location: path

          Type: string

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

          Description: Required. Name of the resource.

          Required: Yes

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

      Path: v1alpha1/{+name}

      Parameter Order: name

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

      Description: Gets the details of a preference set.

  • migrationcenter.projects.locations.preferenceSets.create

      HTTP Method: POST

      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

        preferenceSetId

          Type: string

          Location: query

        parent

          Type: string

          Description: Required. Value for parent.

          Location: path

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

          Required: Yes

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

      Path: v1alpha1/{+parent}/preferenceSets

      Parameter Order: parent

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

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

  • migrationcenter.projects.locations.preferenceSets.list

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

      Parameter Order: parent

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

      Parameters:

        parent

          Required: Yes

          Type: string

          Location: path

          Description: Required. Parent value for `ListPreferenceSetsRequest`.

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

        orderBy

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

          Type: string

          Location: query

        pageToken

          Type: string

          Location: query

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

        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.

      Path: v1alpha1/{+parent}/preferenceSets

      HTTP Method: GET

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

  • migrationcenter.projects.locations.groups.create

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

      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

        parent

          Location: path

          Type: string

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

          Description: Required. Value for parent.

          Required: Yes

        groupId

          Location: query

          Type: string

          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])?`.

      HTTP Method: POST

      Path: v1alpha1/{+parent}/groups

      Parameter Order: parent

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

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

  • migrationcenter.projects.locations.groups.patch

      HTTP Method: PATCH

      Parameter Order: name

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

      Path: v1alpha1/{+name}

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

      Description: Updates the parameters of a group.

      Parameters:

        name

          Type: string

          Location: path

          Required: Yes

          Description: Output only. The name of the group.

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

        updateMask

          Format: google-fieldmask

          Location: query

          Type: string

          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.

        requestId

          Location: query

          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).

  • migrationcenter.projects.locations.groups.list

      HTTP Method: GET

      Parameter Order: parent

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

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

      Parameters:

        orderBy

          Location: query

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

          Type: string

        filter

          Location: query

          Description: Filtering results.

          Type: string

        pageToken

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

          Type: string

          Location: query

        pageSize

          Type: integer

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

          Format: int32

          Location: query

        parent

          Description: Required. Parent value for `ListGroupsRequest`.

          Location: path

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

          Required: Yes

          Type: string

      Path: v1alpha1/{+parent}/groups

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

  • migrationcenter.projects.locations.groups.get

      HTTP Method: GET

      Parameter Order: name

      Parameters:

        name

          Type: string

          Required: Yes

          Description: Required. Name of the resource.

          Location: path

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

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

      Description: Gets the details of a group.

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

      Path: v1alpha1/{+name}

  • migrationcenter.projects.locations.groups.removeAssets

      HTTP Method: POST

      Description: Removes assets from a group.

      Path: v1alpha1/{+group}:removeAssets

      Parameter Order: group

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

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

      Parameters:

        group

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

          Location: path

          Type: string

          Description: Required. Group reference.

          Required: Yes

  • migrationcenter.projects.locations.groups.delete

      Description: Deletes a group.

      HTTP Method: DELETE

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

      Parameter Order: name

      Parameters:

        name

          Type: string

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

          Description: Required. Name of the group resource.

          Location: path

          Required: Yes

        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 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).

          Location: query

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

      Path: v1alpha1/{+name}

  • migrationcenter.projects.locations.groups.addAssets

      Path: v1alpha1/{+group}:addAssets

      Parameter Order: group

      Parameters:

        group

          Type: string

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

          Required: Yes

          Description: Required. Group reference.

          Location: path

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

      HTTP Method: POST

      Description: Adds assets to a group.

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

  • migrationcenter.projects.locations.assets.batchDelete

      Parameters:

        parent

          Type: string

          Location: path

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

          Description: Required. Parent value for batch asset delete.

          Required: Yes

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

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

      Parameter Order: parent

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

      HTTP Method: POST

      Description: Deletes list of Assets.

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

      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 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

        importDataFileId

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

          Type: string

          Location: query

        parent

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

          Required: Yes

          Location: path

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

          Type: string

      HTTP Method: POST

      Description: Creates an import data file.

      Path: v1alpha1/{+parent}/importDataFiles

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

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

      Parameter Order: parent

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

      Parameter Order: parent

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

      Parameters:

        orderBy

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

          Location: query

          Type: string

        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

        parent

          Type: string

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

          Required: Yes

          Location: path

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

        pageSize

          Format: int32

          Location: query

          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.

          Type: integer

        filter

          Description: Filtering results.

          Type: string

          Location: query

      HTTP Method: GET

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

      Description: List import data files.

      Path: v1alpha1/{+parent}/importDataFiles

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

      Description: Gets an import data file.

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

      Path: v1alpha1/{+name}

      Parameter Order: name

      Parameters:

        name

          Location: path

          Description: Required. Name of the ImportDataFile.

          Required: Yes

          Type: string

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

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

      HTTP Method: GET

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

      Parameter Order: name

      HTTP Method: DELETE

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

      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

          Description: Required. Name of the ImportDataFile to delete.

          Type: string

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

          Location: path

          Required: Yes

      Path: v1alpha1/{+name}

      Description: Delete an import data file.

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

Updates

    Methods
  • migrationcenter.projects.locations.importJobs.delete

      Parameters:

        force

          Type: boolean

          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.

          Location: query

Deletions

    Methods
  • migrationcenter.projects.locations.assets.create

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

      Path: v1alpha1/{+parent}/assets

      Parameters:

        parent

          Description: Required. Value for parent.

          Type: string

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

          Required: Yes

          Location: path

        assetId

          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).

          Location: query

          Type: string

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

      Parameter Order: parent

      HTTP Method: POST

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