search method

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

Searches for jobs using the provided SearchJobsRequest.

This call constrains the visibility of jobs present in the database, and only returns jobs that the caller has permission to search against.

request - The metadata request object.

Request parameters:

parent - Required. The resource name of the tenant to search within. The format is "projects/{project_id}/tenants/{tenant_id}". For example, "projects/foo/tenants/bar". Value must have pattern ^projects/\[^/\]+/tenants/\[^/\]+$.

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

Completes with a SearchJobsResponse.

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<SearchJobsResponse> search(
  SearchJobsRequest 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_ = 'v4/' + core.Uri.encodeFull('$parent') + '/jobs:search';

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