2024-03-28
▼ ▲ metastore.projects.locations.services.startMigration
Path: v1alpha/{+service}:startMigration
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/services/{servicesId}:startMigration
HTTP Method: POST
Parameters:
service
Description: Required. The relative resource name of the metastore service to start migrating to, in the following format:projects/{project_id}/locations/{location_id}/services/{service_id}.
Pattern: ^projects/[^/]+/locations/[^/]+/services/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: service
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Starts the Managed Migration process.
▼ ▲ metastore.projects.locations.services.completeMigration
Path: v1alpha/{+service}:completeMigration
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/services/{servicesId}:completeMigration
HTTP Method: POST
Parameters:
service
Description: Required. The relative resource name of the metastore service to complete the migration to, in the following format:projects/{project_id}/locations/{location_id}/services/{service_id}.
Pattern: ^projects/[^/]+/locations/[^/]+/services/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: service
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Completes the managed migration process. The Dataproc Metastore service will switch to using its own backend database after successful migration.
▼ ▲ metastore.projects.locations.services.cancelMigration
Path: v1alpha/{+service}:cancelMigration
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/services/{servicesId}:cancelMigration
HTTP Method: POST
Parameters:
service
Description: Required. The relative resource name of the metastore service to cancel the ongoing migration to, in the following format:projects/{project_id}/locations/{location_id}/services/{service_id}.
Pattern: ^projects/[^/]+/locations/[^/]+/services/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: service
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Cancels the ongoing Managed Migration process.
▼ ▲ metastore.projects.locations.services.migrationExecutions.get
Path: v1alpha/{+name}
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/migrationExecutions/{migrationExecutionsId}
HTTP Method: GET
Parameters:
name
Description: Required. The relative resource name of the migration execution to retrieve, in the following form:projects/{project_number}/locations/{location_id}/services/{service_id}/migrationExecutions/{migration_execution_id}.
Pattern: ^projects/[^/]+/locations/[^/]+/services/[^/]+/migrationExecutions/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets details of a single migration execution.
▼ ▲ metastore.projects.locations.services.migrationExecutions.list
Path: v1alpha/{+parent}/migrationExecutions
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/migrationExecutions
HTTP Method: GET
Parameters:
parent
Description: Required. The relative resource name of the service whose migration executions to list, in the following form:projects/{project_number}/locations/{location_id}/services/{service_id}/migrationExecutions.
Pattern: ^projects/[^/]+/locations/[^/]+/services/[^/]+$
Location: path
Required: Yes
Type: string
pageSize
Description: Optional. The maximum number of migration executions to return. The response may contain less than the maximum number. If unspecified, no more than 500 migration executions are returned. The maximum value is 1000; values above 1000 are changed to 1000.
Location: query
Type: integer
Format: int32
pageToken
Description: Optional. A page token, received from a previous DataprocMetastore.ListMigrationExecutions call. Provide this token to retrieve the subsequent page.To retrieve the first page, supply an empty page token.When paginating, other parameters provided to DataprocMetastore.ListMigrationExecutions must match the call that provided the page token.
Location: query
Type: string
filter
Description: Optional. The filter to apply to list results.
Location: query
Type: string
orderBy
Description: Optional. Specify the ordering of results as described in Sorting Order (https://cloud.google.com/apis/design/design_patterns#sorting_order). If not specified, the results will be sorted in the default order.
Location: query
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists migration executions on a service.
▼ ▲ metastore.projects.locations.services.migrationExecutions.delete
Path: v1alpha/{+name}
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/migrationExecutions/{migrationExecutionsId}
HTTP Method: DELETE
Parameters:
name
Description: Required. The relative resource name of the migrationExecution to delete, in the following form:projects/{project_number}/locations/{location_id}/services/{service_id}/migrationExecutions/{migration_execution_id}.
Pattern: ^projects/[^/]+/locations/[^/]+/services/[^/]+/migrationExecutions/[^/]+$
Location: path
Required: Yes
Type: string
requestId
Description: Optional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore subsequent requests that provide a duplicate request ID for at least 60 minutes after the first request.For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments.The request ID must be a valid UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier#Format) A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.
Location: query
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Deletes a single migration execution.