Package com.valtech.aem.saas.api.indexing

Interface IndexUpdateService

  • public interface IndexUpdateService
    Service for indexing content on SaaS admin.

    • Method Detail

      • indexUrl

        Optional<IndexUpdateResponseDTO> indexUrl​(@NonNull
                                          @NonNull SearchCAConfigurationModel searchConfiguration,
                                          @NonNull
                                          @NonNull String url,
                                          @NonNull
                                          @NonNull String repositoryPath)
        Schedules an 'add index content' job to the indexing queue in saas admin.
        Parameters:
        searchConfiguration - sling model accessing context aware search configurations (i.e client and index).
        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 SearchCAConfigurationModel searchConfiguration,
                                                  @NonNull
                                                  @NonNull String url,
                                                  @NonNull
                                                  @NonNull String repositoryPath)
        Adds an 'delete index' job to the indexing queue in saas admin.
        Parameters:
        searchConfiguration - sling model accessing context aware search configurations (i.e client and index).
        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 SearchCAConfigurationModel searchConfiguration,
                                              @NonNull
                                              @NonNull IndexContentPayloadDTO indexContentPayloadDto)
        Adds an 'add index content' job to the indexing queue in saas admin.
        Parameters:
        searchConfiguration - sling model accessing context aware search configurations (i.e client and index).
        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.

      • indexUrl

        Optional<IndexUpdateResponseDTO> indexUrl​(@NonNull
                                          @NonNull String client,
                                          @NonNull
                                          @NonNull String url,
                                          @NonNull
                                          @NonNull String repositoryPath)
        Schedules an 'add index content' job to the indexing queue in saas admin.
        Parameters:
        client - unique identifier assigned to a site in the saas admin tool.
        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 client,
                                                  @NonNull
                                                  @NonNull String url,
                                                  @NonNull
                                                  @NonNull String repositoryPath)
        Adds an 'delete index' job to the indexing queue in saas admin.
        Parameters:
        client - unique identifier assigned to a site in the saas admin tool.
        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 String client,
                                              @NonNull
                                              @NonNull IndexContentPayloadDTO indexContentPayloadDto)
        Adds an 'add index content' job to the indexing queue in saas admin.
        Parameters:
        client - unique identifier assigned to a site in the saas admin tool.
        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.