Migration Center API (migrationcenter:v1)

2024-03-26

6 new methods

Additions

    Methods
  • migrationcenter.projects.locations.discoveryClients.create

      Path: v1/{+parent}/discoveryClients

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

      HTTP Method: POST

      Parameters:

        parent

          Description: Required. Parent resource.

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

          Location: path

          Required: Yes

          Type: string

        discoveryClientId

          Description: Required. User specified ID for the discovery client. It will become the last component of the discovery client name. The ID must be unique within the project, 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])?`.

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

          Location: query

          Type: string

      Parameter Order: parent

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

      Description: Creates a new discovery client.

  • migrationcenter.projects.locations.discoveryClients.get

      Path: v1/{+name}

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/discoveryClients/{discoveryClientsId}

      HTTP Method: GET

      Parameters:

        name

          Description: Required. The discovery client name.

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

          Location: path

          Required: Yes

          Type: string

      Parameter Order: name

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

      Description: Gets the details of a discovery client.

  • migrationcenter.projects.locations.discoveryClients.list

      Path: v1/{+parent}/discoveryClients

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

      HTTP Method: GET

      Parameters:

        parent

          Description: Required. Parent resource.

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

          Location: path

          Required: Yes

          Type: string

        pageSize

          Description: Optional. The maximum number of items to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default value.

          Location: query

          Type: integer

          Format: int32

        pageToken

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

          Location: query

          Type: string

        filter

          Description: Optional. Filter expression to filter results by.

          Location: query

          Type: string

        orderBy

          Description: Optional. Field to sort by.

          Location: query

          Type: string

      Parameter Order: parent

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

      Description: Lists all the discovery clients in a given project and location.

  • migrationcenter.projects.locations.discoveryClients.patch

      Path: v1/{+name}

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/discoveryClients/{discoveryClientsId}

      HTTP Method: PATCH

      Parameters:

        name

          Description: Output only. Identifier. Full name of this discovery client.

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

          Location: path

          Required: Yes

          Type: string

        updateMask

          Description: Required. Update mask is used to specify the fields to be overwritten in the `DiscoveryClient` 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

          Format: google-fieldmask

        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

      Parameter Order: name

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

      Description: Updates a discovery client.

  • migrationcenter.projects.locations.discoveryClients.sendHeartbeat

      Path: v1/{+name}:sendHeartbeat

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/discoveryClients/{discoveryClientsId}:sendHeartbeat

      HTTP Method: POST

      Parameters:

        name

          Description: Required. The discovery client name.

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

          Location: path

          Required: Yes

          Type: string

      Parameter Order: name

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

      Description: Sends a discovery client heartbeat. Healthy clients are expected to send heartbeats regularly (normally every few minutes).

  • migrationcenter.projects.locations.discoveryClients.delete

      Path: v1/{+name}

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/discoveryClients/{discoveryClientsId}

      HTTP Method: DELETE

      Parameters:

        name

          Description: Required. The discovery client name.

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

          Location: path

          Required: Yes

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

          Type: string

      Parameter Order: name

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

      Description: Deletes a discovery client.