Java API endpoint: getEngineInstanceList

GetEngineInstanceListResponse getEngineInstanceList(xCorrelationId, engineInstanceIDs, engineIDs, hostIDs, workRequestIDs, status, drain, launchStartTime, launchEndTime, modifiedBefore, modifiedAfter, createdBefore, createdAfter, offset, limit, direction, orderBy)

Get engines instances with filtering.

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
    String engineInstanceIDs = "engineInstanceIDs_example"; // String | Field to provide the input to get engine instances by ID list. Separated by commas
    String engineIDs = "engineIDs_example"; // String | Field to provide the input to get engines by Engine ID list. Separated by commas
    UUID hostIDs = new UUID(); // UUID | Filtering engine instances by host IDs. Separated by commas
    UUID workRequestIDs = new UUID(); // UUID | Filters engine instances by workrequest IDs. Separated by commas
    EngineStatusEnum status = new EngineStatusEnum(); // EngineStatusEnum | Field to match the current status
    Boolean drain = true; // Boolean | Filter by drain
    Long launchStartTime = 56L; // Long | The unix timestamp, describing a lower limit for the time an engine instance was launched.
    Long launchEndTime = 56L; // Long | The unix timestamp, describing an upper limit for the time an engine instance was launched.
    Long modifiedBefore = 56L; // Long | Filter by items modified before expressed as timestamp
    Long modifiedAfter = 56L; // Long | Filter by items modified after expressed as timestamp
    Long createdBefore = 56L; // Long | Filter items where created date is before this date
    Long createdAfter = 56L; // Long | Filter items where created date is after this date
    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.
    String orderBy = "orderBy_example"; // String | It should be in [engineID, hostID, status, createdTime, modifiedTime, lastUpdateTime, launchTime]
    try {
      GetEngineInstanceListResponse result = apiInstance.getEngineInstanceList(xCorrelationId, engineInstanceIDs, engineIDs, hostIDs, workRequestIDs, status, drain, launchStartTime, launchEndTime, modifiedBefore, modifiedAfter, createdBefore, createdAfter, offset, limit, direction, orderBy);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling EngineApi#getEngineInstanceList");
      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

GetEngineInstanceListResponse

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
• getEngineInstanceList