search method

Future<GoogleCloudContentwarehouseV1SearchDocumentsResponse> search(
  1. GoogleCloudContentwarehouseV1SearchDocumentsRequest request,
  2. String parent, {
  3. String? $fields,
})

Searches for documents using provided SearchDocumentsRequest.

This call only returns documents that the caller has permission to search against.

request - The metadata request object.

Request parameters:

parent - Required. The parent, which owns this collection of documents. Format: projects/{project_number}/locations/{location}. Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+$.

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

Completes with a GoogleCloudContentwarehouseV1SearchDocumentsResponse.

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<GoogleCloudContentwarehouseV1SearchDocumentsResponse> search(
  GoogleCloudContentwarehouseV1SearchDocumentsRequest request,
  core.String parent, {
  core.String? $fields,
}) async {
  final body_ = convert.json.encode(request);
  final queryParams_ = <core.String, core.List<core.String>>{
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'v1/' + core.Uri.encodeFull('$parent') + '/documents:search';

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