VM Migration API (vmmigration:v1)

2024-02-29

7 new methods

Additions

    Methods
  • vmmigration.projects.locations.imageImports.list

      Path: v1/{+parent}/imageImports

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/imageImports

      HTTP Method: GET

      Parameters:

        parent

          Description: Required. The parent, which owns this collection of targets.

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

          Location: path

          Required: Yes

          Type: string

        pageSize

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

          Location: query

          Type: integer

          Format: int32

        pageToken

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

          Location: query

          Type: string

        filter

          Description: Optional. The filter request (according to https://google.aip.dev/160).

          Location: query

          Type: string

        orderBy

          Description: Optional. The order by fields for the result (according to https://google.aip.dev/132#ordering). Currently ordering is only possible by "name" field.

          Location: query

          Type: string

      Parameter Order: parent

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

      Description: Lists ImageImports in a given project.

  • vmmigration.projects.locations.imageImports.get

      Path: v1/{+name}

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/imageImports/{imageImportsId}

      HTTP Method: GET

      Parameters:

        name

          Description: Required. The ImageImport name.

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

          Location: path

          Required: Yes

          Type: string

      Parameter Order: name

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

      Description: Gets details of a single ImageImport.

  • vmmigration.projects.locations.imageImports.create

      Path: v1/{+parent}/imageImports

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/imageImports

      HTTP Method: POST

      Parameters:

        parent

          Description: Required. The ImageImport's parent.

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

          Location: path

          Required: Yes

          Type: string

        imageImportId

          Description: Required. The image import identifier. This value maximum length is 63 characters, and valid characters are /a-z-/. It must start with an english letter and must not end with a hyphen.

          Location: query

          Type: string

        requestId

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

      Parameter Order: parent

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

      Description: Creates a new ImageImport in a given project.

  • vmmigration.projects.locations.imageImports.delete

      Path: v1/{+name}

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/imageImports/{imageImportsId}

      HTTP Method: DELETE

      Parameters:

        name

          Description: Required. The ImageImport name.

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

          Location: path

          Required: Yes

          Type: string

        requestId

          Description: Optional. A 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 t he 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

      Parameter Order: name

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

      Description: Deletes a single ImageImport.

  • vmmigration.projects.locations.imageImports.imageImportJobs.list

      Path: v1/{+parent}/imageImportJobs

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/imageImports/{imageImportsId}/imageImportJobs

      HTTP Method: GET

      Parameters:

        parent

          Description: Required. The parent, which owns this collection of targets.

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

          Location: path

          Required: Yes

          Type: string

        pageSize

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

          Location: query

          Type: integer

          Format: int32

        pageToken

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

          Location: query

          Type: string

        filter

          Description: Optional. The filter request (according to https://google.aip.dev/160).

          Location: query

          Type: string

        orderBy

          Description: Optional. The order by fields for the result (according to https://google.aip.dev/132#ordering). Currently ordering is only possible by "name" field.

          Location: query

          Type: string

      Parameter Order: parent

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

      Description: Lists ImageImportJobs in a given project.

  • vmmigration.projects.locations.imageImports.imageImportJobs.get

      Path: v1/{+name}

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/imageImports/{imageImportsId}/imageImportJobs/{imageImportJobsId}

      HTTP Method: GET

      Parameters:

        name

          Description: Required. The ImageImportJob name.

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

          Location: path

          Required: Yes

          Type: string

      Parameter Order: name

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

      Description: Gets details of a single ImageImportJob.

  • vmmigration.projects.locations.imageImports.imageImportJobs.cancel

      Path: v1/{+name}:cancel

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/imageImports/{imageImportsId}/imageImportJobs/{imageImportJobsId}:cancel

      HTTP Method: POST

      Parameters:

        name

          Description: Required. The image import job id.

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

          Location: path

          Required: Yes

          Type: string

      Parameter Order: name

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

      Description: Initiates the cancellation of a running clone job.