Clear Objects | Ruby API Client V1 (Deprecated)

This version of the Ruby API client has been deprecated in favor of the latest version of the Ruby API client.

index.clear_index()

About this method

Clear the records of an index without affecting its settings.

This method enables you to delete an index’s contents (records) without removing any settings, rules and synonyms.

If you want to remove the entire index and not just its records, use the delete method instead.

Clearing an index will have no impact on its Analytics data because you cannot clear an index’s analytics data.

Clearing an index counts as one operation. Note, however, that this operation is expensive:

• when you have more than 100 requests pending, your requests will be throttled.
• when you have more than 5000 requests pending, further requests will be ignored.
• if needed, these values can be tuned through configuration.

Examples

1
$index->clearObjects();

1
index.clear_index

1
2
3
index.clearObjects().then(() => {
  // done
});

1
index.clear_objects()

1
2
3
4
5
index.clearObjects { result in
  if case .success(let response) = result {
    print("Response: \(response)")
  }
}

1
index.clearIndexAsync(null);

1
2
3
4
index.ClearObjects();

// Asynchronous
await index.ClearObjectsAsync();

1
2
3
4
5
// Sync version
index.clearObjects();

// Async version
index.clearObjectsAsync();

1
res, err := index.ClearObjects()

1
client.execute { clear index "index" }

1
index.clearObjects()

Parameters

Response

In this section we document the JSON response returned by the API. Each language will encapsulate this response inside objects specific to the language and/or the implementation. So the actual type in your language might differ from what is documented.

JSON format

1
2
3
4
{
  "updatedAt": "2017-12-18T21:22:40.761Z",
  "taskID": 19541511530
}