triglav_client 0.1.32

data/docs/AuthApi.md

@@ -0,0 +1,150 @@
+# TriglavClient::AuthApi
+
+All URIs are relative to *http://localhost/api/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_token**](AuthApi.md#create_token) | **POST** /auth/token | 
+[**delete_token**](AuthApi.md#delete_token) | **DELETE** /auth/token | 
+[**me**](AuthApi.md#me) | **GET** /auth/me | 
+
+
+# **create_token**
+> TokenResponse create_token(credential)
+
+
+
+Creates a new token
+
+### Example
+```ruby
+# load the gem
+require 'triglav_client'
+
+api_instance = TriglavClient::AuthApi.new
+
+credential = TriglavClient::Credential.new # Credential | 
+
+
+begin
+  result = api_instance.create_token(credential)
+  p result
+rescue TriglavClient::ApiError => e
+  puts "Exception when calling AuthApi->create_token: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **credential** | [**Credential**](Credential.md)|  | 
+
+### Return type
+
+[**TokenResponse**](TokenResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **delete_token**
+> delete_token
+
+
+
+Deletes (Expires) a token of header
+
+### Example
+```ruby
+# load the gem
+require 'triglav_client'
+# setup authorization
+TriglavClient.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = TriglavClient::AuthApi.new
+
+begin
+  api_instance.delete_token
+rescue TriglavClient::ApiError => e
+  puts "Exception when calling AuthApi->delete_token: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **me**
+> UserResponse me
+
+
+
+Returns a user property of the access_token
+
+### Example
+```ruby
+# load the gem
+require 'triglav_client'
+# setup authorization
+TriglavClient.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = TriglavClient::AuthApi.new
+
+begin
+  result = api_instance.me
+  p result
+rescue TriglavClient::ApiError => e
+  puts "Exception when calling AuthApi->me: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**UserResponse**](UserResponse.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/BulkinsertResponse.md

@@ -0,0 +1,8 @@
+# TriglavClient::BulkinsertResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**num_inserts** | **Integer** | Number of inserts | [optional] 
+
+

data/docs/Credential.md

@@ -0,0 +1,10 @@
+# TriglavClient::Credential
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**username** | **String** |  | 
+**password** | **String** |  | 
+**authenticator** | **String** |  | [optional] 
+
+

data/docs/ErrorModel.md

@@ -0,0 +1,9 @@
+# TriglavClient::ErrorModel
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**error** | **String** |  | 
+**backtrace** | **Array<String>** |  | 
+
+

data/docs/JobEachResponse.md

@@ -0,0 +1,12 @@
+# TriglavClient::JobEachResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** |  | [optional] 
+**uri** | **String** |  | [optional] 
+**logical_op** | **String** |  | [optional] 
+**created_at** | **DateTime** |  | [optional] 
+**updated_at** | **DateTime** |  | [optional] 
+
+

data/docs/JobMessageEachResponse.md

@@ -0,0 +1,11 @@
+# TriglavClient::JobMessageEachResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** |  | [optional] 
+**job_id** | **Integer** | Job ID | [optional] 
+**time** | **Integer** | Time of event in unix timestamp such as 1476025200 (2016-10-10 in +09:00) | [optional] 
+**timezone** | **String** | Timezone of event time, that is, timezone of %Y-%m-%d for hdfs://path/to/%Y-%m-%d such as +09:00 | [optional] 
+
+

data/docs/JobMessagesApi.md

@@ -0,0 +1,117 @@
+# TriglavClient::JobMessagesApi
+
+All URIs are relative to *http://localhost/api/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**fetch_job_messages**](JobMessagesApi.md#fetch_job_messages) | **GET** /job_messages | 
+[**get_last_job_message_id**](JobMessagesApi.md#get_last_job_message_id) | **GET** /job_messages/last_id | 
+
+
+# **fetch_job_messages**
+> Array<JobMessageEachResponse> fetch_job_messages(offset, job_id, opts)
+
+
+
+Fetch Job messages
+
+### Example
+```ruby
+# load the gem
+require 'triglav_client'
+# setup authorization
+TriglavClient.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = TriglavClient::JobMessagesApi.new
+
+offset = 789 # Integer | Offset (Greater than or equal to) ID for Messages to fetch from
+
+job_id = 789 # Integer | Job ID
+
+opts = { 
+  limit: 789 # Integer | Number of limits
+}
+
+begin
+  result = api_instance.fetch_job_messages(offset, job_id, opts)
+  p result
+rescue TriglavClient::ApiError => e
+  puts "Exception when calling JobMessagesApi->fetch_job_messages: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **offset** | **Integer**| Offset (Greater than or equal to) ID for Messages to fetch from | 
+ **job_id** | **Integer**| Job ID | 
+ **limit** | **Integer**| Number of limits | [optional] 
+
+### Return type
+
+[**Array<JobMessageEachResponse>**](JobMessageEachResponse.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_last_job_message_id**
+> LastJobMessageIdResponse get_last_job_message_id
+
+
+
+Get the current last message id which would be used as a first offset to fetch messages
+
+### Example
+```ruby
+# load the gem
+require 'triglav_client'
+# setup authorization
+TriglavClient.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = TriglavClient::JobMessagesApi.new
+
+begin
+  result = api_instance.get_last_job_message_id
+  p result
+rescue TriglavClient::ApiError => e
+  puts "Exception when calling JobMessagesApi->get_last_job_message_id: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**LastJobMessageIdResponse**](LastJobMessageIdResponse.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/JobRequest.md

@@ -0,0 +1,12 @@
+# TriglavClient::JobRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** |  | [optional] 
+**uri** | **String** |  | [optional] 
+**logical_op** | **String** |  | [optional] 
+**input_resources** | [**Array<ResourceRequest>**](ResourceRequest.md) | New resources are created if id is not given. Update if id is given | [optional] 
+**output_resources** | [**Array<ResourceRequest>**](ResourceRequest.md) | New resources are created if id is not given. Update if id is given | [optional] 
+
+

data/docs/JobResponse.md

@@ -0,0 +1,14 @@
+# TriglavClient::JobResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** |  | [optional] 
+**uri** | **String** |  | [optional] 
+**logical_op** | **String** |  | [optional] 
+**input_resources** | [**Array<ResourceResponse>**](ResourceResponse.md) | Input resources | [optional] 
+**output_resources** | [**Array<ResourceResponse>**](ResourceResponse.md) | Output resources | [optional] 
+**created_at** | **DateTime** |  | [optional] 
+**updated_at** | **DateTime** |  | [optional] 
+
+

data/docs/JobsApi.md

@@ -0,0 +1,217 @@
+# TriglavClient::JobsApi
+
+All URIs are relative to *http://localhost/api/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_or_update_job**](JobsApi.md#create_or_update_job) | **PATCH** /jobs | 
+[**delete_job**](JobsApi.md#delete_job) | **DELETE** /jobs/{id_or_uri} | 
+[**get_job**](JobsApi.md#get_job) | **GET** /jobs/{id_or_uri} | 
+[**list_jobs**](JobsApi.md#list_jobs) | **GET** /jobs | 
+
+
+# **create_or_update_job**
+> JobResponse create_or_update_job(job)
+
+
+
+Creates or Updates a single job
+
+### Example
+```ruby
+# load the gem
+require 'triglav_client'
+# setup authorization
+TriglavClient.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = TriglavClient::JobsApi.new
+
+job = TriglavClient::JobRequest.new # JobRequest | Job parameters
+
+
+begin
+  result = api_instance.create_or_update_job(job)
+  p result
+rescue TriglavClient::ApiError => e
+  puts "Exception when calling JobsApi->create_or_update_job: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **job** | [**JobRequest**](JobRequest.md)| Job parameters | 
+
+### Return type
+
+[**JobResponse**](JobResponse.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **delete_job**
+> delete_job(id_or_uri)
+
+
+
+Deletes single job
+
+### Example
+```ruby
+# load the gem
+require 'triglav_client'
+# setup authorization
+TriglavClient.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = TriglavClient::JobsApi.new
+
+id_or_uri = "id_or_uri_example" # String | ID or URI of job to fetch
+
+
+begin
+  api_instance.delete_job(id_or_uri)
+rescue TriglavClient::ApiError => e
+  puts "Exception when calling JobsApi->delete_job: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id_or_uri** | **String**| ID or URI of job to fetch | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_job**
+> JobResponse get_job(id_or_uri)
+
+
+
+Returns a single job
+
+### Example
+```ruby
+# load the gem
+require 'triglav_client'
+# setup authorization
+TriglavClient.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = TriglavClient::JobsApi.new
+
+id_or_uri = "id_or_uri_example" # String | ID or URI of job to fetch
+
+
+begin
+  result = api_instance.get_job(id_or_uri)
+  p result
+rescue TriglavClient::ApiError => e
+  puts "Exception when calling JobsApi->get_job: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id_or_uri** | **String**| ID or URI of job to fetch | 
+
+### Return type
+
+[**JobResponse**](JobResponse.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **list_jobs**
+> Array<JobEachResponse> list_jobs
+
+
+
+Returns all jobs
+
+### Example
+```ruby
+# load the gem
+require 'triglav_client'
+# setup authorization
+TriglavClient.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = TriglavClient::JobsApi.new
+
+begin
+  result = api_instance.list_jobs
+  p result
+rescue TriglavClient::ApiError => e
+  puts "Exception when calling JobsApi->list_jobs: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Array<JobEachResponse>**](JobEachResponse.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+