Methods
# async allowQuerying(indexName, optionsopt, callbackopt) → {Promise.<boolean>}
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
indexName |
string | ||
options |
Object |
<optional> |
|
timeout |
number |
<optional> |
|
callback |
AllowQueryingCallback |
<optional> |
SearchIndexNotFoundError
Promise.<boolean>
# async analyzeDocument(indexName, document, optionsopt, callbackopt) → {Promise.<Array.<Object>>}
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
indexName |
string | ||
document |
* | ||
options |
Object |
<optional> |
|
timeout |
number |
<optional> |
|
callback |
AnalyzeDocumentCallback |
<optional> |
SearchIndexNotFoundError
Promise.<Array.<Object>>
# async disallowQuerying(indexName, optionsopt, callbackopt) → {Promise.<boolean>}
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
indexName |
string | ||
options |
Object |
<optional> |
|
timeout |
number |
<optional> |
|
callback |
DisallowQueryingCallback |
<optional> |
SearchIndexNotFoundError
Promise.<boolean>
# async dropIndex(indexName, optionsopt, callbackopt) → {Promise.<boolean>}
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
indexName |
string | ||
options |
Object |
<optional> |
|
timeout |
number |
<optional> |
|
callback |
DropSearchIndexCallback |
<optional> |
SearchIndexNotFoundError
Promise.<boolean>
# async freezePlan(indexName, optionsopt, callbackopt) → {Promise.<boolean>}
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
indexName |
string | ||
options |
Object |
<optional> |
|
timeout |
number |
<optional> |
|
callback |
FreezePlanCallback |
<optional> |
SearchIndexNotFoundError
Promise.<boolean>
# async getAllIndexes(optionsopt, callbackopt) → {Promise.<Array.<SearchIndex>>}
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
options |
Object |
<optional> |
|
timeout |
number |
<optional> |
|
callback |
GetAllSearchIndexesCallback |
<optional> |
Promise.<Array.<SearchIndex>>
# async getIndex(indexName, optionsopt, callbackopt) → {Promise.<SearchIndex>}
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
indexName |
string | ||
options |
Object |
<optional> |
|
timeout |
number |
<optional> |
|
callback |
GetSearchIndexCallback |
<optional> |
SearchIndexNotFoundError
Promise.<SearchIndex>
# async getIndexedDocumentsCount(indexName, optionsopt, callbackopt) → {Promise.<number>}
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
indexName |
string | ||
options |
Object |
<optional> |
|
timeout |
number |
<optional> |
|
callback |
GetIndexedDocumentsCountCallback |
<optional> |
SearchIndexNotFoundError
Promise.<number>
# async pauseIngest(indexName, optionsopt, callbackopt) → {Promise.<boolean>}
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
indexName |
string | ||
options |
Object |
<optional> |
|
timeout |
number |
<optional> |
|
callback |
PauseIngestCallback |
<optional> |
SearchIndexNotFoundError
Promise.<boolean>
# async resumeIngest(indexName, optionsopt, callbackopt) → {Promise.<boolean>}
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
indexName |
string | ||
options |
Object |
<optional> |
|
timeout |
number |
<optional> |
|
callback |
ResumeIngestCallback |
<optional> |
SearchIndexNotFoundError
Promise.<boolean>
# async upsertIndex(indexDefinition, optionsopt, callbackopt) → {Promise.<boolean>}
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
indexDefinition |
SearchIndex | ||
options |
Object |
<optional> |
|
timeout |
number |
<optional> |
|
callback |
UpsertSearchIndexCallback |
<optional> |
SearchIndexNotFoundError
Promise.<boolean>