lookup method

Future<GoogleCloudDatacatalogV1Entry> lookup({
  1. String? fullyQualifiedName,
  2. String? linkedResource,
  3. String? location,
  4. String? project,
  5. String? sqlResource,
  6. String? $fields,
})

Gets an entry by its target resource name.

The resource name comes from the source Google Cloud Platform service.

Request parameters:

fullyQualifiedName - [Fully Qualified Name (FQN)](https://cloud.google.com//data-catalog/docs/fully-qualified-names) 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 - The full name of the Google Cloud Platform resource the Data Catalog entry represents. For more information, see 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 - 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 - 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 - 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.

$fields - Selector specifying which fields to include in a partial response.

Completes with a GoogleCloudDatacatalogV1Entry.

Completes with a commons.ApiRequestError if the API endpoint returned an error.

If the used http.Client completes with an error when making a REST call, this method will complete with the same error.

Implementation

async.Future<GoogleCloudDatacatalogV1Entry> lookup({
  core.String? fullyQualifiedName,
  core.String? linkedResource,
  core.String? location,
  core.String? project,
  core.String? sqlResource,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if (fullyQualifiedName != null)
      'fullyQualifiedName': [fullyQualifiedName],
    if (linkedResource != null) 'linkedResource': [linkedResource],
    if (location != null) 'location': [location],
    if (project != null) 'project': [project],
    if (sqlResource != null) 'sqlResource': [sqlResource],
    if ($fields != null) 'fields': [$fields],
  };

  const url_ = 'v1/entries:lookup';

  final response_ = await _requester.request(
    url_,
    'GET',
    queryParams: queryParams_,
  );
  return GoogleCloudDatacatalogV1Entry.fromJson(
      response_ as core.Map<core.String, core.dynamic>);
}