Method: projects.locations.lakes.zones.entities.get

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

Get a metadata entity.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

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

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

  • dataplex.entities.get

Query parameters

Parameters
view

enum (EntityView)

Optional. Used to select the subset of entity information to return. Defaults to BASIC.

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of Entity.

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

EntityView

Entity views for get entity partial result.

Enums
ENTITY_VIEW_UNSPECIFIED The API will default to the BASIC view.
BASIC Minimal view that does not include the schema.
SCHEMA Include basic information and schema.
FULL Include everything. Currently, this is the same as the SCHEMA view.