com.valtech.aem.saas.api.indexing

Interface IndexUpdateService

public interface IndexUpdateService

Service for indexing content on SaaS admin.

Method Summary

Modifier and Type	Method and Description
Optional<IndexUpdateResponseDTO>	deleteIndexedUrl(@NonNull String url, @NonNull String repositoryPath) Adds an 'delete index' job to the indexing queue in saas admin.
Optional<IndexUpdateResponseDTO>	indexContent(@NonNull IndexContentPayloadDTO indexContentPayloadDto) Adds an 'add index content' job to the indexing queue in saas admin.
Optional<IndexUpdateResponseDTO>	indexUrl(@NonNull String url, @NonNull String repositoryPath) Schedules an 'add index content' job to the indexing queue in saas admin.

Method Detail

indexUrl

Optional<IndexUpdateResponseDTO> indexUrl(@NonNull
                                          @NonNull String url,
                                          @NonNull
                                          @NonNull String repositoryPath)

Schedules an 'add index content' job to the indexing queue in saas admin.

Parameters:

url - public url of the resource presenting the content that will be indexed.

repositoryPath - the resource/content node's location in jcr.

Returns:

response optional, which is empty if the there has been an error during the request execution.

deleteIndexedUrl

Optional<IndexUpdateResponseDTO> deleteIndexedUrl(@NonNull
                                                  @NonNull String url,
                                                  @NonNull
                                                  @NonNull String repositoryPath)

Adds an 'delete index' job to the indexing queue in saas admin.

Parameters:

url - public url of the resource presenting the content that will be removed from indexed data.

repositoryPath - the resource/content node's location in jcr.

Returns:

response optional, which is empty if the there has been an error during the request execution.

indexContent

Optional<IndexUpdateResponseDTO> indexContent(@NonNull
                                              @NonNull IndexContentPayloadDTO indexContentPayloadDto)

Adds an 'add index content' job to the indexing queue in saas admin.

Parameters:

indexContentPayloadDto - a pojo that is used for creating a json payload with a predefined structure, that represents the content to be indexed.

Returns:

response optional, which is empty if the there has been an error during the request execution.