List Indices | 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.

client.list_indexes()

About this method

Get a list of indices with their associated metadata.

This method retrieves a list of all indices associated with a given application id.

The returned list includes the name of the index as well as its associated metadata, such as the number of records, size, last build time, and pending tasks.

Calling this method returns all indices, with no paging. So if there are 1000s of indices for a certain application id, then all 1000 indices will be returned at the same time.

The returned list complies with any ACL restrictions of the API key used to retrieve them. For example, if you’re using an API key that only has access to some indices, you will only retrieve these.

Examples

1
var_dump($client->listIndices());

1
client.list_indexes

1
2
3
client.listIndices().then(({ items }) => {
  console.log(items);
});

1
print(client.list_indices())

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

1
2
3
4
5
6
client.listIndexesAsync(new CompletionHandler() {
    @Override
    public void requestCompleted(JSONObject content, AlgoliaException error) {
        // [...]
    }
});

1
2
3
4
var result = client.ListIndices();

// Asynchronous
var result = await client.ListIndicesAsync();

1
2
3
4
5
// Sync version
client.listIndices();

// Async version
client.listIndicesAsync();

1
res, err := client.ListIndices()

1
val indices: Future[Indices] = client.execute { list.indices }

1
2
3
val indices = client.listIndices()

println(indices)

Parameters

No parameters for this method.

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
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
{
  "items":[
    {
      "name": "airports",
      "createdAt": "2017-05-15T08:09:45.173Z",
      "updatedAt": "2017-05-15T08:09:45.173Z",
      "entries":  1005,
      "dataSize": 0,
      "fileSize": 0,
      "lastBuildTimeS": 1,
      "numberOfPendingTasks": 0,
      "pendingTask": false,
      "primary": 'primary_index',
      "replicas": [],
    },
    [...]
  ],
  "nbPages":1
}

items ➔ index object