projects

Changed on

List metadata entities in a zone.

get/v1/{+parent}/entities

Request

  • Base URL: https://dataplex.googleapis.com
  • URL: https://dataplex.googleapis.com/v1/{+parent}/entities
  • Auth: one of:
    • OAuth 2 (implicit, authorization URL https://accounts.google.com/o/oauth2/auth, scopes: https://www.googleapis.com/auth/cloud-platform) and OAuth 2 (authorization code, authorization URL https://accounts.google.com/o/oauth2/auth, token URL https://accounts.google.com/o/oauth2/token, scopes: https://www.googleapis.com/auth/cloud-platform)
    • OAuth 2 (implicit, authorization URL https://accounts.google.com/o/oauth2/auth, scopes: https://www.googleapis.com/auth/dataplex.read-write) and OAuth 2 (authorization code, authorization URL https://accounts.google.com/o/oauth2/auth, token URL https://accounts.google.com/o/oauth2/token, scopes: https://www.googleapis.com/auth/dataplex.read-write)

Path parameters

parentstring required

Required. The resource name of the parent zone: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}.

Query parameters

filterstring

Optional. The following filter parameters can be added to the URL to limit the entities returned by the API: Entity ID: ?filter="id=entityID" Asset ID: ?filter="asset=assetID" Data path ?filter="data_path=gs://my-bucket" Is HIVE compatible: ?filter="hive_compatible=true" Is BigQuery compatible: ?filter="bigquery_compatible=true"

pageSizeinteger

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

pageTokenstring

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

view'ENTITY_VIEW_UNSPECIFIED' | 'TABLES' | 'FILESETS'

Required. Specify the entity view to make a partial list request.

Response

Successful response

Changes

  • 6c7e9028cba8Revision changes
    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/dataplex.read-write was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/dataplex.read-write was removed from the endpoint's security scheme Oauth2c

  • 395bfc8abfeeRevision changes
    • breaking

      removed the media type */* for the response with the status

    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/dataplex.read-write was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/dataplex.read-write was removed from the endpoint's security scheme Oauth2c