EntriesLookupOptions

import type { EntriesLookupOptions } from "https://googleapis.deno.dev/v1/datacatalog:v1.ts";

Additional options for DataCatalog#entriesLookup.

interface EntriesLookupOptions {

fullyQualifiedName?: string;

linkedResource?: string;

location?: string;

project?: string;

sqlResource?: string;

}

§Properties

fullyQualifiedName?: string

[src]

Fully Qualified Name (FQN) of the resource. FQNs take two forms: * For non-regionalized resources: {SYSTEM}:{PROJECT}.{PATH_TO_RESOURCE_SEPARATED_WITH_DOTS} * For regionalized resources: {SYSTEM}:{PROJECT}.{LOCATION_ID}.{PATH_TO_RESOURCE_SEPARATED_WITH_DOTS} Example for a DPMS table: dataproc_metastore:{PROJECT_ID}.{LOCATION_ID}.{INSTANCE_ID}.{DATABASE_ID}.{TABLE_ID}

linkedResource?: string

[src]

The full name of the Google Cloud Platform resource the Data Catalog entry represents. For more information, see [Full Resource Name] (https://cloud.google.com/apis/design/resource_names#full_resource_name). Full names are case-sensitive. For example: * //bigquery.googleapis.com/projects/{PROJECT_ID}/datasets/{DATASET_ID}/tables/{TABLE_ID}

//pubsub.googleapis.com/projects/{PROJECT_ID}/topics/{TOPIC_ID}

location?: string

[src]

Location where the lookup should be performed. Required to lookup entry that is not a part of DPMS or DATAPLEX integrated_system using its fully_qualified_name. Ignored in other cases.

project?: string

[src]

Project where the lookup should be performed. Required to lookup entry that is not a part of DPMS or DATAPLEX integrated_system using its fully_qualified_name. Ignored in other cases.

sqlResource?: string

[src]

The SQL name of the entry. SQL names are case-sensitive. Examples: * pubsub.topic.{PROJECT_ID}.{TOPIC_ID} * pubsub.topic.{PROJECT_ID}.`{TOPIC.ID.SEPARATED.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} Identifiers (*_ID) should comply with the [Lexical structure in Standard SQL] (https://cloud.google.com/bigquery/docs/reference/standard-sql/lexical).