2024-12-07
▼ ▲ metastore.projects.locations.services.list
Path : v2alpha/{+parent}/services
Flat Path : v2alpha/projects/{projectsId}/locations/{locationsId}/services
HTTP Method : GET
Parameters :
parent
Description : Required. The relative resource name of the location of metastore services to list, in the following form:projects/{project_number}/locations/{location_id}.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : Optional. The maximum number of services to return. The response may contain less than the maximum number. If unspecified, no more than 500 services 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.ListServices 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.ListServices 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 services in a project and location.
▼ ▲ metastore.projects.locations.services.get
Path : v2alpha/{+name}
Flat Path : v2alpha/projects/{projectsId}/locations/{locationsId}/services/{servicesId}
HTTP Method : GET
Parameters :
name
Description : Required. The relative resource name of the metastore service to retrieve, in the following form:projects/{project_number}/locations/{location_id}/services/{service_id}.
Pattern : ^projects/[^/]+/locations/[^/]+/services/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets the details of a single service.
▼ ▲ metastore.projects.locations.services.create
Path : v2alpha/{+parent}/services
Flat Path : v2alpha/projects/{projectsId}/locations/{locationsId}/services
HTTP Method : POST
Parameters :
parent
Description : Required. The relative resource name of the location in which to create a metastore service, in the following form:projects/{project_number}/locations/{location_id}.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
serviceId
Description : Required. The ID of the metastore service, which is used as the final component of the metastore service's name.This value must be between 2 and 63 characters long inclusive, begin with a letter, end with a letter or number, and consist of alpha-numeric ASCII characters or hyphens.
Location : query
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 : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a metastore service in a project and location.
▼ ▲ metastore.projects.locations.services.patch
Path : v2alpha/{+name}
Flat Path : v2alpha/projects/{projectsId}/locations/{locationsId}/services/{servicesId}
HTTP Method : PATCH
Parameters :
name
Description : Immutable. The relative resource name of the metastore service, in the following format:projects/{project_number}/locations/{location_id}/services/{service_id}.
Pattern : ^projects/[^/]+/locations/[^/]+/services/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Required. A field mask used to specify the fields to be overwritten in the metastore service resource by the update. Fields specified in the update_mask are relative to the resource (not to the full request). A field is overwritten if it is in the mask.
Location : query
Type : string
Format : google-fieldmask
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 : Updates the parameters of a single service.
▼ ▲ metastore.projects.locations.services.delete
Path : v2alpha/{+name}
Flat Path : v2alpha/projects/{projectsId}/locations/{locationsId}/services/{servicesId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The relative resource name of the metastore service to delete, in the following form:projects/{project_number}/locations/{location_id}/services/{service_id}.
Pattern : ^projects/[^/]+/locations/[^/]+/services/[^/]+$
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 service.
▼ ▲ metastore.projects.locations.services.importMetadata
Path : v2alpha/{+name}:importMetadata
Flat Path : v2alpha/projects/{projectsId}/locations/{locationsId}/services/{servicesId}:importMetadata
HTTP Method : POST
Parameters :
name
Description : Immutable. The relative resource name of the metastore service to run import, in the following form:projects/{project_id}/locations/{location_id}/services/{service_id}.
Pattern : ^projects/[^/]+/locations/[^/]+/services/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Imports Metadata into a Dataproc Metastore service.
▼ ▲ metastore.projects.locations.services.exportMetadata
Path : v2alpha/{+service}:exportMetadata
Flat Path : v2alpha/projects/{projectsId}/locations/{locationsId}/services/{servicesId}:exportMetadata
HTTP Method : POST
Parameters :
service
Description : Required. The relative resource name of the metastore service to run export, in the following form: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 : Exports metadata from a service.
▼ ▲ metastore.projects.locations.services.restore
Path : v2alpha/{+service}:restore
Flat Path : v2alpha/projects/{projectsId}/locations/{locationsId}/services/{servicesId}:restore
HTTP Method : POST
Parameters :
service
Description : Required. The relative resource name of the metastore service to run restore, in the following form: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 : Restores a service from a backup.
▼ ▲ metastore.projects.locations.services.removeIamPolicy
Path : v2alpha/{+resource}:removeIamPolicy
Flat Path : v2alpha/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/{servicesId1}:removeIamPolicy
HTTP Method : POST
Parameters :
resource
Description : Required. The relative resource name of the dataplane resource to remove IAM policy, in the following form:projects/{project_id}/locations/{location_id}/services/{service_id}/databases/{database_id} or projects/{project_id}/locations/{location_id}/services/{service_id}/databases/{database_id}/tables/{table_id}.
Pattern : ^projects/[^/]+/locations/[^/]+/services/[^/]+/.*$
Location : path
Required : Yes
Type : string
Parameter Order : resource
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Removes the attached IAM policies for a resource
▼ ▲ metastore.projects.locations.services.queryMetadata
Path : v2alpha/{+service}:queryMetadata
Flat Path : v2alpha/projects/{projectsId}/locations/{locationsId}/services/{servicesId}:queryMetadata
HTTP Method : POST
Parameters :
service
Description : Required. The relative resource name of the metastore service to query metadata, 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 : Query Dataproc Metastore metadata.
▼ ▲ metastore.projects.locations.services.moveTableToDatabase
Path : v2alpha/{+service}:moveTableToDatabase
Flat Path : v2alpha/projects/{projectsId}/locations/{locationsId}/services/{servicesId}:moveTableToDatabase
HTTP Method : POST
Parameters :
service
Description : Required. The relative resource name of the metastore service to mutate metadata, 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 : Move a table to another database.
▼ ▲ metastore.projects.locations.services.alterLocation
Path : v2alpha/{+service}:alterLocation
Flat Path : v2alpha/projects/{projectsId}/locations/{locationsId}/services/{servicesId}:alterLocation
HTTP Method : POST
Parameters :
service
Description : Required. The relative resource name of the metastore service to mutate metadata, 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 : Alter metadata resource location. The metadata resource can be a database, table, or partition. This functionality only updates the parent directory for the respective metadata resource and does not transfer any existing data to the new location.
▼ ▲ metastore.projects.locations.services.alterTableProperties
Path : v2alpha/{+service}:alterTableProperties
Flat Path : v2alpha/projects/{projectsId}/locations/{locationsId}/services/{servicesId}:alterTableProperties
HTTP Method : POST
Parameters :
service
Description : Required. The relative resource name of the Dataproc Metastore service that's being used to mutate metadata table properties, 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 : Alter metadata table properties.
▼ ▲ metastore.projects.locations.services.startMigration
Path : v2alpha/{+service}:startMigration
Flat Path : v2alpha/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 : v2alpha/{+service}:completeMigration
Flat Path : v2alpha/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 : v2alpha/{+service}:cancelMigration
Flat Path : v2alpha/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.backups.list
Path : v2alpha/{+parent}/backups
Flat Path : v2alpha/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/backups
HTTP Method : GET
Parameters :
parent
Description : Required. The relative resource name of the service whose backups to list, in the following form:projects/{project_number}/locations/{location_id}/services/{service_id}/backups.
Pattern : ^projects/[^/]+/locations/[^/]+/services/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : Optional. The maximum number of backups to return. The response may contain less than the maximum number. If unspecified, no more than 500 backups 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.ListBackups 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.ListBackups 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 backups in a service.
▼ ▲ metastore.projects.locations.services.backups.get
Path : v2alpha/{+name}
Flat Path : v2alpha/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/backups/{backupsId}
HTTP Method : GET
Parameters :
name
Description : Required. The relative resource name of the backup to retrieve, in the following form:projects/{project_number}/locations/{location_id}/services/{service_id}/backups/{backup_id}.
Pattern : ^projects/[^/]+/locations/[^/]+/services/[^/]+/backups/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets details of a single backup.
▼ ▲ metastore.projects.locations.services.backups.create
Path : v2alpha/{+parent}/backups
Flat Path : v2alpha/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/backups
HTTP Method : POST
Parameters :
parent
Description : Required. The relative resource name of the service in which to create a backup of the following form:projects/{project_number}/locations/{location_id}/services/{service_id}.
Pattern : ^projects/[^/]+/locations/[^/]+/services/[^/]+$
Location : path
Required : Yes
Type : string
backupId
Description : Required. The ID of the backup, which is used as the final component of the backup's name.This value must be between 1 and 64 characters long, begin with a letter, end with a letter or number, and consist of alpha-numeric ASCII characters or hyphens.
Location : query
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 : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a new backup in a given project and location.
▼ ▲ metastore.projects.locations.services.backups.delete
Path : v2alpha/{+name}
Flat Path : v2alpha/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/backups/{backupsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The relative resource name of the backup to delete, in the following form:projects/{project_number}/locations/{location_id}/services/{service_id}/backups/{backup_id}.
Pattern : ^projects/[^/]+/locations/[^/]+/services/[^/]+/backups/[^/]+$
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 backup.
▼ ▲ metastore.projects.locations.services.migrationExecutions.get
Path : v2alpha/{+name}
Flat Path : v2alpha/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 : v2alpha/{+parent}/migrationExecutions
Flat Path : v2alpha/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 : v2alpha/{+name}
Flat Path : v2alpha/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.