Google

Dataproc Metastore API

The Dataproc Metastore API is used to manage the lifecycle and configuration of metastore services.

Data & analytics#openapi#analytics#media

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

The Dataproc Metastore API is used to manage the lifecycle and configuration of metastore services.

Endpoints 27

projects.locations.services.migrationExecutions

  • GETGets details of a single migration execution./v1/:nameGets details of a single migration execution.
  • DELETEDeletes a single migration execution./v1/:name?requestId=stringDeletes a single migration execution.
  • GETLists migration executions on a service./v1/:parent/migrationExecutions?filter=string&orderBy=string&pageSize=0&pageToken=stringLists migration executions on a service.

projects.locations.services.metadataImports

  • PATCHUpdates a single import/v1/:name?requestId=string&updateMask=stringUpdates a single import. Only the description field of MetadataImport is supported to be updated.
  • GETLists imports in a service./v1/:parent/metadataImports?filter=string&orderBy=string&pageSize=0&pageToken=stringLists imports in a service.
  • POSTCreates a new MetadataImport in a given project and location./v1/:parent/metadataImports?metadataImportId=string&requestId=stringCreates a new MetadataImport in a given project and location.

projects.locations

  • GETLists information about the supported locations for this service.This method lists locations based on the resource…/v1/:name/locations?extraLocationTypes=string&filter=string&pageSize=0&pageToken=stringLists information about the supported locations for this service.This method lists locations based on the resource scope provided in the…

projects.locations.federations

  • GETLists federations in a project and location./v1/:parent/federations?filter=string&orderBy=string&pageSize=0&pageToken=stringLists federations in a project and location.
  • POSTCreates a metastore federation in a project and location./v1/:parent/federations?federationId=string&requestId=stringCreates a metastore federation in a project and location.

projects.locations.services.databases.tables

  • GETGets the access control policy for a resource/v1/:resource:getIamPolicy?options.requestedPolicyVersion=0Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
  • POSTSets the access control policy on the specified resource/v1/:resource:setIamPolicySets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

projects.locations.services

  • POSTReturns permissions that a caller has on the specified resource/v1/:resource:testIamPermissionsReturns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND…
  • POSTAlter metadata resource location/v1/:service:alterLocationAlter metadata resource location. The metadata resource can be a database, table, or partition. This functionality only updates the parent directory for the…
  • POSTAlter metadata table properties./v1/:service:alterTablePropertiesAlter metadata table properties.
  • POSTCancels the ongoing Managed Migration process./v1/:service:cancelMigrationCancels the ongoing Managed Migration process.
  • POSTCompletes the managed migration process/v1/:service:completeMigrationCompletes the managed migration process. The Dataproc Metastore service will switch to using its own backend database after successful migration.
  • GETLists services in a project and location./v1/:parent/services?filter=string&orderBy=string&pageSize=0&pageToken=stringLists services in a project and location.
  • POSTCreates a metastore service in a project and location./v1/:parent/services?requestId=string&serviceId=stringCreates a metastore service in a project and location.
  • POSTExports metadata from a service./v1/:service:exportMetadataExports metadata from a service.
  • POSTMove a table to another database./v1/:service:moveTableToDatabaseMove a table to another database.
  • POSTQuery Dataproc Metastore metadata./v1/:service:queryMetadataQuery Dataproc Metastore metadata.
  • POSTRestores a service from a backup./v1/:service:restoreRestores a service from a backup.
  • POSTStarts the Managed Migration process./v1/:service:startMigrationStarts the Managed Migration process.

projects.locations.operations

  • POSTStarts asynchronous cancellation on a long-running operation/v1/:name:cancelStarts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the…
  • GETLists operations that match the specified filter in the request/v1/:name/operations?filter=string&pageSize=0&pageToken=string&returnPartialSuccess=trueLists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

projects.locations.services.backups

  • GETLists backups in a service./v1/:parent/backups?filter=string&orderBy=string&pageSize=0&pageToken=stringLists backups in a service.
  • POSTCreates a new backup in a given project and location./v1/:parent/backups?backupId=string&requestId=stringCreates a new backup in a given project and location.

API details

Base URL
https://metastore.googleapis.com
Authentication
OAuth 2.0 (authorization code flow) with 1 scope
An API key in the key query parameter
Operations
27 operations on 21 pathsPOST 16GET 9PATCH 1DELETE 1
Main resources
projects.locations.services 12projects.locations.services.metadataImports 3projects.locations.services.migrationExecutions 3projects.locations.federations 2projects.locations.operations 2projects.locations.services.backups 2projects.locations.services.databases.tables 2projects.locations 1
Response formats
application/json
Description format
Google API Discovery, API version v1

How to test the Dataproc Metastore API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Dataproc Metastore API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Gets details of a single migration execution.” (GET /v1/:name), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Dataproc Metastore API?

The Dataproc Metastore API is used to manage the lifecycle and configuration of metastore services. It is listed under Data & analytics and has 27 endpoints.

Who publishes the Dataproc Metastore API?

It is listed from Google's public API description (an OpenAPI document), not published by Google on Swastik Codes. Anyone who controls googleapis.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Dataproc Metastore API?

Requests go to https://metastore.googleapis.com. Endpoint paths are added to this base URL.

How do I authenticate with the Dataproc Metastore API?

It accepts 2 methods: OAuth 2.0 (authorization code flow) with 1 scope; an API key in the key query parameter.

How many endpoints does the Dataproc Metastore API have?

27 operations on 21 paths (16 POST, 9 GET, 1 PATCH, 1 DELETE). The largest groups are projects.locations.services, projects.locations.services.metadataImports, projects.locations.services.migrationExecutions, projects.locations.federations.

Is forking the Dataproc Metastore API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.