triglav_client 0.1.32

data/docs/LastJobMessageIdResponse.md

@@ -0,0 +1,8 @@
+# TriglavClient::LastJobMessageIdResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | last message id | [optional] 
+
+

data/docs/LastMessageIdResponse.md

@@ -0,0 +1,8 @@
+# TriglavClient::LastMessageIdResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | last message id | [optional] 
+
+

data/docs/MessageEachResponse.md

@@ -0,0 +1,16 @@
+# TriglavClient::MessageEachResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**uuid** | **String** | Universally Unique ID to be used to avoid duplicated messages | [optional] 
+**resource_uri** | **String** | URI of Resource | 
+**resource_unit** | **String** | Time unit of resource to monitor such as singular, daily, or hourly | 
+**resource_time** | **Integer** | Time of Resource in unix timestamp such as 1476025200 (2016-10-10 in +09:00) | 
+**resource_timezone** | **String** | Timezone of resource time, that is, timezone of %Y-%m-%d for hdfs://path/to/%Y-%m-%d such as +09:00 | 
+**payload** | **String** | Any json string | [optional] 
+**id** | **Integer** |  | [optional] 
+**created_at** | **DateTime** |  | [optional] 
+**updated_at** | **DateTime** |  | [optional] 
+
+

data/docs/MessageFetchRequest.md

@@ -0,0 +1,10 @@
+# TriglavClient::MessageFetchRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**offset** | **Integer** | Offset (Greater than or equal to) ID for Messages to fetch from | 
+**limit** | **Integer** | Number of limits | [optional] 
+**resource_uris** | **Array<String>** | URIs of Resource | [optional] 
+
+

data/docs/MessageRequest.md

@@ -0,0 +1,13 @@
+# TriglavClient::MessageRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**uuid** | **String** | Universally Unique ID to be used to avoid duplicated messages | [optional] 
+**resource_uri** | **String** | URI of Resource | 
+**resource_unit** | **String** | Time unit of resource to monitor such as singular, daily, or hourly | 
+**resource_time** | **Integer** | Time of Resource in unix timestamp such as 1476025200 (2016-10-10 in +09:00) | 
+**resource_timezone** | **String** | Timezone of resource time, that is, timezone of %Y-%m-%d for hdfs://path/to/%Y-%m-%d such as +09:00 | 
+**payload** | **String** | Any json string | [optional] 
+
+

data/docs/MessageResponse.md

@@ -0,0 +1,16 @@
+# TriglavClient::MessageResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**uuid** | **String** | Universally Unique ID to be used to avoid duplicated messages | [optional] 
+**resource_uri** | **String** | URI of Resource | 
+**resource_unit** | **String** | Time unit of resource to monitor such as singular, daily, or hourly | 
+**resource_time** | **Integer** | Time of Resource in unix timestamp such as 1476025200 (2016-10-10 in +09:00) | 
+**resource_timezone** | **String** | Timezone of resource time, that is, timezone of %Y-%m-%d for hdfs://path/to/%Y-%m-%d such as +09:00 | 
+**payload** | **String** | Any json string | [optional] 
+**id** | **Integer** |  | [optional] 
+**created_at** | **DateTime** |  | [optional] 
+**updated_at** | **DateTime** |  | [optional] 
+
+

data/docs/MessagesApi.md

@@ -0,0 +1,170 @@
+# TriglavClient::MessagesApi
+
+All URIs are relative to *http://localhost/api/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**fetch_messages**](MessagesApi.md#fetch_messages) | **GET** /messages | 
+[**get_last_message_id**](MessagesApi.md#get_last_message_id) | **GET** /messages/last_id | 
+[**send_messages**](MessagesApi.md#send_messages) | **POST** /messages | 
+
+
+# **fetch_messages**
+> Array<MessageEachResponse> fetch_messages(offset, opts)
+
+
+
+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::MessagesApi.new
+
+offset = 789 # Integer | Offset (Greater than or equal to) ID for Messages to list from
+
+opts = { 
+  limit: 789, # Integer | Number of limits
+  resource_uris: "resource_uris_example" # String | URIs of Resource
+}
+
+begin
+  result = api_instance.fetch_messages(offset, opts)
+  p result
+rescue TriglavClient::ApiError => e
+  puts "Exception when calling MessagesApi->fetch_messages: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **offset** | **Integer**| Offset (Greater than or equal to) ID for Messages to list from | 
+ **limit** | **Integer**| Number of limits | [optional] 
+ **resource_uris** | **String**| URIs of Resource | [optional] 
+
+### Return type
+
+[**Array<MessageEachResponse>**](MessageEachResponse.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_last_message_id**
+> LastMessageIdResponse get_last_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::MessagesApi.new
+
+begin
+  result = api_instance.get_last_message_id
+  p result
+rescue TriglavClient::ApiError => e
+  puts "Exception when calling MessagesApi->get_last_message_id: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**LastMessageIdResponse**](LastMessageIdResponse.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **send_messages**
+> BulkinsertResponse send_messages(messages)
+
+
+
+Enqueues new 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::MessagesApi.new
+
+messages = [TriglavClient::MessageRequest.new] # Array<MessageRequest> | Messages to enqueue
+
+
+begin
+  result = api_instance.send_messages(messages)
+  p result
+rescue TriglavClient::ApiError => e
+  puts "Exception when calling MessagesApi->send_messages: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **messages** | [**Array&lt;MessageRequest&gt;**](MessageRequest.md)| Messages to enqueue | 
+
+### Return type
+
+[**BulkinsertResponse**](BulkinsertResponse.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/ResourceEachResponse.md

@@ -0,0 +1,13 @@
+# TriglavClient::ResourceEachResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**uri** | **String** | resource uri | [optional] 
+**unit** | **String** | 'singualr' or 'daily' or 'hourly' | [optional] 
+**timezone** | **String** | timezone of the format [+-]HH:MM | [optional] 
+**span_in_days** | **Integer** | span in days | [optional] 
+**consumable** | **BOOLEAN** | True if this resource should be consumed | [optional] 
+**notifiable** | **BOOLEAN** | True if a job notifies its end of task to triglav for this resource, that is, monitoring in agent is not necessary | [optional] 
+
+

data/docs/ResourceRequest.md

@@ -0,0 +1,15 @@
+# TriglavClient::ResourceRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** |  | [optional] 
+**description** | **String** |  | [optional] 
+**uri** | **String** | URI of Resource | 
+**unit** | **String** | Time unit of resource to monitor such as singular, daily, or hourly | [optional] 
+**timezone** | **String** | Timezone of resource time, that is, timezone of %Y-%m-%d for hdfs://path/to/%Y-%m-%d such as +09:00 | [optional] 
+**span_in_days** | **Integer** | Time span of resource to monitor, default is 32 | [optional] 
+**consumable** | **BOOLEAN** | True if this resource should be consumed. Input resources are automatically set to true, and output resources are set to false | [optional] 
+**notifiable** | **BOOLEAN** | True if a job notifies its end of task to triglav for this resource, that is, monitoring in agent is not necessary | [optional] 
+
+

data/docs/ResourceResponse.md

@@ -0,0 +1,17 @@
+# TriglavClient::ResourceResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** |  | [optional] 
+**description** | **String** |  | [optional] 
+**uri** | **String** | URI of Resource | 
+**unit** | **String** | Time unit of resource to monitor such as singular, daily, or hourly | [optional] 
+**timezone** | **String** | Timezone of resource time, that is, timezone of %Y-%m-%d for hdfs://path/to/%Y-%m-%d such as +09:00 | [optional] 
+**span_in_days** | **Integer** | Time span of resource to monitor, default is 32 | [optional] 
+**consumable** | **BOOLEAN** | True if this resource should be consumed. Input resources are automatically set to true, and output resources are set to false | [optional] 
+**notifiable** | **BOOLEAN** | True if a job notifies its end of task to triglav for this resource, that is, monitoring in agent is not necessary | [optional] 
+**created_at** | **DateTime** |  | [optional] 
+**updated_at** | **DateTime** |  | [optional] 
+
+

data/docs/ResourcesApi.md

@@ -0,0 +1,335 @@
+# TriglavClient::ResourcesApi
+
+All URIs are relative to *http://localhost/api/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_resource**](ResourcesApi.md#create_resource) | **POST** /resources | 
+[**delete_resource**](ResourcesApi.md#delete_resource) | **DELETE** /resources/{id_or_uri} | 
+[**get_resource**](ResourcesApi.md#get_resource) | **GET** /resources/{id_or_uri} | 
+[**list_aggregated_resources**](ResourcesApi.md#list_aggregated_resources) | **GET** /aggregated_resources | 
+[**list_resources**](ResourcesApi.md#list_resources) | **GET** /resources | 
+[**update_resource**](ResourcesApi.md#update_resource) | **PATCH** /resources/{id_or_uri} | 
+
+
+# **create_resource**
+> ResourceResponse create_resource(resource)
+
+
+
+Creates a new resource
+
+### 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::ResourcesApi.new
+
+resource = TriglavClient::ResourceRequest.new # ResourceRequest | Resource to add
+
+
+begin
+  result = api_instance.create_resource(resource)
+  p result
+rescue TriglavClient::ApiError => e
+  puts "Exception when calling ResourcesApi->create_resource: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **resource** | [**ResourceRequest**](ResourceRequest.md)| Resource to add | 
+
+### Return type
+
+[**ResourceResponse**](ResourceResponse.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **delete_resource**
+> delete_resource(id_or_uri)
+
+
+
+Deletes single resource
+
+### 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::ResourcesApi.new
+
+id_or_uri = "id_or_uri_example" # String | ID or URI of resource to fetch
+
+
+begin
+  api_instance.delete_resource(id_or_uri)
+rescue TriglavClient::ApiError => e
+  puts "Exception when calling ResourcesApi->delete_resource: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id_or_uri** | **String**| ID or URI of resource 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_resource**
+> ResourceResponse get_resource(id_or_uri)
+
+
+
+Returns a single resource
+
+### 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::ResourcesApi.new
+
+id_or_uri = "id_or_uri_example" # String | ID or URI of resource to fetch
+
+
+begin
+  result = api_instance.get_resource(id_or_uri)
+  p result
+rescue TriglavClient::ApiError => e
+  puts "Exception when calling ResourcesApi->get_resource: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id_or_uri** | **String**| ID or URI of resource to fetch | 
+
+### Return type
+
+[**ResourceResponse**](ResourceResponse.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **list_aggregated_resources**
+> Array<AggregatedResourceEachResponse> list_aggregated_resources(uri_prefix)
+
+
+
+Returns aggregated resources to be monitored
+
+### 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::ResourcesApi.new
+
+uri_prefix = "uri_prefix_example" # String | Prefix of Resource URI
+
+
+begin
+  result = api_instance.list_aggregated_resources(uri_prefix)
+  p result
+rescue TriglavClient::ApiError => e
+  puts "Exception when calling ResourcesApi->list_aggregated_resources: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **uri_prefix** | **String**| Prefix of Resource URI | 
+
+### Return type
+
+[**Array<AggregatedResourceEachResponse>**](AggregatedResourceEachResponse.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **list_resources**
+> Array<ResourceEachResponse> list_resources(opts)
+
+
+
+Returns all resources
+
+### 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::ResourcesApi.new
+
+opts = { 
+  uri_prefix: "uri_prefix_example" # String | Prefix of Resource URI
+}
+
+begin
+  result = api_instance.list_resources(opts)
+  p result
+rescue TriglavClient::ApiError => e
+  puts "Exception when calling ResourcesApi->list_resources: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **uri_prefix** | **String**| Prefix of Resource URI | [optional] 
+
+### Return type
+
+[**Array<ResourceEachResponse>**](ResourceEachResponse.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **update_resource**
+> ResourceResponse update_resource(id_or_uri, resource)
+
+
+
+Updates a single resource
+
+### 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::ResourcesApi.new
+
+id_or_uri = "id_or_uri_example" # String | ID or URI of resource to fetch
+
+resource = TriglavClient::ResourceRequest.new # ResourceRequest | Resource parameters to update
+
+
+begin
+  result = api_instance.update_resource(id_or_uri, resource)
+  p result
+rescue TriglavClient::ApiError => e
+  puts "Exception when calling ResourcesApi->update_resource: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id_or_uri** | **String**| ID or URI of resource to fetch | 
+ **resource** | [**ResourceRequest**](ResourceRequest.md)| Resource parameters to update | 
+
+### Return type
+
+[**ResourceResponse**](ResourceResponse.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+