Method: projects.locations.lakes.list

Lists lake resources in a project and location.

HTTP request

GET https://dataplex.googleapis.com/v1/{parent=projects/*/locations/*}/lakes

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The resource name of the lake location, of the form: projects/{project_number}/locations/{locationId} where locationId refers to a GCP region.

Authorization requires the following IAM permission on the specified resource parent:

  • dataplex.lakes.list

Query parameters

Parameters
pageSize

integer

Optional. Maximum number of Lakes to return. The service may return fewer than this value. If unspecified, at most 10 lakes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

pageToken

string

Optional. Page token received from a previous lakes.list call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to lakes.list must match the call that provided the page token.

filter

string

Optional. Filter request.

orderBy

string

Optional. Order by fields for the result.

Request body

The request body must be empty.

Response body

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

List lakes response.

JSON representation
{
  "lakes": [
    {
      object (Lake)
    }
  ],
  "nextPageToken": string,
  "unreachableLocations": [
    string
  ]
}
Fields
lakes[]

object (Lake)

Lakes under the given parent location.

nextPageToken

string

Token to retrieve the next page of results, or empty if there are no more results in the list.

unreachableLocations[]

string

Locations that could not be reached.

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.