# OracleLabsParallelGraphAnalyticsPgxRestApi.AdminFuturesApi

All URIs are relative to */*

Method | HTTP request | Description
------------- | ------------- | -------------
[**cancelAdminFuture**](AdminFuturesApi.md#cancelAdminFuture) | **DELETE** /control/v1/futures/x-future-id | Cancel a future
[**getAdminFuture**](AdminFuturesApi.md#getAdminFuture) | **GET** /control/v1/futures/x-future-id/value | Get the result of a future
[**getAdminFutureStatus**](AdminFuturesApi.md#getAdminFutureStatus) | **GET** /control/v1/futures/x-future-id/status | Get the status of a future

<a name="cancelAdminFuture"></a>
# **cancelAdminFuture**
> cancelAdminFuture(xFutureId, opts)

Cancel a future

Cancel a pending future. This will cause the future to complete exceptionally

### Example
```javascript
import {OracleLabsParallelGraphAnalyticsPgxRestApi} from 'oracle_labs_parallel_graph_analytics__pgx_rest_api';

let apiInstance = new OracleLabsParallelGraphAnalyticsPgxRestApi.AdminFuturesApi();
let xFutureId = "xFutureId_example"; // String | the future ID
let opts = { 
  'csrfToken': "csrfToken_example" // String | CSRF token
};
apiInstance.cancelAdminFuture(xFutureId, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **xFutureId** | **String**| the future ID | 
 **csrfToken** | **String**| CSRF token | [optional] 

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: Not defined

<a name="getAdminFuture"></a>
# **getAdminFuture**
> getAdminFuture(xFutureId)

Get the result of a future

Get the result of a future. Will block the request if the future is not completed on the server side.

### Example
```javascript
import {OracleLabsParallelGraphAnalyticsPgxRestApi} from 'oracle_labs_parallel_graph_analytics__pgx_rest_api';

let apiInstance = new OracleLabsParallelGraphAnalyticsPgxRestApi.AdminFuturesApi();
let xFutureId = "xFutureId_example"; // String | the future ID

apiInstance.getAdminFuture(xFutureId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **xFutureId** | **String**| the future ID | 

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: Not defined

<a name="getAdminFutureStatus"></a>
# **getAdminFutureStatus**
> AsyncStatus getAdminFutureStatus(xFutureId)

Get the status of a future

Get the current status of a future

### Example
```javascript
import {OracleLabsParallelGraphAnalyticsPgxRestApi} from 'oracle_labs_parallel_graph_analytics__pgx_rest_api';

let apiInstance = new OracleLabsParallelGraphAnalyticsPgxRestApi.AdminFuturesApi();
let xFutureId = "xFutureId_example"; // String | the future ID

apiInstance.getAdminFutureStatus(xFutureId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **xFutureId** | **String**| the future ID | 

### Return type

[**AsyncStatus**](AsyncStatus.md)

### Authorization

No authorization required

### HTTP request headers

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