Interface SnIndexerService
- All Known Implementing Classes:
DefaultSnIndexerService
public interface SnIndexerService
Service for indexer operations.
-
Method Summary
Modifier and TypeMethodDescriptioncreateFullIndexerRequest(String indexTypeId, SnIndexerItemSource indexerItemSource) Creates a full indexer request.createFullIndexerRequest(String indexTypeId, SnIndexerItemSource indexerItemSource, SnProgressTracker progressTracker) Creates a full indexer request.createIncrementalIndexerRequest(String indexTypeId, List<SnIndexerItemSourceOperation> indexerItemSourceOperations) Creates an incremental indexer request.createIncrementalIndexerRequest(String indexTypeId, List<SnIndexerItemSourceOperation> indexerItemSourceOperations, SnProgressTracker progressTracker) Creates an incremental indexer request.createItemSource(AbstractSnIndexerItemSourceModel itemSource, Map<String, Object> parameters) Creates a new instance ofSnIndexerItemSource.createItemSourceOperation(SnIndexerItemSourceOperationModel itemSourceOperation, Map<String, Object> parameters) Creates a new instance ofSnIndexerItemSourceOperation.index(SnIndexerRequest indexerRequest) Starts a new indexer operation.
-
Method Details
-
createItemSource
SnIndexerItemSource createItemSource(AbstractSnIndexerItemSourceModel itemSource, Map<String, Object> parameters) throws SnIndexerExceptionCreates a new instance ofSnIndexerItemSource.- Parameters:
itemSource- - the item sourceparameters- - the parameters- Returns:
- the new instance of
SnIndexerItemSource - Throws:
SnIndexerException- if an error occurs
-
createItemSourceOperation
SnIndexerItemSourceOperation createItemSourceOperation(SnIndexerItemSourceOperationModel itemSourceOperation, Map<String, Object> parameters) throws SnIndexerExceptionCreates a new instance ofSnIndexerItemSourceOperation.- Parameters:
itemSourceOperation- - the item source operationparameters- - the parameters- Returns:
- the new instance of
SnIndexerItemSourceOperation - Throws:
SnIndexerException- if an error occurs
-
createFullIndexerRequest
SnIndexerRequest createFullIndexerRequest(String indexTypeId, SnIndexerItemSource indexerItemSource) throws SnIndexerException Creates a full indexer request.- Parameters:
indexTypeId- - the index type idindexerItemSource- - the indexer item source- Returns:
- the new indexer request
- Throws:
SnIndexerException- if an error occurs
-
createFullIndexerRequest
SnIndexerRequest createFullIndexerRequest(String indexTypeId, SnIndexerItemSource indexerItemSource, SnProgressTracker progressTracker) throws SnIndexerException Creates a full indexer request.- Parameters:
indexTypeId- - the index type idindexerItemSource- - the indexer item sourceprogressTracker- - the progress tracker- Returns:
- the new indexer request
- Throws:
SnIndexerException- if an error occurs
-
createIncrementalIndexerRequest
SnIndexerRequest createIncrementalIndexerRequest(String indexTypeId, List<SnIndexerItemSourceOperation> indexerItemSourceOperations) throws SnIndexerException Creates an incremental indexer request.- Parameters:
indexTypeId- - the index type idindexerOperationType- - the indexer operation typeindexerItemSourceOperations- - the indexer item source operations- Returns:
- the new indexer request
- Throws:
SnIndexerException- if an error occurs
-
createIncrementalIndexerRequest
SnIndexerRequest createIncrementalIndexerRequest(String indexTypeId, List<SnIndexerItemSourceOperation> indexerItemSourceOperations, SnProgressTracker progressTracker) throws SnIndexerException Creates an incremental indexer request.- Parameters:
indexTypeId- - the index type idindexerOperationType- - the indexer operation typeindexerItemSourceOperations- - the indexer item source operationsprogressTracker- - the progress tracker- Returns:
- the new indexer request
- Throws:
SnIndexerException- if an error occurs
-
index
Starts a new indexer operation.- Parameters:
indexerRequest- - the indexer request- Returns:
- the indexer response
- Throws:
SnIndexerException- if an error occurs
-