Method: projects.locations.catalogs.databases.locks.list

List all locks in a specified database.

HTTP request

GET https://biglake.googleapis.com/v1alpha1/{parent=projects/*/locations/*/catalogs/*/databases/*}/locks

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The parent, which owns this collection of locks. Format: projects/{project_id_or_number}/locations/{locationId}/catalogs/{catalogId}/databases/{databaseId}

Query parameters

Parameters
pageSize

integer

The maximum number of locks to return. The service may return fewer than this value. If unspecified, at most 50 locks will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken

string

A page token, received from a previous locks.list call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to locks.list must match the call that provided the page token.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

Response message for the locks.list method.

JSON representation 
{
  "locks": [
    {
      object (Lock)
    }
  ],
  "nextPageToken": string
}
Fields
locks[]

object (Lock)

The locks from the specified database.
nextPageToken

string

A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/bigquery
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • biglake.locks.list

For more information, see the IAM documentation.