Skip to content

Commit

Permalink
Merge branch '155-compute-presets-selectable-in-compute-all-panel' in…
Browse files Browse the repository at this point in the history
…to 'master'

Resolve "Compute Presets selectable in Compute All panel"

Closes #155 and #484

See merge request bright-giant/sirius/sirius-frontend!187
  • Loading branch information
Markus Fleischauer committed Dec 2, 2024
2 parents 478dc27 + 831bde7 commit 1709596
Show file tree
Hide file tree
Showing 25 changed files with 1,024 additions and 304 deletions.
1 change: 1 addition & 0 deletions sirius-sdk/sirius-sdk.openapi/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -169,6 +169,7 @@ Class | Method | HTTP request | Description
*JobsApi* | [**getDefaultJobConfig**](docs/JobsApi.md#getDefaultJobConfig) | **GET** /api/default-job-config | Request default job configuration
*JobsApi* | [**getJob**](docs/JobsApi.md#getJob) | **GET** /api/projects/{projectId}/jobs/{jobId} | Get job information and its current state and progress (if available).
*JobsApi* | [**getJobConfig**](docs/JobsApi.md#getJobConfig) | **GET** /api/job-configs/{name} | Request job configuration with given name.
*JobsApi* | [**getJobConfigNames**](docs/JobsApi.md#getJobConfigNames) | **GET** /api/job-config-names | Get all (non-default) job configuration names
*JobsApi* | [**getJobConfigs**](docs/JobsApi.md#getJobConfigs) | **GET** /api/job-configs | Request all available job configurations
*JobsApi* | [**getJobs**](docs/JobsApi.md#getJobs) | **GET** /api/projects/{projectId}/jobs | Get List of all available jobs with information such as current state and progress (if available).
*JobsApi* | [**getJobsPaged**](docs/JobsApi.md#getJobsPaged) | **GET** /api/projects/{projectId}/jobs/page | Get Page of jobs with information such as current state and progress (if available).
Expand Down
99 changes: 83 additions & 16 deletions sirius-sdk/sirius-sdk.openapi/docs/JobsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ All URIs are relative to *http://localhost:8888*
| [**getDefaultJobConfig**](JobsApi.md#getDefaultJobConfig) | **GET** /api/default-job-config | Request default job configuration |
| [**getJob**](JobsApi.md#getJob) | **GET** /api/projects/{projectId}/jobs/{jobId} | Get job information and its current state and progress (if available). |
| [**getJobConfig**](JobsApi.md#getJobConfig) | **GET** /api/job-configs/{name} | Request job configuration with given name. |
| [**getJobConfigNames**](JobsApi.md#getJobConfigNames) | **GET** /api/job-config-names | Get all (non-default) job configuration names |
| [**getJobConfigs**](JobsApi.md#getJobConfigs) | **GET** /api/job-configs | Request all available job configurations |
| [**getJobs**](JobsApi.md#getJobs) | **GET** /api/projects/{projectId}/jobs | Get List of all available jobs with information such as current state and progress (if available). |
| [**getJobsPaged**](JobsApi.md#getJobsPaged) | **GET** /api/projects/{projectId}/jobs/page | Get Page of jobs with information such as current state and progress (if available). |
Expand Down Expand Up @@ -47,8 +48,8 @@ public class Example {
JobsApi apiInstance = new JobsApi(defaultClient);
String projectId = "projectId_example"; // String | project-space to delete job from
String jobId = "jobId_example"; // String | of the job to be deleted
Boolean cancelIfRunning = true; // Boolean | If true job will be canceled if it is not finished. Otherwise, deletion will fail for running jobs or request will block until job has finished.
Boolean awaitDeletion = true; // Boolean | If true request will block until deletion succeeded or failed. If the job is still running the request will wait until the job has finished.
Boolean cancelIfRunning = true; // Boolean | If true, job will be canceled if it is not finished. Otherwise, deletion will fail for running jobs or request will block until job has finished.
Boolean awaitDeletion = true; // Boolean | If true, request will block until deletion succeeded or failed. If the job is still running the request will wait until the job has finished.
try {
apiInstance.deleteJob(projectId, jobId, cancelIfRunning, awaitDeletion);
} catch (ApiException e) {
Expand All @@ -69,8 +70,8 @@ public class Example {
|------------- | ------------- | ------------- | -------------|
| **projectId** | **String**| project-space to delete job from | |
| **jobId** | **String**| of the job to be deleted | |
| **cancelIfRunning** | **Boolean**| If true job will be canceled if it is not finished. Otherwise, deletion will fail for running jobs or request will block until job has finished. | [optional] [default to true] |
| **awaitDeletion** | **Boolean**| If true request will block until deletion succeeded or failed. If the job is still running the request will wait until the job has finished. | [optional] [default to true] |
| **cancelIfRunning** | **Boolean**| If true, job will be canceled if it is not finished. Otherwise, deletion will fail for running jobs or request will block until job has finished. | [optional] [default to true] |
| **awaitDeletion** | **Boolean**| If true, request will block until deletion succeeded or failed. If the job is still running the request will wait until the job has finished. | [optional] [default to true] |

### Return type

Expand Down Expand Up @@ -182,8 +183,8 @@ public class Example {

JobsApi apiInstance = new JobsApi(defaultClient);
String projectId = "projectId_example"; // String | project-space to delete jobs from
Boolean cancelIfRunning = true; // Boolean | If true job will be canceled if it is not finished. Otherwise, deletion will fail for running jobs or request will block until job has finished.
Boolean awaitDeletion = true; // Boolean | If true request will block until deletion succeeded or failed. If the job is still running the request will wait until the job has finished.
Boolean cancelIfRunning = true; // Boolean | If true, job will be canceled if it is not finished. Otherwise, deletion will fail for running jobs or request will block until job has finished.
Boolean awaitDeletion = true; // Boolean | If true, request will block until deletion succeeded or failed. If the job is still running the request will wait until the job has finished.
try {
apiInstance.deleteJobs(projectId, cancelIfRunning, awaitDeletion);
} catch (ApiException e) {
Expand All @@ -203,8 +204,8 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **projectId** | **String**| project-space to delete jobs from | |
| **cancelIfRunning** | **Boolean**| If true job will be canceled if it is not finished. Otherwise, deletion will fail for running jobs or request will block until job has finished. | [optional] [default to true] |
| **awaitDeletion** | **Boolean**| If true request will block until deletion succeeded or failed. If the job is still running the request will wait until the job has finished. | [optional] [default to true] |
| **cancelIfRunning** | **Boolean**| If true, job will be canceled if it is not finished. Otherwise, deletion will fail for running jobs or request will block until job has finished. | [optional] [default to true] |
| **awaitDeletion** | **Boolean**| If true, request will block until deletion succeeded or failed. If the job is still running the request will wait until the job has finished. | [optional] [default to true] |

### Return type

Expand All @@ -228,7 +229,7 @@ No authorization required

## getDefaultJobConfig

> JobSubmission getDefaultJobConfig(includeConfigMap)
> JobSubmission getDefaultJobConfig(includeConfigMap, moveParametersToConfigMap)
Request default job configuration

Expand All @@ -251,8 +252,9 @@ public class Example {

JobsApi apiInstance = new JobsApi(defaultClient);
Boolean includeConfigMap = false; // Boolean | if true, generic configmap with-defaults will be included
Boolean moveParametersToConfigMap = false; // Boolean | if true, object-based parameters will be converted to and added to the generic configMap parameters
try {
JobSubmission result = apiInstance.getDefaultJobConfig(includeConfigMap);
JobSubmission result = apiInstance.getDefaultJobConfig(includeConfigMap, moveParametersToConfigMap);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling JobsApi#getDefaultJobConfig");
Expand All @@ -271,6 +273,7 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **includeConfigMap** | **Boolean**| if true, generic configmap with-defaults will be included | [optional] [default to false] |
| **moveParametersToConfigMap** | **Boolean**| if true, object-based parameters will be converted to and added to the generic configMap parameters | [optional] [default to false] |

### Return type

Expand Down Expand Up @@ -364,7 +367,7 @@ No authorization required

## getJobConfig

> JobSubmission getJobConfig(name, includeConfigMap)
> JobSubmission getJobConfig(name, includeConfigMap, moveParametersToConfigMap)
Request job configuration with given name.

Expand All @@ -387,9 +390,10 @@ public class Example {

JobsApi apiInstance = new JobsApi(defaultClient);
String name = "name_example"; // String | name of the job-config to return
Boolean includeConfigMap = false; // Boolean | if true the generic configmap will be part of the output
Boolean includeConfigMap = false; // Boolean | if true, the generic configmap will be part of the output. DEPRECATED: this parameter will be removed in a future release
Boolean moveParametersToConfigMap = false; // Boolean | if true, object-based parameters will be converted to and added to the generic configMap parameters
try {
JobSubmission result = apiInstance.getJobConfig(name, includeConfigMap);
JobSubmission result = apiInstance.getJobConfig(name, includeConfigMap, moveParametersToConfigMap);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling JobsApi#getJobConfig");
Expand All @@ -408,7 +412,8 @@ public class Example {
| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **name** | **String**| name of the job-config to return | |
| **includeConfigMap** | **Boolean**| if true the generic configmap will be part of the output | [optional] [default to false] |
| **includeConfigMap** | **Boolean**| if true, the generic configmap will be part of the output. DEPRECATED: this parameter will be removed in a future release | [optional] [default to false] |
| **moveParametersToConfigMap** | **Boolean**| if true, object-based parameters will be converted to and added to the generic configMap parameters | [optional] [default to false] |

### Return type

Expand All @@ -430,6 +435,68 @@ No authorization required
| **200** | {@link JobSubmission JobSubmission} for given name. | - |


## getJobConfigNames

> List<String> getJobConfigNames()
Get all (non-default) job configuration names

Get all (non-default) job configuration names

### Example

```java
// Import classes:
import io.sirius.ms.sdk.client.ApiClient;
import io.sirius.ms.sdk.client.ApiException;
import io.sirius.ms.sdk.client.Configuration;
import io.sirius.ms.sdk.client.models.*;
import io.sirius.ms.sdk.api.JobsApi;

public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://localhost:8888");

JobsApi apiInstance = new JobsApi(defaultClient);
try {
List<String> result = apiInstance.getJobConfigNames();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling JobsApi#getJobConfigNames");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
```

### Parameters

This endpoint does not need any parameter.

### Return type

**List&lt;String&gt;**

### Authorization

No authorization required

### HTTP request headers

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


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | OK | - |


## getJobConfigs

> List&lt;JobSubmission&gt; getJobConfigs(includeConfigMap)
Expand All @@ -454,7 +521,7 @@ public class Example {
defaultClient.setBasePath("http://localhost:8888");

JobsApi apiInstance = new JobsApi(defaultClient);
Boolean includeConfigMap = false; // Boolean | if true the generic configmap will be part of the output
Boolean includeConfigMap = false; // Boolean | if true, the generic configmap will be part of the output. DEPRECATED: this parameter will be removed in a future release
try {
List<JobSubmission> result = apiInstance.getJobConfigs(includeConfigMap);
System.out.println(result);
Expand All @@ -474,7 +541,7 @@ public class Example {

| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **includeConfigMap** | **Boolean**| if true the generic configmap will be part of the output | [optional] [default to false] |
| **includeConfigMap** | **Boolean**| if true, the generic configmap will be part of the output. DEPRECATED: this parameter will be removed in a future release | [optional] [default to false] |

### Return type

Expand Down
Loading

0 comments on commit 1709596

Please sign in to comment.