Method: projects.locations.lakes.zones.entities.partitions.list

Stay organized with collections Save and categorize content based on your preferences.

List metadata partitions of an entity.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The resource name of the parent entity: projects/{project_number}/locations/{locationId}/lakes/{lakeId}/zones/{zoneId}/entities/{entityId}.

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

  • dataplex.partitions.list

Query parameters

Parameters
pageSize

integer

Optional. Maximum number of partitions to return. The service may return fewer than this value. If unspecified, 100 partitions will be returned by default. The maximum page size is 500; larger values will will be truncated to 500.

pageToken

string

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

filter

string

Optional. Filter the partitions returned to the caller using a key value pair expression. Supported operators and syntax:

  • logic operators: AND, OR
  • comparison operators: <, >, >=, <= ,=, !=
  • LIKE operators:
  • The right hand of a LIKE operator supports "." and "*" for wildcard searches, for example "value1 LIKE ".*oo.*"
  • parenthetical grouping: ( )

Sample filter expression: `?filter="key1 < value1 OR key2 > value2"

Notes:

  • Keys to the left of operators are case insensitive.
  • Partition results are sorted first by creation time, then by lexicographic order.
  • Up to 20 key value filter pairs are allowed, but due to performance considerations, only the first 10 will be used as a filter.

Request body

The request body must be empty.

Response body

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

List metadata partitions response.

JSON representation
{
  "partitions": [
    {
      object (Partition)
    }
  ],
  "nextPageToken": string
}
Fields
partitions[]

object (Partition)

Partitions under the specified parent entity.

nextPageToken

string

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

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.