Salesforce

Java API endpoint: updateEngineInstanceStatus

« Go Back
Information
Java API endpoint: updateEngineInstanceStatus
000008820
Public
Product Selection
aiWare - API
Article Details

updateEngineInstanceStatus(engineInstanceID, engineInstanceStatus, xCorrelationId)

Updates the Engine Instance Status. A heartbeat communicates back to controller both the aggregated work and delta work from the last heartbeat.

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);
    UUID engineInstanceID = new UUID(); // UUID | ID of Engine Instance
    EngineInstanceStatus engineInstanceStatus = new EngineInstanceStatus(); // EngineInstanceStatus | Engine Instance Status
    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
    try {
      apiInstance.updateEngineInstanceStatus(engineInstanceID, engineInstanceStatus, xCorrelationId);
    } catch (ApiException e) {
      System.err.println("Exception when calling EngineApi#updateEngineInstanceStatus");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

NameTypeDescriptionNotes
engineInstanceIDUUIDID of Engine Instance
engineInstanceStatusEngineInstanceStatusEngine Instance Status
xCorrelationIdStringCorrelation Id that can be passed, traced in the server and will be returned in the response if present in the request[optional]

Return type

null (empty response body)

Authorization

api_key

HTTP request headers

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

HTTP response details

Status codeDescriptionResponse headers
201Item created* X-Aiware-Version -
* X-Correlation-Id -
400Invalid argument. Please see the error response for more information.* X-Aiware-Version -
* X-Correlation-Id -
401Not authorized* X-Aiware-Version -
* X-Correlation-Id -
403Forbidden* X-Aiware-Version -
* X-Correlation-Id -
404Not Found* X-Aiware-Version -
* X-Correlation-Id -
405The request is not allowed.* X-Aiware-Version -
* X-Correlation-Id -
429Too Many Requests* Retry-After -
* X-Aiware-Version -
* X-Correlation-Id -
501Not Implemented* X-Aiware-Version -
* X-Correlation-Id -
503System Unavailable* Retry-After -
* X-Aiware-Version -
* X-Correlation-Id -

 

Additional Technical Documentation Information
Properties
5/23/2025 7:17 PM
5/23/2025 7:18 PM
5/23/2025 7:18 PM
Documentation
Documentation
000008820
Translation Information
English

Powered by