push method

Future<Item> push(PushItemRequest request, String name, { String? $fields, })

Pushes an item onto a queue for later polling and updating.

This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source.

request - The metadata request object.

Request parameters:

name - The name of the item to push into the indexing queue. Format: datasources/{source_id}/items/{ID} This is a required field. The maximum length is 1536 characters. Value must have pattern ^datasources/\[^/\]+/items/\[^/\]+$.

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

Completes with a Item.

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<Item> push(
  PushItemRequest request,
  core.String name, {
  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/indexing/' + core.Uri.encodeFull('$name') + ':push';

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