search method

Future<GoogleCloudDatacatalogV1beta1SearchCatalogResponse> search(
  1. GoogleCloudDatacatalogV1beta1SearchCatalogRequest request, {
  2. String? $fields,
})

Searches Data Catalog for multiple resources like entries, tags that match a query.

This is a custom method (https://cloud.google.com/apis/design/custom_methods) and does not return the complete resource, only the resource identifier and high level fields. Clients can subsequently call Get methods. Note that Data Catalog search queries do not guarantee full recall. Query results that match your query may not be returned, even in subsequent result pages. Also note that results returned (and not returned) can vary across repeated search queries. See Data Catalog Search Syntax for more information.

request - The metadata request object.

Request parameters:

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

Completes with a GoogleCloudDatacatalogV1beta1SearchCatalogResponse.

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<GoogleCloudDatacatalogV1beta1SearchCatalogResponse> search(
  GoogleCloudDatacatalogV1beta1SearchCatalogRequest request, {
  core.String? $fields,
}) async {
  final _body = convert.json.encode(request.toJson());
  final _queryParams = <core.String, core.List<core.String>>{
    if ($fields != null) 'fields': [$fields],
  };

  const _url = 'v1beta1/catalog:search';

  final _response = await _requester.request(
    _url,
    'POST',
    body: _body,
    queryParams: _queryParams,
  );
  return GoogleCloudDatacatalogV1beta1SearchCatalogResponse.fromJson(
      _response as core.Map<core.String, core.dynamic>);
}