lookupEntry method

Future<GoogleCloudDataplexV1Entry> lookupEntry(String name, { List<String>? aspectTypes_1, String? entry, List<String>? paths, String? view, String? $fields, })

Looks up a single entry.

Request parameters:

name - Required. The project to which the request should be attributed in the following form: projects/{project}/locations/{location}. Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+$.

aspectTypes_1 - Optional. Limits the aspects returned to the provided aspect types. Only works if the CUSTOM view is selected.

entry - Required. The resource name of the Entry: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}.

paths - Optional. Limits the aspects returned to those associated with the provided paths within the Entry. Only works if the CUSTOM view is selected.

view - Optional. View for controlling which parts of an entry are to be returned. Possible string values are:

• "ENTRY_VIEW_UNSPECIFIED" : Unspecified EntryView. Defaults to FULL.
• "BASIC" : Returns entry only, without aspects.
• "FULL" : Returns all required aspects as well as the keys of all non-required aspects.
• "CUSTOM" : Returns aspects matching custom fields in GetEntryRequest. If the number of aspects would exceed 100, the first 100 will be returned.
• "ALL" : Returns all aspects. If the number of aspects would exceed 100, the first 100 will be returned.

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

Completes with a GoogleCloudDataplexV1Entry.

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<GoogleCloudDataplexV1Entry> lookupEntry(
  core.String name, {
  core.List<core.String>? aspectTypes_1,
  core.String? entry,
  core.List<core.String>? paths,
  core.String? view,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if (aspectTypes_1 != null) 'aspectTypes': aspectTypes_1,
    if (entry != null) 'entry': [entry],
    if (paths != null) 'paths': paths,
    if (view != null) 'view': [view],
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'v1/' + core.Uri.encodeFull('$name') + ':lookupEntry';

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