Interface EnginesApi
-
- All Known Implementing Classes:
EnginesApiImpl
public interface EnginesApi
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description EngineResponsecreateEngine(CreateEngine engine)booleandeleteEngine(String engineName)EngineResponsegetEngineByName(String engineName)Retrieves an Engine by name.EnginesResponselistEngines(Page page)Retrieves all Engines that the API Key is scoped to access.
-
-
-
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)
-
deleteEngine
boolean deleteEngine(String engineName)
-
-