Method: entries.lookup

Get an entry by target resource name. This method allows clients to use the resource name from the source Google Cloud Platform service to get the Data Catalog Entry.

HTTP request

GET https://datacatalog.googleapis.com/v1/entries:lookup

Query parameters

Parameters
readMask

string (FieldMask format)

The fields to return. If not set or empty, all fields are returned.

A comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

lookupMode

enum (LookupMode)

Union parameter target_name. Required. Represents either the Google Cloud Platform resource or SQL name for a Google Cloud Platform resource. target_name can be only one of the following:
linkedResource

string

The full name of the Google Cloud Platform resource the Data Catalog entry represents. See: https://cloud.google.com/apis/design/resource_names#full_resource_name. Full names are case-sensitive.

Examples:

  • //bigquery.googleapis.com/projects/projectId/datasets/datasetId/tables/tableId
  • //pubsub.googleapis.com/projects/projectId/topics/topicId
sqlResource

string

The SQL name of the entry. SQL names are case-sensitive.

Examples:

  • pubsub.project_id.topic_id
  • pubsub.project_id.`topic.id.with.dots`
  • bigquery.table.project_id.dataset_id.table_id
  • bigquery.dataset.project_id.dataset_id
  • datacatalog.entry.project_id.location_id.entry_group_id.entry_id

*_ids should satisfy the standard SQL rules for identifiers. https://cloud.google.com/bigquery/docs/reference/standard-sql/lexical.

Request body

The request body must be empty.

Response body

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

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

LookupMode

Enums
LOOKUP_MODE_UNSPECIFIED Default mode. Data catalog server will call BigQuery DatasetService to determine the location of a BigQuery asset, falling back to fanout.
SKIP_DATASET_SERVICE Skip DatasetService, always fanout to other regions.
SKIP_FANOUT Skip fanout, fail the request if dataset service is unavailable.