Skip to content

Commit 9d5b92d

Browse files
jeffr-spirejeffr-spire
committed
commit v1 dev
0 parents  commit 9d5b92d

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+4184
-0
lines changed

‎README.md

+102
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
# oort-sdk-client
2+
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
3+
4+
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
5+
6+
- API version: 1.0
7+
- Package version: 1.0.0
8+
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
9+
10+
## Requirements.
11+
12+
Python 2.7 and 3.4+
13+
14+
## Installation & Usage
15+
### pip install
16+
17+
If the python package is hosted on a repository, you can install directly using:
18+
19+
```sh
20+
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
21+
```
22+
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)
23+
24+
Then import the package:
25+
```python
26+
import oort_sdk_client
27+
```
28+
29+
### Setuptools
30+
31+
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
32+
33+
```sh
34+
python setup.py install --user
35+
```
36+
(or `sudo python setup.py install` to install the package for all users)
37+
38+
Then import the package:
39+
```python
40+
import oort_sdk_client
41+
```
42+
43+
## Getting Started
44+
45+
Please follow the [installation procedure](#installation--usage) and then run the following:
46+
47+
```python
48+
from __future__ import print_function
49+
import time
50+
import oort_sdk_client
51+
from oort_sdk_client.rest import ApiException
52+
from pprint import pprint
53+
54+
55+
# Defining host is optional and default to http://localhost:2005/sdk/v1
56+
configuration.host = "http://localhost:2005/sdk/v1"
57+
# Enter a context with an instance of the API client
58+
with oort_sdk_client.ApiClient(configuration) as api_client:
59+
# Create an instance of the API class
60+
api_instance = oort_sdk_client.SdkApi(api_client)
61+
topic = 'topic_example' # str |
62+
63+
try:
64+
api_response = api_instance.query_available_files(topic)
65+
pprint(api_response)
66+
except ApiException as e:
67+
print("Exception when calling SdkApi->query_available_files: %s\n" % e)
68+
69+
```
70+
71+
## Documentation for API Endpoints
72+
73+
All URIs are relative to *http://localhost:2005/sdk/v1*
74+
75+
Class | Method | HTTP request | Description
76+
------------ | ------------- | ------------- | -------------
77+
*SdkApi* | [**query_available_files**](docs/SdkApi.md#query_available_files) | **GET** /query_available_files/{topic} |
78+
*SdkApi* | [**retrieve_file**](docs/SdkApi.md#retrieve_file) | **POST** /retrieve_file |
79+
*SdkApi* | [**send_file**](docs/SdkApi.md#send_file) | **POST** /send_file |
80+
81+
82+
## Documentation For Models
83+
84+
- [AvailableFilesResponse](docs/AvailableFilesResponse.md)
85+
- [ErrorResponse](docs/ErrorResponse.md)
86+
- [FileInfo](docs/FileInfo.md)
87+
- [RetrieveFileRequest](docs/RetrieveFileRequest.md)
88+
- [SendFileRequest](docs/SendFileRequest.md)
89+
- [SendFileResponse](docs/SendFileResponse.md)
90+
- [SendOptions](docs/SendOptions.md)
91+
- [TTLParams](docs/TTLParams.md)
92+
93+
94+
## Documentation For Authorization
95+
96+
All endpoints do not require authorization.
97+
98+
## Author
99+
100+
101+
102+

‎docs/AvailableFilesResponse.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# AvailableFilesResponse
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**files** | [**list[FileInfo]**](FileInfo.md) | |
7+
8+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
9+
10+

‎docs/ErrorResponse.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# ErrorResponse
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**status** | **int** | |
7+
**message** | **str** | |
8+
9+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10+
11+

‎docs/FileInfo.md

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# FileInfo
2+
3+
Information about the file and the transfer request.
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**id** | **str** | |
8+
**path** | **str** | |
9+
**size** | **int** | |
10+
**modified** | **int** | |
11+
**created** | **int** | |
12+
**crc32** | **str** | |
13+
14+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
15+
16+

‎docs/RetrieveFileRequest.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# RetrieveFileRequest
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**id** | **str** | |
7+
**save_path** | **str** | |
8+
9+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10+
11+

‎docs/SdkApi.md

+172
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,172 @@
1+
# oort_sdk_client.SdkApi
2+
3+
All URIs are relative to *http://localhost:2005/sdk/v1*
4+
5+
Method | HTTP request | Description
6+
------------- | ------------- | -------------
7+
[**query_available_files**](SdkApi.md#query_available_files) | **GET** /query_available_files/{topic} |
8+
[**retrieve_file**](SdkApi.md#retrieve_file) | **POST** /retrieve_file |
9+
[**send_file**](SdkApi.md#send_file) | **POST** /send_file |
10+
11+
12+
# **query_available_files**
13+
> AvailableFilesResponse query_available_files(topic)
14+
15+
16+
17+
### Example
18+
19+
```python
20+
from __future__ import print_function
21+
import time
22+
import oort_sdk_client
23+
from oort_sdk_client.rest import ApiException
24+
from pprint import pprint
25+
26+
# Enter a context with an instance of the API client
27+
with oort_sdk_client.ApiClient() as api_client:
28+
# Create an instance of the API class
29+
api_instance = oort_sdk_client.SdkApi(api_client)
30+
topic = 'topic_example' # str |
31+
32+
try:
33+
api_response = api_instance.query_available_files(topic)
34+
pprint(api_response)
35+
except ApiException as e:
36+
print("Exception when calling SdkApi->query_available_files: %s\n" % e)
37+
```
38+
39+
### Parameters
40+
41+
Name | Type | Description | Notes
42+
------------- | ------------- | ------------- | -------------
43+
**topic** | **str**| |
44+
45+
### Return type
46+
47+
[**AvailableFilesResponse**](AvailableFilesResponse.md)
48+
49+
### Authorization
50+
51+
No authorization required
52+
53+
### HTTP request headers
54+
55+
- **Content-Type**: Not defined
56+
- **Accept**: application/json
57+
58+
### HTTP response details
59+
| Status code | Description | Response headers |
60+
|-------------|-------------|------------------|
61+
**200** | OK | - |
62+
63+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
64+
65+
# **retrieve_file**
66+
> FileInfo retrieve_file(retrieve_file_request)
67+
68+
69+
70+
### Example
71+
72+
```python
73+
from __future__ import print_function
74+
import time
75+
import oort_sdk_client
76+
from oort_sdk_client.rest import ApiException
77+
from pprint import pprint
78+
79+
# Enter a context with an instance of the API client
80+
with oort_sdk_client.ApiClient() as api_client:
81+
# Create an instance of the API class
82+
api_instance = oort_sdk_client.SdkApi(api_client)
83+
retrieve_file_request = oort_sdk_client.RetrieveFileRequest() # RetrieveFileRequest |
84+
85+
try:
86+
api_response = api_instance.retrieve_file(retrieve_file_request)
87+
pprint(api_response)
88+
except ApiException as e:
89+
print("Exception when calling SdkApi->retrieve_file: %s\n" % e)
90+
```
91+
92+
### Parameters
93+
94+
Name | Type | Description | Notes
95+
------------- | ------------- | ------------- | -------------
96+
**retrieve_file_request** | [**RetrieveFileRequest**](RetrieveFileRequest.md)| |
97+
98+
### Return type
99+
100+
[**FileInfo**](FileInfo.md)
101+
102+
### Authorization
103+
104+
No authorization required
105+
106+
### HTTP request headers
107+
108+
- **Content-Type**: application/json
109+
- **Accept**: application/json
110+
111+
### HTTP response details
112+
| Status code | Description | Response headers |
113+
|-------------|-------------|------------------|
114+
**200** | OK | - |
115+
**400** | Bad request | - |
116+
117+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
118+
119+
# **send_file**
120+
> SendFileResponse send_file(send_file_request)
121+
122+
123+
124+
### Example
125+
126+
```python
127+
from __future__ import print_function
128+
import time
129+
import oort_sdk_client
130+
from oort_sdk_client.rest import ApiException
131+
from pprint import pprint
132+
133+
# Enter a context with an instance of the API client
134+
with oort_sdk_client.ApiClient() as api_client:
135+
# Create an instance of the API class
136+
api_instance = oort_sdk_client.SdkApi(api_client)
137+
send_file_request = oort_sdk_client.SendFileRequest() # SendFileRequest | The file and parameters for sending
138+
139+
try:
140+
api_response = api_instance.send_file(send_file_request)
141+
pprint(api_response)
142+
except ApiException as e:
143+
print("Exception when calling SdkApi->send_file: %s\n" % e)
144+
```
145+
146+
### Parameters
147+
148+
Name | Type | Description | Notes
149+
------------- | ------------- | ------------- | -------------
150+
**send_file_request** | [**SendFileRequest**](SendFileRequest.md)| The file and parameters for sending |
151+
152+
### Return type
153+
154+
[**SendFileResponse**](SendFileResponse.md)
155+
156+
### Authorization
157+
158+
No authorization required
159+
160+
### HTTP request headers
161+
162+
- **Content-Type**: application/json
163+
- **Accept**: application/json
164+
165+
### HTTP response details
166+
| Status code | Description | Response headers |
167+
|-------------|-------------|------------------|
168+
**200** | OK | - |
169+
**400** | Bad request | - |
170+
171+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
172+

‎docs/SendFileRequest.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# SendFileRequest
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**destination** | **str** | the destination to send the file to |
7+
**filepath** | **str** | the source filepath |
8+
**topic** | **str** | the pipeline topic to send the file to |
9+
**options** | [**SendOptions**](SendOptions.md) | | [optional]
10+
11+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12+
13+

‎docs/SendFileResponse.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# SendFileResponse
2+
3+
Response to a send file request
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**uuid** | **str** | |
8+
9+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10+
11+

‎docs/SendOptions.md

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# SendOptions
2+
3+
options to apply to a send request
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**ttl_params** | [**TTLParams**](TTLParams.md) | | [optional]
8+
**reliable** | **bool** | whether to send an item reliably, i.e., with retries | [optional] [default to True]
9+
10+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11+
12+

‎docs/TTLParams.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# TTLParams
2+
3+
TTL parameters for a sent item
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**urgent** | **int** | TTL in seconds for urgent items | [optional] [default to 9000]
8+
**bulk** | **int** | TTL in seconds for bulk items | [optional] [default to 43200]
9+
**surplus** | **int** | TTL in seconds for surplus items | [optional] [default to 172800]
10+
11+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12+
13+

0 commit comments

Comments
 (0)