nodeum_sdk 1.86.0 → 1.87.0

data/docs/CloudConnector.md

@@ -12,6 +12,7 @@ Name | Type | Description | Notes
 **region** | **String** |  | [optional] 
 **access_key** | **String** |  | [optional] 
 **secret_key** | **String** |  | [optional] 
+**options** | **String** | S3FS mounting options, separated by comma | [optional] 
 
 ## Code Sample
 
@@ -25,7 +26,8 @@ instance = Nodeum::CloudConnector.new(id: null,
                                  provider: null,
                                  region: null,
                                  access_key: null,
-                                 secret_key: null)
+                                 secret_key: null,
+                                 options: null)
 ```
 
 

data/docs/DefaultFacet.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**count** | **Integer** |  | [optional] 
+**count** | **Integer** |  | [optional] [readonly] 
 
 ## Code Sample
 

data/docs/FileFacet.md

@@ -4,9 +4,9 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**files_count** | **Integer** |  | [optional] 
-**file_size_sum** | **Integer** |  | [optional] 
-**cost** | **Float** |  | [optional] 
+**files_count** | **Integer** |  | [optional] [readonly] 
+**file_size_sum** | **Integer** |  | [optional] [readonly] 
+**cost** | **Float** |  | [optional] [readonly] 
 
 ## Code Sample
 

data/docs/FileFacetAllOf.md

@@ -4,9 +4,9 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**files_count** | **Integer** |  | [optional] 
-**file_size_sum** | **Integer** |  | [optional] 
-**cost** | **Float** |  | [optional] 
+**files_count** | **Integer** |  | [optional] [readonly] 
+**file_size_sum** | **Integer** |  | [optional] [readonly] 
+**cost** | **Float** |  | [optional] [readonly] 
 
 ## Code Sample
 

data/docs/FileMetadataDefinition.md

@@ -0,0 +1,16 @@
+# Nodeum::FileMetadataDefinition
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+## Code Sample
+
+```ruby
+require 'Nodeum'
+
+instance = Nodeum::FileMetadataDefinition.new()
+```
+
+

data/docs/FileMetadataDefinitionCollection.md

@@ -0,0 +1,19 @@
+# Nodeum::FileMetadataDefinitionCollection
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** |  | [optional] [readonly] 
+**file_metadata_definitions** | [**Array<FileMetadataDefinition>**](FileMetadataDefinition.md) |  | [optional] [readonly] 
+
+## Code Sample
+
+```ruby
+require 'Nodeum'
+
+instance = Nodeum::FileMetadataDefinitionCollection.new(count: 1,
+                                 file_metadata_definitions: null)
+```
+
+

data/docs/MetadataApi.md

@@ -0,0 +1,252 @@
+# Nodeum::MetadataApi
+
+All URIs are relative to *http://localhost/api/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**index_file_metadata_definitions**](MetadataApi.md#index_file_metadata_definitions) | **GET** /file_metadata_definitions | List file metadata definitions
+[**index_task_metadata_definitions**](MetadataApi.md#index_task_metadata_definitions) | **GET** /task_metadata_definitions | List task metadata definitions
+[**show_file_metadata_definition**](MetadataApi.md#show_file_metadata_definition) | **GET** /file_metadata_definitions/{metadata_definition_id} | Displays a specific task metadata definition.
+[**show_task_metadata_definition**](MetadataApi.md#show_task_metadata_definition) | **GET** /task_metadata_definitions/{metadata_definition_id} | Displays a specific task metadata definition.
+
+
+
+## index_file_metadata_definitions
+
+> FileMetadataDefinitionCollection index_file_metadata_definitions(opts)
+
+List file metadata definitions
+
+**API Key Scope**: file_metadata_definitions / index
+
+### Example
+
+```ruby
+# load the gem
+require 'nodeum_sdk'
+# setup authorization
+Nodeum.configure do |config|
+  # Configure HTTP basic authorization: BasicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+
+  # Configure API key authorization: BearerAuth
+  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 = Nodeum::MetadataApi.new
+opts = {
+  limit: 56, # Integer | The number of items to display for pagination.
+  offset: 56 # Integer | The number of items to skip for pagination.
+}
+
+begin
+  #List file metadata definitions
+  result = api_instance.index_file_metadata_definitions(opts)
+  p result
+rescue Nodeum::ApiError => e
+  puts "Exception when calling MetadataApi->index_file_metadata_definitions: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **limit** | **Integer**| The number of items to display for pagination. | [optional] 
+ **offset** | **Integer**| The number of items to skip for pagination. | [optional] 
+
+### Return type
+
+[**FileMetadataDefinitionCollection**](FileMetadataDefinitionCollection.md)
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth), [BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## index_task_metadata_definitions
+
+> TaskMetadataDefinitionCollection index_task_metadata_definitions(opts)
+
+List task metadata definitions
+
+**API Key Scope**: task_metadata_definitions / index
+
+### Example
+
+```ruby
+# load the gem
+require 'nodeum_sdk'
+# setup authorization
+Nodeum.configure do |config|
+  # Configure HTTP basic authorization: BasicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+
+  # Configure API key authorization: BearerAuth
+  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 = Nodeum::MetadataApi.new
+opts = {
+  limit: 56, # Integer | The number of items to display for pagination.
+  offset: 56 # Integer | The number of items to skip for pagination.
+}
+
+begin
+  #List task metadata definitions
+  result = api_instance.index_task_metadata_definitions(opts)
+  p result
+rescue Nodeum::ApiError => e
+  puts "Exception when calling MetadataApi->index_task_metadata_definitions: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **limit** | **Integer**| The number of items to display for pagination. | [optional] 
+ **offset** | **Integer**| The number of items to skip for pagination. | [optional] 
+
+### Return type
+
+[**TaskMetadataDefinitionCollection**](TaskMetadataDefinitionCollection.md)
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth), [BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## show_file_metadata_definition
+
+> FileMetadataDefinition show_file_metadata_definition(metadata_definition_id)
+
+Displays a specific task metadata definition.
+
+**API Key Scope**: file_metadata_definitions / show
+
+### Example
+
+```ruby
+# load the gem
+require 'nodeum_sdk'
+# setup authorization
+Nodeum.configure do |config|
+  # Configure HTTP basic authorization: BasicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+
+  # Configure API key authorization: BearerAuth
+  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 = Nodeum::MetadataApi.new
+metadata_definition_id = 'metadata_definition_id_example' # String | Numeric ID or key of a metadata definition
+
+begin
+  #Displays a specific task metadata definition.
+  result = api_instance.show_file_metadata_definition(metadata_definition_id)
+  p result
+rescue Nodeum::ApiError => e
+  puts "Exception when calling MetadataApi->show_file_metadata_definition: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **metadata_definition_id** | **String**| Numeric ID or key of a metadata definition | 
+
+### Return type
+
+[**FileMetadataDefinition**](FileMetadataDefinition.md)
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth), [BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## show_task_metadata_definition
+
+> TaskMetadataDefinition show_task_metadata_definition(metadata_definition_id)
+
+Displays a specific task metadata definition.
+
+**API Key Scope**: task_metadata_definitions / show
+
+### Example
+
+```ruby
+# load the gem
+require 'nodeum_sdk'
+# setup authorization
+Nodeum.configure do |config|
+  # Configure HTTP basic authorization: BasicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+
+  # Configure API key authorization: BearerAuth
+  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 = Nodeum::MetadataApi.new
+metadata_definition_id = 'metadata_definition_id_example' # String | Numeric ID or key of a metadata definition
+
+begin
+  #Displays a specific task metadata definition.
+  result = api_instance.show_task_metadata_definition(metadata_definition_id)
+  p result
+rescue Nodeum::ApiError => e
+  puts "Exception when calling MetadataApi->show_task_metadata_definition: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **metadata_definition_id** | **String**| Numeric ID or key of a metadata definition | 
+
+### Return type
+
+[**TaskMetadataDefinition**](TaskMetadataDefinition.md)
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth), [BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/MetadataDefinition.md

@@ -0,0 +1,27 @@
+# Nodeum::MetadataDefinition
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** |  | [optional] [readonly] 
+**key** | **String** |  | [optional] 
+**name** | **String** |  | [optional] 
+**mandatory** | **Boolean** |  | [optional] 
+**type** | **String** |  | [optional] 
+**comment** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Nodeum'
+
+instance = Nodeum::MetadataDefinition.new(id: 1,
+                                 key: my_metadata,
+                                 name: My Metadata,
+                                 mandatory: null,
+                                 type: null,
+                                 comment: null)
+```
+
+

data/docs/StatisticsApi.md

@@ -7,6 +7,7 @@ Method | HTTP request | Description
 [**statistics_by_date**](StatisticsApi.md#statistics_by_date) | **GET** /statistics/by_date | Get statistics about files, grouped by date
 [**statistics_by_file_extension**](StatisticsApi.md#statistics_by_file_extension) | **GET** /statistics/by_file_extension | Get statistics about files, grouped by file extension
 [**statistics_by_group_owner**](StatisticsApi.md#statistics_by_group_owner) | **GET** /statistics/by_group_owner | Get statistics about files, grouped by owner (group)
+[**statistics_by_metadata**](StatisticsApi.md#statistics_by_metadata) | **GET** /statistics/by_metadata | Get statistics about files, grouped by metadata
 [**statistics_by_primary_cloud**](StatisticsApi.md#statistics_by_primary_cloud) | **GET** /statistics/by_primary_cloud | Get statistics about files, grouped by primary Cloud
 [**statistics_by_primary_name**](StatisticsApi.md#statistics_by_primary_name) | **GET** /statistics/by_primary_name | Get statistics about files, grouped by primary storages
 [**statistics_by_primary_nas**](StatisticsApi.md#statistics_by_primary_nas) | **GET** /statistics/by_primary_nas | Get statistics about files, grouped by primary NAS
@@ -18,6 +19,7 @@ Method | HTTP request | Description
 [**statistics_by_size**](StatisticsApi.md#statistics_by_size) | **GET** /statistics/by_size | Get statistics about files, grouped by size
 [**statistics_by_user_owner**](StatisticsApi.md#statistics_by_user_owner) | **GET** /statistics/by_user_owner | Get statistics about files, grouped by owner (user)
 [**statistics_storage**](StatisticsApi.md#statistics_storage) | **GET** /statistics/storage | Get statistics about storages, grouped by types
+[**statistics_task_by_metadata**](StatisticsApi.md#statistics_task_by_metadata) | **GET** /statistics/task_by_metadata | Get statistics about tasks executions, grouped by metadata
 [**statistics_task_by_status**](StatisticsApi.md#statistics_task_by_status) | **GET** /statistics/task_by_status | Get statistics about tasks executions, grouped by status
 [**statistics_task_by_storage**](StatisticsApi.md#statistics_task_by_storage) | **GET** /statistics/task_by_storage | Get statistics about tasks executions, grouped by source and destination
 [**statistics_task_by_workflow**](StatisticsApi.md#statistics_task_by_workflow) | **GET** /statistics/task_by_workflow | Get statistics about tasks executions, grouped by workflow
@@ -224,6 +226,74 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
+## statistics_by_metadata
+
+> ByMetadataFacet statistics_by_metadata(opts)
+
+Get statistics about files, grouped by metadata
+
+**API Key Scope**: statistics / by_metadata
+
+### Example
+
+```ruby
+# load the gem
+require 'nodeum_sdk'
+# setup authorization
+Nodeum.configure do |config|
+  # Configure HTTP basic authorization: BasicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+
+  # Configure API key authorization: BearerAuth
+  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 = Nodeum::StatisticsApi.new
+opts = {
+  q: 'q_example', # String | Solr query
+  fq: ['fq_example'], # Array<String> | Solr filter query  Multiple query can be separated by `|`.
+  date_attr: 'date_attr_example', # String | Type of date to facet on
+  sort: 'count', # String | Sort results of facet
+  limit: 10 # Integer | Limit results of facet
+}
+
+begin
+  #Get statistics about files, grouped by metadata
+  result = api_instance.statistics_by_metadata(opts)
+  p result
+rescue Nodeum::ApiError => e
+  puts "Exception when calling StatisticsApi->statistics_by_metadata: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **q** | **String**| Solr query | [optional] 
+ **fq** | [**Array&lt;String&gt;**](String.md)| Solr filter query  Multiple query can be separated by &#x60;|&#x60;. | [optional] 
+ **date_attr** | **String**| Type of date to facet on | [optional] 
+ **sort** | **String**| Sort results of facet | [optional] [default to &#39;count&#39;]
+ **limit** | **Integer**| Limit results of facet | [optional] [default to 10]
+
+### Return type
+
+[**ByMetadataFacet**](ByMetadataFacet.md)
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth), [BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## statistics_by_primary_cloud
 
 > ByPrimaryCloudFacet statistics_by_primary_cloud(opts)
@@ -962,6 +1032,72 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
+## statistics_task_by_metadata
+
+> ByTaskMetadataFacet statistics_task_by_metadata(opts)
+
+Get statistics about tasks executions, grouped by metadata
+
+**API Key Scope**: statistics / task_by_metadata
+
+### Example
+
+```ruby
+# load the gem
+require 'nodeum_sdk'
+# setup authorization
+Nodeum.configure do |config|
+  # Configure HTTP basic authorization: BasicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+
+  # Configure API key authorization: BearerAuth
+  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 = Nodeum::StatisticsApi.new
+opts = {
+  q: 'q_example', # String | Solr query
+  fq: ['fq_example'], # Array<String> | Solr filter query  Multiple query can be separated by `|`.
+  sort: 'count', # String | Sort results of facet on task
+  limit: 10 # Integer | Limit results of facet
+}
+
+begin
+  #Get statistics about tasks executions, grouped by metadata
+  result = api_instance.statistics_task_by_metadata(opts)
+  p result
+rescue Nodeum::ApiError => e
+  puts "Exception when calling StatisticsApi->statistics_task_by_metadata: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **q** | **String**| Solr query | [optional] 
+ **fq** | [**Array&lt;String&gt;**](String.md)| Solr filter query  Multiple query can be separated by &#x60;|&#x60;. | [optional] 
+ **sort** | **String**| Sort results of facet on task | [optional] [default to &#39;count&#39;]
+ **limit** | **Integer**| Limit results of facet | [optional] [default to 10]
+
+### Return type
+
+[**ByTaskMetadataFacet**](ByTaskMetadataFacet.md)
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth), [BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## statistics_task_by_status
 
 > ByTaskStatusFacet statistics_task_by_status(opts)