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
@@ -0,0 +1,19 @@
|
|
1
|
+
# Nodeum::UserConfigurationCollection
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**configurations** | [**Array<UserConfiguration>**](UserConfiguration.md) | | [optional]
|
8
|
+
**count** | **Integer** | | [optional]
|
9
|
+
|
10
|
+
## Code Sample
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'Nodeum'
|
14
|
+
|
15
|
+
instance = Nodeum::UserConfigurationCollection.new(configurations: null,
|
16
|
+
count: 1)
|
17
|
+
```
|
18
|
+
|
19
|
+
|
data/docs/UsersApi.md
CHANGED
@@ -5,12 +5,17 @@ All URIs are relative to *http://localhost/api/v2*
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
7
|
[**create_api_key**](UsersApi.md#create_api_key) | **POST** /users/me/api_keys | Creates a new API Key for current user.
|
8
|
+
[**create_configuration**](UsersApi.md#create_configuration) | **POST** /users/me/configurations | Creates a new configuration value for current user.
|
8
9
|
[**destroy_api_key**](UsersApi.md#destroy_api_key) | **DELETE** /users/me/api_keys/{api_key_id} | Destroys a specific API Key.
|
10
|
+
[**destroy_configuration**](UsersApi.md#destroy_configuration) | **DELETE** /users/me/configurations/{configuration_id} | Destroys a specific configuration value.
|
9
11
|
[**index_api_keys**](UsersApi.md#index_api_keys) | **GET** /users/me/api_keys | Lists all API keys of current user.
|
12
|
+
[**index_configurations**](UsersApi.md#index_configurations) | **GET** /users/me/configurations | Lists all configurations of current user.
|
10
13
|
[**index_system_groups**](UsersApi.md#index_system_groups) | **GET** /groups/-/systems | List all system groups.
|
11
14
|
[**index_system_users**](UsersApi.md#index_system_users) | **GET** /users/-/systems | List all system users.
|
12
15
|
[**show_api_key**](UsersApi.md#show_api_key) | **GET** /users/me/api_keys/{api_key_id} | Displays a specific API Key with its scopes.
|
16
|
+
[**show_configuration**](UsersApi.md#show_configuration) | **GET** /users/me/configurations/{configuration_id} | Displays a specific configuration value.
|
13
17
|
[**update_api_key**](UsersApi.md#update_api_key) | **PUT** /users/me/api_keys/{api_key_id} | Updates a specific API Key.
|
18
|
+
[**update_configuration**](UsersApi.md#update_configuration) | **PUT** /users/me/configurations/{configuration_id} | Updates a specific configuration value.
|
14
19
|
|
15
20
|
|
16
21
|
|
@@ -72,6 +77,64 @@ Name | Type | Description | Notes
|
|
72
77
|
- **Accept**: application/json
|
73
78
|
|
74
79
|
|
80
|
+
## create_configuration
|
81
|
+
|
82
|
+
> UserConfiguration create_configuration(configuration_body)
|
83
|
+
|
84
|
+
Creates a new configuration value for current user.
|
85
|
+
|
86
|
+
**API Key Scope**: configurations / create
|
87
|
+
|
88
|
+
### Example
|
89
|
+
|
90
|
+
```ruby
|
91
|
+
# load the gem
|
92
|
+
require 'nodeum_sdk'
|
93
|
+
# setup authorization
|
94
|
+
Nodeum.configure do |config|
|
95
|
+
# Configure HTTP basic authorization: BasicAuth
|
96
|
+
config.username = 'YOUR USERNAME'
|
97
|
+
config.password = 'YOUR PASSWORD'
|
98
|
+
|
99
|
+
# Configure API key authorization: BearerAuth
|
100
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
101
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
102
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
103
|
+
end
|
104
|
+
|
105
|
+
api_instance = Nodeum::UsersApi.new
|
106
|
+
configuration_body = Nodeum::UserConfiguration.new # UserConfiguration |
|
107
|
+
|
108
|
+
begin
|
109
|
+
#Creates a new configuration value for current user.
|
110
|
+
result = api_instance.create_configuration(configuration_body)
|
111
|
+
p result
|
112
|
+
rescue Nodeum::ApiError => e
|
113
|
+
puts "Exception when calling UsersApi->create_configuration: #{e}"
|
114
|
+
end
|
115
|
+
```
|
116
|
+
|
117
|
+
### Parameters
|
118
|
+
|
119
|
+
|
120
|
+
Name | Type | Description | Notes
|
121
|
+
------------- | ------------- | ------------- | -------------
|
122
|
+
**configuration_body** | [**UserConfiguration**](UserConfiguration.md)| |
|
123
|
+
|
124
|
+
### Return type
|
125
|
+
|
126
|
+
[**UserConfiguration**](UserConfiguration.md)
|
127
|
+
|
128
|
+
### Authorization
|
129
|
+
|
130
|
+
[BasicAuth](../README.md#BasicAuth), [BearerAuth](../README.md#BearerAuth)
|
131
|
+
|
132
|
+
### HTTP request headers
|
133
|
+
|
134
|
+
- **Content-Type**: application/json
|
135
|
+
- **Accept**: application/json
|
136
|
+
|
137
|
+
|
75
138
|
## destroy_api_key
|
76
139
|
|
77
140
|
> destroy_api_key(api_key_id)
|
@@ -129,6 +192,63 @@ nil (empty response body)
|
|
129
192
|
- **Accept**: Not defined
|
130
193
|
|
131
194
|
|
195
|
+
## destroy_configuration
|
196
|
+
|
197
|
+
> destroy_configuration(configuration_id)
|
198
|
+
|
199
|
+
Destroys a specific configuration value.
|
200
|
+
|
201
|
+
**API Key Scope**: configurations / destroy
|
202
|
+
|
203
|
+
### Example
|
204
|
+
|
205
|
+
```ruby
|
206
|
+
# load the gem
|
207
|
+
require 'nodeum_sdk'
|
208
|
+
# setup authorization
|
209
|
+
Nodeum.configure do |config|
|
210
|
+
# Configure HTTP basic authorization: BasicAuth
|
211
|
+
config.username = 'YOUR USERNAME'
|
212
|
+
config.password = 'YOUR PASSWORD'
|
213
|
+
|
214
|
+
# Configure API key authorization: BearerAuth
|
215
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
216
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
217
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
218
|
+
end
|
219
|
+
|
220
|
+
api_instance = Nodeum::UsersApi.new
|
221
|
+
configuration_id = 'configuration_id_example' # String | Numeric ID, or key of configuration.
|
222
|
+
|
223
|
+
begin
|
224
|
+
#Destroys a specific configuration value.
|
225
|
+
api_instance.destroy_configuration(configuration_id)
|
226
|
+
rescue Nodeum::ApiError => e
|
227
|
+
puts "Exception when calling UsersApi->destroy_configuration: #{e}"
|
228
|
+
end
|
229
|
+
```
|
230
|
+
|
231
|
+
### Parameters
|
232
|
+
|
233
|
+
|
234
|
+
Name | Type | Description | Notes
|
235
|
+
------------- | ------------- | ------------- | -------------
|
236
|
+
**configuration_id** | **String**| Numeric ID, or key of configuration. |
|
237
|
+
|
238
|
+
### Return type
|
239
|
+
|
240
|
+
nil (empty response body)
|
241
|
+
|
242
|
+
### Authorization
|
243
|
+
|
244
|
+
[BasicAuth](../README.md#BasicAuth), [BearerAuth](../README.md#BearerAuth)
|
245
|
+
|
246
|
+
### HTTP request headers
|
247
|
+
|
248
|
+
- **Content-Type**: Not defined
|
249
|
+
- **Accept**: Not defined
|
250
|
+
|
251
|
+
|
132
252
|
## index_api_keys
|
133
253
|
|
134
254
|
> ApiKeyCollection index_api_keys(opts)
|
@@ -191,6 +311,68 @@ Name | Type | Description | Notes
|
|
191
311
|
- **Accept**: application/json
|
192
312
|
|
193
313
|
|
314
|
+
## index_configurations
|
315
|
+
|
316
|
+
> UserConfigurationCollection index_configurations(opts)
|
317
|
+
|
318
|
+
Lists all configurations of current user.
|
319
|
+
|
320
|
+
**API Key Scope**: configurations / index
|
321
|
+
|
322
|
+
### Example
|
323
|
+
|
324
|
+
```ruby
|
325
|
+
# load the gem
|
326
|
+
require 'nodeum_sdk'
|
327
|
+
# setup authorization
|
328
|
+
Nodeum.configure do |config|
|
329
|
+
# Configure HTTP basic authorization: BasicAuth
|
330
|
+
config.username = 'YOUR USERNAME'
|
331
|
+
config.password = 'YOUR PASSWORD'
|
332
|
+
|
333
|
+
# Configure API key authorization: BearerAuth
|
334
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
335
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
336
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
337
|
+
end
|
338
|
+
|
339
|
+
api_instance = Nodeum::UsersApi.new
|
340
|
+
opts = {
|
341
|
+
limit: 56, # Integer | The number of items to display for pagination.
|
342
|
+
offset: 56 # Integer | The number of items to skip for pagination.
|
343
|
+
}
|
344
|
+
|
345
|
+
begin
|
346
|
+
#Lists all configurations of current user.
|
347
|
+
result = api_instance.index_configurations(opts)
|
348
|
+
p result
|
349
|
+
rescue Nodeum::ApiError => e
|
350
|
+
puts "Exception when calling UsersApi->index_configurations: #{e}"
|
351
|
+
end
|
352
|
+
```
|
353
|
+
|
354
|
+
### Parameters
|
355
|
+
|
356
|
+
|
357
|
+
Name | Type | Description | Notes
|
358
|
+
------------- | ------------- | ------------- | -------------
|
359
|
+
**limit** | **Integer**| The number of items to display for pagination. | [optional]
|
360
|
+
**offset** | **Integer**| The number of items to skip for pagination. | [optional]
|
361
|
+
|
362
|
+
### Return type
|
363
|
+
|
364
|
+
[**UserConfigurationCollection**](UserConfigurationCollection.md)
|
365
|
+
|
366
|
+
### Authorization
|
367
|
+
|
368
|
+
[BasicAuth](../README.md#BasicAuth), [BearerAuth](../README.md#BearerAuth)
|
369
|
+
|
370
|
+
### HTTP request headers
|
371
|
+
|
372
|
+
- **Content-Type**: Not defined
|
373
|
+
- **Accept**: application/json
|
374
|
+
|
375
|
+
|
194
376
|
## index_system_groups
|
195
377
|
|
196
378
|
> SystemGroupCollection index_system_groups
|
@@ -357,6 +539,64 @@ Name | Type | Description | Notes
|
|
357
539
|
- **Accept**: application/json
|
358
540
|
|
359
541
|
|
542
|
+
## show_configuration
|
543
|
+
|
544
|
+
> UserConfiguration show_configuration(configuration_id)
|
545
|
+
|
546
|
+
Displays a specific configuration value.
|
547
|
+
|
548
|
+
**API Key Scope**: configurations / show
|
549
|
+
|
550
|
+
### Example
|
551
|
+
|
552
|
+
```ruby
|
553
|
+
# load the gem
|
554
|
+
require 'nodeum_sdk'
|
555
|
+
# setup authorization
|
556
|
+
Nodeum.configure do |config|
|
557
|
+
# Configure HTTP basic authorization: BasicAuth
|
558
|
+
config.username = 'YOUR USERNAME'
|
559
|
+
config.password = 'YOUR PASSWORD'
|
560
|
+
|
561
|
+
# Configure API key authorization: BearerAuth
|
562
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
563
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
564
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
565
|
+
end
|
566
|
+
|
567
|
+
api_instance = Nodeum::UsersApi.new
|
568
|
+
configuration_id = 'configuration_id_example' # String | Numeric ID, or key of configuration.
|
569
|
+
|
570
|
+
begin
|
571
|
+
#Displays a specific configuration value.
|
572
|
+
result = api_instance.show_configuration(configuration_id)
|
573
|
+
p result
|
574
|
+
rescue Nodeum::ApiError => e
|
575
|
+
puts "Exception when calling UsersApi->show_configuration: #{e}"
|
576
|
+
end
|
577
|
+
```
|
578
|
+
|
579
|
+
### Parameters
|
580
|
+
|
581
|
+
|
582
|
+
Name | Type | Description | Notes
|
583
|
+
------------- | ------------- | ------------- | -------------
|
584
|
+
**configuration_id** | **String**| Numeric ID, or key of configuration. |
|
585
|
+
|
586
|
+
### Return type
|
587
|
+
|
588
|
+
[**UserConfiguration**](UserConfiguration.md)
|
589
|
+
|
590
|
+
### Authorization
|
591
|
+
|
592
|
+
[BasicAuth](../README.md#BasicAuth), [BearerAuth](../README.md#BearerAuth)
|
593
|
+
|
594
|
+
### HTTP request headers
|
595
|
+
|
596
|
+
- **Content-Type**: Not defined
|
597
|
+
- **Accept**: application/json
|
598
|
+
|
599
|
+
|
360
600
|
## update_api_key
|
361
601
|
|
362
602
|
> ApiKeyFull update_api_key(api_key_id, api_key_body)
|
@@ -416,3 +656,63 @@ Name | Type | Description | Notes
|
|
416
656
|
- **Content-Type**: application/json
|
417
657
|
- **Accept**: application/json
|
418
658
|
|
659
|
+
|
660
|
+
## update_configuration
|
661
|
+
|
662
|
+
> UserConfiguration update_configuration(configuration_id, configuration_body)
|
663
|
+
|
664
|
+
Updates a specific configuration value.
|
665
|
+
|
666
|
+
**API Key Scope**: configurations / update
|
667
|
+
|
668
|
+
### Example
|
669
|
+
|
670
|
+
```ruby
|
671
|
+
# load the gem
|
672
|
+
require 'nodeum_sdk'
|
673
|
+
# setup authorization
|
674
|
+
Nodeum.configure do |config|
|
675
|
+
# Configure HTTP basic authorization: BasicAuth
|
676
|
+
config.username = 'YOUR USERNAME'
|
677
|
+
config.password = 'YOUR PASSWORD'
|
678
|
+
|
679
|
+
# Configure API key authorization: BearerAuth
|
680
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
681
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
682
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
683
|
+
end
|
684
|
+
|
685
|
+
api_instance = Nodeum::UsersApi.new
|
686
|
+
configuration_id = 'configuration_id_example' # String | Numeric ID, or key of configuration.
|
687
|
+
configuration_body = Nodeum::UserConfiguration.new # UserConfiguration |
|
688
|
+
|
689
|
+
begin
|
690
|
+
#Updates a specific configuration value.
|
691
|
+
result = api_instance.update_configuration(configuration_id, configuration_body)
|
692
|
+
p result
|
693
|
+
rescue Nodeum::ApiError => e
|
694
|
+
puts "Exception when calling UsersApi->update_configuration: #{e}"
|
695
|
+
end
|
696
|
+
```
|
697
|
+
|
698
|
+
### Parameters
|
699
|
+
|
700
|
+
|
701
|
+
Name | Type | Description | Notes
|
702
|
+
------------- | ------------- | ------------- | -------------
|
703
|
+
**configuration_id** | **String**| Numeric ID, or key of configuration. |
|
704
|
+
**configuration_body** | [**UserConfiguration**](UserConfiguration.md)| |
|
705
|
+
|
706
|
+
### Return type
|
707
|
+
|
708
|
+
[**UserConfiguration**](UserConfiguration.md)
|
709
|
+
|
710
|
+
### Authorization
|
711
|
+
|
712
|
+
[BasicAuth](../README.md#BasicAuth), [BearerAuth](../README.md#BearerAuth)
|
713
|
+
|
714
|
+
### HTTP request headers
|
715
|
+
|
716
|
+
- **Content-Type**: application/json
|
717
|
+
- **Accept**: application/json
|
718
|
+
|
data/lib/nodeum_sdk.rb
CHANGED
@@ -33,15 +33,32 @@ require 'nodeum_sdk/models/by_file_extension_facet'
|
|
33
33
|
require 'nodeum_sdk/models/by_file_extension_facet_all_of'
|
34
34
|
require 'nodeum_sdk/models/by_group_owner_facet'
|
35
35
|
require 'nodeum_sdk/models/by_group_owner_facet_all_of'
|
36
|
+
require 'nodeum_sdk/models/by_primary_cloud_facet'
|
37
|
+
require 'nodeum_sdk/models/by_primary_cloud_facet_all_of'
|
36
38
|
require 'nodeum_sdk/models/by_primary_facet'
|
37
39
|
require 'nodeum_sdk/models/by_primary_facet_all_of'
|
38
|
-
require 'nodeum_sdk/models/
|
39
|
-
require 'nodeum_sdk/models/
|
40
|
-
require 'nodeum_sdk/models/
|
41
|
-
require 'nodeum_sdk/models/
|
40
|
+
require 'nodeum_sdk/models/by_primary_nas_facet'
|
41
|
+
require 'nodeum_sdk/models/by_primary_nas_facet_all_of'
|
42
|
+
require 'nodeum_sdk/models/by_primary_storage_facet'
|
43
|
+
require 'nodeum_sdk/models/by_primary_type_facet'
|
44
|
+
require 'nodeum_sdk/models/by_secondary_cloud_facet'
|
45
|
+
require 'nodeum_sdk/models/by_secondary_cloud_facet_all_of'
|
46
|
+
require 'nodeum_sdk/models/by_secondary_nas_facet'
|
47
|
+
require 'nodeum_sdk/models/by_secondary_nas_facet_all_of'
|
48
|
+
require 'nodeum_sdk/models/by_secondary_storage_facet'
|
49
|
+
require 'nodeum_sdk/models/by_secondary_tape_facet'
|
50
|
+
require 'nodeum_sdk/models/by_secondary_tape_facet_all_of'
|
42
51
|
require 'nodeum_sdk/models/by_secondary_type_facet'
|
43
52
|
require 'nodeum_sdk/models/by_secondary_type_facet_all_of'
|
44
53
|
require 'nodeum_sdk/models/by_size_facet'
|
54
|
+
require 'nodeum_sdk/models/by_task_status_facet'
|
55
|
+
require 'nodeum_sdk/models/by_task_status_facet_all_of'
|
56
|
+
require 'nodeum_sdk/models/by_task_storage_facet'
|
57
|
+
require 'nodeum_sdk/models/by_task_storage_facet_all_of'
|
58
|
+
require 'nodeum_sdk/models/by_task_workflow_facet'
|
59
|
+
require 'nodeum_sdk/models/by_task_workflow_facet_all_of'
|
60
|
+
require 'nodeum_sdk/models/by_type_facet_bucket'
|
61
|
+
require 'nodeum_sdk/models/by_type_facet_buckets'
|
45
62
|
require 'nodeum_sdk/models/by_user_owner_facet'
|
46
63
|
require 'nodeum_sdk/models/by_user_owner_facet_all_of'
|
47
64
|
require 'nodeum_sdk/models/cloud_bucket'
|
@@ -54,8 +71,10 @@ require 'nodeum_sdk/models/container_collection'
|
|
54
71
|
require 'nodeum_sdk/models/container_privilege'
|
55
72
|
require 'nodeum_sdk/models/container_privilege_collection'
|
56
73
|
require 'nodeum_sdk/models/date_to_file_facets'
|
74
|
+
require 'nodeum_sdk/models/default_facet'
|
57
75
|
require 'nodeum_sdk/models/error'
|
58
76
|
require 'nodeum_sdk/models/file_facet'
|
77
|
+
require 'nodeum_sdk/models/file_facet_all_of'
|
59
78
|
require 'nodeum_sdk/models/frozen'
|
60
79
|
require 'nodeum_sdk/models/greater_than'
|
61
80
|
require 'nodeum_sdk/models/greater_than_all_of'
|
@@ -93,6 +112,16 @@ require 'nodeum_sdk/models/quota_on_cache'
|
|
93
112
|
require 'nodeum_sdk/models/reset'
|
94
113
|
require 'nodeum_sdk/models/reset_sections'
|
95
114
|
require 'nodeum_sdk/models/size_to_date_facets'
|
115
|
+
require 'nodeum_sdk/models/storage_by_type_facets'
|
116
|
+
require 'nodeum_sdk/models/storage_cloud_bucket_by_type_facets'
|
117
|
+
require 'nodeum_sdk/models/storage_cloud_bucket_facets'
|
118
|
+
require 'nodeum_sdk/models/storage_facet'
|
119
|
+
require 'nodeum_sdk/models/storage_nas_share_by_type_facets'
|
120
|
+
require 'nodeum_sdk/models/storage_nas_share_facets'
|
121
|
+
require 'nodeum_sdk/models/storage_pool_by_type_facets'
|
122
|
+
require 'nodeum_sdk/models/storage_pool_facets'
|
123
|
+
require 'nodeum_sdk/models/storage_tape_by_type_facets'
|
124
|
+
require 'nodeum_sdk/models/storage_tape_facets'
|
96
125
|
require 'nodeum_sdk/models/system_group'
|
97
126
|
require 'nodeum_sdk/models/system_group_collection'
|
98
127
|
require 'nodeum_sdk/models/system_user'
|
@@ -114,6 +143,9 @@ require 'nodeum_sdk/models/tape_library_device_collection'
|
|
114
143
|
require 'nodeum_sdk/models/tape_stat'
|
115
144
|
require 'nodeum_sdk/models/tape_stat_collection'
|
116
145
|
require 'nodeum_sdk/models/task'
|
146
|
+
require 'nodeum_sdk/models/task_by_workflow_bucket'
|
147
|
+
require 'nodeum_sdk/models/task_by_workflow_bucket_all_of'
|
148
|
+
require 'nodeum_sdk/models/task_by_workflow_buckets'
|
117
149
|
require 'nodeum_sdk/models/task_callback'
|
118
150
|
require 'nodeum_sdk/models/task_callback_collection'
|
119
151
|
require 'nodeum_sdk/models/task_collection'
|
@@ -122,6 +154,10 @@ require 'nodeum_sdk/models/task_destination_down'
|
|
122
154
|
require 'nodeum_sdk/models/task_destination_up'
|
123
155
|
require 'nodeum_sdk/models/task_execution'
|
124
156
|
require 'nodeum_sdk/models/task_execution_collection'
|
157
|
+
require 'nodeum_sdk/models/task_facet'
|
158
|
+
require 'nodeum_sdk/models/task_facet_all_of'
|
159
|
+
require 'nodeum_sdk/models/task_facet_bucket'
|
160
|
+
require 'nodeum_sdk/models/task_facet_buckets'
|
125
161
|
require 'nodeum_sdk/models/task_metadatum'
|
126
162
|
require 'nodeum_sdk/models/task_metadatum_collection'
|
127
163
|
require 'nodeum_sdk/models/task_option'
|
@@ -135,7 +171,10 @@ require 'nodeum_sdk/models/too_long'
|
|
135
171
|
require 'nodeum_sdk/models/too_long_all_of'
|
136
172
|
require 'nodeum_sdk/models/too_short'
|
137
173
|
require 'nodeum_sdk/models/too_short_all_of'
|
174
|
+
require 'nodeum_sdk/models/type_to_primary_facets'
|
138
175
|
require 'nodeum_sdk/models/type_to_secondary_facets'
|
176
|
+
require 'nodeum_sdk/models/user_configuration'
|
177
|
+
require 'nodeum_sdk/models/user_configuration_collection'
|
139
178
|
|
140
179
|
# APIs
|
141
180
|
require 'nodeum_sdk/api/cloud_buckets_api'
|