nodeum_sdk 1.85.1

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.
Files changed (439) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +9 -0
  3. data/LICENSE +21 -0
  4. data/README.md +472 -0
  5. data/Rakefile +10 -0
  6. data/docs/ActiveJobStatus.md +23 -0
  7. data/docs/ApiKey.md +21 -0
  8. data/docs/ApiKeyCollection.md +19 -0
  9. data/docs/ApiKeyFull.md +17 -0
  10. data/docs/ApiKeyFullAllOf.md +17 -0
  11. data/docs/ApiKeyScope.md +19 -0
  12. data/docs/AttributeError.md +17 -0
  13. data/docs/Blank.md +16 -0
  14. data/docs/ByDateFacet.md +35 -0
  15. data/docs/ByDateFacetBucket.md +17 -0
  16. data/docs/ByDateFacetBucketAllOf.md +17 -0
  17. data/docs/ByDateFacetBuckets.md +17 -0
  18. data/docs/ByFileExtensionFacet.md +17 -0
  19. data/docs/ByFileExtensionFacetAllOf.md +17 -0
  20. data/docs/ByGroupOwnerFacet.md +17 -0
  21. data/docs/ByGroupOwnerFacetAllOf.md +17 -0
  22. data/docs/ByPrimaryFacet.md +17 -0
  23. data/docs/ByPrimaryFacetAllOf.md +17 -0
  24. data/docs/BySecondaryBucket.md +17 -0
  25. data/docs/BySecondaryBucketAllOf.md +17 -0
  26. data/docs/BySecondaryBuckets.md +17 -0
  27. data/docs/BySecondaryFacet.md +29 -0
  28. data/docs/BySecondaryTypeFacet.md +17 -0
  29. data/docs/BySecondaryTypeFacetAllOf.md +17 -0
  30. data/docs/BySizeFacet.md +35 -0
  31. data/docs/ByUserOwnerFacet.md +17 -0
  32. data/docs/ByUserOwnerFacetAllOf.md +17 -0
  33. data/docs/CloudBucket.md +31 -0
  34. data/docs/CloudBucketCollection.md +19 -0
  35. data/docs/CloudBucketSimpleCollection.md +17 -0
  36. data/docs/CloudBucketsApi.md +908 -0
  37. data/docs/CloudConnector.md +31 -0
  38. data/docs/CloudConnectorCollection.md +19 -0
  39. data/docs/CloudConnectorsApi.md +442 -0
  40. data/docs/Container.md +35 -0
  41. data/docs/ContainerCollection.md +19 -0
  42. data/docs/ContainerPrivilege.md +23 -0
  43. data/docs/ContainerPrivilegeCollection.md +19 -0
  44. data/docs/ContainersApi.md +650 -0
  45. data/docs/DateToFileFacets.md +31 -0
  46. data/docs/Error.md +19 -0
  47. data/docs/FileFacet.md +19 -0
  48. data/docs/FilesApi.md +2090 -0
  49. data/docs/Frozen.md +16 -0
  50. data/docs/GreaterThan.md +19 -0
  51. data/docs/GreaterThanAllOf.md +19 -0
  52. data/docs/GreaterThanOrEqualTo.md +19 -0
  53. data/docs/ImportFile.md +39 -0
  54. data/docs/ImportFileCollection.md +19 -0
  55. data/docs/ImportFileWithPath.md +41 -0
  56. data/docs/Invalid.md +17 -0
  57. data/docs/LessThan.md +19 -0
  58. data/docs/LessThanAllOf.md +19 -0
  59. data/docs/LessThanOrEqualTo.md +19 -0
  60. data/docs/MountCollection.md +17 -0
  61. data/docs/MountInfo.md +57 -0
  62. data/docs/MountNotification.md +19 -0
  63. data/docs/MountStatus.md +21 -0
  64. data/docs/MountsApi.md +63 -0
  65. data/docs/Nas.md +27 -0
  66. data/docs/NasApi.md +322 -0
  67. data/docs/NasCollection.md +19 -0
  68. data/docs/NasShare.md +35 -0
  69. data/docs/NasShareCollection.md +19 -0
  70. data/docs/NasSharesApi.md +1155 -0
  71. data/docs/NodeumFile.md +39 -0
  72. data/docs/NodeumFileCollection.md +19 -0
  73. data/docs/NodeumFileWithPath.md +17 -0
  74. data/docs/NodeumFileWithPathAllOf.md +17 -0
  75. data/docs/OccurrenceLessThan.md +19 -0
  76. data/docs/OccurrenceLessThanAllOf.md +19 -0
  77. data/docs/OccurrenceLessThanOrEqualTo.md +19 -0
  78. data/docs/OnTapesFile.md +25 -0
  79. data/docs/OnTapesFileCollection.md +19 -0
  80. data/docs/Pool.md +27 -0
  81. data/docs/PoolCollection.md +19 -0
  82. data/docs/PoolUp.md +21 -0
  83. data/docs/PoolUpAllOf.md +21 -0
  84. data/docs/PoolsApi.md +798 -0
  85. data/docs/PrimaryScan.md +25 -0
  86. data/docs/QuotaOnCache.md +16 -0
  87. data/docs/Reset.md +17 -0
  88. data/docs/ResetSections.md +21 -0
  89. data/docs/SizeToDateFacets.md +31 -0
  90. data/docs/StatisticsApi.md +386 -0
  91. data/docs/SystemGroup.md +21 -0
  92. data/docs/SystemGroupCollection.md +19 -0
  93. data/docs/SystemUser.md +23 -0
  94. data/docs/SystemUserCollection.md +19 -0
  95. data/docs/SystemsApi.md +183 -0
  96. data/docs/Taken.md +17 -0
  97. data/docs/TakenAllOf.md +17 -0
  98. data/docs/Tape.md +65 -0
  99. data/docs/TapeCollection.md +19 -0
  100. data/docs/TapeDrive.md +55 -0
  101. data/docs/TapeDriveAllOf.md +55 -0
  102. data/docs/TapeDriveCollection.md +19 -0
  103. data/docs/TapeDriveDevice.md +29 -0
  104. data/docs/TapeDriveDeviceCollection.md +17 -0
  105. data/docs/TapeDrivesApi.md +730 -0
  106. data/docs/TapeLibrariesApi.md +403 -0
  107. data/docs/TapeLibrary.md +27 -0
  108. data/docs/TapeLibraryAllOf.md +27 -0
  109. data/docs/TapeLibraryCollection.md +19 -0
  110. data/docs/TapeLibraryDevice.md +37 -0
  111. data/docs/TapeLibraryDeviceCollection.md +17 -0
  112. data/docs/TapeStat.md +115 -0
  113. data/docs/TapeStatCollection.md +19 -0
  114. data/docs/TapesApi.md +959 -0
  115. data/docs/Task.md +55 -0
  116. data/docs/TaskCallback.md +21 -0
  117. data/docs/TaskCallbackCollection.md +19 -0
  118. data/docs/TaskCallbacksApi.md +326 -0
  119. data/docs/TaskCollection.md +19 -0
  120. data/docs/TaskDestinationCollection.md +19 -0
  121. data/docs/TaskDestinationDown.md +25 -0
  122. data/docs/TaskDestinationUp.md +27 -0
  123. data/docs/TaskDestinationsApi.md +328 -0
  124. data/docs/TaskExecution.md +51 -0
  125. data/docs/TaskExecutionCollection.md +19 -0
  126. data/docs/TaskExecutionsApi.md +336 -0
  127. data/docs/TaskMetadataApi.md +326 -0
  128. data/docs/TaskMetadatum.md +21 -0
  129. data/docs/TaskMetadatumCollection.md +19 -0
  130. data/docs/TaskOption.md +21 -0
  131. data/docs/TaskOptionCollection.md +19 -0
  132. data/docs/TaskOptionsApi.md +326 -0
  133. data/docs/TaskSchedule.md +34 -0
  134. data/docs/TaskScheduleCollection.md +19 -0
  135. data/docs/TaskSchedulesApi.md +322 -0
  136. data/docs/TaskSourceCollection.md +19 -0
  137. data/docs/TaskSourceDown.md +29 -0
  138. data/docs/TaskSourceUp.md +33 -0
  139. data/docs/TaskSourcesApi.md +330 -0
  140. data/docs/TasksApi.md +846 -0
  141. data/docs/TooLong.md +17 -0
  142. data/docs/TooLongAllOf.md +17 -0
  143. data/docs/TooShort.md +17 -0
  144. data/docs/TooShortAllOf.md +17 -0
  145. data/docs/TypeToSecondaryFacets.md +25 -0
  146. data/docs/UsersApi.md +418 -0
  147. data/git_push.sh +58 -0
  148. data/lib/nodeum_sdk.rb +180 -0
  149. data/lib/nodeum_sdk/api/cloud_buckets_api.rb +1026 -0
  150. data/lib/nodeum_sdk/api/cloud_connectors_api.rb +491 -0
  151. data/lib/nodeum_sdk/api/containers_api.rb +736 -0
  152. data/lib/nodeum_sdk/api/files_api.rb +2418 -0
  153. data/lib/nodeum_sdk/api/mounts_api.rb +78 -0
  154. data/lib/nodeum_sdk/api/nas_api.rb +361 -0
  155. data/lib/nodeum_sdk/api/nas_shares_api.rb +1305 -0
  156. data/lib/nodeum_sdk/api/pools_api.rb +876 -0
  157. data/lib/nodeum_sdk/api/statistics_api.rb +418 -0
  158. data/lib/nodeum_sdk/api/systems_api.rb +215 -0
  159. data/lib/nodeum_sdk/api/tape_drives_api.rb +858 -0
  160. data/lib/nodeum_sdk/api/tape_libraries_api.rb +457 -0
  161. data/lib/nodeum_sdk/api/tapes_api.rb +1104 -0
  162. data/lib/nodeum_sdk/api/task_callbacks_api.rb +382 -0
  163. data/lib/nodeum_sdk/api/task_destinations_api.rb +385 -0
  164. data/lib/nodeum_sdk/api/task_executions_api.rb +399 -0
  165. data/lib/nodeum_sdk/api/task_metadata_api.rb +382 -0
  166. data/lib/nodeum_sdk/api/task_options_api.rb +382 -0
  167. data/lib/nodeum_sdk/api/task_schedules_api.rb +364 -0
  168. data/lib/nodeum_sdk/api/task_sources_api.rb +388 -0
  169. data/lib/nodeum_sdk/api/tasks_api.rb +951 -0
  170. data/lib/nodeum_sdk/api/users_api.rb +452 -0
  171. data/lib/nodeum_sdk/api_client.rb +386 -0
  172. data/lib/nodeum_sdk/api_error.rb +57 -0
  173. data/lib/nodeum_sdk/configuration.rb +255 -0
  174. data/lib/nodeum_sdk/models/active_job_status.rb +267 -0
  175. data/lib/nodeum_sdk/models/api_key.rb +224 -0
  176. data/lib/nodeum_sdk/models/api_key_collection.rb +217 -0
  177. data/lib/nodeum_sdk/models/api_key_full.rb +220 -0
  178. data/lib/nodeum_sdk/models/api_key_full_all_of.rb +208 -0
  179. data/lib/nodeum_sdk/models/api_key_scope.rb +215 -0
  180. data/lib/nodeum_sdk/models/attribute_error.rb +216 -0
  181. data/lib/nodeum_sdk/models/blank.rb +209 -0
  182. data/lib/nodeum_sdk/models/by_date_facet.rb +295 -0
  183. data/lib/nodeum_sdk/models/by_date_facet_bucket.rb +218 -0
  184. data/lib/nodeum_sdk/models/by_date_facet_bucket_all_of.rb +206 -0
  185. data/lib/nodeum_sdk/models/by_date_facet_buckets.rb +208 -0
  186. data/lib/nodeum_sdk/models/by_file_extension_facet.rb +218 -0
  187. data/lib/nodeum_sdk/models/by_file_extension_facet_all_of.rb +206 -0
  188. data/lib/nodeum_sdk/models/by_group_owner_facet.rb +218 -0
  189. data/lib/nodeum_sdk/models/by_group_owner_facet_all_of.rb +206 -0
  190. data/lib/nodeum_sdk/models/by_primary_facet.rb +218 -0
  191. data/lib/nodeum_sdk/models/by_primary_facet_all_of.rb +206 -0
  192. data/lib/nodeum_sdk/models/by_secondary_bucket.rb +218 -0
  193. data/lib/nodeum_sdk/models/by_secondary_bucket_all_of.rb +206 -0
  194. data/lib/nodeum_sdk/models/by_secondary_buckets.rb +208 -0
  195. data/lib/nodeum_sdk/models/by_secondary_facet.rb +268 -0
  196. data/lib/nodeum_sdk/models/by_secondary_type_facet.rb +218 -0
  197. data/lib/nodeum_sdk/models/by_secondary_type_facet_all_of.rb +206 -0
  198. data/lib/nodeum_sdk/models/by_size_facet.rb +295 -0
  199. data/lib/nodeum_sdk/models/by_user_owner_facet.rb +218 -0
  200. data/lib/nodeum_sdk/models/by_user_owner_facet_all_of.rb +206 -0
  201. data/lib/nodeum_sdk/models/cloud_bucket.rb +269 -0
  202. data/lib/nodeum_sdk/models/cloud_bucket_collection.rb +217 -0
  203. data/lib/nodeum_sdk/models/cloud_bucket_simple_collection.rb +208 -0
  204. data/lib/nodeum_sdk/models/cloud_connector.rb +303 -0
  205. data/lib/nodeum_sdk/models/cloud_connector_collection.rb +217 -0
  206. data/lib/nodeum_sdk/models/container.rb +321 -0
  207. data/lib/nodeum_sdk/models/container_collection.rb +217 -0
  208. data/lib/nodeum_sdk/models/container_privilege.rb +279 -0
  209. data/lib/nodeum_sdk/models/container_privilege_collection.rb +217 -0
  210. data/lib/nodeum_sdk/models/date_to_file_facets.rb +269 -0
  211. data/lib/nodeum_sdk/models/error.rb +221 -0
  212. data/lib/nodeum_sdk/models/file_facet.rb +215 -0
  213. data/lib/nodeum_sdk/models/frozen.rb +209 -0
  214. data/lib/nodeum_sdk/models/greater_than.rb +230 -0
  215. data/lib/nodeum_sdk/models/greater_than_all_of.rb +217 -0
  216. data/lib/nodeum_sdk/models/greater_than_or_equal_to.rb +230 -0
  217. data/lib/nodeum_sdk/models/import_file.rb +339 -0
  218. data/lib/nodeum_sdk/models/import_file_collection.rb +217 -0
  219. data/lib/nodeum_sdk/models/import_file_with_path.rb +356 -0
  220. data/lib/nodeum_sdk/models/invalid.rb +220 -0
  221. data/lib/nodeum_sdk/models/less_than.rb +230 -0
  222. data/lib/nodeum_sdk/models/less_than_all_of.rb +217 -0
  223. data/lib/nodeum_sdk/models/less_than_or_equal_to.rb +230 -0
  224. data/lib/nodeum_sdk/models/mount_collection.rb +208 -0
  225. data/lib/nodeum_sdk/models/mount_info.rb +420 -0
  226. data/lib/nodeum_sdk/models/mount_notification.rb +249 -0
  227. data/lib/nodeum_sdk/models/mount_status.rb +224 -0
  228. data/lib/nodeum_sdk/models/nas.rb +285 -0
  229. data/lib/nodeum_sdk/models/nas_collection.rb +217 -0
  230. data/lib/nodeum_sdk/models/nas_share.rb +287 -0
  231. data/lib/nodeum_sdk/models/nas_share_collection.rb +217 -0
  232. data/lib/nodeum_sdk/models/nodeum_file.rb +339 -0
  233. data/lib/nodeum_sdk/models/nodeum_file_collection.rb +217 -0
  234. data/lib/nodeum_sdk/models/nodeum_file_with_path.rb +240 -0
  235. data/lib/nodeum_sdk/models/nodeum_file_with_path_all_of.rb +206 -0
  236. data/lib/nodeum_sdk/models/occurrence_less_than.rb +230 -0
  237. data/lib/nodeum_sdk/models/occurrence_less_than_all_of.rb +217 -0
  238. data/lib/nodeum_sdk/models/occurrence_less_than_or_equal_to.rb +230 -0
  239. data/lib/nodeum_sdk/models/on_tapes_file.rb +278 -0
  240. data/lib/nodeum_sdk/models/on_tapes_file_collection.rb +217 -0
  241. data/lib/nodeum_sdk/models/pool.rb +297 -0
  242. data/lib/nodeum_sdk/models/pool_collection.rb +217 -0
  243. data/lib/nodeum_sdk/models/pool_up.rb +264 -0
  244. data/lib/nodeum_sdk/models/pool_up_all_of.rb +230 -0
  245. data/lib/nodeum_sdk/models/primary_scan.rb +276 -0
  246. data/lib/nodeum_sdk/models/quota_on_cache.rb +209 -0
  247. data/lib/nodeum_sdk/models/reset.rb +209 -0
  248. data/lib/nodeum_sdk/models/reset_sections.rb +265 -0
  249. data/lib/nodeum_sdk/models/size_to_date_facets.rb +269 -0
  250. data/lib/nodeum_sdk/models/system_group.rb +226 -0
  251. data/lib/nodeum_sdk/models/system_group_collection.rb +217 -0
  252. data/lib/nodeum_sdk/models/system_user.rb +233 -0
  253. data/lib/nodeum_sdk/models/system_user_collection.rb +217 -0
  254. data/lib/nodeum_sdk/models/taken.rb +220 -0
  255. data/lib/nodeum_sdk/models/taken_all_of.rb +207 -0
  256. data/lib/nodeum_sdk/models/tape.rb +456 -0
  257. data/lib/nodeum_sdk/models/tape_collection.rb +217 -0
  258. data/lib/nodeum_sdk/models/tape_drive.rb +423 -0
  259. data/lib/nodeum_sdk/models/tape_drive_all_of.rb +411 -0
  260. data/lib/nodeum_sdk/models/tape_drive_collection.rb +217 -0
  261. data/lib/nodeum_sdk/models/tape_drive_device.rb +261 -0
  262. data/lib/nodeum_sdk/models/tape_drive_device_collection.rb +208 -0
  263. data/lib/nodeum_sdk/models/tape_library.rb +297 -0
  264. data/lib/nodeum_sdk/models/tape_library_all_of.rb +285 -0
  265. data/lib/nodeum_sdk/models/tape_library_collection.rb +217 -0
  266. data/lib/nodeum_sdk/models/tape_library_device.rb +330 -0
  267. data/lib/nodeum_sdk/models/tape_library_device_collection.rb +208 -0
  268. data/lib/nodeum_sdk/models/tape_stat.rb +647 -0
  269. data/lib/nodeum_sdk/models/tape_stat_collection.rb +217 -0
  270. data/lib/nodeum_sdk/models/task.rb +483 -0
  271. data/lib/nodeum_sdk/models/task_callback.rb +258 -0
  272. data/lib/nodeum_sdk/models/task_callback_collection.rb +217 -0
  273. data/lib/nodeum_sdk/models/task_collection.rb +217 -0
  274. data/lib/nodeum_sdk/models/task_destination_collection.rb +217 -0
  275. data/lib/nodeum_sdk/models/task_destination_down.rb +242 -0
  276. data/lib/nodeum_sdk/models/task_destination_up.rb +251 -0
  277. data/lib/nodeum_sdk/models/task_execution.rb +441 -0
  278. data/lib/nodeum_sdk/models/task_execution_collection.rb +217 -0
  279. data/lib/nodeum_sdk/models/task_metadatum.rb +224 -0
  280. data/lib/nodeum_sdk/models/task_metadatum_collection.rb +217 -0
  281. data/lib/nodeum_sdk/models/task_option.rb +258 -0
  282. data/lib/nodeum_sdk/models/task_option_collection.rb +217 -0
  283. data/lib/nodeum_sdk/models/task_schedule.rb +278 -0
  284. data/lib/nodeum_sdk/models/task_schedule_collection.rb +217 -0
  285. data/lib/nodeum_sdk/models/task_source_collection.rb +217 -0
  286. data/lib/nodeum_sdk/models/task_source_down.rb +262 -0
  287. data/lib/nodeum_sdk/models/task_source_up.rb +280 -0
  288. data/lib/nodeum_sdk/models/too_long.rb +220 -0
  289. data/lib/nodeum_sdk/models/too_long_all_of.rb +207 -0
  290. data/lib/nodeum_sdk/models/too_short.rb +220 -0
  291. data/lib/nodeum_sdk/models/too_short_all_of.rb +207 -0
  292. data/lib/nodeum_sdk/models/type_to_secondary_facets.rb +242 -0
  293. data/lib/nodeum_sdk/version.rb +15 -0
  294. data/nodeum_sdk.gemspec +39 -0
  295. data/spec/api/cloud_buckets_api_spec.rb +237 -0
  296. data/spec/api/cloud_connectors_api_spec.rb +129 -0
  297. data/spec/api/containers_api_spec.rb +180 -0
  298. data/spec/api/files_api_spec.rb +570 -0
  299. data/spec/api/mounts_api_spec.rb +46 -0
  300. data/spec/api/nas_api_spec.rb +104 -0
  301. data/spec/api/nas_shares_api_spec.rb +292 -0
  302. data/spec/api/pools_api_spec.rb +203 -0
  303. data/spec/api/statistics_api_spec.rb +113 -0
  304. data/spec/api/systems_api_spec.rb +70 -0
  305. data/spec/api/tape_drives_api_spec.rb +220 -0
  306. data/spec/api/tape_libraries_api_spec.rb +127 -0
  307. data/spec/api/tapes_api_spec.rb +279 -0
  308. data/spec/api/task_callbacks_api_spec.rb +106 -0
  309. data/spec/api/task_destinations_api_spec.rb +107 -0
  310. data/spec/api/task_executions_api_spec.rb +127 -0
  311. data/spec/api/task_metadata_api_spec.rb +106 -0
  312. data/spec/api/task_options_api_spec.rb +106 -0
  313. data/spec/api/task_schedules_api_spec.rb +104 -0
  314. data/spec/api/task_sources_api_spec.rb +108 -0
  315. data/spec/api/tasks_api_spec.rb +226 -0
  316. data/spec/api/users_api_spec.rb +119 -0
  317. data/spec/api_client_spec.rb +226 -0
  318. data/spec/configuration_spec.rb +42 -0
  319. data/spec/models/active_job_status_spec.rb +63 -0
  320. data/spec/models/api_key_collection_spec.rb +47 -0
  321. data/spec/models/api_key_full_all_of_spec.rb +41 -0
  322. data/spec/models/api_key_full_spec.rb +41 -0
  323. data/spec/models/api_key_scope_spec.rb +47 -0
  324. data/spec/models/api_key_spec.rb +53 -0
  325. data/spec/models/attribute_error_spec.rb +41 -0
  326. data/spec/models/blank_spec.rb +35 -0
  327. data/spec/models/by_date_facet_bucket_all_of_spec.rb +41 -0
  328. data/spec/models/by_date_facet_bucket_spec.rb +41 -0
  329. data/spec/models/by_date_facet_buckets_spec.rb +41 -0
  330. data/spec/models/by_date_facet_spec.rb +95 -0
  331. data/spec/models/by_file_extension_facet_all_of_spec.rb +41 -0
  332. data/spec/models/by_file_extension_facet_spec.rb +41 -0
  333. data/spec/models/by_group_owner_facet_all_of_spec.rb +41 -0
  334. data/spec/models/by_group_owner_facet_spec.rb +41 -0
  335. data/spec/models/by_primary_facet_all_of_spec.rb +41 -0
  336. data/spec/models/by_primary_facet_spec.rb +41 -0
  337. data/spec/models/by_secondary_bucket_all_of_spec.rb +41 -0
  338. data/spec/models/by_secondary_bucket_spec.rb +41 -0
  339. data/spec/models/by_secondary_buckets_spec.rb +41 -0
  340. data/spec/models/by_secondary_facet_spec.rb +77 -0
  341. data/spec/models/by_secondary_type_facet_all_of_spec.rb +41 -0
  342. data/spec/models/by_secondary_type_facet_spec.rb +41 -0
  343. data/spec/models/by_size_facet_spec.rb +95 -0
  344. data/spec/models/by_user_owner_facet_all_of_spec.rb +41 -0
  345. data/spec/models/by_user_owner_facet_spec.rb +41 -0
  346. data/spec/models/cloud_bucket_collection_spec.rb +47 -0
  347. data/spec/models/cloud_bucket_simple_collection_spec.rb +41 -0
  348. data/spec/models/cloud_bucket_spec.rb +83 -0
  349. data/spec/models/cloud_connector_collection_spec.rb +47 -0
  350. data/spec/models/cloud_connector_spec.rb +87 -0
  351. data/spec/models/container_collection_spec.rb +47 -0
  352. data/spec/models/container_privilege_collection_spec.rb +47 -0
  353. data/spec/models/container_privilege_spec.rb +67 -0
  354. data/spec/models/container_spec.rb +99 -0
  355. data/spec/models/date_to_file_facets_spec.rb +83 -0
  356. data/spec/models/error_spec.rb +47 -0
  357. data/spec/models/file_facet_spec.rb +47 -0
  358. data/spec/models/frozen_spec.rb +35 -0
  359. data/spec/models/greater_than_all_of_spec.rb +47 -0
  360. data/spec/models/greater_than_or_equal_to_spec.rb +47 -0
  361. data/spec/models/greater_than_spec.rb +47 -0
  362. data/spec/models/import_file_collection_spec.rb +47 -0
  363. data/spec/models/import_file_spec.rb +111 -0
  364. data/spec/models/import_file_with_path_spec.rb +117 -0
  365. data/spec/models/invalid_spec.rb +41 -0
  366. data/spec/models/less_than_all_of_spec.rb +47 -0
  367. data/spec/models/less_than_or_equal_to_spec.rb +47 -0
  368. data/spec/models/less_than_spec.rb +47 -0
  369. data/spec/models/mount_collection_spec.rb +41 -0
  370. data/spec/models/mount_info_spec.rb +165 -0
  371. data/spec/models/mount_notification_spec.rb +51 -0
  372. data/spec/models/mount_status_spec.rb +53 -0
  373. data/spec/models/nas_collection_spec.rb +47 -0
  374. data/spec/models/nas_share_collection_spec.rb +47 -0
  375. data/spec/models/nas_share_spec.rb +95 -0
  376. data/spec/models/nas_spec.rb +75 -0
  377. data/spec/models/nodeum_file_collection_spec.rb +47 -0
  378. data/spec/models/nodeum_file_spec.rb +111 -0
  379. data/spec/models/nodeum_file_with_path_all_of_spec.rb +41 -0
  380. data/spec/models/nodeum_file_with_path_spec.rb +41 -0
  381. data/spec/models/occurrence_less_than_all_of_spec.rb +47 -0
  382. data/spec/models/occurrence_less_than_or_equal_to_spec.rb +47 -0
  383. data/spec/models/occurrence_less_than_spec.rb +47 -0
  384. data/spec/models/on_tapes_file_collection_spec.rb +47 -0
  385. data/spec/models/on_tapes_file_spec.rb +69 -0
  386. data/spec/models/pool_collection_spec.rb +47 -0
  387. data/spec/models/pool_spec.rb +79 -0
  388. data/spec/models/pool_up_all_of_spec.rb +53 -0
  389. data/spec/models/pool_up_spec.rb +53 -0
  390. data/spec/models/primary_scan_spec.rb +69 -0
  391. data/spec/models/quota_on_cache_spec.rb +35 -0
  392. data/spec/models/reset_sections_spec.rb +57 -0
  393. data/spec/models/reset_spec.rb +41 -0
  394. data/spec/models/size_to_date_facets_spec.rb +83 -0
  395. data/spec/models/system_group_collection_spec.rb +47 -0
  396. data/spec/models/system_group_spec.rb +53 -0
  397. data/spec/models/system_user_collection_spec.rb +47 -0
  398. data/spec/models/system_user_spec.rb +59 -0
  399. data/spec/models/taken_all_of_spec.rb +41 -0
  400. data/spec/models/taken_spec.rb +41 -0
  401. data/spec/models/tape_collection_spec.rb +47 -0
  402. data/spec/models/tape_drive_all_of_spec.rb +159 -0
  403. data/spec/models/tape_drive_collection_spec.rb +47 -0
  404. data/spec/models/tape_drive_device_collection_spec.rb +41 -0
  405. data/spec/models/tape_drive_device_spec.rb +77 -0
  406. data/spec/models/tape_drive_spec.rb +159 -0
  407. data/spec/models/tape_library_all_of_spec.rb +75 -0
  408. data/spec/models/tape_library_collection_spec.rb +47 -0
  409. data/spec/models/tape_library_device_collection_spec.rb +41 -0
  410. data/spec/models/tape_library_device_spec.rb +105 -0
  411. data/spec/models/tape_library_spec.rb +75 -0
  412. data/spec/models/tape_spec.rb +189 -0
  413. data/spec/models/tape_stat_collection_spec.rb +47 -0
  414. data/spec/models/tape_stat_spec.rb +335 -0
  415. data/spec/models/task_callback_collection_spec.rb +47 -0
  416. data/spec/models/task_callback_spec.rb +57 -0
  417. data/spec/models/task_collection_spec.rb +47 -0
  418. data/spec/models/task_destination_collection_spec.rb +47 -0
  419. data/spec/models/task_destination_down_spec.rb +65 -0
  420. data/spec/models/task_destination_up_spec.rb +71 -0
  421. data/spec/models/task_execution_collection_spec.rb +47 -0
  422. data/spec/models/task_execution_spec.rb +163 -0
  423. data/spec/models/task_metadatum_collection_spec.rb +47 -0
  424. data/spec/models/task_metadatum_spec.rb +53 -0
  425. data/spec/models/task_option_collection_spec.rb +47 -0
  426. data/spec/models/task_option_spec.rb +57 -0
  427. data/spec/models/task_schedule_collection_spec.rb +47 -0
  428. data/spec/models/task_schedule_spec.rb +89 -0
  429. data/spec/models/task_source_collection_spec.rb +47 -0
  430. data/spec/models/task_source_down_spec.rb +77 -0
  431. data/spec/models/task_source_up_spec.rb +89 -0
  432. data/spec/models/task_spec.rb +183 -0
  433. data/spec/models/too_long_all_of_spec.rb +41 -0
  434. data/spec/models/too_long_spec.rb +41 -0
  435. data/spec/models/too_short_all_of_spec.rb +41 -0
  436. data/spec/models/too_short_spec.rb +41 -0
  437. data/spec/models/type_to_secondary_facets_spec.rb +65 -0
  438. data/spec/spec_helper.rb +111 -0
  439. metadata +718 -0
@@ -0,0 +1,35 @@
1
+ # Nodeum::Container
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **id** | **Integer** | | [optional] [readonly]
8
+ **name** | **String** | | [optional]
9
+ **comment** | **String** | | [optional]
10
+ **quota_total_size** | **Integer** | | [optional]
11
+ **quota_on_cache** | **Integer** | | [optional]
12
+ **stat_total_files** | **Integer** | | [optional] [readonly]
13
+ **stat_total_size** | **Integer** | | [optional] [readonly]
14
+ **stat_size_on_cache** | **Integer** | | [optional] [readonly]
15
+ **guest_right** | **String** | | [optional]
16
+ **last_update** | **String** | | [optional] [readonly]
17
+
18
+ ## Code Sample
19
+
20
+ ```ruby
21
+ require 'Nodeum'
22
+
23
+ instance = Nodeum::Container.new(id: 100,
24
+ name: my-container,
25
+ comment: Read only container for random stuff,
26
+ quota_total_size: null,
27
+ quota_on_cache: null,
28
+ stat_total_files: 99301,
29
+ stat_total_size: 6145076462,
30
+ stat_size_on_cache: 6899417088,
31
+ guest_right: read,
32
+ last_update: 2019-08-05T14:24:15.000Z)
33
+ ```
34
+
35
+
@@ -0,0 +1,19 @@
1
+ # Nodeum::ContainerCollection
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **count** | **Integer** | | [optional] [readonly]
8
+ **containers** | [**Array<Container>**](Container.md) | | [optional] [readonly]
9
+
10
+ ## Code Sample
11
+
12
+ ```ruby
13
+ require 'Nodeum'
14
+
15
+ instance = Nodeum::ContainerCollection.new(count: 1,
16
+ containers: null)
17
+ ```
18
+
19
+
@@ -0,0 +1,23 @@
1
+ # Nodeum::ContainerPrivilege
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **id** | **Integer** | | [optional] [readonly]
8
+ **name** | **String** | | [optional]
9
+ **privilege** | **String** | | [optional]
10
+ **type** | **String** | | [optional]
11
+
12
+ ## Code Sample
13
+
14
+ ```ruby
15
+ require 'Nodeum'
16
+
17
+ instance = Nodeum::ContainerPrivilege.new(id: 1,
18
+ name: admin,
19
+ privilege: read_write,
20
+ type: user)
21
+ ```
22
+
23
+
@@ -0,0 +1,19 @@
1
+ # Nodeum::ContainerPrivilegeCollection
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **count** | **Integer** | | [optional] [readonly]
8
+ **container_privileges** | [**Array<ContainerPrivilege>**](ContainerPrivilege.md) | | [optional] [readonly]
9
+
10
+ ## Code Sample
11
+
12
+ ```ruby
13
+ require 'Nodeum'
14
+
15
+ instance = Nodeum::ContainerPrivilegeCollection.new(count: 1,
16
+ container_privileges: null)
17
+ ```
18
+
19
+
@@ -0,0 +1,650 @@
1
+ # Nodeum::ContainersApi
2
+
3
+ All URIs are relative to *http://localhost/api/v2*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**create_container**](ContainersApi.md#create_container) | **POST** /containers | Creates a new container.
8
+ [**create_container_privilege**](ContainersApi.md#create_container_privilege) | **POST** /containers/{container_id}/container_privileges | Creates a new privilege on the container.
9
+ [**destroy_container**](ContainersApi.md#destroy_container) | **DELETE** /containers/{container_id} | Destroys a specific container.
10
+ [**destroy_container_privilege**](ContainersApi.md#destroy_container_privilege) | **DELETE** /containers/{container_id}/container_privileges/{container_privilege_id} | Destroys a specific privilege.
11
+ [**index_container_privileges**](ContainersApi.md#index_container_privileges) | **GET** /containers/{container_id}/container_privileges | Lists all privilege on the container.
12
+ [**index_containers**](ContainersApi.md#index_containers) | **GET** /containers | Lists all containers.
13
+ [**show_container**](ContainersApi.md#show_container) | **GET** /containers/{container_id} | Displays a specific container.
14
+ [**show_container_privilege**](ContainersApi.md#show_container_privilege) | **GET** /containers/{container_id}/container_privileges/{container_privilege_id} | Displays a specific privilege.
15
+ [**update_container**](ContainersApi.md#update_container) | **PUT** /containers/{container_id} | Updates a specific container.
16
+ [**update_container_privilege**](ContainersApi.md#update_container_privilege) | **PUT** /containers/{container_id}/container_privileges/{container_privilege_id} | Updates a specific privilege.
17
+
18
+
19
+
20
+ ## create_container
21
+
22
+ > Container create_container(container_body)
23
+
24
+ Creates a new container.
25
+
26
+ It **does not** yet create the file structure and configure the samba connection. Use API v1 instead. **API Key Scope**: containers / create
27
+
28
+ ### Example
29
+
30
+ ```ruby
31
+ # load the gem
32
+ require 'nodeum_sdk'
33
+ # setup authorization
34
+ Nodeum.configure do |config|
35
+ # Configure HTTP basic authorization: BasicAuth
36
+ config.username = 'YOUR USERNAME'
37
+ config.password = 'YOUR PASSWORD'
38
+
39
+ # Configure API key authorization: BearerAuth
40
+ config.api_key['Authorization'] = 'YOUR API KEY'
41
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
42
+ #config.api_key_prefix['Authorization'] = 'Bearer'
43
+ end
44
+
45
+ api_instance = Nodeum::ContainersApi.new
46
+ container_body = Nodeum::Container.new # Container |
47
+
48
+ begin
49
+ #Creates a new container.
50
+ result = api_instance.create_container(container_body)
51
+ p result
52
+ rescue Nodeum::ApiError => e
53
+ puts "Exception when calling ContainersApi->create_container: #{e}"
54
+ end
55
+ ```
56
+
57
+ ### Parameters
58
+
59
+
60
+ Name | Type | Description | Notes
61
+ ------------- | ------------- | ------------- | -------------
62
+ **container_body** | [**Container**](Container.md)| |
63
+
64
+ ### Return type
65
+
66
+ [**Container**](Container.md)
67
+
68
+ ### Authorization
69
+
70
+ [BasicAuth](../README.md#BasicAuth), [BearerAuth](../README.md#BearerAuth)
71
+
72
+ ### HTTP request headers
73
+
74
+ - **Content-Type**: application/json
75
+ - **Accept**: application/json
76
+
77
+
78
+ ## create_container_privilege
79
+
80
+ > ContainerPrivilege create_container_privilege(container_id, container_privilege_body)
81
+
82
+ Creates a new privilege on the container.
83
+
84
+ **API Key Scope**: container_privileges / create
85
+
86
+ ### Example
87
+
88
+ ```ruby
89
+ # load the gem
90
+ require 'nodeum_sdk'
91
+ # setup authorization
92
+ Nodeum.configure do |config|
93
+ # Configure HTTP basic authorization: BasicAuth
94
+ config.username = 'YOUR USERNAME'
95
+ config.password = 'YOUR PASSWORD'
96
+
97
+ # Configure API key authorization: BearerAuth
98
+ config.api_key['Authorization'] = 'YOUR API KEY'
99
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
100
+ #config.api_key_prefix['Authorization'] = 'Bearer'
101
+ end
102
+
103
+ api_instance = Nodeum::ContainersApi.new
104
+ container_id = 'container_id_example' # String | Numeric ID or name of container.
105
+ container_privilege_body = Nodeum::ContainerPrivilege.new # ContainerPrivilege |
106
+
107
+ begin
108
+ #Creates a new privilege on the container.
109
+ result = api_instance.create_container_privilege(container_id, container_privilege_body)
110
+ p result
111
+ rescue Nodeum::ApiError => e
112
+ puts "Exception when calling ContainersApi->create_container_privilege: #{e}"
113
+ end
114
+ ```
115
+
116
+ ### Parameters
117
+
118
+
119
+ Name | Type | Description | Notes
120
+ ------------- | ------------- | ------------- | -------------
121
+ **container_id** | **String**| Numeric ID or name of container. |
122
+ **container_privilege_body** | [**ContainerPrivilege**](ContainerPrivilege.md)| |
123
+
124
+ ### Return type
125
+
126
+ [**ContainerPrivilege**](ContainerPrivilege.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
+
138
+ ## destroy_container
139
+
140
+ > destroy_container(container_id)
141
+
142
+ Destroys a specific container.
143
+
144
+ **API Key Scope**: containers / destroy
145
+
146
+ ### Example
147
+
148
+ ```ruby
149
+ # load the gem
150
+ require 'nodeum_sdk'
151
+ # setup authorization
152
+ Nodeum.configure do |config|
153
+ # Configure HTTP basic authorization: BasicAuth
154
+ config.username = 'YOUR USERNAME'
155
+ config.password = 'YOUR PASSWORD'
156
+
157
+ # Configure API key authorization: BearerAuth
158
+ config.api_key['Authorization'] = 'YOUR API KEY'
159
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
160
+ #config.api_key_prefix['Authorization'] = 'Bearer'
161
+ end
162
+
163
+ api_instance = Nodeum::ContainersApi.new
164
+ container_id = 'container_id_example' # String | Numeric ID or name of container.
165
+
166
+ begin
167
+ #Destroys a specific container.
168
+ api_instance.destroy_container(container_id)
169
+ rescue Nodeum::ApiError => e
170
+ puts "Exception when calling ContainersApi->destroy_container: #{e}"
171
+ end
172
+ ```
173
+
174
+ ### Parameters
175
+
176
+
177
+ Name | Type | Description | Notes
178
+ ------------- | ------------- | ------------- | -------------
179
+ **container_id** | **String**| Numeric ID or name of container. |
180
+
181
+ ### Return type
182
+
183
+ nil (empty response body)
184
+
185
+ ### Authorization
186
+
187
+ [BasicAuth](../README.md#BasicAuth), [BearerAuth](../README.md#BearerAuth)
188
+
189
+ ### HTTP request headers
190
+
191
+ - **Content-Type**: Not defined
192
+ - **Accept**: Not defined
193
+
194
+
195
+ ## destroy_container_privilege
196
+
197
+ > destroy_container_privilege(container_id, container_privilege_id)
198
+
199
+ Destroys a specific privilege.
200
+
201
+ **API Key Scope**: container_privileges / 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::ContainersApi.new
221
+ container_id = 'container_id_example' # String | Numeric ID or name of container.
222
+ container_privilege_id = 56 # Integer | Numeric ID of container privilege.
223
+
224
+ begin
225
+ #Destroys a specific privilege.
226
+ api_instance.destroy_container_privilege(container_id, container_privilege_id)
227
+ rescue Nodeum::ApiError => e
228
+ puts "Exception when calling ContainersApi->destroy_container_privilege: #{e}"
229
+ end
230
+ ```
231
+
232
+ ### Parameters
233
+
234
+
235
+ Name | Type | Description | Notes
236
+ ------------- | ------------- | ------------- | -------------
237
+ **container_id** | **String**| Numeric ID or name of container. |
238
+ **container_privilege_id** | **Integer**| Numeric ID of container privilege. |
239
+
240
+ ### Return type
241
+
242
+ nil (empty response body)
243
+
244
+ ### Authorization
245
+
246
+ [BasicAuth](../README.md#BasicAuth), [BearerAuth](../README.md#BearerAuth)
247
+
248
+ ### HTTP request headers
249
+
250
+ - **Content-Type**: Not defined
251
+ - **Accept**: Not defined
252
+
253
+
254
+ ## index_container_privileges
255
+
256
+ > ContainerPrivilegeCollection index_container_privileges(container_id, opts)
257
+
258
+ Lists all privilege on the container.
259
+
260
+ **API Key Scope**: container_privileges / index
261
+
262
+ ### Example
263
+
264
+ ```ruby
265
+ # load the gem
266
+ require 'nodeum_sdk'
267
+ # setup authorization
268
+ Nodeum.configure do |config|
269
+ # Configure HTTP basic authorization: BasicAuth
270
+ config.username = 'YOUR USERNAME'
271
+ config.password = 'YOUR PASSWORD'
272
+
273
+ # Configure API key authorization: BearerAuth
274
+ config.api_key['Authorization'] = 'YOUR API KEY'
275
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
276
+ #config.api_key_prefix['Authorization'] = 'Bearer'
277
+ end
278
+
279
+ api_instance = Nodeum::ContainersApi.new
280
+ container_id = 'container_id_example' # String | Numeric ID or name of container.
281
+ opts = {
282
+ limit: 56, # Integer | The number of items to display for pagination.
283
+ offset: 56, # Integer | The number of items to skip for pagination.
284
+ sort_by: ['sort_by_example'], # Array<String> | Sort results by attribute. Can sort on multiple attributes, separated by `|`. Order direction can be suffixing the attribute by either `:asc` (default) or `:desc`.
285
+ id: 'id_example', # String | Filter on id
286
+ name: 'name_example', # String | Filter on name
287
+ privilege: 'privilege_example', # String | Filter on privilege
288
+ type: 'type_example' # String | Filter on type
289
+ }
290
+
291
+ begin
292
+ #Lists all privilege on the container.
293
+ result = api_instance.index_container_privileges(container_id, opts)
294
+ p result
295
+ rescue Nodeum::ApiError => e
296
+ puts "Exception when calling ContainersApi->index_container_privileges: #{e}"
297
+ end
298
+ ```
299
+
300
+ ### Parameters
301
+
302
+
303
+ Name | Type | Description | Notes
304
+ ------------- | ------------- | ------------- | -------------
305
+ **container_id** | **String**| Numeric ID or name of container. |
306
+ **limit** | **Integer**| The number of items to display for pagination. | [optional]
307
+ **offset** | **Integer**| The number of items to skip for pagination. | [optional]
308
+ **sort_by** | [**Array&lt;String&gt;**](String.md)| Sort results by attribute. Can sort on multiple attributes, separated by &#x60;|&#x60;. Order direction can be suffixing the attribute by either &#x60;:asc&#x60; (default) or &#x60;:desc&#x60;. | [optional]
309
+ **id** | **String**| Filter on id | [optional]
310
+ **name** | **String**| Filter on name | [optional]
311
+ **privilege** | **String**| Filter on privilege | [optional]
312
+ **type** | **String**| Filter on type | [optional]
313
+
314
+ ### Return type
315
+
316
+ [**ContainerPrivilegeCollection**](ContainerPrivilegeCollection.md)
317
+
318
+ ### Authorization
319
+
320
+ [BasicAuth](../README.md#BasicAuth), [BearerAuth](../README.md#BearerAuth)
321
+
322
+ ### HTTP request headers
323
+
324
+ - **Content-Type**: Not defined
325
+ - **Accept**: application/json
326
+
327
+
328
+ ## index_containers
329
+
330
+ > ContainerCollection index_containers(opts)
331
+
332
+ Lists all containers.
333
+
334
+ **API Key Scope**: containers / index
335
+
336
+ ### Example
337
+
338
+ ```ruby
339
+ # load the gem
340
+ require 'nodeum_sdk'
341
+ # setup authorization
342
+ Nodeum.configure do |config|
343
+ # Configure HTTP basic authorization: BasicAuth
344
+ config.username = 'YOUR USERNAME'
345
+ config.password = 'YOUR PASSWORD'
346
+
347
+ # Configure API key authorization: BearerAuth
348
+ config.api_key['Authorization'] = 'YOUR API KEY'
349
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
350
+ #config.api_key_prefix['Authorization'] = 'Bearer'
351
+ end
352
+
353
+ api_instance = Nodeum::ContainersApi.new
354
+ opts = {
355
+ limit: 56, # Integer | The number of items to display for pagination.
356
+ offset: 56, # Integer | The number of items to skip for pagination.
357
+ sort_by: ['sort_by_example'], # Array<String> | Sort results by attribute. Can sort on multiple attributes, separated by `|`. Order direction can be suffixing the attribute by either `:asc` (default) or `:desc`.
358
+ id: 'id_example', # String | Filter on id
359
+ name: 'name_example', # String | Filter on name
360
+ comment: 'comment_example', # String | Filter on comment
361
+ quota_total_size: 'quota_total_size_example', # String | Filter on quota total size
362
+ quota_on_cache: 'quota_on_cache_example', # String | Filter on quota on cache
363
+ stat_total_files: 'stat_total_files_example', # String | Filter on stat total files
364
+ stat_total_size: 'stat_total_size_example', # String | Filter on stat total size
365
+ stat_size_on_cache: 'stat_size_on_cache_example', # String | Filter on stat size on cache
366
+ guest_right: 'guest_right_example', # String | Filter on guest right
367
+ last_update: 'last_update_example' # String | Filter on last update
368
+ }
369
+
370
+ begin
371
+ #Lists all containers.
372
+ result = api_instance.index_containers(opts)
373
+ p result
374
+ rescue Nodeum::ApiError => e
375
+ puts "Exception when calling ContainersApi->index_containers: #{e}"
376
+ end
377
+ ```
378
+
379
+ ### Parameters
380
+
381
+
382
+ Name | Type | Description | Notes
383
+ ------------- | ------------- | ------------- | -------------
384
+ **limit** | **Integer**| The number of items to display for pagination. | [optional]
385
+ **offset** | **Integer**| The number of items to skip for pagination. | [optional]
386
+ **sort_by** | [**Array&lt;String&gt;**](String.md)| Sort results by attribute. Can sort on multiple attributes, separated by &#x60;|&#x60;. Order direction can be suffixing the attribute by either &#x60;:asc&#x60; (default) or &#x60;:desc&#x60;. | [optional]
387
+ **id** | **String**| Filter on id | [optional]
388
+ **name** | **String**| Filter on name | [optional]
389
+ **comment** | **String**| Filter on comment | [optional]
390
+ **quota_total_size** | **String**| Filter on quota total size | [optional]
391
+ **quota_on_cache** | **String**| Filter on quota on cache | [optional]
392
+ **stat_total_files** | **String**| Filter on stat total files | [optional]
393
+ **stat_total_size** | **String**| Filter on stat total size | [optional]
394
+ **stat_size_on_cache** | **String**| Filter on stat size on cache | [optional]
395
+ **guest_right** | **String**| Filter on guest right | [optional]
396
+ **last_update** | **String**| Filter on last update | [optional]
397
+
398
+ ### Return type
399
+
400
+ [**ContainerCollection**](ContainerCollection.md)
401
+
402
+ ### Authorization
403
+
404
+ [BasicAuth](../README.md#BasicAuth), [BearerAuth](../README.md#BearerAuth)
405
+
406
+ ### HTTP request headers
407
+
408
+ - **Content-Type**: Not defined
409
+ - **Accept**: application/json
410
+
411
+
412
+ ## show_container
413
+
414
+ > Container show_container(container_id)
415
+
416
+ Displays a specific container.
417
+
418
+ **API Key Scope**: containers / show
419
+
420
+ ### Example
421
+
422
+ ```ruby
423
+ # load the gem
424
+ require 'nodeum_sdk'
425
+ # setup authorization
426
+ Nodeum.configure do |config|
427
+ # Configure HTTP basic authorization: BasicAuth
428
+ config.username = 'YOUR USERNAME'
429
+ config.password = 'YOUR PASSWORD'
430
+
431
+ # Configure API key authorization: BearerAuth
432
+ config.api_key['Authorization'] = 'YOUR API KEY'
433
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
434
+ #config.api_key_prefix['Authorization'] = 'Bearer'
435
+ end
436
+
437
+ api_instance = Nodeum::ContainersApi.new
438
+ container_id = 'container_id_example' # String | Numeric ID or name of container.
439
+
440
+ begin
441
+ #Displays a specific container.
442
+ result = api_instance.show_container(container_id)
443
+ p result
444
+ rescue Nodeum::ApiError => e
445
+ puts "Exception when calling ContainersApi->show_container: #{e}"
446
+ end
447
+ ```
448
+
449
+ ### Parameters
450
+
451
+
452
+ Name | Type | Description | Notes
453
+ ------------- | ------------- | ------------- | -------------
454
+ **container_id** | **String**| Numeric ID or name of container. |
455
+
456
+ ### Return type
457
+
458
+ [**Container**](Container.md)
459
+
460
+ ### Authorization
461
+
462
+ [BasicAuth](../README.md#BasicAuth), [BearerAuth](../README.md#BearerAuth)
463
+
464
+ ### HTTP request headers
465
+
466
+ - **Content-Type**: Not defined
467
+ - **Accept**: application/json
468
+
469
+
470
+ ## show_container_privilege
471
+
472
+ > ContainerPrivilege show_container_privilege(container_id, container_privilege_id)
473
+
474
+ Displays a specific privilege.
475
+
476
+ **API Key Scope**: container_privileges / show
477
+
478
+ ### Example
479
+
480
+ ```ruby
481
+ # load the gem
482
+ require 'nodeum_sdk'
483
+ # setup authorization
484
+ Nodeum.configure do |config|
485
+ # Configure HTTP basic authorization: BasicAuth
486
+ config.username = 'YOUR USERNAME'
487
+ config.password = 'YOUR PASSWORD'
488
+
489
+ # Configure API key authorization: BearerAuth
490
+ config.api_key['Authorization'] = 'YOUR API KEY'
491
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
492
+ #config.api_key_prefix['Authorization'] = 'Bearer'
493
+ end
494
+
495
+ api_instance = Nodeum::ContainersApi.new
496
+ container_id = 'container_id_example' # String | Numeric ID or name of container.
497
+ container_privilege_id = 56 # Integer | Numeric ID of container privilege.
498
+
499
+ begin
500
+ #Displays a specific privilege.
501
+ result = api_instance.show_container_privilege(container_id, container_privilege_id)
502
+ p result
503
+ rescue Nodeum::ApiError => e
504
+ puts "Exception when calling ContainersApi->show_container_privilege: #{e}"
505
+ end
506
+ ```
507
+
508
+ ### Parameters
509
+
510
+
511
+ Name | Type | Description | Notes
512
+ ------------- | ------------- | ------------- | -------------
513
+ **container_id** | **String**| Numeric ID or name of container. |
514
+ **container_privilege_id** | **Integer**| Numeric ID of container privilege. |
515
+
516
+ ### Return type
517
+
518
+ [**ContainerPrivilege**](ContainerPrivilege.md)
519
+
520
+ ### Authorization
521
+
522
+ [BasicAuth](../README.md#BasicAuth), [BearerAuth](../README.md#BearerAuth)
523
+
524
+ ### HTTP request headers
525
+
526
+ - **Content-Type**: Not defined
527
+ - **Accept**: application/json
528
+
529
+
530
+ ## update_container
531
+
532
+ > Container update_container(container_id, container_body)
533
+
534
+ Updates a specific container.
535
+
536
+ It **does not** yet create the file structure and configure the samba connection. Use API v1 instead. **API Key Scope**: containers / update
537
+
538
+ ### Example
539
+
540
+ ```ruby
541
+ # load the gem
542
+ require 'nodeum_sdk'
543
+ # setup authorization
544
+ Nodeum.configure do |config|
545
+ # Configure HTTP basic authorization: BasicAuth
546
+ config.username = 'YOUR USERNAME'
547
+ config.password = 'YOUR PASSWORD'
548
+
549
+ # Configure API key authorization: BearerAuth
550
+ config.api_key['Authorization'] = 'YOUR API KEY'
551
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
552
+ #config.api_key_prefix['Authorization'] = 'Bearer'
553
+ end
554
+
555
+ api_instance = Nodeum::ContainersApi.new
556
+ container_id = 'container_id_example' # String | Numeric ID or name of container.
557
+ container_body = Nodeum::Container.new # Container |
558
+
559
+ begin
560
+ #Updates a specific container.
561
+ result = api_instance.update_container(container_id, container_body)
562
+ p result
563
+ rescue Nodeum::ApiError => e
564
+ puts "Exception when calling ContainersApi->update_container: #{e}"
565
+ end
566
+ ```
567
+
568
+ ### Parameters
569
+
570
+
571
+ Name | Type | Description | Notes
572
+ ------------- | ------------- | ------------- | -------------
573
+ **container_id** | **String**| Numeric ID or name of container. |
574
+ **container_body** | [**Container**](Container.md)| |
575
+
576
+ ### Return type
577
+
578
+ [**Container**](Container.md)
579
+
580
+ ### Authorization
581
+
582
+ [BasicAuth](../README.md#BasicAuth), [BearerAuth](../README.md#BearerAuth)
583
+
584
+ ### HTTP request headers
585
+
586
+ - **Content-Type**: application/json
587
+ - **Accept**: application/json
588
+
589
+
590
+ ## update_container_privilege
591
+
592
+ > ContainerPrivilege update_container_privilege(container_id, container_privilege_id, container_privilege_body)
593
+
594
+ Updates a specific privilege.
595
+
596
+ **API Key Scope**: container_privileges / update
597
+
598
+ ### Example
599
+
600
+ ```ruby
601
+ # load the gem
602
+ require 'nodeum_sdk'
603
+ # setup authorization
604
+ Nodeum.configure do |config|
605
+ # Configure HTTP basic authorization: BasicAuth
606
+ config.username = 'YOUR USERNAME'
607
+ config.password = 'YOUR PASSWORD'
608
+
609
+ # Configure API key authorization: BearerAuth
610
+ config.api_key['Authorization'] = 'YOUR API KEY'
611
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
612
+ #config.api_key_prefix['Authorization'] = 'Bearer'
613
+ end
614
+
615
+ api_instance = Nodeum::ContainersApi.new
616
+ container_id = 'container_id_example' # String | Numeric ID or name of container.
617
+ container_privilege_id = 56 # Integer | Numeric ID of container privilege.
618
+ container_privilege_body = Nodeum::ContainerPrivilege.new # ContainerPrivilege |
619
+
620
+ begin
621
+ #Updates a specific privilege.
622
+ result = api_instance.update_container_privilege(container_id, container_privilege_id, container_privilege_body)
623
+ p result
624
+ rescue Nodeum::ApiError => e
625
+ puts "Exception when calling ContainersApi->update_container_privilege: #{e}"
626
+ end
627
+ ```
628
+
629
+ ### Parameters
630
+
631
+
632
+ Name | Type | Description | Notes
633
+ ------------- | ------------- | ------------- | -------------
634
+ **container_id** | **String**| Numeric ID or name of container. |
635
+ **container_privilege_id** | **Integer**| Numeric ID of container privilege. |
636
+ **container_privilege_body** | [**ContainerPrivilege**](ContainerPrivilege.md)| |
637
+
638
+ ### Return type
639
+
640
+ [**ContainerPrivilege**](ContainerPrivilege.md)
641
+
642
+ ### Authorization
643
+
644
+ [BasicAuth](../README.md#BasicAuth), [BearerAuth](../README.md#BearerAuth)
645
+
646
+ ### HTTP request headers
647
+
648
+ - **Content-Type**: application/json
649
+ - **Accept**: application/json
650
+