nodeum_sdk 1.85.1 → 1.86.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +69 -14
- data/docs/ByDateFacet.md +4 -0
- data/docs/ByFileExtensionFacet.md +2 -2
- data/docs/ByFileExtensionFacetAllOf.md +2 -2
- data/docs/ByGroupOwnerFacet.md +2 -2
- data/docs/ByGroupOwnerFacetAllOf.md +2 -2
- data/docs/ByPrimaryCloudFacet.md +21 -0
- data/docs/ByPrimaryCloudFacetAllOf.md +21 -0
- data/docs/ByPrimaryFacet.md +2 -2
- data/docs/ByPrimaryFacetAllOf.md +2 -2
- data/docs/ByPrimaryNasFacet.md +21 -0
- data/docs/ByPrimaryNasFacetAllOf.md +21 -0
- data/docs/ByPrimaryStorageFacet.md +31 -0
- data/docs/ByPrimaryTypeFacet.md +41 -0
- data/docs/BySecondaryCloudFacet.md +21 -0
- data/docs/BySecondaryCloudFacetAllOf.md +21 -0
- data/docs/BySecondaryNasFacet.md +21 -0
- data/docs/BySecondaryNasFacetAllOf.md +21 -0
- data/docs/BySecondaryStorageFacet.md +35 -0
- data/docs/BySecondaryTapeFacet.md +21 -0
- data/docs/BySecondaryTapeFacetAllOf.md +21 -0
- data/docs/BySecondaryTypeFacet.md +2 -2
- data/docs/BySecondaryTypeFacetAllOf.md +2 -2
- data/docs/BySizeFacet.md +4 -0
- data/docs/ByTaskStatusFacet.md +17 -0
- data/docs/ByTaskStatusFacetAllOf.md +17 -0
- data/docs/ByTaskStorageFacet.md +19 -0
- data/docs/ByTaskStorageFacetAllOf.md +19 -0
- data/docs/ByTaskWorkflowFacet.md +17 -0
- data/docs/ByTaskWorkflowFacetAllOf.md +17 -0
- data/docs/ByTypeFacetBucket.md +19 -0
- data/docs/ByTypeFacetBuckets.md +17 -0
- data/docs/ByUserOwnerFacet.md +2 -2
- data/docs/ByUserOwnerFacetAllOf.md +2 -2
- data/docs/Container.md +4 -0
- data/docs/DefaultFacet.md +17 -0
- data/docs/FileFacet.md +5 -3
- data/docs/FileFacetAllOf.md +21 -0
- data/docs/StatisticsApi.md +805 -42
- data/docs/StorageByTypeFacets.md +25 -0
- data/docs/StorageCloudBucketByTypeFacets.md +19 -0
- data/docs/StorageCloudBucketFacets.md +21 -0
- data/docs/StorageFacet.md +27 -0
- data/docs/StorageNasShareByTypeFacets.md +19 -0
- data/docs/StorageNasShareFacets.md +21 -0
- data/docs/StoragePoolByTypeFacets.md +19 -0
- data/docs/StoragePoolFacets.md +21 -0
- data/docs/StorageTapeByTypeFacets.md +21 -0
- data/docs/StorageTapeFacets.md +23 -0
- data/docs/TaskByWorkflowBucket.md +19 -0
- data/docs/TaskByWorkflowBucketAllOf.md +19 -0
- data/docs/TaskByWorkflowBuckets.md +17 -0
- data/docs/TaskFacet.md +27 -0
- data/docs/TaskFacetAllOf.md +27 -0
- data/docs/TaskFacetBucket.md +31 -0
- data/docs/TaskFacetBuckets.md +17 -0
- data/docs/TypeToPrimaryFacets.md +23 -0
- data/docs/TypeToSecondaryFacets.md +2 -0
- data/docs/UserConfiguration.md +21 -0
- data/docs/UserConfigurationCollection.md +19 -0
- data/docs/UsersApi.md +300 -0
- data/lib/nodeum_sdk.rb +43 -4
- data/lib/nodeum_sdk/api/statistics_api.rb +910 -51
- data/lib/nodeum_sdk/api/users_api.rb +318 -0
- data/lib/nodeum_sdk/models/by_date_facet.rb +19 -1
- data/lib/nodeum_sdk/models/by_file_extension_facet.rb +7 -7
- data/lib/nodeum_sdk/models/by_file_extension_facet_all_of.rb +7 -7
- data/lib/nodeum_sdk/models/by_group_owner_facet.rb +7 -7
- data/lib/nodeum_sdk/models/by_group_owner_facet_all_of.rb +7 -7
- data/lib/nodeum_sdk/models/by_primary_cloud_facet.rb +236 -0
- data/lib/nodeum_sdk/models/by_primary_cloud_facet_all_of.rb +224 -0
- data/lib/nodeum_sdk/models/by_primary_facet.rb +7 -7
- data/lib/nodeum_sdk/models/by_primary_facet_all_of.rb +7 -7
- data/lib/nodeum_sdk/models/by_primary_nas_facet.rb +236 -0
- data/lib/nodeum_sdk/models/by_primary_nas_facet_all_of.rb +224 -0
- data/lib/nodeum_sdk/models/by_primary_storage_facet.rb +277 -0
- data/lib/nodeum_sdk/models/by_primary_type_facet.rb +322 -0
- data/lib/nodeum_sdk/models/by_secondary_cloud_facet.rb +236 -0
- data/lib/nodeum_sdk/models/by_secondary_cloud_facet_all_of.rb +224 -0
- data/lib/nodeum_sdk/models/by_secondary_nas_facet.rb +236 -0
- data/lib/nodeum_sdk/models/by_secondary_nas_facet_all_of.rb +224 -0
- data/lib/nodeum_sdk/models/by_secondary_storage_facet.rb +295 -0
- data/lib/nodeum_sdk/models/by_secondary_tape_facet.rb +236 -0
- data/lib/nodeum_sdk/models/by_secondary_tape_facet_all_of.rb +224 -0
- data/lib/nodeum_sdk/models/by_secondary_type_facet.rb +7 -7
- data/lib/nodeum_sdk/models/by_secondary_type_facet_all_of.rb +7 -7
- data/lib/nodeum_sdk/models/by_size_facet.rb +19 -1
- data/lib/nodeum_sdk/models/by_task_status_facet.rb +218 -0
- data/lib/nodeum_sdk/models/by_task_status_facet_all_of.rb +206 -0
- data/lib/nodeum_sdk/models/by_task_storage_facet.rb +227 -0
- data/lib/nodeum_sdk/models/by_task_storage_facet_all_of.rb +215 -0
- data/lib/nodeum_sdk/models/by_task_workflow_facet.rb +218 -0
- data/lib/nodeum_sdk/models/by_task_workflow_facet_all_of.rb +206 -0
- data/lib/nodeum_sdk/models/by_type_facet_bucket.rb +223 -0
- data/lib/nodeum_sdk/models/by_type_facet_buckets.rb +208 -0
- data/lib/nodeum_sdk/models/by_user_owner_facet.rb +7 -7
- data/lib/nodeum_sdk/models/by_user_owner_facet_all_of.rb +7 -7
- data/lib/nodeum_sdk/models/container.rb +19 -1
- data/lib/nodeum_sdk/models/default_facet.rb +206 -0
- data/lib/nodeum_sdk/models/file_facet.rb +35 -14
- data/lib/nodeum_sdk/models/file_facet_all_of.rb +224 -0
- data/lib/nodeum_sdk/models/storage_by_type_facets.rb +242 -0
- data/lib/nodeum_sdk/models/storage_cloud_bucket_by_type_facets.rb +215 -0
- data/lib/nodeum_sdk/models/storage_cloud_bucket_facets.rb +232 -0
- data/lib/nodeum_sdk/models/storage_facet.rb +259 -0
- data/lib/nodeum_sdk/models/storage_nas_share_by_type_facets.rb +215 -0
- data/lib/nodeum_sdk/models/storage_nas_share_facets.rb +232 -0
- data/lib/nodeum_sdk/models/storage_pool_by_type_facets.rb +215 -0
- data/lib/nodeum_sdk/models/storage_pool_facets.rb +232 -0
- data/lib/nodeum_sdk/models/storage_tape_by_type_facets.rb +224 -0
- data/lib/nodeum_sdk/models/storage_tape_facets.rb +241 -0
- data/lib/nodeum_sdk/models/task_by_workflow_bucket.rb +227 -0
- data/lib/nodeum_sdk/models/task_by_workflow_bucket_all_of.rb +215 -0
- data/lib/nodeum_sdk/models/task_by_workflow_buckets.rb +208 -0
- data/lib/nodeum_sdk/models/task_facet.rb +263 -0
- data/lib/nodeum_sdk/models/task_facet_all_of.rb +251 -0
- data/lib/nodeum_sdk/models/task_facet_bucket.rb +277 -0
- data/lib/nodeum_sdk/models/task_facet_buckets.rb +208 -0
- data/lib/nodeum_sdk/models/type_to_primary_facets.rb +233 -0
- data/lib/nodeum_sdk/models/type_to_secondary_facets.rb +10 -1
- data/lib/nodeum_sdk/models/user_configuration.rb +224 -0
- data/lib/nodeum_sdk/models/user_configuration_collection.rb +217 -0
- data/lib/nodeum_sdk/version.rb +1 -1
- data/spec/models/by_primary_cloud_facet_all_of_spec.rb +53 -0
- data/spec/models/by_primary_cloud_facet_spec.rb +53 -0
- data/spec/models/by_primary_nas_facet_all_of_spec.rb +53 -0
- data/spec/models/by_primary_nas_facet_spec.rb +53 -0
- data/spec/models/by_primary_storage_facet_spec.rb +83 -0
- data/spec/models/by_primary_type_facet_spec.rb +113 -0
- data/spec/models/by_secondary_cloud_facet_all_of_spec.rb +53 -0
- data/spec/models/by_secondary_cloud_facet_spec.rb +53 -0
- data/spec/models/by_secondary_nas_facet_all_of_spec.rb +53 -0
- data/spec/models/by_secondary_nas_facet_spec.rb +53 -0
- data/spec/models/by_secondary_storage_facet_spec.rb +95 -0
- data/spec/models/by_secondary_tape_facet_all_of_spec.rb +53 -0
- data/spec/models/by_secondary_tape_facet_spec.rb +53 -0
- data/spec/models/by_task_status_facet_all_of_spec.rb +41 -0
- data/spec/models/by_task_status_facet_spec.rb +41 -0
- data/spec/models/by_task_storage_facet_all_of_spec.rb +47 -0
- data/spec/models/by_task_storage_facet_spec.rb +47 -0
- data/spec/models/by_task_workflow_facet_all_of_spec.rb +41 -0
- data/spec/models/by_task_workflow_facet_spec.rb +41 -0
- data/spec/models/by_type_facet_bucket_spec.rb +47 -0
- data/spec/models/by_type_facet_buckets_spec.rb +41 -0
- data/spec/models/default_facet_spec.rb +41 -0
- data/spec/models/file_facet_all_of_spec.rb +53 -0
- data/spec/models/storage_by_type_facets_spec.rb +65 -0
- data/spec/models/storage_cloud_bucket_by_type_facets_spec.rb +47 -0
- data/spec/models/storage_cloud_bucket_facets_spec.rb +53 -0
- data/spec/models/storage_facet_spec.rb +71 -0
- data/spec/models/storage_nas_share_by_type_facets_spec.rb +47 -0
- data/spec/models/storage_nas_share_facets_spec.rb +53 -0
- data/spec/models/storage_pool_by_type_facets_spec.rb +47 -0
- data/spec/models/storage_pool_facets_spec.rb +53 -0
- data/spec/models/storage_tape_by_type_facets_spec.rb +53 -0
- data/spec/models/storage_tape_facets_spec.rb +59 -0
- data/spec/models/task_by_workflow_bucket_all_of_spec.rb +47 -0
- data/spec/models/task_by_workflow_bucket_spec.rb +47 -0
- data/spec/models/task_by_workflow_buckets_spec.rb +41 -0
- data/spec/models/task_facet_all_of_spec.rb +71 -0
- data/spec/models/task_facet_bucket_spec.rb +83 -0
- data/spec/models/task_facet_buckets_spec.rb +41 -0
- data/spec/models/task_facet_spec.rb +71 -0
- data/spec/models/type_to_primary_facets_spec.rb +59 -0
- data/spec/models/user_configuration_collection_spec.rb +47 -0
- data/spec/models/user_configuration_spec.rb +53 -0
- metadata +174 -2
data/docs/FileFacet.md
CHANGED
@@ -4,16 +4,18 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**
|
7
|
+
**files_count** | **Integer** | | [optional]
|
8
8
|
**file_size_sum** | **Integer** | | [optional]
|
9
|
+
**cost** | **Float** | | [optional]
|
9
10
|
|
10
11
|
## Code Sample
|
11
12
|
|
12
13
|
```ruby
|
13
14
|
require 'Nodeum'
|
14
15
|
|
15
|
-
instance = Nodeum::FileFacet.new(
|
16
|
-
file_size_sum: null
|
16
|
+
instance = Nodeum::FileFacet.new(files_count: null,
|
17
|
+
file_size_sum: null,
|
18
|
+
cost: null)
|
17
19
|
```
|
18
20
|
|
19
21
|
|
@@ -0,0 +1,21 @@
|
|
1
|
+
# Nodeum::FileFacetAllOf
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**files_count** | **Integer** | | [optional]
|
8
|
+
**file_size_sum** | **Integer** | | [optional]
|
9
|
+
**cost** | **Float** | | [optional]
|
10
|
+
|
11
|
+
## Code Sample
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'Nodeum'
|
15
|
+
|
16
|
+
instance = Nodeum::FileFacetAllOf.new(files_count: null,
|
17
|
+
file_size_sum: null,
|
18
|
+
cost: null)
|
19
|
+
```
|
20
|
+
|
21
|
+
|
data/docs/StatisticsApi.md
CHANGED
@@ -4,20 +4,95 @@ All URIs are relative to *http://localhost/api/v2*
|
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
-
[**
|
8
|
-
[**
|
9
|
-
[**
|
10
|
-
[**
|
11
|
-
[**
|
12
|
-
[**
|
7
|
+
[**statistics_by_date**](StatisticsApi.md#statistics_by_date) | **GET** /statistics/by_date | Get statistics about files, grouped by date
|
8
|
+
[**statistics_by_file_extension**](StatisticsApi.md#statistics_by_file_extension) | **GET** /statistics/by_file_extension | Get statistics about files, grouped by file extension
|
9
|
+
[**statistics_by_group_owner**](StatisticsApi.md#statistics_by_group_owner) | **GET** /statistics/by_group_owner | Get statistics about files, grouped by owner (group)
|
10
|
+
[**statistics_by_primary_cloud**](StatisticsApi.md#statistics_by_primary_cloud) | **GET** /statistics/by_primary_cloud | Get statistics about files, grouped by primary Cloud
|
11
|
+
[**statistics_by_primary_name**](StatisticsApi.md#statistics_by_primary_name) | **GET** /statistics/by_primary_name | Get statistics about files, grouped by primary storages
|
12
|
+
[**statistics_by_primary_nas**](StatisticsApi.md#statistics_by_primary_nas) | **GET** /statistics/by_primary_nas | Get statistics about files, grouped by primary NAS
|
13
|
+
[**statistics_by_primary_storage**](StatisticsApi.md#statistics_by_primary_storage) | **GET** /statistics/by_primary_storage | Get statistics about files, grouped by primary storage
|
14
|
+
[**statistics_by_secondary_cloud**](StatisticsApi.md#statistics_by_secondary_cloud) | **GET** /statistics/by_secondary_cloud | Get statistics about files, grouped by secondary Cloud
|
15
|
+
[**statistics_by_secondary_nas**](StatisticsApi.md#statistics_by_secondary_nas) | **GET** /statistics/by_secondary_nas | Get statistics about files, grouped by secondary NAS
|
16
|
+
[**statistics_by_secondary_storage**](StatisticsApi.md#statistics_by_secondary_storage) | **GET** /statistics/by_secondary_storage | Get statistics about files, grouped by secondary storage
|
17
|
+
[**statistics_by_secondary_tape**](StatisticsApi.md#statistics_by_secondary_tape) | **GET** /statistics/by_secondary_tape | Get statistics about files, grouped by secondary Tape
|
18
|
+
[**statistics_by_size**](StatisticsApi.md#statistics_by_size) | **GET** /statistics/by_size | Get statistics about files, grouped by size
|
19
|
+
[**statistics_by_user_owner**](StatisticsApi.md#statistics_by_user_owner) | **GET** /statistics/by_user_owner | Get statistics about files, grouped by owner (user)
|
20
|
+
[**statistics_storage**](StatisticsApi.md#statistics_storage) | **GET** /statistics/storage | Get statistics about storages, grouped by types
|
21
|
+
[**statistics_task_by_status**](StatisticsApi.md#statistics_task_by_status) | **GET** /statistics/task_by_status | Get statistics about tasks executions, grouped by status
|
22
|
+
[**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
|
23
|
+
[**statistics_task_by_workflow**](StatisticsApi.md#statistics_task_by_workflow) | **GET** /statistics/task_by_workflow | Get statistics about tasks executions, grouped by workflow
|
13
24
|
|
14
25
|
|
15
26
|
|
27
|
+
## statistics_by_date
|
28
|
+
|
29
|
+
> ByDateFacet statistics_by_date(opts)
|
30
|
+
|
31
|
+
Get statistics about files, grouped by date
|
32
|
+
|
33
|
+
**API Key Scope**: statistics / by_date
|
34
|
+
|
35
|
+
### Example
|
36
|
+
|
37
|
+
```ruby
|
38
|
+
# load the gem
|
39
|
+
require 'nodeum_sdk'
|
40
|
+
# setup authorization
|
41
|
+
Nodeum.configure do |config|
|
42
|
+
# Configure HTTP basic authorization: BasicAuth
|
43
|
+
config.username = 'YOUR USERNAME'
|
44
|
+
config.password = 'YOUR PASSWORD'
|
45
|
+
|
46
|
+
# Configure API key authorization: BearerAuth
|
47
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
48
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
49
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
50
|
+
end
|
51
|
+
|
52
|
+
api_instance = Nodeum::StatisticsApi.new
|
53
|
+
opts = {
|
54
|
+
q: 'q_example', # String | Solr query
|
55
|
+
fq: ['fq_example'], # Array<String> | Solr filter query Multiple query can be separated by `|`.
|
56
|
+
date_attr: 'date_attr_example' # String | Type of date to facet on
|
57
|
+
}
|
58
|
+
|
59
|
+
begin
|
60
|
+
#Get statistics about files, grouped by date
|
61
|
+
result = api_instance.statistics_by_date(opts)
|
62
|
+
p result
|
63
|
+
rescue Nodeum::ApiError => e
|
64
|
+
puts "Exception when calling StatisticsApi->statistics_by_date: #{e}"
|
65
|
+
end
|
66
|
+
```
|
67
|
+
|
68
|
+
### Parameters
|
69
|
+
|
70
|
+
|
71
|
+
Name | Type | Description | Notes
|
72
|
+
------------- | ------------- | ------------- | -------------
|
73
|
+
**q** | **String**| Solr query | [optional]
|
74
|
+
**fq** | [**Array<String>**](String.md)| Solr filter query Multiple query can be separated by `|`. | [optional]
|
75
|
+
**date_attr** | **String**| Type of date to facet on | [optional]
|
76
|
+
|
77
|
+
### Return type
|
78
|
+
|
79
|
+
[**ByDateFacet**](ByDateFacet.md)
|
80
|
+
|
81
|
+
### Authorization
|
82
|
+
|
83
|
+
[BasicAuth](../README.md#BasicAuth), [BearerAuth](../README.md#BearerAuth)
|
84
|
+
|
85
|
+
### HTTP request headers
|
86
|
+
|
87
|
+
- **Content-Type**: Not defined
|
88
|
+
- **Accept**: application/json
|
89
|
+
|
90
|
+
|
16
91
|
## statistics_by_file_extension
|
17
92
|
|
18
93
|
> ByFileExtensionFacet statistics_by_file_extension(opts)
|
19
94
|
|
20
|
-
|
95
|
+
Get statistics about files, grouped by file extension
|
21
96
|
|
22
97
|
**API Key Scope**: statistics / by_file_extension
|
23
98
|
|
@@ -41,11 +116,14 @@ end
|
|
41
116
|
api_instance = Nodeum::StatisticsApi.new
|
42
117
|
opts = {
|
43
118
|
q: 'q_example', # String | Solr query
|
44
|
-
|
119
|
+
fq: ['fq_example'], # Array<String> | Solr filter query Multiple query can be separated by `|`.
|
120
|
+
date_attr: 'date_attr_example', # String | Type of date to facet on
|
121
|
+
sort: 'count', # String | Sort results of facet
|
122
|
+
limit: 10 # Integer | Limit results of facet
|
45
123
|
}
|
46
124
|
|
47
125
|
begin
|
48
|
-
#
|
126
|
+
#Get statistics about files, grouped by file extension
|
49
127
|
result = api_instance.statistics_by_file_extension(opts)
|
50
128
|
p result
|
51
129
|
rescue Nodeum::ApiError => e
|
@@ -59,7 +137,10 @@ end
|
|
59
137
|
Name | Type | Description | Notes
|
60
138
|
------------- | ------------- | ------------- | -------------
|
61
139
|
**q** | **String**| Solr query | [optional]
|
140
|
+
**fq** | [**Array<String>**](String.md)| Solr filter query Multiple query can be separated by `|`. | [optional]
|
62
141
|
**date_attr** | **String**| Type of date to facet on | [optional]
|
142
|
+
**sort** | **String**| Sort results of facet | [optional] [default to 'count']
|
143
|
+
**limit** | **Integer**| Limit results of facet | [optional] [default to 10]
|
63
144
|
|
64
145
|
### Return type
|
65
146
|
|
@@ -79,7 +160,7 @@ Name | Type | Description | Notes
|
|
79
160
|
|
80
161
|
> ByGroupOwnerFacet statistics_by_group_owner(opts)
|
81
162
|
|
82
|
-
|
163
|
+
Get statistics about files, grouped by owner (group)
|
83
164
|
|
84
165
|
**API Key Scope**: statistics / by_group_owner
|
85
166
|
|
@@ -103,11 +184,14 @@ end
|
|
103
184
|
api_instance = Nodeum::StatisticsApi.new
|
104
185
|
opts = {
|
105
186
|
q: 'q_example', # String | Solr query
|
106
|
-
|
187
|
+
fq: ['fq_example'], # Array<String> | Solr filter query Multiple query can be separated by `|`.
|
188
|
+
date_attr: 'date_attr_example', # String | Type of date to facet on
|
189
|
+
sort: 'count', # String | Sort results of facet
|
190
|
+
limit: 10 # Integer | Limit results of facet
|
107
191
|
}
|
108
192
|
|
109
193
|
begin
|
110
|
-
#
|
194
|
+
#Get statistics about files, grouped by owner (group)
|
111
195
|
result = api_instance.statistics_by_group_owner(opts)
|
112
196
|
p result
|
113
197
|
rescue Nodeum::ApiError => e
|
@@ -121,7 +205,10 @@ end
|
|
121
205
|
Name | Type | Description | Notes
|
122
206
|
------------- | ------------- | ------------- | -------------
|
123
207
|
**q** | **String**| Solr query | [optional]
|
208
|
+
**fq** | [**Array<String>**](String.md)| Solr filter query Multiple query can be separated by `|`. | [optional]
|
124
209
|
**date_attr** | **String**| Type of date to facet on | [optional]
|
210
|
+
**sort** | **String**| Sort results of facet | [optional] [default to 'count']
|
211
|
+
**limit** | **Integer**| Limit results of facet | [optional] [default to 10]
|
125
212
|
|
126
213
|
### Return type
|
127
214
|
|
@@ -137,11 +224,79 @@ Name | Type | Description | Notes
|
|
137
224
|
- **Accept**: application/json
|
138
225
|
|
139
226
|
|
227
|
+
## statistics_by_primary_cloud
|
228
|
+
|
229
|
+
> ByPrimaryCloudFacet statistics_by_primary_cloud(opts)
|
230
|
+
|
231
|
+
Get statistics about files, grouped by primary Cloud
|
232
|
+
|
233
|
+
**API Key Scope**: statistics / by_primary_cloud
|
234
|
+
|
235
|
+
### Example
|
236
|
+
|
237
|
+
```ruby
|
238
|
+
# load the gem
|
239
|
+
require 'nodeum_sdk'
|
240
|
+
# setup authorization
|
241
|
+
Nodeum.configure do |config|
|
242
|
+
# Configure HTTP basic authorization: BasicAuth
|
243
|
+
config.username = 'YOUR USERNAME'
|
244
|
+
config.password = 'YOUR PASSWORD'
|
245
|
+
|
246
|
+
# Configure API key authorization: BearerAuth
|
247
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
248
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
249
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
250
|
+
end
|
251
|
+
|
252
|
+
api_instance = Nodeum::StatisticsApi.new
|
253
|
+
opts = {
|
254
|
+
q: 'q_example', # String | Solr query
|
255
|
+
fq: ['fq_example'], # Array<String> | Solr filter query Multiple query can be separated by `|`.
|
256
|
+
date_attr: 'date_attr_example', # String | Type of date to facet on
|
257
|
+
sort: 'count', # String | Sort results of facet
|
258
|
+
limit: 10 # Integer | Limit results of facet
|
259
|
+
}
|
260
|
+
|
261
|
+
begin
|
262
|
+
#Get statistics about files, grouped by primary Cloud
|
263
|
+
result = api_instance.statistics_by_primary_cloud(opts)
|
264
|
+
p result
|
265
|
+
rescue Nodeum::ApiError => e
|
266
|
+
puts "Exception when calling StatisticsApi->statistics_by_primary_cloud: #{e}"
|
267
|
+
end
|
268
|
+
```
|
269
|
+
|
270
|
+
### Parameters
|
271
|
+
|
272
|
+
|
273
|
+
Name | Type | Description | Notes
|
274
|
+
------------- | ------------- | ------------- | -------------
|
275
|
+
**q** | **String**| Solr query | [optional]
|
276
|
+
**fq** | [**Array<String>**](String.md)| Solr filter query Multiple query can be separated by `|`. | [optional]
|
277
|
+
**date_attr** | **String**| Type of date to facet on | [optional]
|
278
|
+
**sort** | **String**| Sort results of facet | [optional] [default to 'count']
|
279
|
+
**limit** | **Integer**| Limit results of facet | [optional] [default to 10]
|
280
|
+
|
281
|
+
### Return type
|
282
|
+
|
283
|
+
[**ByPrimaryCloudFacet**](ByPrimaryCloudFacet.md)
|
284
|
+
|
285
|
+
### Authorization
|
286
|
+
|
287
|
+
[BasicAuth](../README.md#BasicAuth), [BearerAuth](../README.md#BearerAuth)
|
288
|
+
|
289
|
+
### HTTP request headers
|
290
|
+
|
291
|
+
- **Content-Type**: Not defined
|
292
|
+
- **Accept**: application/json
|
293
|
+
|
294
|
+
|
140
295
|
## statistics_by_primary_name
|
141
296
|
|
142
297
|
> ByPrimaryFacet statistics_by_primary_name(opts)
|
143
298
|
|
144
|
-
|
299
|
+
Get statistics about files, grouped by primary storages
|
145
300
|
|
146
301
|
**API Key Scope**: statistics / by_primary_name
|
147
302
|
|
@@ -165,11 +320,14 @@ end
|
|
165
320
|
api_instance = Nodeum::StatisticsApi.new
|
166
321
|
opts = {
|
167
322
|
q: 'q_example', # String | Solr query
|
168
|
-
|
323
|
+
fq: ['fq_example'], # Array<String> | Solr filter query Multiple query can be separated by `|`.
|
324
|
+
date_attr: 'date_attr_example', # String | Type of date to facet on
|
325
|
+
sort: 'count', # String | Sort results of facet
|
326
|
+
limit: 10 # Integer | Limit results of facet
|
169
327
|
}
|
170
328
|
|
171
329
|
begin
|
172
|
-
#
|
330
|
+
#Get statistics about files, grouped by primary storages
|
173
331
|
result = api_instance.statistics_by_primary_name(opts)
|
174
332
|
p result
|
175
333
|
rescue Nodeum::ApiError => e
|
@@ -183,7 +341,10 @@ end
|
|
183
341
|
Name | Type | Description | Notes
|
184
342
|
------------- | ------------- | ------------- | -------------
|
185
343
|
**q** | **String**| Solr query | [optional]
|
344
|
+
**fq** | [**Array<String>**](String.md)| Solr filter query Multiple query can be separated by `|`. | [optional]
|
186
345
|
**date_attr** | **String**| Type of date to facet on | [optional]
|
346
|
+
**sort** | **String**| Sort results of facet | [optional] [default to 'count']
|
347
|
+
**limit** | **Integer**| Limit results of facet | [optional] [default to 10]
|
187
348
|
|
188
349
|
### Return type
|
189
350
|
|
@@ -199,13 +360,13 @@ Name | Type | Description | Notes
|
|
199
360
|
- **Accept**: application/json
|
200
361
|
|
201
362
|
|
202
|
-
##
|
363
|
+
## statistics_by_primary_nas
|
203
364
|
|
204
|
-
>
|
365
|
+
> ByPrimaryNasFacet statistics_by_primary_nas(opts)
|
205
366
|
|
206
|
-
|
367
|
+
Get statistics about files, grouped by primary NAS
|
207
368
|
|
208
|
-
**API Key Scope**: statistics /
|
369
|
+
**API Key Scope**: statistics / by_primary_nas
|
209
370
|
|
210
371
|
### Example
|
211
372
|
|
@@ -227,15 +388,18 @@ end
|
|
227
388
|
api_instance = Nodeum::StatisticsApi.new
|
228
389
|
opts = {
|
229
390
|
q: 'q_example', # String | Solr query
|
230
|
-
|
391
|
+
fq: ['fq_example'], # Array<String> | Solr filter query Multiple query can be separated by `|`.
|
392
|
+
date_attr: 'date_attr_example', # String | Type of date to facet on
|
393
|
+
sort: 'count', # String | Sort results of facet
|
394
|
+
limit: 10 # Integer | Limit results of facet
|
231
395
|
}
|
232
396
|
|
233
397
|
begin
|
234
|
-
#
|
235
|
-
result = api_instance.
|
398
|
+
#Get statistics about files, grouped by primary NAS
|
399
|
+
result = api_instance.statistics_by_primary_nas(opts)
|
236
400
|
p result
|
237
401
|
rescue Nodeum::ApiError => e
|
238
|
-
puts "Exception when calling StatisticsApi->
|
402
|
+
puts "Exception when calling StatisticsApi->statistics_by_primary_nas: #{e}"
|
239
403
|
end
|
240
404
|
```
|
241
405
|
|
@@ -245,11 +409,14 @@ end
|
|
245
409
|
Name | Type | Description | Notes
|
246
410
|
------------- | ------------- | ------------- | -------------
|
247
411
|
**q** | **String**| Solr query | [optional]
|
412
|
+
**fq** | [**Array<String>**](String.md)| Solr filter query Multiple query can be separated by `|`. | [optional]
|
248
413
|
**date_attr** | **String**| Type of date to facet on | [optional]
|
414
|
+
**sort** | **String**| Sort results of facet | [optional] [default to 'count']
|
415
|
+
**limit** | **Integer**| Limit results of facet | [optional] [default to 10]
|
249
416
|
|
250
417
|
### Return type
|
251
418
|
|
252
|
-
[**
|
419
|
+
[**ByPrimaryNasFacet**](ByPrimaryNasFacet.md)
|
253
420
|
|
254
421
|
### Authorization
|
255
422
|
|
@@ -261,13 +428,13 @@ Name | Type | Description | Notes
|
|
261
428
|
- **Accept**: application/json
|
262
429
|
|
263
430
|
|
264
|
-
##
|
431
|
+
## statistics_by_primary_storage
|
265
432
|
|
266
|
-
>
|
433
|
+
> ByPrimaryStorageFacet statistics_by_primary_storage(opts)
|
267
434
|
|
268
|
-
|
435
|
+
Get statistics about files, grouped by primary storage
|
269
436
|
|
270
|
-
**API Key Scope**: statistics /
|
437
|
+
**API Key Scope**: statistics / by_primary_storage
|
271
438
|
|
272
439
|
### Example
|
273
440
|
|
@@ -289,15 +456,18 @@ end
|
|
289
456
|
api_instance = Nodeum::StatisticsApi.new
|
290
457
|
opts = {
|
291
458
|
q: 'q_example', # String | Solr query
|
292
|
-
|
459
|
+
fq: ['fq_example'], # Array<String> | Solr filter query Multiple query can be separated by `|`.
|
460
|
+
date_attr: 'date_attr_example', # String | Type of date to facet on
|
461
|
+
sort: 'count', # String | Sort results of facet
|
462
|
+
limit: 10 # Integer | Limit results of facet
|
293
463
|
}
|
294
464
|
|
295
465
|
begin
|
296
|
-
#
|
297
|
-
result = api_instance.
|
466
|
+
#Get statistics about files, grouped by primary storage
|
467
|
+
result = api_instance.statistics_by_primary_storage(opts)
|
298
468
|
p result
|
299
469
|
rescue Nodeum::ApiError => e
|
300
|
-
puts "Exception when calling StatisticsApi->
|
470
|
+
puts "Exception when calling StatisticsApi->statistics_by_primary_storage: #{e}"
|
301
471
|
end
|
302
472
|
```
|
303
473
|
|
@@ -307,11 +477,14 @@ end
|
|
307
477
|
Name | Type | Description | Notes
|
308
478
|
------------- | ------------- | ------------- | -------------
|
309
479
|
**q** | **String**| Solr query | [optional]
|
480
|
+
**fq** | [**Array<String>**](String.md)| Solr filter query Multiple query can be separated by `|`. | [optional]
|
310
481
|
**date_attr** | **String**| Type of date to facet on | [optional]
|
482
|
+
**sort** | **String**| Sort results of facet | [optional] [default to 'count']
|
483
|
+
**limit** | **Integer**| Limit results of facet | [optional] [default to 10]
|
311
484
|
|
312
485
|
### Return type
|
313
486
|
|
314
|
-
[**
|
487
|
+
[**ByPrimaryStorageFacet**](ByPrimaryStorageFacet.md)
|
315
488
|
|
316
489
|
### Authorization
|
317
490
|
|
@@ -323,13 +496,13 @@ Name | Type | Description | Notes
|
|
323
496
|
- **Accept**: application/json
|
324
497
|
|
325
498
|
|
326
|
-
##
|
499
|
+
## statistics_by_secondary_cloud
|
327
500
|
|
328
|
-
>
|
501
|
+
> BySecondaryCloudFacet statistics_by_secondary_cloud(opts)
|
329
502
|
|
330
|
-
|
503
|
+
Get statistics about files, grouped by secondary Cloud
|
331
504
|
|
332
|
-
**API Key Scope**: statistics /
|
505
|
+
**API Key Scope**: statistics / by_secondary_cloud
|
333
506
|
|
334
507
|
### Example
|
335
508
|
|
@@ -351,15 +524,18 @@ end
|
|
351
524
|
api_instance = Nodeum::StatisticsApi.new
|
352
525
|
opts = {
|
353
526
|
q: 'q_example', # String | Solr query
|
354
|
-
|
527
|
+
fq: ['fq_example'], # Array<String> | Solr filter query Multiple query can be separated by `|`.
|
528
|
+
date_attr: 'date_attr_example', # String | Type of date to facet on
|
529
|
+
sort: 'count', # String | Sort results of facet
|
530
|
+
limit: 10 # Integer | Limit results of facet
|
355
531
|
}
|
356
532
|
|
357
533
|
begin
|
358
|
-
#
|
359
|
-
result = api_instance.
|
534
|
+
#Get statistics about files, grouped by secondary Cloud
|
535
|
+
result = api_instance.statistics_by_secondary_cloud(opts)
|
360
536
|
p result
|
361
537
|
rescue Nodeum::ApiError => e
|
362
|
-
puts "Exception when calling StatisticsApi->
|
538
|
+
puts "Exception when calling StatisticsApi->statistics_by_secondary_cloud: #{e}"
|
363
539
|
end
|
364
540
|
```
|
365
541
|
|
@@ -369,11 +545,598 @@ end
|
|
369
545
|
Name | Type | Description | Notes
|
370
546
|
------------- | ------------- | ------------- | -------------
|
371
547
|
**q** | **String**| Solr query | [optional]
|
548
|
+
**fq** | [**Array<String>**](String.md)| Solr filter query Multiple query can be separated by `|`. | [optional]
|
372
549
|
**date_attr** | **String**| Type of date to facet on | [optional]
|
550
|
+
**sort** | **String**| Sort results of facet | [optional] [default to 'count']
|
551
|
+
**limit** | **Integer**| Limit results of facet | [optional] [default to 10]
|
373
552
|
|
374
553
|
### Return type
|
375
554
|
|
376
|
-
[**
|
555
|
+
[**BySecondaryCloudFacet**](BySecondaryCloudFacet.md)
|
556
|
+
|
557
|
+
### Authorization
|
558
|
+
|
559
|
+
[BasicAuth](../README.md#BasicAuth), [BearerAuth](../README.md#BearerAuth)
|
560
|
+
|
561
|
+
### HTTP request headers
|
562
|
+
|
563
|
+
- **Content-Type**: Not defined
|
564
|
+
- **Accept**: application/json
|
565
|
+
|
566
|
+
|
567
|
+
## statistics_by_secondary_nas
|
568
|
+
|
569
|
+
> BySecondaryNasFacet statistics_by_secondary_nas(opts)
|
570
|
+
|
571
|
+
Get statistics about files, grouped by secondary NAS
|
572
|
+
|
573
|
+
**API Key Scope**: statistics / by_secondary_nas
|
574
|
+
|
575
|
+
### Example
|
576
|
+
|
577
|
+
```ruby
|
578
|
+
# load the gem
|
579
|
+
require 'nodeum_sdk'
|
580
|
+
# setup authorization
|
581
|
+
Nodeum.configure do |config|
|
582
|
+
# Configure HTTP basic authorization: BasicAuth
|
583
|
+
config.username = 'YOUR USERNAME'
|
584
|
+
config.password = 'YOUR PASSWORD'
|
585
|
+
|
586
|
+
# Configure API key authorization: BearerAuth
|
587
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
588
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
589
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
590
|
+
end
|
591
|
+
|
592
|
+
api_instance = Nodeum::StatisticsApi.new
|
593
|
+
opts = {
|
594
|
+
q: 'q_example', # String | Solr query
|
595
|
+
fq: ['fq_example'], # Array<String> | Solr filter query Multiple query can be separated by `|`.
|
596
|
+
date_attr: 'date_attr_example', # String | Type of date to facet on
|
597
|
+
sort: 'count', # String | Sort results of facet
|
598
|
+
limit: 10 # Integer | Limit results of facet
|
599
|
+
}
|
600
|
+
|
601
|
+
begin
|
602
|
+
#Get statistics about files, grouped by secondary NAS
|
603
|
+
result = api_instance.statistics_by_secondary_nas(opts)
|
604
|
+
p result
|
605
|
+
rescue Nodeum::ApiError => e
|
606
|
+
puts "Exception when calling StatisticsApi->statistics_by_secondary_nas: #{e}"
|
607
|
+
end
|
608
|
+
```
|
609
|
+
|
610
|
+
### Parameters
|
611
|
+
|
612
|
+
|
613
|
+
Name | Type | Description | Notes
|
614
|
+
------------- | ------------- | ------------- | -------------
|
615
|
+
**q** | **String**| Solr query | [optional]
|
616
|
+
**fq** | [**Array<String>**](String.md)| Solr filter query Multiple query can be separated by `|`. | [optional]
|
617
|
+
**date_attr** | **String**| Type of date to facet on | [optional]
|
618
|
+
**sort** | **String**| Sort results of facet | [optional] [default to 'count']
|
619
|
+
**limit** | **Integer**| Limit results of facet | [optional] [default to 10]
|
620
|
+
|
621
|
+
### Return type
|
622
|
+
|
623
|
+
[**BySecondaryNasFacet**](BySecondaryNasFacet.md)
|
624
|
+
|
625
|
+
### Authorization
|
626
|
+
|
627
|
+
[BasicAuth](../README.md#BasicAuth), [BearerAuth](../README.md#BearerAuth)
|
628
|
+
|
629
|
+
### HTTP request headers
|
630
|
+
|
631
|
+
- **Content-Type**: Not defined
|
632
|
+
- **Accept**: application/json
|
633
|
+
|
634
|
+
|
635
|
+
## statistics_by_secondary_storage
|
636
|
+
|
637
|
+
> BySecondaryStorageFacet statistics_by_secondary_storage(opts)
|
638
|
+
|
639
|
+
Get statistics about files, grouped by secondary storage
|
640
|
+
|
641
|
+
**API Key Scope**: statistics / by_secondary_storage
|
642
|
+
|
643
|
+
### Example
|
644
|
+
|
645
|
+
```ruby
|
646
|
+
# load the gem
|
647
|
+
require 'nodeum_sdk'
|
648
|
+
# setup authorization
|
649
|
+
Nodeum.configure do |config|
|
650
|
+
# Configure HTTP basic authorization: BasicAuth
|
651
|
+
config.username = 'YOUR USERNAME'
|
652
|
+
config.password = 'YOUR PASSWORD'
|
653
|
+
|
654
|
+
# Configure API key authorization: BearerAuth
|
655
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
656
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
657
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
658
|
+
end
|
659
|
+
|
660
|
+
api_instance = Nodeum::StatisticsApi.new
|
661
|
+
opts = {
|
662
|
+
q: 'q_example', # String | Solr query
|
663
|
+
fq: ['fq_example'], # Array<String> | Solr filter query Multiple query can be separated by `|`.
|
664
|
+
date_attr: 'date_attr_example', # String | Type of date to facet on
|
665
|
+
sort: 'count', # String | Sort results of facet
|
666
|
+
limit: 10 # Integer | Limit results of facet
|
667
|
+
}
|
668
|
+
|
669
|
+
begin
|
670
|
+
#Get statistics about files, grouped by secondary storage
|
671
|
+
result = api_instance.statistics_by_secondary_storage(opts)
|
672
|
+
p result
|
673
|
+
rescue Nodeum::ApiError => e
|
674
|
+
puts "Exception when calling StatisticsApi->statistics_by_secondary_storage: #{e}"
|
675
|
+
end
|
676
|
+
```
|
677
|
+
|
678
|
+
### Parameters
|
679
|
+
|
680
|
+
|
681
|
+
Name | Type | Description | Notes
|
682
|
+
------------- | ------------- | ------------- | -------------
|
683
|
+
**q** | **String**| Solr query | [optional]
|
684
|
+
**fq** | [**Array<String>**](String.md)| Solr filter query Multiple query can be separated by `|`. | [optional]
|
685
|
+
**date_attr** | **String**| Type of date to facet on | [optional]
|
686
|
+
**sort** | **String**| Sort results of facet | [optional] [default to 'count']
|
687
|
+
**limit** | **Integer**| Limit results of facet | [optional] [default to 10]
|
688
|
+
|
689
|
+
### Return type
|
690
|
+
|
691
|
+
[**BySecondaryStorageFacet**](BySecondaryStorageFacet.md)
|
692
|
+
|
693
|
+
### Authorization
|
694
|
+
|
695
|
+
[BasicAuth](../README.md#BasicAuth), [BearerAuth](../README.md#BearerAuth)
|
696
|
+
|
697
|
+
### HTTP request headers
|
698
|
+
|
699
|
+
- **Content-Type**: Not defined
|
700
|
+
- **Accept**: application/json
|
701
|
+
|
702
|
+
|
703
|
+
## statistics_by_secondary_tape
|
704
|
+
|
705
|
+
> BySecondaryTapeFacet statistics_by_secondary_tape(opts)
|
706
|
+
|
707
|
+
Get statistics about files, grouped by secondary Tape
|
708
|
+
|
709
|
+
**API Key Scope**: statistics / by_secondary_tape
|
710
|
+
|
711
|
+
### Example
|
712
|
+
|
713
|
+
```ruby
|
714
|
+
# load the gem
|
715
|
+
require 'nodeum_sdk'
|
716
|
+
# setup authorization
|
717
|
+
Nodeum.configure do |config|
|
718
|
+
# Configure HTTP basic authorization: BasicAuth
|
719
|
+
config.username = 'YOUR USERNAME'
|
720
|
+
config.password = 'YOUR PASSWORD'
|
721
|
+
|
722
|
+
# Configure API key authorization: BearerAuth
|
723
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
724
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
725
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
726
|
+
end
|
727
|
+
|
728
|
+
api_instance = Nodeum::StatisticsApi.new
|
729
|
+
opts = {
|
730
|
+
q: 'q_example', # String | Solr query
|
731
|
+
fq: ['fq_example'], # Array<String> | Solr filter query Multiple query can be separated by `|`.
|
732
|
+
date_attr: 'date_attr_example', # String | Type of date to facet on
|
733
|
+
sort: 'count', # String | Sort results of facet
|
734
|
+
limit: 10 # Integer | Limit results of facet
|
735
|
+
}
|
736
|
+
|
737
|
+
begin
|
738
|
+
#Get statistics about files, grouped by secondary Tape
|
739
|
+
result = api_instance.statistics_by_secondary_tape(opts)
|
740
|
+
p result
|
741
|
+
rescue Nodeum::ApiError => e
|
742
|
+
puts "Exception when calling StatisticsApi->statistics_by_secondary_tape: #{e}"
|
743
|
+
end
|
744
|
+
```
|
745
|
+
|
746
|
+
### Parameters
|
747
|
+
|
748
|
+
|
749
|
+
Name | Type | Description | Notes
|
750
|
+
------------- | ------------- | ------------- | -------------
|
751
|
+
**q** | **String**| Solr query | [optional]
|
752
|
+
**fq** | [**Array<String>**](String.md)| Solr filter query Multiple query can be separated by `|`. | [optional]
|
753
|
+
**date_attr** | **String**| Type of date to facet on | [optional]
|
754
|
+
**sort** | **String**| Sort results of facet | [optional] [default to 'count']
|
755
|
+
**limit** | **Integer**| Limit results of facet | [optional] [default to 10]
|
756
|
+
|
757
|
+
### Return type
|
758
|
+
|
759
|
+
[**BySecondaryTapeFacet**](BySecondaryTapeFacet.md)
|
760
|
+
|
761
|
+
### Authorization
|
762
|
+
|
763
|
+
[BasicAuth](../README.md#BasicAuth), [BearerAuth](../README.md#BearerAuth)
|
764
|
+
|
765
|
+
### HTTP request headers
|
766
|
+
|
767
|
+
- **Content-Type**: Not defined
|
768
|
+
- **Accept**: application/json
|
769
|
+
|
770
|
+
|
771
|
+
## statistics_by_size
|
772
|
+
|
773
|
+
> BySizeFacet statistics_by_size(opts)
|
774
|
+
|
775
|
+
Get statistics about files, grouped by size
|
776
|
+
|
777
|
+
**API Key Scope**: statistics / by_size
|
778
|
+
|
779
|
+
### Example
|
780
|
+
|
781
|
+
```ruby
|
782
|
+
# load the gem
|
783
|
+
require 'nodeum_sdk'
|
784
|
+
# setup authorization
|
785
|
+
Nodeum.configure do |config|
|
786
|
+
# Configure HTTP basic authorization: BasicAuth
|
787
|
+
config.username = 'YOUR USERNAME'
|
788
|
+
config.password = 'YOUR PASSWORD'
|
789
|
+
|
790
|
+
# Configure API key authorization: BearerAuth
|
791
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
792
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
793
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
794
|
+
end
|
795
|
+
|
796
|
+
api_instance = Nodeum::StatisticsApi.new
|
797
|
+
opts = {
|
798
|
+
q: 'q_example', # String | Solr query
|
799
|
+
fq: ['fq_example'], # Array<String> | Solr filter query Multiple query can be separated by `|`.
|
800
|
+
date_attr: 'date_attr_example' # String | Type of date to facet on
|
801
|
+
}
|
802
|
+
|
803
|
+
begin
|
804
|
+
#Get statistics about files, grouped by size
|
805
|
+
result = api_instance.statistics_by_size(opts)
|
806
|
+
p result
|
807
|
+
rescue Nodeum::ApiError => e
|
808
|
+
puts "Exception when calling StatisticsApi->statistics_by_size: #{e}"
|
809
|
+
end
|
810
|
+
```
|
811
|
+
|
812
|
+
### Parameters
|
813
|
+
|
814
|
+
|
815
|
+
Name | Type | Description | Notes
|
816
|
+
------------- | ------------- | ------------- | -------------
|
817
|
+
**q** | **String**| Solr query | [optional]
|
818
|
+
**fq** | [**Array<String>**](String.md)| Solr filter query Multiple query can be separated by `|`. | [optional]
|
819
|
+
**date_attr** | **String**| Type of date to facet on | [optional]
|
820
|
+
|
821
|
+
### Return type
|
822
|
+
|
823
|
+
[**BySizeFacet**](BySizeFacet.md)
|
824
|
+
|
825
|
+
### Authorization
|
826
|
+
|
827
|
+
[BasicAuth](../README.md#BasicAuth), [BearerAuth](../README.md#BearerAuth)
|
828
|
+
|
829
|
+
### HTTP request headers
|
830
|
+
|
831
|
+
- **Content-Type**: Not defined
|
832
|
+
- **Accept**: application/json
|
833
|
+
|
834
|
+
|
835
|
+
## statistics_by_user_owner
|
836
|
+
|
837
|
+
> ByUserOwnerFacet statistics_by_user_owner(opts)
|
838
|
+
|
839
|
+
Get statistics about files, grouped by owner (user)
|
840
|
+
|
841
|
+
**API Key Scope**: statistics / by_user_owner
|
842
|
+
|
843
|
+
### Example
|
844
|
+
|
845
|
+
```ruby
|
846
|
+
# load the gem
|
847
|
+
require 'nodeum_sdk'
|
848
|
+
# setup authorization
|
849
|
+
Nodeum.configure do |config|
|
850
|
+
# Configure HTTP basic authorization: BasicAuth
|
851
|
+
config.username = 'YOUR USERNAME'
|
852
|
+
config.password = 'YOUR PASSWORD'
|
853
|
+
|
854
|
+
# Configure API key authorization: BearerAuth
|
855
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
856
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
857
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
858
|
+
end
|
859
|
+
|
860
|
+
api_instance = Nodeum::StatisticsApi.new
|
861
|
+
opts = {
|
862
|
+
q: 'q_example', # String | Solr query
|
863
|
+
fq: ['fq_example'], # Array<String> | Solr filter query Multiple query can be separated by `|`.
|
864
|
+
date_attr: 'date_attr_example', # String | Type of date to facet on
|
865
|
+
sort: 'count', # String | Sort results of facet
|
866
|
+
limit: 10 # Integer | Limit results of facet
|
867
|
+
}
|
868
|
+
|
869
|
+
begin
|
870
|
+
#Get statistics about files, grouped by owner (user)
|
871
|
+
result = api_instance.statistics_by_user_owner(opts)
|
872
|
+
p result
|
873
|
+
rescue Nodeum::ApiError => e
|
874
|
+
puts "Exception when calling StatisticsApi->statistics_by_user_owner: #{e}"
|
875
|
+
end
|
876
|
+
```
|
877
|
+
|
878
|
+
### Parameters
|
879
|
+
|
880
|
+
|
881
|
+
Name | Type | Description | Notes
|
882
|
+
------------- | ------------- | ------------- | -------------
|
883
|
+
**q** | **String**| Solr query | [optional]
|
884
|
+
**fq** | [**Array<String>**](String.md)| Solr filter query Multiple query can be separated by `|`. | [optional]
|
885
|
+
**date_attr** | **String**| Type of date to facet on | [optional]
|
886
|
+
**sort** | **String**| Sort results of facet | [optional] [default to 'count']
|
887
|
+
**limit** | **Integer**| Limit results of facet | [optional] [default to 10]
|
888
|
+
|
889
|
+
### Return type
|
890
|
+
|
891
|
+
[**ByUserOwnerFacet**](ByUserOwnerFacet.md)
|
892
|
+
|
893
|
+
### Authorization
|
894
|
+
|
895
|
+
[BasicAuth](../README.md#BasicAuth), [BearerAuth](../README.md#BearerAuth)
|
896
|
+
|
897
|
+
### HTTP request headers
|
898
|
+
|
899
|
+
- **Content-Type**: Not defined
|
900
|
+
- **Accept**: application/json
|
901
|
+
|
902
|
+
|
903
|
+
## statistics_storage
|
904
|
+
|
905
|
+
> StorageFacet statistics_storage(opts)
|
906
|
+
|
907
|
+
Get statistics about storages, grouped by types
|
908
|
+
|
909
|
+
**API Key Scope**: statistics / storages
|
910
|
+
|
911
|
+
### Example
|
912
|
+
|
913
|
+
```ruby
|
914
|
+
# load the gem
|
915
|
+
require 'nodeum_sdk'
|
916
|
+
# setup authorization
|
917
|
+
Nodeum.configure do |config|
|
918
|
+
# Configure HTTP basic authorization: BasicAuth
|
919
|
+
config.username = 'YOUR USERNAME'
|
920
|
+
config.password = 'YOUR PASSWORD'
|
921
|
+
|
922
|
+
# Configure API key authorization: BearerAuth
|
923
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
924
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
925
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
926
|
+
end
|
927
|
+
|
928
|
+
api_instance = Nodeum::StatisticsApi.new
|
929
|
+
opts = {
|
930
|
+
q: 'q_example', # String | Solr query
|
931
|
+
fq: ['fq_example'] # Array<String> | Solr filter query Multiple query can be separated by `|`.
|
932
|
+
}
|
933
|
+
|
934
|
+
begin
|
935
|
+
#Get statistics about storages, grouped by types
|
936
|
+
result = api_instance.statistics_storage(opts)
|
937
|
+
p result
|
938
|
+
rescue Nodeum::ApiError => e
|
939
|
+
puts "Exception when calling StatisticsApi->statistics_storage: #{e}"
|
940
|
+
end
|
941
|
+
```
|
942
|
+
|
943
|
+
### Parameters
|
944
|
+
|
945
|
+
|
946
|
+
Name | Type | Description | Notes
|
947
|
+
------------- | ------------- | ------------- | -------------
|
948
|
+
**q** | **String**| Solr query | [optional]
|
949
|
+
**fq** | [**Array<String>**](String.md)| Solr filter query Multiple query can be separated by `|`. | [optional]
|
950
|
+
|
951
|
+
### Return type
|
952
|
+
|
953
|
+
[**StorageFacet**](StorageFacet.md)
|
954
|
+
|
955
|
+
### Authorization
|
956
|
+
|
957
|
+
[BasicAuth](../README.md#BasicAuth), [BearerAuth](../README.md#BearerAuth)
|
958
|
+
|
959
|
+
### HTTP request headers
|
960
|
+
|
961
|
+
- **Content-Type**: Not defined
|
962
|
+
- **Accept**: application/json
|
963
|
+
|
964
|
+
|
965
|
+
## statistics_task_by_status
|
966
|
+
|
967
|
+
> ByTaskStatusFacet statistics_task_by_status(opts)
|
968
|
+
|
969
|
+
Get statistics about tasks executions, grouped by status
|
970
|
+
|
971
|
+
**API Key Scope**: statistics / task_by_status
|
972
|
+
|
973
|
+
### Example
|
974
|
+
|
975
|
+
```ruby
|
976
|
+
# load the gem
|
977
|
+
require 'nodeum_sdk'
|
978
|
+
# setup authorization
|
979
|
+
Nodeum.configure do |config|
|
980
|
+
# Configure HTTP basic authorization: BasicAuth
|
981
|
+
config.username = 'YOUR USERNAME'
|
982
|
+
config.password = 'YOUR PASSWORD'
|
983
|
+
|
984
|
+
# Configure API key authorization: BearerAuth
|
985
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
986
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
987
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
988
|
+
end
|
989
|
+
|
990
|
+
api_instance = Nodeum::StatisticsApi.new
|
991
|
+
opts = {
|
992
|
+
q: 'q_example', # String | Solr query
|
993
|
+
fq: ['fq_example'] # Array<String> | Solr filter query Multiple query can be separated by `|`.
|
994
|
+
}
|
995
|
+
|
996
|
+
begin
|
997
|
+
#Get statistics about tasks executions, grouped by status
|
998
|
+
result = api_instance.statistics_task_by_status(opts)
|
999
|
+
p result
|
1000
|
+
rescue Nodeum::ApiError => e
|
1001
|
+
puts "Exception when calling StatisticsApi->statistics_task_by_status: #{e}"
|
1002
|
+
end
|
1003
|
+
```
|
1004
|
+
|
1005
|
+
### Parameters
|
1006
|
+
|
1007
|
+
|
1008
|
+
Name | Type | Description | Notes
|
1009
|
+
------------- | ------------- | ------------- | -------------
|
1010
|
+
**q** | **String**| Solr query | [optional]
|
1011
|
+
**fq** | [**Array<String>**](String.md)| Solr filter query Multiple query can be separated by `|`. | [optional]
|
1012
|
+
|
1013
|
+
### Return type
|
1014
|
+
|
1015
|
+
[**ByTaskStatusFacet**](ByTaskStatusFacet.md)
|
1016
|
+
|
1017
|
+
### Authorization
|
1018
|
+
|
1019
|
+
[BasicAuth](../README.md#BasicAuth), [BearerAuth](../README.md#BearerAuth)
|
1020
|
+
|
1021
|
+
### HTTP request headers
|
1022
|
+
|
1023
|
+
- **Content-Type**: Not defined
|
1024
|
+
- **Accept**: application/json
|
1025
|
+
|
1026
|
+
|
1027
|
+
## statistics_task_by_storage
|
1028
|
+
|
1029
|
+
> ByTaskStorageFacet statistics_task_by_storage(opts)
|
1030
|
+
|
1031
|
+
Get statistics about tasks executions, grouped by source and destination
|
1032
|
+
|
1033
|
+
**API Key Scope**: statistics / task_by_storage
|
1034
|
+
|
1035
|
+
### Example
|
1036
|
+
|
1037
|
+
```ruby
|
1038
|
+
# load the gem
|
1039
|
+
require 'nodeum_sdk'
|
1040
|
+
# setup authorization
|
1041
|
+
Nodeum.configure do |config|
|
1042
|
+
# Configure HTTP basic authorization: BasicAuth
|
1043
|
+
config.username = 'YOUR USERNAME'
|
1044
|
+
config.password = 'YOUR PASSWORD'
|
1045
|
+
|
1046
|
+
# Configure API key authorization: BearerAuth
|
1047
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
1048
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1049
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
1050
|
+
end
|
1051
|
+
|
1052
|
+
api_instance = Nodeum::StatisticsApi.new
|
1053
|
+
opts = {
|
1054
|
+
q: 'q_example', # String | Solr query
|
1055
|
+
fq: ['fq_example'] # Array<String> | Solr filter query Multiple query can be separated by `|`.
|
1056
|
+
}
|
1057
|
+
|
1058
|
+
begin
|
1059
|
+
#Get statistics about tasks executions, grouped by source and destination
|
1060
|
+
result = api_instance.statistics_task_by_storage(opts)
|
1061
|
+
p result
|
1062
|
+
rescue Nodeum::ApiError => e
|
1063
|
+
puts "Exception when calling StatisticsApi->statistics_task_by_storage: #{e}"
|
1064
|
+
end
|
1065
|
+
```
|
1066
|
+
|
1067
|
+
### Parameters
|
1068
|
+
|
1069
|
+
|
1070
|
+
Name | Type | Description | Notes
|
1071
|
+
------------- | ------------- | ------------- | -------------
|
1072
|
+
**q** | **String**| Solr query | [optional]
|
1073
|
+
**fq** | [**Array<String>**](String.md)| Solr filter query Multiple query can be separated by `|`. | [optional]
|
1074
|
+
|
1075
|
+
### Return type
|
1076
|
+
|
1077
|
+
[**ByTaskStorageFacet**](ByTaskStorageFacet.md)
|
1078
|
+
|
1079
|
+
### Authorization
|
1080
|
+
|
1081
|
+
[BasicAuth](../README.md#BasicAuth), [BearerAuth](../README.md#BearerAuth)
|
1082
|
+
|
1083
|
+
### HTTP request headers
|
1084
|
+
|
1085
|
+
- **Content-Type**: Not defined
|
1086
|
+
- **Accept**: application/json
|
1087
|
+
|
1088
|
+
|
1089
|
+
## statistics_task_by_workflow
|
1090
|
+
|
1091
|
+
> ByTaskWorkflowFacet statistics_task_by_workflow(opts)
|
1092
|
+
|
1093
|
+
Get statistics about tasks executions, grouped by workflow
|
1094
|
+
|
1095
|
+
**API Key Scope**: statistics / task_by_workflow
|
1096
|
+
|
1097
|
+
### Example
|
1098
|
+
|
1099
|
+
```ruby
|
1100
|
+
# load the gem
|
1101
|
+
require 'nodeum_sdk'
|
1102
|
+
# setup authorization
|
1103
|
+
Nodeum.configure do |config|
|
1104
|
+
# Configure HTTP basic authorization: BasicAuth
|
1105
|
+
config.username = 'YOUR USERNAME'
|
1106
|
+
config.password = 'YOUR PASSWORD'
|
1107
|
+
|
1108
|
+
# Configure API key authorization: BearerAuth
|
1109
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
1110
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1111
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
1112
|
+
end
|
1113
|
+
|
1114
|
+
api_instance = Nodeum::StatisticsApi.new
|
1115
|
+
opts = {
|
1116
|
+
q: 'q_example', # String | Solr query
|
1117
|
+
fq: ['fq_example'] # Array<String> | Solr filter query Multiple query can be separated by `|`.
|
1118
|
+
}
|
1119
|
+
|
1120
|
+
begin
|
1121
|
+
#Get statistics about tasks executions, grouped by workflow
|
1122
|
+
result = api_instance.statistics_task_by_workflow(opts)
|
1123
|
+
p result
|
1124
|
+
rescue Nodeum::ApiError => e
|
1125
|
+
puts "Exception when calling StatisticsApi->statistics_task_by_workflow: #{e}"
|
1126
|
+
end
|
1127
|
+
```
|
1128
|
+
|
1129
|
+
### Parameters
|
1130
|
+
|
1131
|
+
|
1132
|
+
Name | Type | Description | Notes
|
1133
|
+
------------- | ------------- | ------------- | -------------
|
1134
|
+
**q** | **String**| Solr query | [optional]
|
1135
|
+
**fq** | [**Array<String>**](String.md)| Solr filter query Multiple query can be separated by `|`. | [optional]
|
1136
|
+
|
1137
|
+
### Return type
|
1138
|
+
|
1139
|
+
[**ByTaskWorkflowFacet**](ByTaskWorkflowFacet.md)
|
377
1140
|
|
378
1141
|
### Authorization
|
379
1142
|
|