All URIs are relative to /v1
Method | HTTP request | Description |
---|---|---|
createTaskGraphLog | POST /taskgraphs/{namespace}/log | |
getTaskGraphLog | GET /taskgraphs/{namespace}/logs/{id} | |
listTaskGraphLogs | GET /taskgraphs/logs | |
reportClientNode | POST /taskgraphs/{namespace}/logs/{id}/report_client_node | |
resubmitTaskGraphExecution | POST /taskgraphs/{namespace}/executions/{id}/resubmit | |
retryTaskGraphExecution | POST /taskgraphs/{namespace}/executions/{id}/retry | |
stopTaskGraphExecution | POST /taskgraphs/{namespace}/executions/{id}/stop | |
submitTaskGraph | POST /taskgraphs/{namespace}/graphs/{id}/submit | |
updateTaskGraphLog | PATCH /taskgraphs/{namespace}/logs/{id} |
TaskGraphLog createTaskGraphLog(namespace, log)
Create a task graph log.
// Import classes:
import io.tiledb.cloud.rest_api.ApiClient;
import io.tiledb.cloud.rest_api.ApiException;
import io.tiledb.cloud.rest_api.Configuration;
import io.tiledb.cloud.rest_api.auth.*;
import io.tiledb.cloud.rest_api.models.*;
import io.tiledb.cloud.rest_api.api.TaskGraphLogsApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("/v1");
// Configure HTTP basic authorization: BasicAuth
HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth");
BasicAuth.setUsername("YOUR USERNAME");
BasicAuth.setPassword("YOUR PASSWORD");
// Configure API key authorization: ApiKeyAuth
ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
ApiKeyAuth.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.setApiKeyPrefix("Token");
TaskGraphLogsApi apiInstance = new TaskGraphLogsApi(defaultClient);
String namespace = "namespace_example"; // String | The namespace that will own this task graph log.
TaskGraphLog log = new TaskGraphLog(); // TaskGraphLog |
try {
TaskGraphLog result = apiInstance.createTaskGraphLog(namespace, log);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling TaskGraphLogsApi#createTaskGraphLog");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
namespace | String | The namespace that will own this task graph log. | |
log | TaskGraphLog |
- Content-Type: application/json
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
201 | The task graph was created. The returned TaskGraphLog will include the data the client sent, with the server-defined fields added in. | - |
502 | Bad Gateway | - |
0 | error response | - |
TaskGraphLog getTaskGraphLog(namespace, id)
Fetch information about a single task graph execution.
// Import classes:
import io.tiledb.cloud.rest_api.ApiClient;
import io.tiledb.cloud.rest_api.ApiException;
import io.tiledb.cloud.rest_api.Configuration;
import io.tiledb.cloud.rest_api.auth.*;
import io.tiledb.cloud.rest_api.models.*;
import io.tiledb.cloud.rest_api.api.TaskGraphLogsApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("/v1");
// Configure HTTP basic authorization: BasicAuth
HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth");
BasicAuth.setUsername("YOUR USERNAME");
BasicAuth.setPassword("YOUR PASSWORD");
// Configure API key authorization: ApiKeyAuth
ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
ApiKeyAuth.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.setApiKeyPrefix("Token");
TaskGraphLogsApi apiInstance = new TaskGraphLogsApi(defaultClient);
String namespace = "namespace_example"; // String | The namespace that owns this task graph log.
String id = "id_example"; // String | The UUID of the task graph log entry.
try {
TaskGraphLog result = apiInstance.getTaskGraphLog(namespace, id);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling TaskGraphLogsApi#getTaskGraphLog");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
namespace | String | The namespace that owns this task graph log. | |
id | String | The UUID of the task graph log entry. |
- Content-Type: Not defined
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | Information about the execution of a single task graph. | - |
502 | Bad Gateway | - |
0 | error response | - |
TaskGraphLogsData listTaskGraphLogs(namespace, createdBy, status, search, startTime, endTime, page, perPage)
Fetch the task graph logs of a namespace the user has access to. The returned entries will include only summary data, and will not include information about the individual tasks that were executed. (This information is available when requesting an individual task graph log.) Entries in the response are ordered from newest to oldest. Pagination parameters work as in other API methods; see PaginationMetadata.
// Import classes:
import io.tiledb.cloud.rest_api.ApiClient;
import io.tiledb.cloud.rest_api.ApiException;
import io.tiledb.cloud.rest_api.Configuration;
import io.tiledb.cloud.rest_api.auth.*;
import io.tiledb.cloud.rest_api.models.*;
import io.tiledb.cloud.rest_api.api.TaskGraphLogsApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("/v1");
// Configure HTTP basic authorization: BasicAuth
HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth");
BasicAuth.setUsername("YOUR USERNAME");
BasicAuth.setPassword("YOUR PASSWORD");
// Configure API key authorization: ApiKeyAuth
ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
ApiKeyAuth.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.setApiKeyPrefix("Token");
TaskGraphLogsApi apiInstance = new TaskGraphLogsApi(defaultClient);
String namespace = "namespace_example"; // String | Include logs for this namespace.
String createdBy = "createdBy_example"; // String | Include logs from only this user.
String status = "status_example"; // String | Filter to only return these statuses
String search = "search_example"; // String | search string that will look at name.
OffsetDateTime startTime = OffsetDateTime.now(); // OffsetDateTime | Include logs created after this time.
OffsetDateTime endTime = OffsetDateTime.now(); // OffsetDateTime | Include logs created before this time.
Integer page = 56; // Integer | pagination offset
Integer perPage = 56; // Integer | pagination limit
try {
TaskGraphLogsData result = apiInstance.listTaskGraphLogs(namespace, createdBy, status, search, startTime, endTime, page, perPage);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling TaskGraphLogsApi#listTaskGraphLogs");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
namespace | String | Include logs for this namespace. | [optional] |
createdBy | String | Include logs from only this user. | [optional] |
status | String | Filter to only return these statuses | [optional] |
search | String | search string that will look at name. | [optional] |
startTime | OffsetDateTime | Include logs created after this time. | [optional] |
endTime | OffsetDateTime | Include logs created before this time. | [optional] |
page | Integer | pagination offset | [optional] |
perPage | Integer | pagination limit | [optional] |
- Content-Type: Not defined
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | The task graph logs that matched the user's query. | - |
502 | Bad Gateway | - |
0 | error response | - |
reportClientNode(namespace, id, report)
// Import classes:
import io.tiledb.cloud.rest_api.ApiClient;
import io.tiledb.cloud.rest_api.ApiException;
import io.tiledb.cloud.rest_api.Configuration;
import io.tiledb.cloud.rest_api.auth.*;
import io.tiledb.cloud.rest_api.models.*;
import io.tiledb.cloud.rest_api.api.TaskGraphLogsApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("/v1");
// Configure HTTP basic authorization: BasicAuth
HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth");
BasicAuth.setUsername("YOUR USERNAME");
BasicAuth.setPassword("YOUR PASSWORD");
// Configure API key authorization: ApiKeyAuth
ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
ApiKeyAuth.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.setApiKeyPrefix("Token");
TaskGraphLogsApi apiInstance = new TaskGraphLogsApi(defaultClient);
String namespace = "namespace_example"; // String | The namespace that owns this task graph log.
String id = "id_example"; // String | The UUID of the task graph log entry.
TaskGraphClientNodeStatus report = new TaskGraphClientNodeStatus(); // TaskGraphClientNodeStatus | The node status to report.
try {
apiInstance.reportClientNode(namespace, id, report);
} catch (ApiException e) {
System.err.println("Exception when calling TaskGraphLogsApi#reportClientNode");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
namespace | String | The namespace that owns this task graph log. | |
id | String | The UUID of the task graph log entry. | |
report | TaskGraphClientNodeStatus | The node status to report. |
null (empty response body)
- Content-Type: application/json
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
204 | Status reported successfully. | - |
502 | Bad Gateway | - |
0 | error response | - |
TaskGraphLog resubmitTaskGraphExecution(namespace, id)
Resubmits a task graph in the given namespace using the associated execution id.
// Import classes:
import io.tiledb.cloud.rest_api.ApiClient;
import io.tiledb.cloud.rest_api.ApiException;
import io.tiledb.cloud.rest_api.Configuration;
import io.tiledb.cloud.rest_api.auth.*;
import io.tiledb.cloud.rest_api.models.*;
import io.tiledb.cloud.rest_api.api.TaskGraphLogsApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("/v1");
// Configure HTTP basic authorization: BasicAuth
HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth");
BasicAuth.setUsername("YOUR USERNAME");
BasicAuth.setPassword("YOUR PASSWORD");
// Configure API key authorization: ApiKeyAuth
ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
ApiKeyAuth.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.setApiKeyPrefix("Token");
TaskGraphLogsApi apiInstance = new TaskGraphLogsApi(defaultClient);
String namespace = "namespace_example"; // String | The namespace that owns this task graph execution.
String id = "id_example"; // String | The UUID of the task graph execution (TaskGraphLog).
try {
TaskGraphLog result = apiInstance.resubmitTaskGraphExecution(namespace, id);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling TaskGraphLogsApi#resubmitTaskGraphExecution");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
namespace | String | The namespace that owns this task graph execution. | |
id | String | The UUID of the task graph execution (TaskGraphLog). |
- Content-Type: Not defined
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
202 | Information about the task graph execution. | - |
502 | Bad Gateway | - |
0 | error response | - |
TaskGraphLog retryTaskGraphExecution(namespace, id)
Retries failed tasks of a task graph in the given namespace using the associated execution id.
// Import classes:
import io.tiledb.cloud.rest_api.ApiClient;
import io.tiledb.cloud.rest_api.ApiException;
import io.tiledb.cloud.rest_api.Configuration;
import io.tiledb.cloud.rest_api.auth.*;
import io.tiledb.cloud.rest_api.models.*;
import io.tiledb.cloud.rest_api.api.TaskGraphLogsApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("/v1");
// Configure HTTP basic authorization: BasicAuth
HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth");
BasicAuth.setUsername("YOUR USERNAME");
BasicAuth.setPassword("YOUR PASSWORD");
// Configure API key authorization: ApiKeyAuth
ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
ApiKeyAuth.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.setApiKeyPrefix("Token");
TaskGraphLogsApi apiInstance = new TaskGraphLogsApi(defaultClient);
String namespace = "namespace_example"; // String | The namespace that owns this task graph execution.
String id = "id_example"; // String | The UUID of the task graph execution (TaskGraphLog).
try {
TaskGraphLog result = apiInstance.retryTaskGraphExecution(namespace, id);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling TaskGraphLogsApi#retryTaskGraphExecution");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
namespace | String | The namespace that owns this task graph execution. | |
id | String | The UUID of the task graph execution (TaskGraphLog). |
- Content-Type: Not defined
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
202 | Information about the task graph execution. | - |
502 | Bad Gateway | - |
0 | error response | - |
stopTaskGraphExecution(namespace, id)
Stops a task graph execution in the given namespace using the associated associated execution id.
// Import classes:
import io.tiledb.cloud.rest_api.ApiClient;
import io.tiledb.cloud.rest_api.ApiException;
import io.tiledb.cloud.rest_api.Configuration;
import io.tiledb.cloud.rest_api.auth.*;
import io.tiledb.cloud.rest_api.models.*;
import io.tiledb.cloud.rest_api.api.TaskGraphLogsApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("/v1");
// Configure HTTP basic authorization: BasicAuth
HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth");
BasicAuth.setUsername("YOUR USERNAME");
BasicAuth.setPassword("YOUR PASSWORD");
// Configure API key authorization: ApiKeyAuth
ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
ApiKeyAuth.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.setApiKeyPrefix("Token");
TaskGraphLogsApi apiInstance = new TaskGraphLogsApi(defaultClient);
String namespace = "namespace_example"; // String | The namespace that owns this task graph execution.
String id = "id_example"; // String | The UUID of the task graph execution (TaskGraphLog).
try {
apiInstance.stopTaskGraphExecution(namespace, id);
} catch (ApiException e) {
System.err.println("Exception when calling TaskGraphLogsApi#stopTaskGraphExecution");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
namespace | String | The namespace that owns this task graph execution. | |
id | String | The UUID of the task graph execution (TaskGraphLog). |
null (empty response body)
- Content-Type: Not defined
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
204 | Graph stopped successfully | - |
502 | Bad Gateway | - |
0 | error response | - |
TaskGraphLog submitTaskGraph(namespace, id)
Submit a single task graph for execution.
// Import classes:
import io.tiledb.cloud.rest_api.ApiClient;
import io.tiledb.cloud.rest_api.ApiException;
import io.tiledb.cloud.rest_api.Configuration;
import io.tiledb.cloud.rest_api.auth.*;
import io.tiledb.cloud.rest_api.models.*;
import io.tiledb.cloud.rest_api.api.TaskGraphLogsApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("/v1");
// Configure HTTP basic authorization: BasicAuth
HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth");
BasicAuth.setUsername("YOUR USERNAME");
BasicAuth.setPassword("YOUR PASSWORD");
// Configure API key authorization: ApiKeyAuth
ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
ApiKeyAuth.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.setApiKeyPrefix("Token");
TaskGraphLogsApi apiInstance = new TaskGraphLogsApi(defaultClient);
String namespace = "namespace_example"; // String | The namespace that owns this task graph.
String id = "id_example"; // String | The UUID of the task graph entry.
try {
TaskGraphLog result = apiInstance.submitTaskGraph(namespace, id);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling TaskGraphLogsApi#submitTaskGraph");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
namespace | String | The namespace that owns this task graph. | |
id | String | The UUID of the task graph entry. |
- Content-Type: Not defined
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
202 | Information about the execution of a single task graph. | - |
502 | Bad Gateway | - |
0 | error response | - |
updateTaskGraphLog(namespace, id, log)
Update information about a single task graph execution.
// Import classes:
import io.tiledb.cloud.rest_api.ApiClient;
import io.tiledb.cloud.rest_api.ApiException;
import io.tiledb.cloud.rest_api.Configuration;
import io.tiledb.cloud.rest_api.auth.*;
import io.tiledb.cloud.rest_api.models.*;
import io.tiledb.cloud.rest_api.api.TaskGraphLogsApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("/v1");
// Configure HTTP basic authorization: BasicAuth
HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth");
BasicAuth.setUsername("YOUR USERNAME");
BasicAuth.setPassword("YOUR PASSWORD");
// Configure API key authorization: ApiKeyAuth
ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
ApiKeyAuth.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.setApiKeyPrefix("Token");
TaskGraphLogsApi apiInstance = new TaskGraphLogsApi(defaultClient);
String namespace = "namespace_example"; // String | The namespace that owns this task graph log.
String id = "id_example"; // String | The UUID of the task graph log entry.
TaskGraphLog log = new TaskGraphLog(); // TaskGraphLog | Updates to make to the task graph log. The only manual update that a client should need to make to a task graph log is to update its completion status to `succeeded`, `failed`, or `cancelled`.
try {
apiInstance.updateTaskGraphLog(namespace, id, log);
} catch (ApiException e) {
System.err.println("Exception when calling TaskGraphLogsApi#updateTaskGraphLog");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
namespace | String | The namespace that owns this task graph log. | |
id | String | The UUID of the task graph log entry. | |
log | TaskGraphLog | Updates to make to the task graph log. The only manual update that a client should need to make to a task graph log is to update its completion status to `succeeded`, `failed`, or `cancelled`. |
null (empty response body)
- Content-Type: application/json
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
204 | Log entry updated successfully. | - |
502 | Bad Gateway | - |
0 | error response | - |