delete method

Future<GoogleLongrunningOperation> delete (
  1. String projectId,
  2. String indexId,
  3. {String $fields}
)

Deletes an existing index. An index can only be deleted if it is in a READY or ERROR state. On successful execution of the request, the index will be in a DELETING state. And on completion of the returned google.longrunning.Operation, the index will be removed. During index deletion, the process could result in an error, in which case the index will move to the ERROR state. The process can be recovered by fixing the data that caused the error, followed by calling delete again.

Request parameters:

projectId - Project ID against which to make the request.

indexId - The resource ID of the index to delete.

$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> delete(
    core.String projectId, core.String indexId,
    {core.String $fields}) {
  var _url;
  var _queryParams = new core.Map<core.String, core.List<core.String>>();
  var _uploadMedia;
  var _uploadOptions;
  var _downloadOptions = commons.DownloadOptions.Metadata;
  var _body;

  if (projectId == null) {
    throw new core.ArgumentError("Parameter projectId is required.");
  }
  if (indexId == null) {
    throw new core.ArgumentError("Parameter indexId is required.");
  }
  if ($fields != null) {
    _queryParams["fields"] = [$fields];
  }

  _url = 'v1/projects/' +
      commons.Escaper.ecapeVariable('$projectId') +
      '/indexes/' +
      commons.Escaper.ecapeVariable('$indexId');

  var _response = _requester.request(_url, "DELETE",
      body: _body,
      queryParams: _queryParams,
      uploadOptions: _uploadOptions,
      uploadMedia: _uploadMedia,
      downloadOptions: _downloadOptions);
  return _response
      .then((data) => new GoogleLongrunningOperation.fromJson(data));
}