elements_index

Index

The Index endpoints.

Functions

This module offers a collection of functions designed to address specific tasks and provide utilities for various purposes. Explore the available functions to make the most of the functionalities provided by this module.

• elements_build_indexes
• elements_get_plans

---

Back To Top

elements_build_indexes

Builds all indexes.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_build_indexes(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsBuildIndexRequest	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	Any
_request	ElementsRequest

---

Back To Top

elements_get_plans

Gets all index plans.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_plans(_offset=undefined, _count=undefined, _callback=undefined)

Argument	Type	Description
_offset	Real
_count	Real
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsPaginationIndexPlanObject or Undefined
_request	ElementsRequest

---