Following commands have been created to enable user to toggle indexing and retrieve indexing status:
{PANEL:StartIndexing}
This methods starts indexing, if it was previously stopped.
{CODE:java start_indexing_1@ClientApi\Commands\HowTo\StartStopIndexingAndGetIndexingStatus.java /}
| Parameters | ||
|---|---|---|
| maxNumberOfParallelIndexTasks | Integer | if set then maximum number of parallel indexing tasks will be set to this value |
{CODE:java start_indexing_2@ClientApi\Commands\HowTo\StartStopIndexingAndGetIndexingStatus.java /}
{PANEL/}
{PANEL:StopIndexing}
This methods stops indexing, if it was running.
{CODE:java stop_indexing_1@ClientApi\Commands\HowTo\StartStopIndexingAndGetIndexingStatus.java /}
{CODE:java stop_indexing_2@ClientApi\Commands\HowTo\StartStopIndexingAndGetIndexingStatus.java /}
{PANEL/}
{PANEL:GetIndexingStatus}
This methods retrieves current status of the indexing.
{CODE:java get_indexing_status_1@ClientApi\Commands\HowTo\StartStopIndexingAndGetIndexingStatus.java /}
| Return Value | |
|---|---|
| String | "Indexing" if the indexing is running, "Paused" otherwise. |
{CODE:java get_indexing_status_2@ClientApi\Commands\HowTo\StartStopIndexingAndGetIndexingStatus.java /}
{PANEL/}