https://github.com/dfornika/ga4gh-wes-client-java
https://github.com/dfornika/ga4gh-wes-client-java
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/dfornika/ga4gh-wes-client-java
- Owner: dfornika
- Created: 2019-03-21T19:11:19.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2019-03-21T19:50:01.000Z (about 6 years ago)
- Last Synced: 2025-01-24T23:48:53.486Z (5 months ago)
- Language: Java
- Size: 59.6 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ga4gh-wes-client-java
Workflow Execution Service
- API version: 1.0.0
- Build date: 2019-03-21T18:04:40.054Z[GMT]
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
*Automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen)*
## Requirements
Building the API client library requires:
1. Java 1.7+
2. Maven/Gradle
## Installation
To install the API client library to your local Maven repository, simply execute:
```shell
mvn clean install
```
To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:
```shell
mvn clean deploy
```
Refer to the [OSSRH Guide](http://central.sonatype.org/pages/ossrh-guide.html) for more information.
### Maven users
Add this dependency to your project's POM:
```xml
com.github.dfornika
ga4gh-wes-client
1.0.0
compile
```
### Gradle users
Add this dependency to your project's build file:
```groovy
compile "com.github.dfornika:ga4gh-wes-client:1.0.0"
```
### Others
At first generate the JAR by executing:
```shell
mvn clean package
```
Then manually install the following JARs:
* `target/ga4gh-wes-client-1.0.0.jar`
* `target/lib/*.jar`
## Getting Started
Please follow the [installation](#installation) instruction and execute the following Java code:
```java
import com.github.dfornika.ga4ghwes.client.*;
import com.github.dfornika.ga4ghwes.client.auth.*;
import com.github.dfornika.ga4ghwes.client.model.*;
import WorkflowExecutionServiceApi;
import java.io.File;
import java.util.*;
public class WorkflowExecutionServiceApiExample {
public static void main(String[] args) {
WorkflowExecutionServiceApi apiInstance = new WorkflowExecutionServiceApi();
String runId = "runId_example"; // String |
try {
RunId result = apiInstance.cancelRun(runId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling WorkflowExecutionServiceApi#cancelRun");
e.printStackTrace();
}
}
}
import com.github.dfornika.ga4ghwes.client.*;
import com.github.dfornika.ga4ghwes.client.auth.*;
import com.github.dfornika.ga4ghwes.client.model.*;
import WorkflowExecutionServiceApi;
import java.io.File;
import java.util.*;
public class WorkflowExecutionServiceApiExample {
public static void main(String[] args) {
WorkflowExecutionServiceApi apiInstance = new WorkflowExecutionServiceApi();
String runId = "runId_example"; // String |
try {
RunLog result = apiInstance.getRunLog(runId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling WorkflowExecutionServiceApi#getRunLog");
e.printStackTrace();
}
}
}
import com.github.dfornika.ga4ghwes.client.*;
import com.github.dfornika.ga4ghwes.client.auth.*;
import com.github.dfornika.ga4ghwes.client.model.*;
import WorkflowExecutionServiceApi;
import java.io.File;
import java.util.*;
public class WorkflowExecutionServiceApiExample {
public static void main(String[] args) {
WorkflowExecutionServiceApi apiInstance = new WorkflowExecutionServiceApi();
String runId = "runId_example"; // String |
try {
RunStatus result = apiInstance.getRunStatus(runId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling WorkflowExecutionServiceApi#getRunStatus");
e.printStackTrace();
}
}
}
import com.github.dfornika.ga4ghwes.client.*;
import com.github.dfornika.ga4ghwes.client.auth.*;
import com.github.dfornika.ga4ghwes.client.model.*;
import WorkflowExecutionServiceApi;
import java.io.File;
import java.util.*;
public class WorkflowExecutionServiceApiExample {
public static void main(String[] args) {
WorkflowExecutionServiceApi apiInstance = new WorkflowExecutionServiceApi();
try {
ServiceInfo result = apiInstance.getServiceInfo();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling WorkflowExecutionServiceApi#getServiceInfo");
e.printStackTrace();
}
}
}
import com.github.dfornika.ga4ghwes.client.*;
import com.github.dfornika.ga4ghwes.client.auth.*;
import com.github.dfornika.ga4ghwes.client.model.*;
import WorkflowExecutionServiceApi;
import java.io.File;
import java.util.*;
public class WorkflowExecutionServiceApiExample {
public static void main(String[] args) {
WorkflowExecutionServiceApi apiInstance = new WorkflowExecutionServiceApi();
Long pageSize = 789L; // Long | OPTIONAL The preferred number of workflow runs to return in a page. If not provided, the implementation should use a default page size. The implementation must not return more items than `page_size`, but it may return fewer. Clients should not assume that if fewer than `page_size` items are returned that all items have been returned. The availability of additional pages is indicated by the value of `next_page_token` in the response.
String pageToken = "pageToken_example"; // String | OPTIONAL Token to use to indicate where to start getting results. If unspecified, return the first page of results.
try {
RunListResponse result = apiInstance.listRuns(pageSize, pageToken);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling WorkflowExecutionServiceApi#listRuns");
e.printStackTrace();
}
}
}
import com.github.dfornika.ga4ghwes.client.*;
import com.github.dfornika.ga4ghwesr.client.auth.*;
import com.github.dfornika.ga4ghwes.client.model.*;
import WorkflowExecutionServiceApi;
import java.io.File;
import java.util.*;
public class WorkflowExecutionServiceApiExample {
public static void main(String[] args) {
WorkflowExecutionServiceApi apiInstance = new WorkflowExecutionServiceApi();
String workflowParams = "workflowParams_example"; // String |
String workflowType = "workflowType_example"; // String |
String workflowTypeVersion = "workflowTypeVersion_example"; // String |
String tags = "tags_example"; // String |
String workflowEngineParameters = "workflowEngineParameters_example"; // String |
String workflowUrl = "workflowUrl_example"; // String |
List workflowAttachment = Arrays.asList(new File("/path/to/file")); // List |
try {
RunId result = apiInstance.runWorkflow(workflowParams, workflowType, workflowTypeVersion, tags, workflowEngineParameters, workflowUrl, workflowAttachment);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling WorkflowExecutionServiceApi#runWorkflow");
e.printStackTrace();
}
}
}
```
## Documentation for API Endpoints
All URIs are relative to *///ga4gh/wes/v1*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*WorkflowExecutionServiceApi* | [**cancelRun**](docs/WorkflowExecutionServiceApi.md#cancelRun) | **POST** /runs/{run_id}/cancel | Cancel a running workflow.
*WorkflowExecutionServiceApi* | [**getRunLog**](docs/WorkflowExecutionServiceApi.md#getRunLog) | **GET** /runs/{run_id} | Get detailed info about a workflow run.
*WorkflowExecutionServiceApi* | [**getRunStatus**](docs/WorkflowExecutionServiceApi.md#getRunStatus) | **GET** /runs/{run_id}/status | Get quick status info about a workflow run.
*WorkflowExecutionServiceApi* | [**getServiceInfo**](docs/WorkflowExecutionServiceApi.md#getServiceInfo) | **GET** /service-info | Get information about Workflow Execution Service.
*WorkflowExecutionServiceApi* | [**listRuns**](docs/WorkflowExecutionServiceApi.md#listRuns) | **GET** /runs | List the workflow runs.
*WorkflowExecutionServiceApi* | [**runWorkflow**](docs/WorkflowExecutionServiceApi.md#runWorkflow) | **POST** /runs | Run a workflow.
## Documentation for Models
- [Body](docs/Body.md)
- [DefaultWorkflowEngineParameter](docs/DefaultWorkflowEngineParameter.md)
- [ErrorResponse](docs/ErrorResponse.md)
- [Log](docs/Log.md)
- [RunId](docs/RunId.md)
- [RunListResponse](docs/RunListResponse.md)
- [RunLog](docs/RunLog.md)
- [RunRequest](docs/RunRequest.md)
- [RunStatus](docs/RunStatus.md)
- [ServiceInfo](docs/ServiceInfo.md)
- [State](docs/State.md)
- [WorkflowTypeVersion](docs/WorkflowTypeVersion.md)
## Documentation for Authorization
All endpoints do not require authorization.
Authentication schemes defined for the API:
## Recommendation
It's recommended to create an instance of `ApiClient` per thread in a multithreaded environment to avoid any potential issues.
## Author