Java API endpoint: getEngines

GetEnginesResponse getEngines(xCorrelationId, internalApplicationID, internalOrganizationID, engineName, engineState, engineType, engineOutputType, engineCategoryID, engineIDs, offset, limit, direction, startTime, endTime, preload, orderBy)

Get the list of engines deployed and available on aiWARE.

Example

// Import classes:
import com.veritone.aiware.ApiClient;
import com.veritone.aiware.ApiException;
import com.veritone.aiware.Configuration;
import com.veritone.aiware.auth.*;
import com.veritone.aiware.models.*;
import com.veritone.aiware.edge.EngineApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.aiware.com/edge/v1");
    
    // Configure API key authorization: api_key
    ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
    api_key.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //api_key.setApiKeyPrefix("Token");

    EngineApi apiInstance = new EngineApi(defaultClient);
    String xCorrelationId = "xCorrelationId_example"; // String | Correlation Id that can be passed, traced in the server and will be returned in the response if present in the request
    UUID internalApplicationID = new UUID(); // UUID | Internal ID of Application
    UUID internalOrganizationID = new UUID(); // UUID | ID of Organization.  UUID.  This ID is unique to this aiWARE installation.
    String engineName = "engineName_example"; // String | Field to string match against the engine names
    EngineStateEnum engineState = new EngineStateEnum(); // EngineStateEnum | Field to match the current state
    EngineTypeEnum engineType = new EngineTypeEnum(); // EngineTypeEnum | Field to match the current type
    EngineTypeEnum engineOutputType = new EngineTypeEnum(); // EngineTypeEnum | Field to match the current type
    String engineCategoryID = "engineCategoryID_example"; // String | Filter to the particular engine category ID
    String engineIDs = "engineIDs_example"; // String | Field to provide the input to get engines by Engine ID list. Separated by commas
    Long offset = 56L; // Long | the number of data to skip before getting the result set
    Long limit = 10lL; // Long | the number of items to return.
    String direction = "\"DESC\""; // String | the sort order.  ASC or DESC.
    Long startTime = 56L; // Long | The unix timestamp, describing the start time for the stats
    Long endTime = 56L; // Long | The unix timestamp, describing the end time for the stats
    Boolean preload = true; // Boolean | Filter engines by preload
    String orderBy = "orderBy_example"; // String | The value should be in [name, state, type, organizationID, createdTime]
    try {
      GetEnginesResponse result = apiInstance.getEngines(xCorrelationId, internalApplicationID, internalOrganizationID, engineName, engineState, engineType, engineOutputType, engineCategoryID, engineIDs, offset, limit, direction, startTime, endTime, preload, orderBy);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling EngineApi#getEngines");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Return type

GetEnginesResponse

Authorization

api_key

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

• AI Processing API and clients
• Java API client for AI Processing
• Engine API
• getEngines