purge method

Future<GoogleLongrunningOperation> purge(
  1. GoogleCloudRetailV2PurgeUserEventsRequest request,
  2. String parent, {
  3. String? $fields,
})

Deletes permanently all user events specified by the filter provided.

Depending on the number of events specified by the filter, this operation could take hours or days to complete. To test a filter, use the list command first.

request - The metadata request object.

Request parameters:

parent - Required. The resource name of the catalog under which the events are created. The format is projects/${projectId}/locations/global/catalogs/${catalogId} Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+/catalogs/\[^/\]+$.

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

Completes with a GoogleLongrunningOperation.

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<GoogleLongrunningOperation> purge(
  GoogleCloudRetailV2PurgeUserEventsRequest 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_ = 'v2/' + core.Uri.encodeFull('$parent') + '/userEvents:purge';

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