Interface EnginesApi


  • public interface EnginesApi
    Represents operations in the AppSearch Engines API
    • Method Detail

      • getEngineByName

        EngineResponse getEngineByName​(String engineName)
        Retrieves an Engine by name.
        Parameters:
        engineName - The name of the engine
        Returns:
        the engine
      • listEngines

        EnginesResponse listEngines​(Page page)
        Retrieves all Engines that the API Key is scoped to access.
        Parameters:
        page - Optional, the pagination info
        Returns:
        a list of engines
      • createEngine

        EngineResponse createEngine​(CreateEngine engine)
        Create a new Engine
        Parameters:
        engine - The engine to create
        Returns:
        The Engine create response
      • deleteEngine

        boolean deleteEngine​(String engineName)
        Delete an engine
        Parameters:
        engineName - The name of the engine to delete
        Returns:
        true if the engine was successfully deleted, otherwise false