Salesforce

Java API endpoint: pauseBuild

« Go Back
Information
Java API endpoint: pauseBuild
000008809
Public
Product Selection
aiWare - API
Article Details

AdminOperationResponse pauseBuild(buildID, xCorrelationId, buildState)

This API pauses a build so that tasks based on this engine build will not run.

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 buildID = new UUID(); // UUID | ID of Build
    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 buildState = "buildState_example"; // String | Filter builds by the build state
    try {
      AdminOperationResponse result = apiInstance.pauseBuild(buildID, xCorrelationId, buildState);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling EngineApi#pauseBuild");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

NameTypeDescriptionNotes
buildIDUUIDID of Build
xCorrelationIdStringCorrelation Id that can be passed, traced in the server and will be returned in the response if present in the request[optional]
buildStateStringFilter builds by the build state[optional]

Return type

AdminOperationResponse

Authorization

api_key

HTTP request headers

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

HTTP response details

Status codeDescriptionResponse headers
204Pause a particular build* 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/19/2025 9:07 PM
5/19/2025 9:08 PM
5/19/2025 9:08 PM
Documentation
Documentation
000008809
Translation Information
English

Powered by