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.
- checksums.yaml +7 -0
- data/Gemfile +9 -0
- data/LICENSE +21 -0
- data/README.md +472 -0
- data/Rakefile +10 -0
- data/docs/ActiveJobStatus.md +23 -0
- data/docs/ApiKey.md +21 -0
- data/docs/ApiKeyCollection.md +19 -0
- data/docs/ApiKeyFull.md +17 -0
- data/docs/ApiKeyFullAllOf.md +17 -0
- data/docs/ApiKeyScope.md +19 -0
- data/docs/AttributeError.md +17 -0
- data/docs/Blank.md +16 -0
- data/docs/ByDateFacet.md +35 -0
- data/docs/ByDateFacetBucket.md +17 -0
- data/docs/ByDateFacetBucketAllOf.md +17 -0
- data/docs/ByDateFacetBuckets.md +17 -0
- data/docs/ByFileExtensionFacet.md +17 -0
- data/docs/ByFileExtensionFacetAllOf.md +17 -0
- data/docs/ByGroupOwnerFacet.md +17 -0
- data/docs/ByGroupOwnerFacetAllOf.md +17 -0
- data/docs/ByPrimaryFacet.md +17 -0
- data/docs/ByPrimaryFacetAllOf.md +17 -0
- data/docs/BySecondaryBucket.md +17 -0
- data/docs/BySecondaryBucketAllOf.md +17 -0
- data/docs/BySecondaryBuckets.md +17 -0
- data/docs/BySecondaryFacet.md +29 -0
- data/docs/BySecondaryTypeFacet.md +17 -0
- data/docs/BySecondaryTypeFacetAllOf.md +17 -0
- data/docs/BySizeFacet.md +35 -0
- data/docs/ByUserOwnerFacet.md +17 -0
- data/docs/ByUserOwnerFacetAllOf.md +17 -0
- data/docs/CloudBucket.md +31 -0
- data/docs/CloudBucketCollection.md +19 -0
- data/docs/CloudBucketSimpleCollection.md +17 -0
- data/docs/CloudBucketsApi.md +908 -0
- data/docs/CloudConnector.md +31 -0
- data/docs/CloudConnectorCollection.md +19 -0
- data/docs/CloudConnectorsApi.md +442 -0
- data/docs/Container.md +35 -0
- data/docs/ContainerCollection.md +19 -0
- data/docs/ContainerPrivilege.md +23 -0
- data/docs/ContainerPrivilegeCollection.md +19 -0
- data/docs/ContainersApi.md +650 -0
- data/docs/DateToFileFacets.md +31 -0
- data/docs/Error.md +19 -0
- data/docs/FileFacet.md +19 -0
- data/docs/FilesApi.md +2090 -0
- data/docs/Frozen.md +16 -0
- data/docs/GreaterThan.md +19 -0
- data/docs/GreaterThanAllOf.md +19 -0
- data/docs/GreaterThanOrEqualTo.md +19 -0
- data/docs/ImportFile.md +39 -0
- data/docs/ImportFileCollection.md +19 -0
- data/docs/ImportFileWithPath.md +41 -0
- data/docs/Invalid.md +17 -0
- data/docs/LessThan.md +19 -0
- data/docs/LessThanAllOf.md +19 -0
- data/docs/LessThanOrEqualTo.md +19 -0
- data/docs/MountCollection.md +17 -0
- data/docs/MountInfo.md +57 -0
- data/docs/MountNotification.md +19 -0
- data/docs/MountStatus.md +21 -0
- data/docs/MountsApi.md +63 -0
- data/docs/Nas.md +27 -0
- data/docs/NasApi.md +322 -0
- data/docs/NasCollection.md +19 -0
- data/docs/NasShare.md +35 -0
- data/docs/NasShareCollection.md +19 -0
- data/docs/NasSharesApi.md +1155 -0
- data/docs/NodeumFile.md +39 -0
- data/docs/NodeumFileCollection.md +19 -0
- data/docs/NodeumFileWithPath.md +17 -0
- data/docs/NodeumFileWithPathAllOf.md +17 -0
- data/docs/OccurrenceLessThan.md +19 -0
- data/docs/OccurrenceLessThanAllOf.md +19 -0
- data/docs/OccurrenceLessThanOrEqualTo.md +19 -0
- data/docs/OnTapesFile.md +25 -0
- data/docs/OnTapesFileCollection.md +19 -0
- data/docs/Pool.md +27 -0
- data/docs/PoolCollection.md +19 -0
- data/docs/PoolUp.md +21 -0
- data/docs/PoolUpAllOf.md +21 -0
- data/docs/PoolsApi.md +798 -0
- data/docs/PrimaryScan.md +25 -0
- data/docs/QuotaOnCache.md +16 -0
- data/docs/Reset.md +17 -0
- data/docs/ResetSections.md +21 -0
- data/docs/SizeToDateFacets.md +31 -0
- data/docs/StatisticsApi.md +386 -0
- data/docs/SystemGroup.md +21 -0
- data/docs/SystemGroupCollection.md +19 -0
- data/docs/SystemUser.md +23 -0
- data/docs/SystemUserCollection.md +19 -0
- data/docs/SystemsApi.md +183 -0
- data/docs/Taken.md +17 -0
- data/docs/TakenAllOf.md +17 -0
- data/docs/Tape.md +65 -0
- data/docs/TapeCollection.md +19 -0
- data/docs/TapeDrive.md +55 -0
- data/docs/TapeDriveAllOf.md +55 -0
- data/docs/TapeDriveCollection.md +19 -0
- data/docs/TapeDriveDevice.md +29 -0
- data/docs/TapeDriveDeviceCollection.md +17 -0
- data/docs/TapeDrivesApi.md +730 -0
- data/docs/TapeLibrariesApi.md +403 -0
- data/docs/TapeLibrary.md +27 -0
- data/docs/TapeLibraryAllOf.md +27 -0
- data/docs/TapeLibraryCollection.md +19 -0
- data/docs/TapeLibraryDevice.md +37 -0
- data/docs/TapeLibraryDeviceCollection.md +17 -0
- data/docs/TapeStat.md +115 -0
- data/docs/TapeStatCollection.md +19 -0
- data/docs/TapesApi.md +959 -0
- data/docs/Task.md +55 -0
- data/docs/TaskCallback.md +21 -0
- data/docs/TaskCallbackCollection.md +19 -0
- data/docs/TaskCallbacksApi.md +326 -0
- data/docs/TaskCollection.md +19 -0
- data/docs/TaskDestinationCollection.md +19 -0
- data/docs/TaskDestinationDown.md +25 -0
- data/docs/TaskDestinationUp.md +27 -0
- data/docs/TaskDestinationsApi.md +328 -0
- data/docs/TaskExecution.md +51 -0
- data/docs/TaskExecutionCollection.md +19 -0
- data/docs/TaskExecutionsApi.md +336 -0
- data/docs/TaskMetadataApi.md +326 -0
- data/docs/TaskMetadatum.md +21 -0
- data/docs/TaskMetadatumCollection.md +19 -0
- data/docs/TaskOption.md +21 -0
- data/docs/TaskOptionCollection.md +19 -0
- data/docs/TaskOptionsApi.md +326 -0
- data/docs/TaskSchedule.md +34 -0
- data/docs/TaskScheduleCollection.md +19 -0
- data/docs/TaskSchedulesApi.md +322 -0
- data/docs/TaskSourceCollection.md +19 -0
- data/docs/TaskSourceDown.md +29 -0
- data/docs/TaskSourceUp.md +33 -0
- data/docs/TaskSourcesApi.md +330 -0
- data/docs/TasksApi.md +846 -0
- data/docs/TooLong.md +17 -0
- data/docs/TooLongAllOf.md +17 -0
- data/docs/TooShort.md +17 -0
- data/docs/TooShortAllOf.md +17 -0
- data/docs/TypeToSecondaryFacets.md +25 -0
- data/docs/UsersApi.md +418 -0
- data/git_push.sh +58 -0
- data/lib/nodeum_sdk.rb +180 -0
- data/lib/nodeum_sdk/api/cloud_buckets_api.rb +1026 -0
- data/lib/nodeum_sdk/api/cloud_connectors_api.rb +491 -0
- data/lib/nodeum_sdk/api/containers_api.rb +736 -0
- data/lib/nodeum_sdk/api/files_api.rb +2418 -0
- data/lib/nodeum_sdk/api/mounts_api.rb +78 -0
- data/lib/nodeum_sdk/api/nas_api.rb +361 -0
- data/lib/nodeum_sdk/api/nas_shares_api.rb +1305 -0
- data/lib/nodeum_sdk/api/pools_api.rb +876 -0
- data/lib/nodeum_sdk/api/statistics_api.rb +418 -0
- data/lib/nodeum_sdk/api/systems_api.rb +215 -0
- data/lib/nodeum_sdk/api/tape_drives_api.rb +858 -0
- data/lib/nodeum_sdk/api/tape_libraries_api.rb +457 -0
- data/lib/nodeum_sdk/api/tapes_api.rb +1104 -0
- data/lib/nodeum_sdk/api/task_callbacks_api.rb +382 -0
- data/lib/nodeum_sdk/api/task_destinations_api.rb +385 -0
- data/lib/nodeum_sdk/api/task_executions_api.rb +399 -0
- data/lib/nodeum_sdk/api/task_metadata_api.rb +382 -0
- data/lib/nodeum_sdk/api/task_options_api.rb +382 -0
- data/lib/nodeum_sdk/api/task_schedules_api.rb +364 -0
- data/lib/nodeum_sdk/api/task_sources_api.rb +388 -0
- data/lib/nodeum_sdk/api/tasks_api.rb +951 -0
- data/lib/nodeum_sdk/api/users_api.rb +452 -0
- data/lib/nodeum_sdk/api_client.rb +386 -0
- data/lib/nodeum_sdk/api_error.rb +57 -0
- data/lib/nodeum_sdk/configuration.rb +255 -0
- data/lib/nodeum_sdk/models/active_job_status.rb +267 -0
- data/lib/nodeum_sdk/models/api_key.rb +224 -0
- data/lib/nodeum_sdk/models/api_key_collection.rb +217 -0
- data/lib/nodeum_sdk/models/api_key_full.rb +220 -0
- data/lib/nodeum_sdk/models/api_key_full_all_of.rb +208 -0
- data/lib/nodeum_sdk/models/api_key_scope.rb +215 -0
- data/lib/nodeum_sdk/models/attribute_error.rb +216 -0
- data/lib/nodeum_sdk/models/blank.rb +209 -0
- data/lib/nodeum_sdk/models/by_date_facet.rb +295 -0
- data/lib/nodeum_sdk/models/by_date_facet_bucket.rb +218 -0
- data/lib/nodeum_sdk/models/by_date_facet_bucket_all_of.rb +206 -0
- data/lib/nodeum_sdk/models/by_date_facet_buckets.rb +208 -0
- data/lib/nodeum_sdk/models/by_file_extension_facet.rb +218 -0
- data/lib/nodeum_sdk/models/by_file_extension_facet_all_of.rb +206 -0
- data/lib/nodeum_sdk/models/by_group_owner_facet.rb +218 -0
- data/lib/nodeum_sdk/models/by_group_owner_facet_all_of.rb +206 -0
- data/lib/nodeum_sdk/models/by_primary_facet.rb +218 -0
- data/lib/nodeum_sdk/models/by_primary_facet_all_of.rb +206 -0
- data/lib/nodeum_sdk/models/by_secondary_bucket.rb +218 -0
- data/lib/nodeum_sdk/models/by_secondary_bucket_all_of.rb +206 -0
- data/lib/nodeum_sdk/models/by_secondary_buckets.rb +208 -0
- data/lib/nodeum_sdk/models/by_secondary_facet.rb +268 -0
- data/lib/nodeum_sdk/models/by_secondary_type_facet.rb +218 -0
- data/lib/nodeum_sdk/models/by_secondary_type_facet_all_of.rb +206 -0
- data/lib/nodeum_sdk/models/by_size_facet.rb +295 -0
- data/lib/nodeum_sdk/models/by_user_owner_facet.rb +218 -0
- data/lib/nodeum_sdk/models/by_user_owner_facet_all_of.rb +206 -0
- data/lib/nodeum_sdk/models/cloud_bucket.rb +269 -0
- data/lib/nodeum_sdk/models/cloud_bucket_collection.rb +217 -0
- data/lib/nodeum_sdk/models/cloud_bucket_simple_collection.rb +208 -0
- data/lib/nodeum_sdk/models/cloud_connector.rb +303 -0
- data/lib/nodeum_sdk/models/cloud_connector_collection.rb +217 -0
- data/lib/nodeum_sdk/models/container.rb +321 -0
- data/lib/nodeum_sdk/models/container_collection.rb +217 -0
- data/lib/nodeum_sdk/models/container_privilege.rb +279 -0
- data/lib/nodeum_sdk/models/container_privilege_collection.rb +217 -0
- data/lib/nodeum_sdk/models/date_to_file_facets.rb +269 -0
- data/lib/nodeum_sdk/models/error.rb +221 -0
- data/lib/nodeum_sdk/models/file_facet.rb +215 -0
- data/lib/nodeum_sdk/models/frozen.rb +209 -0
- data/lib/nodeum_sdk/models/greater_than.rb +230 -0
- data/lib/nodeum_sdk/models/greater_than_all_of.rb +217 -0
- data/lib/nodeum_sdk/models/greater_than_or_equal_to.rb +230 -0
- data/lib/nodeum_sdk/models/import_file.rb +339 -0
- data/lib/nodeum_sdk/models/import_file_collection.rb +217 -0
- data/lib/nodeum_sdk/models/import_file_with_path.rb +356 -0
- data/lib/nodeum_sdk/models/invalid.rb +220 -0
- data/lib/nodeum_sdk/models/less_than.rb +230 -0
- data/lib/nodeum_sdk/models/less_than_all_of.rb +217 -0
- data/lib/nodeum_sdk/models/less_than_or_equal_to.rb +230 -0
- data/lib/nodeum_sdk/models/mount_collection.rb +208 -0
- data/lib/nodeum_sdk/models/mount_info.rb +420 -0
- data/lib/nodeum_sdk/models/mount_notification.rb +249 -0
- data/lib/nodeum_sdk/models/mount_status.rb +224 -0
- data/lib/nodeum_sdk/models/nas.rb +285 -0
- data/lib/nodeum_sdk/models/nas_collection.rb +217 -0
- data/lib/nodeum_sdk/models/nas_share.rb +287 -0
- data/lib/nodeum_sdk/models/nas_share_collection.rb +217 -0
- data/lib/nodeum_sdk/models/nodeum_file.rb +339 -0
- data/lib/nodeum_sdk/models/nodeum_file_collection.rb +217 -0
- data/lib/nodeum_sdk/models/nodeum_file_with_path.rb +240 -0
- data/lib/nodeum_sdk/models/nodeum_file_with_path_all_of.rb +206 -0
- data/lib/nodeum_sdk/models/occurrence_less_than.rb +230 -0
- data/lib/nodeum_sdk/models/occurrence_less_than_all_of.rb +217 -0
- data/lib/nodeum_sdk/models/occurrence_less_than_or_equal_to.rb +230 -0
- data/lib/nodeum_sdk/models/on_tapes_file.rb +278 -0
- data/lib/nodeum_sdk/models/on_tapes_file_collection.rb +217 -0
- data/lib/nodeum_sdk/models/pool.rb +297 -0
- data/lib/nodeum_sdk/models/pool_collection.rb +217 -0
- data/lib/nodeum_sdk/models/pool_up.rb +264 -0
- data/lib/nodeum_sdk/models/pool_up_all_of.rb +230 -0
- data/lib/nodeum_sdk/models/primary_scan.rb +276 -0
- data/lib/nodeum_sdk/models/quota_on_cache.rb +209 -0
- data/lib/nodeum_sdk/models/reset.rb +209 -0
- data/lib/nodeum_sdk/models/reset_sections.rb +265 -0
- data/lib/nodeum_sdk/models/size_to_date_facets.rb +269 -0
- data/lib/nodeum_sdk/models/system_group.rb +226 -0
- data/lib/nodeum_sdk/models/system_group_collection.rb +217 -0
- data/lib/nodeum_sdk/models/system_user.rb +233 -0
- data/lib/nodeum_sdk/models/system_user_collection.rb +217 -0
- data/lib/nodeum_sdk/models/taken.rb +220 -0
- data/lib/nodeum_sdk/models/taken_all_of.rb +207 -0
- data/lib/nodeum_sdk/models/tape.rb +456 -0
- data/lib/nodeum_sdk/models/tape_collection.rb +217 -0
- data/lib/nodeum_sdk/models/tape_drive.rb +423 -0
- data/lib/nodeum_sdk/models/tape_drive_all_of.rb +411 -0
- data/lib/nodeum_sdk/models/tape_drive_collection.rb +217 -0
- data/lib/nodeum_sdk/models/tape_drive_device.rb +261 -0
- data/lib/nodeum_sdk/models/tape_drive_device_collection.rb +208 -0
- data/lib/nodeum_sdk/models/tape_library.rb +297 -0
- data/lib/nodeum_sdk/models/tape_library_all_of.rb +285 -0
- data/lib/nodeum_sdk/models/tape_library_collection.rb +217 -0
- data/lib/nodeum_sdk/models/tape_library_device.rb +330 -0
- data/lib/nodeum_sdk/models/tape_library_device_collection.rb +208 -0
- data/lib/nodeum_sdk/models/tape_stat.rb +647 -0
- data/lib/nodeum_sdk/models/tape_stat_collection.rb +217 -0
- data/lib/nodeum_sdk/models/task.rb +483 -0
- data/lib/nodeum_sdk/models/task_callback.rb +258 -0
- data/lib/nodeum_sdk/models/task_callback_collection.rb +217 -0
- data/lib/nodeum_sdk/models/task_collection.rb +217 -0
- data/lib/nodeum_sdk/models/task_destination_collection.rb +217 -0
- data/lib/nodeum_sdk/models/task_destination_down.rb +242 -0
- data/lib/nodeum_sdk/models/task_destination_up.rb +251 -0
- data/lib/nodeum_sdk/models/task_execution.rb +441 -0
- data/lib/nodeum_sdk/models/task_execution_collection.rb +217 -0
- data/lib/nodeum_sdk/models/task_metadatum.rb +224 -0
- data/lib/nodeum_sdk/models/task_metadatum_collection.rb +217 -0
- data/lib/nodeum_sdk/models/task_option.rb +258 -0
- data/lib/nodeum_sdk/models/task_option_collection.rb +217 -0
- data/lib/nodeum_sdk/models/task_schedule.rb +278 -0
- data/lib/nodeum_sdk/models/task_schedule_collection.rb +217 -0
- data/lib/nodeum_sdk/models/task_source_collection.rb +217 -0
- data/lib/nodeum_sdk/models/task_source_down.rb +262 -0
- data/lib/nodeum_sdk/models/task_source_up.rb +280 -0
- data/lib/nodeum_sdk/models/too_long.rb +220 -0
- data/lib/nodeum_sdk/models/too_long_all_of.rb +207 -0
- data/lib/nodeum_sdk/models/too_short.rb +220 -0
- data/lib/nodeum_sdk/models/too_short_all_of.rb +207 -0
- data/lib/nodeum_sdk/models/type_to_secondary_facets.rb +242 -0
- data/lib/nodeum_sdk/version.rb +15 -0
- data/nodeum_sdk.gemspec +39 -0
- data/spec/api/cloud_buckets_api_spec.rb +237 -0
- data/spec/api/cloud_connectors_api_spec.rb +129 -0
- data/spec/api/containers_api_spec.rb +180 -0
- data/spec/api/files_api_spec.rb +570 -0
- data/spec/api/mounts_api_spec.rb +46 -0
- data/spec/api/nas_api_spec.rb +104 -0
- data/spec/api/nas_shares_api_spec.rb +292 -0
- data/spec/api/pools_api_spec.rb +203 -0
- data/spec/api/statistics_api_spec.rb +113 -0
- data/spec/api/systems_api_spec.rb +70 -0
- data/spec/api/tape_drives_api_spec.rb +220 -0
- data/spec/api/tape_libraries_api_spec.rb +127 -0
- data/spec/api/tapes_api_spec.rb +279 -0
- data/spec/api/task_callbacks_api_spec.rb +106 -0
- data/spec/api/task_destinations_api_spec.rb +107 -0
- data/spec/api/task_executions_api_spec.rb +127 -0
- data/spec/api/task_metadata_api_spec.rb +106 -0
- data/spec/api/task_options_api_spec.rb +106 -0
- data/spec/api/task_schedules_api_spec.rb +104 -0
- data/spec/api/task_sources_api_spec.rb +108 -0
- data/spec/api/tasks_api_spec.rb +226 -0
- data/spec/api/users_api_spec.rb +119 -0
- data/spec/api_client_spec.rb +226 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/models/active_job_status_spec.rb +63 -0
- data/spec/models/api_key_collection_spec.rb +47 -0
- data/spec/models/api_key_full_all_of_spec.rb +41 -0
- data/spec/models/api_key_full_spec.rb +41 -0
- data/spec/models/api_key_scope_spec.rb +47 -0
- data/spec/models/api_key_spec.rb +53 -0
- data/spec/models/attribute_error_spec.rb +41 -0
- data/spec/models/blank_spec.rb +35 -0
- data/spec/models/by_date_facet_bucket_all_of_spec.rb +41 -0
- data/spec/models/by_date_facet_bucket_spec.rb +41 -0
- data/spec/models/by_date_facet_buckets_spec.rb +41 -0
- data/spec/models/by_date_facet_spec.rb +95 -0
- data/spec/models/by_file_extension_facet_all_of_spec.rb +41 -0
- data/spec/models/by_file_extension_facet_spec.rb +41 -0
- data/spec/models/by_group_owner_facet_all_of_spec.rb +41 -0
- data/spec/models/by_group_owner_facet_spec.rb +41 -0
- data/spec/models/by_primary_facet_all_of_spec.rb +41 -0
- data/spec/models/by_primary_facet_spec.rb +41 -0
- data/spec/models/by_secondary_bucket_all_of_spec.rb +41 -0
- data/spec/models/by_secondary_bucket_spec.rb +41 -0
- data/spec/models/by_secondary_buckets_spec.rb +41 -0
- data/spec/models/by_secondary_facet_spec.rb +77 -0
- data/spec/models/by_secondary_type_facet_all_of_spec.rb +41 -0
- data/spec/models/by_secondary_type_facet_spec.rb +41 -0
- data/spec/models/by_size_facet_spec.rb +95 -0
- data/spec/models/by_user_owner_facet_all_of_spec.rb +41 -0
- data/spec/models/by_user_owner_facet_spec.rb +41 -0
- data/spec/models/cloud_bucket_collection_spec.rb +47 -0
- data/spec/models/cloud_bucket_simple_collection_spec.rb +41 -0
- data/spec/models/cloud_bucket_spec.rb +83 -0
- data/spec/models/cloud_connector_collection_spec.rb +47 -0
- data/spec/models/cloud_connector_spec.rb +87 -0
- data/spec/models/container_collection_spec.rb +47 -0
- data/spec/models/container_privilege_collection_spec.rb +47 -0
- data/spec/models/container_privilege_spec.rb +67 -0
- data/spec/models/container_spec.rb +99 -0
- data/spec/models/date_to_file_facets_spec.rb +83 -0
- data/spec/models/error_spec.rb +47 -0
- data/spec/models/file_facet_spec.rb +47 -0
- data/spec/models/frozen_spec.rb +35 -0
- data/spec/models/greater_than_all_of_spec.rb +47 -0
- data/spec/models/greater_than_or_equal_to_spec.rb +47 -0
- data/spec/models/greater_than_spec.rb +47 -0
- data/spec/models/import_file_collection_spec.rb +47 -0
- data/spec/models/import_file_spec.rb +111 -0
- data/spec/models/import_file_with_path_spec.rb +117 -0
- data/spec/models/invalid_spec.rb +41 -0
- data/spec/models/less_than_all_of_spec.rb +47 -0
- data/spec/models/less_than_or_equal_to_spec.rb +47 -0
- data/spec/models/less_than_spec.rb +47 -0
- data/spec/models/mount_collection_spec.rb +41 -0
- data/spec/models/mount_info_spec.rb +165 -0
- data/spec/models/mount_notification_spec.rb +51 -0
- data/spec/models/mount_status_spec.rb +53 -0
- data/spec/models/nas_collection_spec.rb +47 -0
- data/spec/models/nas_share_collection_spec.rb +47 -0
- data/spec/models/nas_share_spec.rb +95 -0
- data/spec/models/nas_spec.rb +75 -0
- data/spec/models/nodeum_file_collection_spec.rb +47 -0
- data/spec/models/nodeum_file_spec.rb +111 -0
- data/spec/models/nodeum_file_with_path_all_of_spec.rb +41 -0
- data/spec/models/nodeum_file_with_path_spec.rb +41 -0
- data/spec/models/occurrence_less_than_all_of_spec.rb +47 -0
- data/spec/models/occurrence_less_than_or_equal_to_spec.rb +47 -0
- data/spec/models/occurrence_less_than_spec.rb +47 -0
- data/spec/models/on_tapes_file_collection_spec.rb +47 -0
- data/spec/models/on_tapes_file_spec.rb +69 -0
- data/spec/models/pool_collection_spec.rb +47 -0
- data/spec/models/pool_spec.rb +79 -0
- data/spec/models/pool_up_all_of_spec.rb +53 -0
- data/spec/models/pool_up_spec.rb +53 -0
- data/spec/models/primary_scan_spec.rb +69 -0
- data/spec/models/quota_on_cache_spec.rb +35 -0
- data/spec/models/reset_sections_spec.rb +57 -0
- data/spec/models/reset_spec.rb +41 -0
- data/spec/models/size_to_date_facets_spec.rb +83 -0
- data/spec/models/system_group_collection_spec.rb +47 -0
- data/spec/models/system_group_spec.rb +53 -0
- data/spec/models/system_user_collection_spec.rb +47 -0
- data/spec/models/system_user_spec.rb +59 -0
- data/spec/models/taken_all_of_spec.rb +41 -0
- data/spec/models/taken_spec.rb +41 -0
- data/spec/models/tape_collection_spec.rb +47 -0
- data/spec/models/tape_drive_all_of_spec.rb +159 -0
- data/spec/models/tape_drive_collection_spec.rb +47 -0
- data/spec/models/tape_drive_device_collection_spec.rb +41 -0
- data/spec/models/tape_drive_device_spec.rb +77 -0
- data/spec/models/tape_drive_spec.rb +159 -0
- data/spec/models/tape_library_all_of_spec.rb +75 -0
- data/spec/models/tape_library_collection_spec.rb +47 -0
- data/spec/models/tape_library_device_collection_spec.rb +41 -0
- data/spec/models/tape_library_device_spec.rb +105 -0
- data/spec/models/tape_library_spec.rb +75 -0
- data/spec/models/tape_spec.rb +189 -0
- data/spec/models/tape_stat_collection_spec.rb +47 -0
- data/spec/models/tape_stat_spec.rb +335 -0
- data/spec/models/task_callback_collection_spec.rb +47 -0
- data/spec/models/task_callback_spec.rb +57 -0
- data/spec/models/task_collection_spec.rb +47 -0
- data/spec/models/task_destination_collection_spec.rb +47 -0
- data/spec/models/task_destination_down_spec.rb +65 -0
- data/spec/models/task_destination_up_spec.rb +71 -0
- data/spec/models/task_execution_collection_spec.rb +47 -0
- data/spec/models/task_execution_spec.rb +163 -0
- data/spec/models/task_metadatum_collection_spec.rb +47 -0
- data/spec/models/task_metadatum_spec.rb +53 -0
- data/spec/models/task_option_collection_spec.rb +47 -0
- data/spec/models/task_option_spec.rb +57 -0
- data/spec/models/task_schedule_collection_spec.rb +47 -0
- data/spec/models/task_schedule_spec.rb +89 -0
- data/spec/models/task_source_collection_spec.rb +47 -0
- data/spec/models/task_source_down_spec.rb +77 -0
- data/spec/models/task_source_up_spec.rb +89 -0
- data/spec/models/task_spec.rb +183 -0
- data/spec/models/too_long_all_of_spec.rb +41 -0
- data/spec/models/too_long_spec.rb +41 -0
- data/spec/models/too_short_all_of_spec.rb +41 -0
- data/spec/models/too_short_spec.rb +41 -0
- data/spec/models/type_to_secondary_facets_spec.rb +65 -0
- data/spec/spec_helper.rb +111 -0
- metadata +718 -0
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# Nodeum::DateToFileFacets
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**in_cache** | [**FileFacet**](FileFacet.md) | | [optional]
|
|
8
|
+
**less_1_week** | [**FileFacet**](FileFacet.md) | | [optional]
|
|
9
|
+
**less_1_month** | [**FileFacet**](FileFacet.md) | | [optional]
|
|
10
|
+
**less_3_months** | [**FileFacet**](FileFacet.md) | | [optional]
|
|
11
|
+
**less_6_months** | [**FileFacet**](FileFacet.md) | | [optional]
|
|
12
|
+
**less_1_year** | [**FileFacet**](FileFacet.md) | | [optional]
|
|
13
|
+
**less_2_years** | [**FileFacet**](FileFacet.md) | | [optional]
|
|
14
|
+
**more_2_years** | [**FileFacet**](FileFacet.md) | | [optional]
|
|
15
|
+
|
|
16
|
+
## Code Sample
|
|
17
|
+
|
|
18
|
+
```ruby
|
|
19
|
+
require 'Nodeum'
|
|
20
|
+
|
|
21
|
+
instance = Nodeum::DateToFileFacets.new(in_cache: null,
|
|
22
|
+
less_1_week: null,
|
|
23
|
+
less_1_month: null,
|
|
24
|
+
less_3_months: null,
|
|
25
|
+
less_6_months: null,
|
|
26
|
+
less_1_year: null,
|
|
27
|
+
less_2_years: null,
|
|
28
|
+
more_2_years: null)
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
|
data/docs/Error.md
ADDED
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# Nodeum::Error
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**details** | **Hash<String, Array<AttributeError>>** | Parsable objects describing the errors. The key is the invalid attribute name. | [optional]
|
|
8
|
+
**messages** | **Array<String>** | English description of the errors. | [optional]
|
|
9
|
+
|
|
10
|
+
## Code Sample
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'Nodeum'
|
|
14
|
+
|
|
15
|
+
instance = Nodeum::Error.new(details: null,
|
|
16
|
+
messages: null)
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
|
data/docs/FileFacet.md
ADDED
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# Nodeum::FileFacet
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**count** | **Integer** | | [optional]
|
|
8
|
+
**file_size_sum** | **Integer** | | [optional]
|
|
9
|
+
|
|
10
|
+
## Code Sample
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'Nodeum'
|
|
14
|
+
|
|
15
|
+
instance = Nodeum::FileFacet.new(count: null,
|
|
16
|
+
file_size_sum: null)
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
|
data/docs/FilesApi.md
ADDED
|
@@ -0,0 +1,2090 @@
|
|
|
1
|
+
# Nodeum::FilesApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *http://localhost/api/v2*
|
|
4
|
+
|
|
5
|
+
Method | HTTP request | Description
|
|
6
|
+
------------- | ------------- | -------------
|
|
7
|
+
[**files_children**](FilesApi.md#files_children) | **GET** /files/{file_parent_id}/children | Lists files under a specific folder.
|
|
8
|
+
[**files_children_by_container**](FilesApi.md#files_children_by_container) | **GET** /containers/{container_id}/files/{file_parent_id}/children | Lists files under a specific folder.
|
|
9
|
+
[**files_children_by_pool**](FilesApi.md#files_children_by_pool) | **GET** /pools/{pool_id}/files/{file_parent_id}/children | Lists files under a specific folder.
|
|
10
|
+
[**files_children_by_task**](FilesApi.md#files_children_by_task) | **GET** /tasks/{task_id}/files/{file_parent_id}/children | Lists files under a specific folder.
|
|
11
|
+
[**files_children_by_task_execution**](FilesApi.md#files_children_by_task_execution) | **GET** /task_executions/{task_execution_id}/files/{file_parent_id}/children | Lists files under a specific folder.
|
|
12
|
+
[**files_children_by_task_execution_by_task**](FilesApi.md#files_children_by_task_execution_by_task) | **GET** /tasks/{task_id}/task_executions/{task_execution_id}/files/{file_parent_id}/children | Lists files under a specific folder.
|
|
13
|
+
[**import_files_children_by_pool**](FilesApi.md#import_files_children_by_pool) | **GET** /pools/{pool_id}/import_files/{file_parent_id}/children | Lists files under a specific folder on tape of pools, specific for Data Exchange.
|
|
14
|
+
[**index_files**](FilesApi.md#index_files) | **GET** /files | Lists files on root.
|
|
15
|
+
[**index_files_by_container**](FilesApi.md#index_files_by_container) | **GET** /containers/{container_id}/files | Lists files on root.
|
|
16
|
+
[**index_files_by_pool**](FilesApi.md#index_files_by_pool) | **GET** /pools/{pool_id}/files | Lists files on root.
|
|
17
|
+
[**index_files_by_task**](FilesApi.md#index_files_by_task) | **GET** /tasks/{task_id}/files | Lists files on root.
|
|
18
|
+
[**index_files_by_task_execution**](FilesApi.md#index_files_by_task_execution) | **GET** /task_executions/{task_execution_id}/files | Lists files on root.
|
|
19
|
+
[**index_files_by_task_execution_by_task**](FilesApi.md#index_files_by_task_execution_by_task) | **GET** /tasks/{task_id}/task_executions/{task_execution_id}/files | Lists files on root.
|
|
20
|
+
[**index_import_files_by_pool**](FilesApi.md#index_import_files_by_pool) | **GET** /pools/{pool_id}/import_files | Lists files on root of tape of pools, specific for Data Exchange.
|
|
21
|
+
[**index_on_tapes_files_by_pool**](FilesApi.md#index_on_tapes_files_by_pool) | **GET** /pools/{pool_id}/on_tapes_files | Lists files on root of tape of pools, specific for Active and Offline.
|
|
22
|
+
[**index_tapes_by_file_by_pool**](FilesApi.md#index_tapes_by_file_by_pool) | **GET** /pools/{pool_id}/files/{file_id}/tapes | Displays tapes containing specific file, related to the specific pool.
|
|
23
|
+
[**index_tapes_by_file_by_task**](FilesApi.md#index_tapes_by_file_by_task) | **GET** /tasks/{task_id}/files/{file_id}/tapes | Displays tapes containing specific file, related to the specific task.
|
|
24
|
+
[**index_tapes_by_file_by_task_execution**](FilesApi.md#index_tapes_by_file_by_task_execution) | **GET** /task_executions/{task_execution_id}/files/{file_id}/tapes | Displays tapes containing specific file, related to the specific task.
|
|
25
|
+
[**index_tapes_by_file_by_task_execution_by_task**](FilesApi.md#index_tapes_by_file_by_task_execution_by_task) | **GET** /tasks/{task_id}/task_executions/{task_execution_id}/files/{file_id}/tapes | Displays tapes containing specific file, related to the specific task.
|
|
26
|
+
[**on_tapes_files_children_by_pool**](FilesApi.md#on_tapes_files_children_by_pool) | **GET** /pools/{pool_id}/on_tapes_files/{file_parent_id}/children | Lists files under a specific folder on tape of pools, specific for Active and Offline.
|
|
27
|
+
[**show_file**](FilesApi.md#show_file) | **GET** /files/{file_id} | Displays a specific file.
|
|
28
|
+
[**show_file_by_container**](FilesApi.md#show_file_by_container) | **GET** /containers/{container_id}/files/{file_id} | Displays a specific file.
|
|
29
|
+
[**show_file_by_pool**](FilesApi.md#show_file_by_pool) | **GET** /pools/{pool_id}/files/{file_id} | Displays a specific file.
|
|
30
|
+
[**show_file_by_task**](FilesApi.md#show_file_by_task) | **GET** /tasks/{task_id}/files/{file_id} | Displays a specific file.
|
|
31
|
+
[**show_file_by_task_execution**](FilesApi.md#show_file_by_task_execution) | **GET** /task_executions/{task_execution_id}/files/{file_id} | Displays a specific file.
|
|
32
|
+
[**show_file_by_task_execution_by_task**](FilesApi.md#show_file_by_task_execution_by_task) | **GET** /tasks/{task_id}/task_executions/{task_execution_id}/files/{file_id} | Displays a specific file.
|
|
33
|
+
[**show_import_file_by_pool**](FilesApi.md#show_import_file_by_pool) | **GET** /pools/{pool_id}/import_files/{file_id} | Displays a specific file on tape of pools, specific for Data Exchange.
|
|
34
|
+
[**show_on_tape_file_by_pool**](FilesApi.md#show_on_tape_file_by_pool) | **GET** /pools/{pool_id}/on_tapes_files/{file_id} | Displays a specific file on tape of pools, specific for Active and Offline.
|
|
35
|
+
|
|
36
|
+
|
|
37
|
+
|
|
38
|
+
## files_children
|
|
39
|
+
|
|
40
|
+
> NodeumFileCollection files_children(file_parent_id, opts)
|
|
41
|
+
|
|
42
|
+
Lists files under a specific folder.
|
|
43
|
+
|
|
44
|
+
**API Key Scope**: files / index
|
|
45
|
+
|
|
46
|
+
### Example
|
|
47
|
+
|
|
48
|
+
```ruby
|
|
49
|
+
# load the gem
|
|
50
|
+
require 'nodeum_sdk'
|
|
51
|
+
# setup authorization
|
|
52
|
+
Nodeum.configure do |config|
|
|
53
|
+
# Configure HTTP basic authorization: BasicAuth
|
|
54
|
+
config.username = 'YOUR USERNAME'
|
|
55
|
+
config.password = 'YOUR PASSWORD'
|
|
56
|
+
|
|
57
|
+
# Configure API key authorization: BearerAuth
|
|
58
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
59
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
60
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
61
|
+
end
|
|
62
|
+
|
|
63
|
+
api_instance = Nodeum::FilesApi.new
|
|
64
|
+
file_parent_id = 56 # Integer | Numeric ID of parent folder.
|
|
65
|
+
opts = {
|
|
66
|
+
limit: 56, # Integer | The number of items to display for pagination.
|
|
67
|
+
offset: 56, # Integer | The number of items to skip for pagination.
|
|
68
|
+
file_id: 'file_id_example', # String | Filter on file id
|
|
69
|
+
name: 'name_example', # String | Filter on name
|
|
70
|
+
type: 'type_example', # String | Filter on type
|
|
71
|
+
permission: 'permission_example', # String | Filter on permission
|
|
72
|
+
size: 'size_example', # String | Filter on size
|
|
73
|
+
change_date: 'change_date_example', # String | Filter on change date
|
|
74
|
+
modification_date: 'modification_date_example', # String | Filter on modification date
|
|
75
|
+
access_date: 'access_date_example', # String | Filter on access date
|
|
76
|
+
gid: 'gid_example', # String | Filter on gid
|
|
77
|
+
uid: 'uid_example' # String | Filter on uid
|
|
78
|
+
}
|
|
79
|
+
|
|
80
|
+
begin
|
|
81
|
+
#Lists files under a specific folder.
|
|
82
|
+
result = api_instance.files_children(file_parent_id, opts)
|
|
83
|
+
p result
|
|
84
|
+
rescue Nodeum::ApiError => e
|
|
85
|
+
puts "Exception when calling FilesApi->files_children: #{e}"
|
|
86
|
+
end
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
### Parameters
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
Name | Type | Description | Notes
|
|
93
|
+
------------- | ------------- | ------------- | -------------
|
|
94
|
+
**file_parent_id** | **Integer**| Numeric ID of parent folder. |
|
|
95
|
+
**limit** | **Integer**| The number of items to display for pagination. | [optional]
|
|
96
|
+
**offset** | **Integer**| The number of items to skip for pagination. | [optional]
|
|
97
|
+
**file_id** | **String**| Filter on file id | [optional]
|
|
98
|
+
**name** | **String**| Filter on name | [optional]
|
|
99
|
+
**type** | **String**| Filter on type | [optional]
|
|
100
|
+
**permission** | **String**| Filter on permission | [optional]
|
|
101
|
+
**size** | **String**| Filter on size | [optional]
|
|
102
|
+
**change_date** | **String**| Filter on change date | [optional]
|
|
103
|
+
**modification_date** | **String**| Filter on modification date | [optional]
|
|
104
|
+
**access_date** | **String**| Filter on access date | [optional]
|
|
105
|
+
**gid** | **String**| Filter on gid | [optional]
|
|
106
|
+
**uid** | **String**| Filter on uid | [optional]
|
|
107
|
+
|
|
108
|
+
### Return type
|
|
109
|
+
|
|
110
|
+
[**NodeumFileCollection**](NodeumFileCollection.md)
|
|
111
|
+
|
|
112
|
+
### Authorization
|
|
113
|
+
|
|
114
|
+
[BasicAuth](../README.md#BasicAuth), [BearerAuth](../README.md#BearerAuth)
|
|
115
|
+
|
|
116
|
+
### HTTP request headers
|
|
117
|
+
|
|
118
|
+
- **Content-Type**: Not defined
|
|
119
|
+
- **Accept**: application/json
|
|
120
|
+
|
|
121
|
+
|
|
122
|
+
## files_children_by_container
|
|
123
|
+
|
|
124
|
+
> NodeumFileCollection files_children_by_container(container_id, file_parent_id, opts)
|
|
125
|
+
|
|
126
|
+
Lists files under a specific folder.
|
|
127
|
+
|
|
128
|
+
**API Key Scope**: files / index
|
|
129
|
+
|
|
130
|
+
### Example
|
|
131
|
+
|
|
132
|
+
```ruby
|
|
133
|
+
# load the gem
|
|
134
|
+
require 'nodeum_sdk'
|
|
135
|
+
# setup authorization
|
|
136
|
+
Nodeum.configure do |config|
|
|
137
|
+
# Configure HTTP basic authorization: BasicAuth
|
|
138
|
+
config.username = 'YOUR USERNAME'
|
|
139
|
+
config.password = 'YOUR PASSWORD'
|
|
140
|
+
|
|
141
|
+
# Configure API key authorization: BearerAuth
|
|
142
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
143
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
144
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
145
|
+
end
|
|
146
|
+
|
|
147
|
+
api_instance = Nodeum::FilesApi.new
|
|
148
|
+
container_id = 'container_id_example' # String | Numeric ID or name of container.
|
|
149
|
+
file_parent_id = 56 # Integer | Numeric ID of parent folder.
|
|
150
|
+
opts = {
|
|
151
|
+
limit: 56, # Integer | The number of items to display for pagination.
|
|
152
|
+
offset: 56, # Integer | The number of items to skip for pagination.
|
|
153
|
+
file_id: 'file_id_example', # String | Filter on file id
|
|
154
|
+
name: 'name_example', # String | Filter on name
|
|
155
|
+
type: 'type_example', # String | Filter on type
|
|
156
|
+
permission: 'permission_example', # String | Filter on permission
|
|
157
|
+
size: 'size_example', # String | Filter on size
|
|
158
|
+
change_date: 'change_date_example', # String | Filter on change date
|
|
159
|
+
modification_date: 'modification_date_example', # String | Filter on modification date
|
|
160
|
+
access_date: 'access_date_example', # String | Filter on access date
|
|
161
|
+
gid: 'gid_example', # String | Filter on gid
|
|
162
|
+
uid: 'uid_example' # String | Filter on uid
|
|
163
|
+
}
|
|
164
|
+
|
|
165
|
+
begin
|
|
166
|
+
#Lists files under a specific folder.
|
|
167
|
+
result = api_instance.files_children_by_container(container_id, file_parent_id, opts)
|
|
168
|
+
p result
|
|
169
|
+
rescue Nodeum::ApiError => e
|
|
170
|
+
puts "Exception when calling FilesApi->files_children_by_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
|
+
**file_parent_id** | **Integer**| Numeric ID of parent folder. |
|
|
181
|
+
**limit** | **Integer**| The number of items to display for pagination. | [optional]
|
|
182
|
+
**offset** | **Integer**| The number of items to skip for pagination. | [optional]
|
|
183
|
+
**file_id** | **String**| Filter on file id | [optional]
|
|
184
|
+
**name** | **String**| Filter on name | [optional]
|
|
185
|
+
**type** | **String**| Filter on type | [optional]
|
|
186
|
+
**permission** | **String**| Filter on permission | [optional]
|
|
187
|
+
**size** | **String**| Filter on size | [optional]
|
|
188
|
+
**change_date** | **String**| Filter on change date | [optional]
|
|
189
|
+
**modification_date** | **String**| Filter on modification date | [optional]
|
|
190
|
+
**access_date** | **String**| Filter on access date | [optional]
|
|
191
|
+
**gid** | **String**| Filter on gid | [optional]
|
|
192
|
+
**uid** | **String**| Filter on uid | [optional]
|
|
193
|
+
|
|
194
|
+
### Return type
|
|
195
|
+
|
|
196
|
+
[**NodeumFileCollection**](NodeumFileCollection.md)
|
|
197
|
+
|
|
198
|
+
### Authorization
|
|
199
|
+
|
|
200
|
+
[BasicAuth](../README.md#BasicAuth), [BearerAuth](../README.md#BearerAuth)
|
|
201
|
+
|
|
202
|
+
### HTTP request headers
|
|
203
|
+
|
|
204
|
+
- **Content-Type**: Not defined
|
|
205
|
+
- **Accept**: application/json
|
|
206
|
+
|
|
207
|
+
|
|
208
|
+
## files_children_by_pool
|
|
209
|
+
|
|
210
|
+
> NodeumFileCollection files_children_by_pool(pool_id, file_parent_id, opts)
|
|
211
|
+
|
|
212
|
+
Lists files under a specific folder.
|
|
213
|
+
|
|
214
|
+
**API Key Scope**: files / index
|
|
215
|
+
|
|
216
|
+
### Example
|
|
217
|
+
|
|
218
|
+
```ruby
|
|
219
|
+
# load the gem
|
|
220
|
+
require 'nodeum_sdk'
|
|
221
|
+
# setup authorization
|
|
222
|
+
Nodeum.configure do |config|
|
|
223
|
+
# Configure HTTP basic authorization: BasicAuth
|
|
224
|
+
config.username = 'YOUR USERNAME'
|
|
225
|
+
config.password = 'YOUR PASSWORD'
|
|
226
|
+
|
|
227
|
+
# Configure API key authorization: BearerAuth
|
|
228
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
229
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
230
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
231
|
+
end
|
|
232
|
+
|
|
233
|
+
api_instance = Nodeum::FilesApi.new
|
|
234
|
+
pool_id = 'pool_id_example' # String | Numeric ID, or name of pool.
|
|
235
|
+
file_parent_id = 56 # Integer | Numeric ID of parent folder.
|
|
236
|
+
opts = {
|
|
237
|
+
limit: 56, # Integer | The number of items to display for pagination.
|
|
238
|
+
offset: 56, # Integer | The number of items to skip for pagination.
|
|
239
|
+
file_id: 'file_id_example', # String | Filter on file id
|
|
240
|
+
name: 'name_example', # String | Filter on name
|
|
241
|
+
type: 'type_example', # String | Filter on type
|
|
242
|
+
permission: 'permission_example', # String | Filter on permission
|
|
243
|
+
size: 'size_example', # String | Filter on size
|
|
244
|
+
change_date: 'change_date_example', # String | Filter on change date
|
|
245
|
+
modification_date: 'modification_date_example', # String | Filter on modification date
|
|
246
|
+
access_date: 'access_date_example', # String | Filter on access date
|
|
247
|
+
gid: 'gid_example', # String | Filter on gid
|
|
248
|
+
uid: 'uid_example' # String | Filter on uid
|
|
249
|
+
}
|
|
250
|
+
|
|
251
|
+
begin
|
|
252
|
+
#Lists files under a specific folder.
|
|
253
|
+
result = api_instance.files_children_by_pool(pool_id, file_parent_id, opts)
|
|
254
|
+
p result
|
|
255
|
+
rescue Nodeum::ApiError => e
|
|
256
|
+
puts "Exception when calling FilesApi->files_children_by_pool: #{e}"
|
|
257
|
+
end
|
|
258
|
+
```
|
|
259
|
+
|
|
260
|
+
### Parameters
|
|
261
|
+
|
|
262
|
+
|
|
263
|
+
Name | Type | Description | Notes
|
|
264
|
+
------------- | ------------- | ------------- | -------------
|
|
265
|
+
**pool_id** | **String**| Numeric ID, or name of pool. |
|
|
266
|
+
**file_parent_id** | **Integer**| Numeric ID of parent folder. |
|
|
267
|
+
**limit** | **Integer**| The number of items to display for pagination. | [optional]
|
|
268
|
+
**offset** | **Integer**| The number of items to skip for pagination. | [optional]
|
|
269
|
+
**file_id** | **String**| Filter on file id | [optional]
|
|
270
|
+
**name** | **String**| Filter on name | [optional]
|
|
271
|
+
**type** | **String**| Filter on type | [optional]
|
|
272
|
+
**permission** | **String**| Filter on permission | [optional]
|
|
273
|
+
**size** | **String**| Filter on size | [optional]
|
|
274
|
+
**change_date** | **String**| Filter on change date | [optional]
|
|
275
|
+
**modification_date** | **String**| Filter on modification date | [optional]
|
|
276
|
+
**access_date** | **String**| Filter on access date | [optional]
|
|
277
|
+
**gid** | **String**| Filter on gid | [optional]
|
|
278
|
+
**uid** | **String**| Filter on uid | [optional]
|
|
279
|
+
|
|
280
|
+
### Return type
|
|
281
|
+
|
|
282
|
+
[**NodeumFileCollection**](NodeumFileCollection.md)
|
|
283
|
+
|
|
284
|
+
### Authorization
|
|
285
|
+
|
|
286
|
+
[BasicAuth](../README.md#BasicAuth), [BearerAuth](../README.md#BearerAuth)
|
|
287
|
+
|
|
288
|
+
### HTTP request headers
|
|
289
|
+
|
|
290
|
+
- **Content-Type**: Not defined
|
|
291
|
+
- **Accept**: application/json
|
|
292
|
+
|
|
293
|
+
|
|
294
|
+
## files_children_by_task
|
|
295
|
+
|
|
296
|
+
> NodeumFileCollection files_children_by_task(task_id, file_parent_id, opts)
|
|
297
|
+
|
|
298
|
+
Lists files under a specific folder.
|
|
299
|
+
|
|
300
|
+
**API Key Scope**: files / index
|
|
301
|
+
|
|
302
|
+
### Example
|
|
303
|
+
|
|
304
|
+
```ruby
|
|
305
|
+
# load the gem
|
|
306
|
+
require 'nodeum_sdk'
|
|
307
|
+
# setup authorization
|
|
308
|
+
Nodeum.configure do |config|
|
|
309
|
+
# Configure HTTP basic authorization: BasicAuth
|
|
310
|
+
config.username = 'YOUR USERNAME'
|
|
311
|
+
config.password = 'YOUR PASSWORD'
|
|
312
|
+
|
|
313
|
+
# Configure API key authorization: BearerAuth
|
|
314
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
315
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
316
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
317
|
+
end
|
|
318
|
+
|
|
319
|
+
api_instance = Nodeum::FilesApi.new
|
|
320
|
+
task_id = 'task_id_example' # String | Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID.
|
|
321
|
+
file_parent_id = 56 # Integer | Numeric ID of parent folder.
|
|
322
|
+
opts = {
|
|
323
|
+
limit: 56, # Integer | The number of items to display for pagination.
|
|
324
|
+
offset: 56, # Integer | The number of items to skip for pagination.
|
|
325
|
+
file_id: 'file_id_example', # String | Filter on file id
|
|
326
|
+
name: 'name_example', # String | Filter on name
|
|
327
|
+
type: 'type_example', # String | Filter on type
|
|
328
|
+
permission: 'permission_example', # String | Filter on permission
|
|
329
|
+
size: 'size_example', # String | Filter on size
|
|
330
|
+
change_date: 'change_date_example', # String | Filter on change date
|
|
331
|
+
modification_date: 'modification_date_example', # String | Filter on modification date
|
|
332
|
+
access_date: 'access_date_example', # String | Filter on access date
|
|
333
|
+
gid: 'gid_example', # String | Filter on gid
|
|
334
|
+
uid: 'uid_example' # String | Filter on uid
|
|
335
|
+
}
|
|
336
|
+
|
|
337
|
+
begin
|
|
338
|
+
#Lists files under a specific folder.
|
|
339
|
+
result = api_instance.files_children_by_task(task_id, file_parent_id, opts)
|
|
340
|
+
p result
|
|
341
|
+
rescue Nodeum::ApiError => e
|
|
342
|
+
puts "Exception when calling FilesApi->files_children_by_task: #{e}"
|
|
343
|
+
end
|
|
344
|
+
```
|
|
345
|
+
|
|
346
|
+
### Parameters
|
|
347
|
+
|
|
348
|
+
|
|
349
|
+
Name | Type | Description | Notes
|
|
350
|
+
------------- | ------------- | ------------- | -------------
|
|
351
|
+
**task_id** | **String**| Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID. |
|
|
352
|
+
**file_parent_id** | **Integer**| Numeric ID of parent folder. |
|
|
353
|
+
**limit** | **Integer**| The number of items to display for pagination. | [optional]
|
|
354
|
+
**offset** | **Integer**| The number of items to skip for pagination. | [optional]
|
|
355
|
+
**file_id** | **String**| Filter on file id | [optional]
|
|
356
|
+
**name** | **String**| Filter on name | [optional]
|
|
357
|
+
**type** | **String**| Filter on type | [optional]
|
|
358
|
+
**permission** | **String**| Filter on permission | [optional]
|
|
359
|
+
**size** | **String**| Filter on size | [optional]
|
|
360
|
+
**change_date** | **String**| Filter on change date | [optional]
|
|
361
|
+
**modification_date** | **String**| Filter on modification date | [optional]
|
|
362
|
+
**access_date** | **String**| Filter on access date | [optional]
|
|
363
|
+
**gid** | **String**| Filter on gid | [optional]
|
|
364
|
+
**uid** | **String**| Filter on uid | [optional]
|
|
365
|
+
|
|
366
|
+
### Return type
|
|
367
|
+
|
|
368
|
+
[**NodeumFileCollection**](NodeumFileCollection.md)
|
|
369
|
+
|
|
370
|
+
### Authorization
|
|
371
|
+
|
|
372
|
+
[BasicAuth](../README.md#BasicAuth), [BearerAuth](../README.md#BearerAuth)
|
|
373
|
+
|
|
374
|
+
### HTTP request headers
|
|
375
|
+
|
|
376
|
+
- **Content-Type**: Not defined
|
|
377
|
+
- **Accept**: application/json
|
|
378
|
+
|
|
379
|
+
|
|
380
|
+
## files_children_by_task_execution
|
|
381
|
+
|
|
382
|
+
> NodeumFileCollection files_children_by_task_execution(task_execution_id, file_parent_id, opts)
|
|
383
|
+
|
|
384
|
+
Lists files under a specific folder.
|
|
385
|
+
|
|
386
|
+
**API Key Scope**: files / index
|
|
387
|
+
|
|
388
|
+
### Example
|
|
389
|
+
|
|
390
|
+
```ruby
|
|
391
|
+
# load the gem
|
|
392
|
+
require 'nodeum_sdk'
|
|
393
|
+
# setup authorization
|
|
394
|
+
Nodeum.configure do |config|
|
|
395
|
+
# Configure HTTP basic authorization: BasicAuth
|
|
396
|
+
config.username = 'YOUR USERNAME'
|
|
397
|
+
config.password = 'YOUR PASSWORD'
|
|
398
|
+
|
|
399
|
+
# Configure API key authorization: BearerAuth
|
|
400
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
401
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
402
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
403
|
+
end
|
|
404
|
+
|
|
405
|
+
api_instance = Nodeum::FilesApi.new
|
|
406
|
+
task_execution_id = 'task_execution_id_example' # String | Numeric ID of task execution.
|
|
407
|
+
file_parent_id = 56 # Integer | Numeric ID of parent folder.
|
|
408
|
+
opts = {
|
|
409
|
+
limit: 56, # Integer | The number of items to display for pagination.
|
|
410
|
+
offset: 56, # Integer | The number of items to skip for pagination.
|
|
411
|
+
file_id: 'file_id_example', # String | Filter on file id
|
|
412
|
+
name: 'name_example', # String | Filter on name
|
|
413
|
+
type: 'type_example', # String | Filter on type
|
|
414
|
+
permission: 'permission_example', # String | Filter on permission
|
|
415
|
+
size: 'size_example', # String | Filter on size
|
|
416
|
+
change_date: 'change_date_example', # String | Filter on change date
|
|
417
|
+
modification_date: 'modification_date_example', # String | Filter on modification date
|
|
418
|
+
access_date: 'access_date_example', # String | Filter on access date
|
|
419
|
+
gid: 'gid_example', # String | Filter on gid
|
|
420
|
+
uid: 'uid_example' # String | Filter on uid
|
|
421
|
+
}
|
|
422
|
+
|
|
423
|
+
begin
|
|
424
|
+
#Lists files under a specific folder.
|
|
425
|
+
result = api_instance.files_children_by_task_execution(task_execution_id, file_parent_id, opts)
|
|
426
|
+
p result
|
|
427
|
+
rescue Nodeum::ApiError => e
|
|
428
|
+
puts "Exception when calling FilesApi->files_children_by_task_execution: #{e}"
|
|
429
|
+
end
|
|
430
|
+
```
|
|
431
|
+
|
|
432
|
+
### Parameters
|
|
433
|
+
|
|
434
|
+
|
|
435
|
+
Name | Type | Description | Notes
|
|
436
|
+
------------- | ------------- | ------------- | -------------
|
|
437
|
+
**task_execution_id** | **String**| Numeric ID of task execution. |
|
|
438
|
+
**file_parent_id** | **Integer**| Numeric ID of parent folder. |
|
|
439
|
+
**limit** | **Integer**| The number of items to display for pagination. | [optional]
|
|
440
|
+
**offset** | **Integer**| The number of items to skip for pagination. | [optional]
|
|
441
|
+
**file_id** | **String**| Filter on file id | [optional]
|
|
442
|
+
**name** | **String**| Filter on name | [optional]
|
|
443
|
+
**type** | **String**| Filter on type | [optional]
|
|
444
|
+
**permission** | **String**| Filter on permission | [optional]
|
|
445
|
+
**size** | **String**| Filter on size | [optional]
|
|
446
|
+
**change_date** | **String**| Filter on change date | [optional]
|
|
447
|
+
**modification_date** | **String**| Filter on modification date | [optional]
|
|
448
|
+
**access_date** | **String**| Filter on access date | [optional]
|
|
449
|
+
**gid** | **String**| Filter on gid | [optional]
|
|
450
|
+
**uid** | **String**| Filter on uid | [optional]
|
|
451
|
+
|
|
452
|
+
### Return type
|
|
453
|
+
|
|
454
|
+
[**NodeumFileCollection**](NodeumFileCollection.md)
|
|
455
|
+
|
|
456
|
+
### Authorization
|
|
457
|
+
|
|
458
|
+
[BasicAuth](../README.md#BasicAuth), [BearerAuth](../README.md#BearerAuth)
|
|
459
|
+
|
|
460
|
+
### HTTP request headers
|
|
461
|
+
|
|
462
|
+
- **Content-Type**: Not defined
|
|
463
|
+
- **Accept**: application/json
|
|
464
|
+
|
|
465
|
+
|
|
466
|
+
## files_children_by_task_execution_by_task
|
|
467
|
+
|
|
468
|
+
> NodeumFileCollection files_children_by_task_execution_by_task(task_id, task_execution_id, file_parent_id, opts)
|
|
469
|
+
|
|
470
|
+
Lists files under a specific folder.
|
|
471
|
+
|
|
472
|
+
**API Key Scope**: files / index
|
|
473
|
+
|
|
474
|
+
### Example
|
|
475
|
+
|
|
476
|
+
```ruby
|
|
477
|
+
# load the gem
|
|
478
|
+
require 'nodeum_sdk'
|
|
479
|
+
# setup authorization
|
|
480
|
+
Nodeum.configure do |config|
|
|
481
|
+
# Configure HTTP basic authorization: BasicAuth
|
|
482
|
+
config.username = 'YOUR USERNAME'
|
|
483
|
+
config.password = 'YOUR PASSWORD'
|
|
484
|
+
|
|
485
|
+
# Configure API key authorization: BearerAuth
|
|
486
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
487
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
488
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
489
|
+
end
|
|
490
|
+
|
|
491
|
+
api_instance = Nodeum::FilesApi.new
|
|
492
|
+
task_id = 'task_id_example' # String | Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID.
|
|
493
|
+
task_execution_id = 'task_execution_id_example' # String | Numeric ID of task execution.
|
|
494
|
+
file_parent_id = 56 # Integer | Numeric ID of parent folder.
|
|
495
|
+
opts = {
|
|
496
|
+
limit: 56, # Integer | The number of items to display for pagination.
|
|
497
|
+
offset: 56, # Integer | The number of items to skip for pagination.
|
|
498
|
+
file_id: 'file_id_example', # String | Filter on file id
|
|
499
|
+
name: 'name_example', # String | Filter on name
|
|
500
|
+
type: 'type_example', # String | Filter on type
|
|
501
|
+
permission: 'permission_example', # String | Filter on permission
|
|
502
|
+
size: 'size_example', # String | Filter on size
|
|
503
|
+
change_date: 'change_date_example', # String | Filter on change date
|
|
504
|
+
modification_date: 'modification_date_example', # String | Filter on modification date
|
|
505
|
+
access_date: 'access_date_example', # String | Filter on access date
|
|
506
|
+
gid: 'gid_example', # String | Filter on gid
|
|
507
|
+
uid: 'uid_example' # String | Filter on uid
|
|
508
|
+
}
|
|
509
|
+
|
|
510
|
+
begin
|
|
511
|
+
#Lists files under a specific folder.
|
|
512
|
+
result = api_instance.files_children_by_task_execution_by_task(task_id, task_execution_id, file_parent_id, opts)
|
|
513
|
+
p result
|
|
514
|
+
rescue Nodeum::ApiError => e
|
|
515
|
+
puts "Exception when calling FilesApi->files_children_by_task_execution_by_task: #{e}"
|
|
516
|
+
end
|
|
517
|
+
```
|
|
518
|
+
|
|
519
|
+
### Parameters
|
|
520
|
+
|
|
521
|
+
|
|
522
|
+
Name | Type | Description | Notes
|
|
523
|
+
------------- | ------------- | ------------- | -------------
|
|
524
|
+
**task_id** | **String**| Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID. |
|
|
525
|
+
**task_execution_id** | **String**| Numeric ID of task execution. |
|
|
526
|
+
**file_parent_id** | **Integer**| Numeric ID of parent folder. |
|
|
527
|
+
**limit** | **Integer**| The number of items to display for pagination. | [optional]
|
|
528
|
+
**offset** | **Integer**| The number of items to skip for pagination. | [optional]
|
|
529
|
+
**file_id** | **String**| Filter on file id | [optional]
|
|
530
|
+
**name** | **String**| Filter on name | [optional]
|
|
531
|
+
**type** | **String**| Filter on type | [optional]
|
|
532
|
+
**permission** | **String**| Filter on permission | [optional]
|
|
533
|
+
**size** | **String**| Filter on size | [optional]
|
|
534
|
+
**change_date** | **String**| Filter on change date | [optional]
|
|
535
|
+
**modification_date** | **String**| Filter on modification date | [optional]
|
|
536
|
+
**access_date** | **String**| Filter on access date | [optional]
|
|
537
|
+
**gid** | **String**| Filter on gid | [optional]
|
|
538
|
+
**uid** | **String**| Filter on uid | [optional]
|
|
539
|
+
|
|
540
|
+
### Return type
|
|
541
|
+
|
|
542
|
+
[**NodeumFileCollection**](NodeumFileCollection.md)
|
|
543
|
+
|
|
544
|
+
### Authorization
|
|
545
|
+
|
|
546
|
+
[BasicAuth](../README.md#BasicAuth), [BearerAuth](../README.md#BearerAuth)
|
|
547
|
+
|
|
548
|
+
### HTTP request headers
|
|
549
|
+
|
|
550
|
+
- **Content-Type**: Not defined
|
|
551
|
+
- **Accept**: application/json
|
|
552
|
+
|
|
553
|
+
|
|
554
|
+
## import_files_children_by_pool
|
|
555
|
+
|
|
556
|
+
> ImportFileCollection import_files_children_by_pool(pool_id, file_parent_id, opts)
|
|
557
|
+
|
|
558
|
+
Lists files under a specific folder on tape of pools, specific for Data Exchange.
|
|
559
|
+
|
|
560
|
+
**API Key Scope**: import_files / index
|
|
561
|
+
|
|
562
|
+
### Example
|
|
563
|
+
|
|
564
|
+
```ruby
|
|
565
|
+
# load the gem
|
|
566
|
+
require 'nodeum_sdk'
|
|
567
|
+
# setup authorization
|
|
568
|
+
Nodeum.configure do |config|
|
|
569
|
+
# Configure HTTP basic authorization: BasicAuth
|
|
570
|
+
config.username = 'YOUR USERNAME'
|
|
571
|
+
config.password = 'YOUR PASSWORD'
|
|
572
|
+
|
|
573
|
+
# Configure API key authorization: BearerAuth
|
|
574
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
575
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
576
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
577
|
+
end
|
|
578
|
+
|
|
579
|
+
api_instance = Nodeum::FilesApi.new
|
|
580
|
+
pool_id = 'pool_id_example' # String | Numeric ID, or name of pool.
|
|
581
|
+
file_parent_id = 56 # Integer | Numeric ID of parent folder.
|
|
582
|
+
opts = {
|
|
583
|
+
limit: 56, # Integer | The number of items to display for pagination.
|
|
584
|
+
offset: 56, # Integer | The number of items to skip for pagination.
|
|
585
|
+
file_id: 'file_id_example', # String | Filter on file id
|
|
586
|
+
name: 'name_example', # String | Filter on name
|
|
587
|
+
type: 'type_example', # String | Filter on type
|
|
588
|
+
permission: 'permission_example', # String | Filter on permission
|
|
589
|
+
size: 'size_example', # String | Filter on size
|
|
590
|
+
change_date: 'change_date_example', # String | Filter on change date
|
|
591
|
+
modification_date: 'modification_date_example', # String | Filter on modification date
|
|
592
|
+
access_date: 'access_date_example', # String | Filter on access date
|
|
593
|
+
gid: 'gid_example', # String | Filter on gid
|
|
594
|
+
uid: 'uid_example' # String | Filter on uid
|
|
595
|
+
}
|
|
596
|
+
|
|
597
|
+
begin
|
|
598
|
+
#Lists files under a specific folder on tape of pools, specific for Data Exchange.
|
|
599
|
+
result = api_instance.import_files_children_by_pool(pool_id, file_parent_id, opts)
|
|
600
|
+
p result
|
|
601
|
+
rescue Nodeum::ApiError => e
|
|
602
|
+
puts "Exception when calling FilesApi->import_files_children_by_pool: #{e}"
|
|
603
|
+
end
|
|
604
|
+
```
|
|
605
|
+
|
|
606
|
+
### Parameters
|
|
607
|
+
|
|
608
|
+
|
|
609
|
+
Name | Type | Description | Notes
|
|
610
|
+
------------- | ------------- | ------------- | -------------
|
|
611
|
+
**pool_id** | **String**| Numeric ID, or name of pool. |
|
|
612
|
+
**file_parent_id** | **Integer**| Numeric ID of parent folder. |
|
|
613
|
+
**limit** | **Integer**| The number of items to display for pagination. | [optional]
|
|
614
|
+
**offset** | **Integer**| The number of items to skip for pagination. | [optional]
|
|
615
|
+
**file_id** | **String**| Filter on file id | [optional]
|
|
616
|
+
**name** | **String**| Filter on name | [optional]
|
|
617
|
+
**type** | **String**| Filter on type | [optional]
|
|
618
|
+
**permission** | **String**| Filter on permission | [optional]
|
|
619
|
+
**size** | **String**| Filter on size | [optional]
|
|
620
|
+
**change_date** | **String**| Filter on change date | [optional]
|
|
621
|
+
**modification_date** | **String**| Filter on modification date | [optional]
|
|
622
|
+
**access_date** | **String**| Filter on access date | [optional]
|
|
623
|
+
**gid** | **String**| Filter on gid | [optional]
|
|
624
|
+
**uid** | **String**| Filter on uid | [optional]
|
|
625
|
+
|
|
626
|
+
### Return type
|
|
627
|
+
|
|
628
|
+
[**ImportFileCollection**](ImportFileCollection.md)
|
|
629
|
+
|
|
630
|
+
### Authorization
|
|
631
|
+
|
|
632
|
+
[BasicAuth](../README.md#BasicAuth), [BearerAuth](../README.md#BearerAuth)
|
|
633
|
+
|
|
634
|
+
### HTTP request headers
|
|
635
|
+
|
|
636
|
+
- **Content-Type**: Not defined
|
|
637
|
+
- **Accept**: application/json
|
|
638
|
+
|
|
639
|
+
|
|
640
|
+
## index_files
|
|
641
|
+
|
|
642
|
+
> NodeumFileCollection index_files(opts)
|
|
643
|
+
|
|
644
|
+
Lists files on root.
|
|
645
|
+
|
|
646
|
+
**API Key Scope**: files / index
|
|
647
|
+
|
|
648
|
+
### Example
|
|
649
|
+
|
|
650
|
+
```ruby
|
|
651
|
+
# load the gem
|
|
652
|
+
require 'nodeum_sdk'
|
|
653
|
+
# setup authorization
|
|
654
|
+
Nodeum.configure do |config|
|
|
655
|
+
# Configure HTTP basic authorization: BasicAuth
|
|
656
|
+
config.username = 'YOUR USERNAME'
|
|
657
|
+
config.password = 'YOUR PASSWORD'
|
|
658
|
+
|
|
659
|
+
# Configure API key authorization: BearerAuth
|
|
660
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
661
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
662
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
663
|
+
end
|
|
664
|
+
|
|
665
|
+
api_instance = Nodeum::FilesApi.new
|
|
666
|
+
opts = {
|
|
667
|
+
limit: 56, # Integer | The number of items to display for pagination.
|
|
668
|
+
offset: 56, # Integer | The number of items to skip for pagination.
|
|
669
|
+
file_id: 'file_id_example', # String | Filter on file id
|
|
670
|
+
name: 'name_example', # String | Filter on name
|
|
671
|
+
type: 'type_example', # String | Filter on type
|
|
672
|
+
permission: 'permission_example', # String | Filter on permission
|
|
673
|
+
size: 'size_example', # String | Filter on size
|
|
674
|
+
change_date: 'change_date_example', # String | Filter on change date
|
|
675
|
+
modification_date: 'modification_date_example', # String | Filter on modification date
|
|
676
|
+
access_date: 'access_date_example', # String | Filter on access date
|
|
677
|
+
gid: 'gid_example', # String | Filter on gid
|
|
678
|
+
uid: 'uid_example' # String | Filter on uid
|
|
679
|
+
}
|
|
680
|
+
|
|
681
|
+
begin
|
|
682
|
+
#Lists files on root.
|
|
683
|
+
result = api_instance.index_files(opts)
|
|
684
|
+
p result
|
|
685
|
+
rescue Nodeum::ApiError => e
|
|
686
|
+
puts "Exception when calling FilesApi->index_files: #{e}"
|
|
687
|
+
end
|
|
688
|
+
```
|
|
689
|
+
|
|
690
|
+
### Parameters
|
|
691
|
+
|
|
692
|
+
|
|
693
|
+
Name | Type | Description | Notes
|
|
694
|
+
------------- | ------------- | ------------- | -------------
|
|
695
|
+
**limit** | **Integer**| The number of items to display for pagination. | [optional]
|
|
696
|
+
**offset** | **Integer**| The number of items to skip for pagination. | [optional]
|
|
697
|
+
**file_id** | **String**| Filter on file id | [optional]
|
|
698
|
+
**name** | **String**| Filter on name | [optional]
|
|
699
|
+
**type** | **String**| Filter on type | [optional]
|
|
700
|
+
**permission** | **String**| Filter on permission | [optional]
|
|
701
|
+
**size** | **String**| Filter on size | [optional]
|
|
702
|
+
**change_date** | **String**| Filter on change date | [optional]
|
|
703
|
+
**modification_date** | **String**| Filter on modification date | [optional]
|
|
704
|
+
**access_date** | **String**| Filter on access date | [optional]
|
|
705
|
+
**gid** | **String**| Filter on gid | [optional]
|
|
706
|
+
**uid** | **String**| Filter on uid | [optional]
|
|
707
|
+
|
|
708
|
+
### Return type
|
|
709
|
+
|
|
710
|
+
[**NodeumFileCollection**](NodeumFileCollection.md)
|
|
711
|
+
|
|
712
|
+
### Authorization
|
|
713
|
+
|
|
714
|
+
[BasicAuth](../README.md#BasicAuth), [BearerAuth](../README.md#BearerAuth)
|
|
715
|
+
|
|
716
|
+
### HTTP request headers
|
|
717
|
+
|
|
718
|
+
- **Content-Type**: Not defined
|
|
719
|
+
- **Accept**: application/json
|
|
720
|
+
|
|
721
|
+
|
|
722
|
+
## index_files_by_container
|
|
723
|
+
|
|
724
|
+
> NodeumFileCollection index_files_by_container(container_id, opts)
|
|
725
|
+
|
|
726
|
+
Lists files on root.
|
|
727
|
+
|
|
728
|
+
**API Key Scope**: files / index
|
|
729
|
+
|
|
730
|
+
### Example
|
|
731
|
+
|
|
732
|
+
```ruby
|
|
733
|
+
# load the gem
|
|
734
|
+
require 'nodeum_sdk'
|
|
735
|
+
# setup authorization
|
|
736
|
+
Nodeum.configure do |config|
|
|
737
|
+
# Configure HTTP basic authorization: BasicAuth
|
|
738
|
+
config.username = 'YOUR USERNAME'
|
|
739
|
+
config.password = 'YOUR PASSWORD'
|
|
740
|
+
|
|
741
|
+
# Configure API key authorization: BearerAuth
|
|
742
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
743
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
744
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
745
|
+
end
|
|
746
|
+
|
|
747
|
+
api_instance = Nodeum::FilesApi.new
|
|
748
|
+
container_id = 'container_id_example' # String | Numeric ID or name of container.
|
|
749
|
+
opts = {
|
|
750
|
+
limit: 56, # Integer | The number of items to display for pagination.
|
|
751
|
+
offset: 56, # Integer | The number of items to skip for pagination.
|
|
752
|
+
file_id: 'file_id_example', # String | Filter on file id
|
|
753
|
+
name: 'name_example', # String | Filter on name
|
|
754
|
+
type: 'type_example', # String | Filter on type
|
|
755
|
+
permission: 'permission_example', # String | Filter on permission
|
|
756
|
+
size: 'size_example', # String | Filter on size
|
|
757
|
+
change_date: 'change_date_example', # String | Filter on change date
|
|
758
|
+
modification_date: 'modification_date_example', # String | Filter on modification date
|
|
759
|
+
access_date: 'access_date_example', # String | Filter on access date
|
|
760
|
+
gid: 'gid_example', # String | Filter on gid
|
|
761
|
+
uid: 'uid_example' # String | Filter on uid
|
|
762
|
+
}
|
|
763
|
+
|
|
764
|
+
begin
|
|
765
|
+
#Lists files on root.
|
|
766
|
+
result = api_instance.index_files_by_container(container_id, opts)
|
|
767
|
+
p result
|
|
768
|
+
rescue Nodeum::ApiError => e
|
|
769
|
+
puts "Exception when calling FilesApi->index_files_by_container: #{e}"
|
|
770
|
+
end
|
|
771
|
+
```
|
|
772
|
+
|
|
773
|
+
### Parameters
|
|
774
|
+
|
|
775
|
+
|
|
776
|
+
Name | Type | Description | Notes
|
|
777
|
+
------------- | ------------- | ------------- | -------------
|
|
778
|
+
**container_id** | **String**| Numeric ID or name of container. |
|
|
779
|
+
**limit** | **Integer**| The number of items to display for pagination. | [optional]
|
|
780
|
+
**offset** | **Integer**| The number of items to skip for pagination. | [optional]
|
|
781
|
+
**file_id** | **String**| Filter on file id | [optional]
|
|
782
|
+
**name** | **String**| Filter on name | [optional]
|
|
783
|
+
**type** | **String**| Filter on type | [optional]
|
|
784
|
+
**permission** | **String**| Filter on permission | [optional]
|
|
785
|
+
**size** | **String**| Filter on size | [optional]
|
|
786
|
+
**change_date** | **String**| Filter on change date | [optional]
|
|
787
|
+
**modification_date** | **String**| Filter on modification date | [optional]
|
|
788
|
+
**access_date** | **String**| Filter on access date | [optional]
|
|
789
|
+
**gid** | **String**| Filter on gid | [optional]
|
|
790
|
+
**uid** | **String**| Filter on uid | [optional]
|
|
791
|
+
|
|
792
|
+
### Return type
|
|
793
|
+
|
|
794
|
+
[**NodeumFileCollection**](NodeumFileCollection.md)
|
|
795
|
+
|
|
796
|
+
### Authorization
|
|
797
|
+
|
|
798
|
+
[BasicAuth](../README.md#BasicAuth), [BearerAuth](../README.md#BearerAuth)
|
|
799
|
+
|
|
800
|
+
### HTTP request headers
|
|
801
|
+
|
|
802
|
+
- **Content-Type**: Not defined
|
|
803
|
+
- **Accept**: application/json
|
|
804
|
+
|
|
805
|
+
|
|
806
|
+
## index_files_by_pool
|
|
807
|
+
|
|
808
|
+
> NodeumFileCollection index_files_by_pool(pool_id, opts)
|
|
809
|
+
|
|
810
|
+
Lists files on root.
|
|
811
|
+
|
|
812
|
+
**API Key Scope**: files / index
|
|
813
|
+
|
|
814
|
+
### Example
|
|
815
|
+
|
|
816
|
+
```ruby
|
|
817
|
+
# load the gem
|
|
818
|
+
require 'nodeum_sdk'
|
|
819
|
+
# setup authorization
|
|
820
|
+
Nodeum.configure do |config|
|
|
821
|
+
# Configure HTTP basic authorization: BasicAuth
|
|
822
|
+
config.username = 'YOUR USERNAME'
|
|
823
|
+
config.password = 'YOUR PASSWORD'
|
|
824
|
+
|
|
825
|
+
# Configure API key authorization: BearerAuth
|
|
826
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
827
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
828
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
829
|
+
end
|
|
830
|
+
|
|
831
|
+
api_instance = Nodeum::FilesApi.new
|
|
832
|
+
pool_id = 'pool_id_example' # String | Numeric ID, or name of pool.
|
|
833
|
+
opts = {
|
|
834
|
+
limit: 56, # Integer | The number of items to display for pagination.
|
|
835
|
+
offset: 56, # Integer | The number of items to skip for pagination.
|
|
836
|
+
file_id: 'file_id_example', # String | Filter on file id
|
|
837
|
+
name: 'name_example', # String | Filter on name
|
|
838
|
+
type: 'type_example', # String | Filter on type
|
|
839
|
+
permission: 'permission_example', # String | Filter on permission
|
|
840
|
+
size: 'size_example', # String | Filter on size
|
|
841
|
+
change_date: 'change_date_example', # String | Filter on change date
|
|
842
|
+
modification_date: 'modification_date_example', # String | Filter on modification date
|
|
843
|
+
access_date: 'access_date_example', # String | Filter on access date
|
|
844
|
+
gid: 'gid_example', # String | Filter on gid
|
|
845
|
+
uid: 'uid_example' # String | Filter on uid
|
|
846
|
+
}
|
|
847
|
+
|
|
848
|
+
begin
|
|
849
|
+
#Lists files on root.
|
|
850
|
+
result = api_instance.index_files_by_pool(pool_id, opts)
|
|
851
|
+
p result
|
|
852
|
+
rescue Nodeum::ApiError => e
|
|
853
|
+
puts "Exception when calling FilesApi->index_files_by_pool: #{e}"
|
|
854
|
+
end
|
|
855
|
+
```
|
|
856
|
+
|
|
857
|
+
### Parameters
|
|
858
|
+
|
|
859
|
+
|
|
860
|
+
Name | Type | Description | Notes
|
|
861
|
+
------------- | ------------- | ------------- | -------------
|
|
862
|
+
**pool_id** | **String**| Numeric ID, or name of pool. |
|
|
863
|
+
**limit** | **Integer**| The number of items to display for pagination. | [optional]
|
|
864
|
+
**offset** | **Integer**| The number of items to skip for pagination. | [optional]
|
|
865
|
+
**file_id** | **String**| Filter on file id | [optional]
|
|
866
|
+
**name** | **String**| Filter on name | [optional]
|
|
867
|
+
**type** | **String**| Filter on type | [optional]
|
|
868
|
+
**permission** | **String**| Filter on permission | [optional]
|
|
869
|
+
**size** | **String**| Filter on size | [optional]
|
|
870
|
+
**change_date** | **String**| Filter on change date | [optional]
|
|
871
|
+
**modification_date** | **String**| Filter on modification date | [optional]
|
|
872
|
+
**access_date** | **String**| Filter on access date | [optional]
|
|
873
|
+
**gid** | **String**| Filter on gid | [optional]
|
|
874
|
+
**uid** | **String**| Filter on uid | [optional]
|
|
875
|
+
|
|
876
|
+
### Return type
|
|
877
|
+
|
|
878
|
+
[**NodeumFileCollection**](NodeumFileCollection.md)
|
|
879
|
+
|
|
880
|
+
### Authorization
|
|
881
|
+
|
|
882
|
+
[BasicAuth](../README.md#BasicAuth), [BearerAuth](../README.md#BearerAuth)
|
|
883
|
+
|
|
884
|
+
### HTTP request headers
|
|
885
|
+
|
|
886
|
+
- **Content-Type**: Not defined
|
|
887
|
+
- **Accept**: application/json
|
|
888
|
+
|
|
889
|
+
|
|
890
|
+
## index_files_by_task
|
|
891
|
+
|
|
892
|
+
> NodeumFileCollection index_files_by_task(task_id, opts)
|
|
893
|
+
|
|
894
|
+
Lists files on root.
|
|
895
|
+
|
|
896
|
+
**API Key Scope**: files / index
|
|
897
|
+
|
|
898
|
+
### Example
|
|
899
|
+
|
|
900
|
+
```ruby
|
|
901
|
+
# load the gem
|
|
902
|
+
require 'nodeum_sdk'
|
|
903
|
+
# setup authorization
|
|
904
|
+
Nodeum.configure do |config|
|
|
905
|
+
# Configure HTTP basic authorization: BasicAuth
|
|
906
|
+
config.username = 'YOUR USERNAME'
|
|
907
|
+
config.password = 'YOUR PASSWORD'
|
|
908
|
+
|
|
909
|
+
# Configure API key authorization: BearerAuth
|
|
910
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
911
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
912
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
913
|
+
end
|
|
914
|
+
|
|
915
|
+
api_instance = Nodeum::FilesApi.new
|
|
916
|
+
task_id = 'task_id_example' # String | Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID.
|
|
917
|
+
opts = {
|
|
918
|
+
limit: 56, # Integer | The number of items to display for pagination.
|
|
919
|
+
offset: 56, # Integer | The number of items to skip for pagination.
|
|
920
|
+
file_id: 'file_id_example', # String | Filter on file id
|
|
921
|
+
name: 'name_example', # String | Filter on name
|
|
922
|
+
type: 'type_example', # String | Filter on type
|
|
923
|
+
permission: 'permission_example', # String | Filter on permission
|
|
924
|
+
size: 'size_example', # String | Filter on size
|
|
925
|
+
change_date: 'change_date_example', # String | Filter on change date
|
|
926
|
+
modification_date: 'modification_date_example', # String | Filter on modification date
|
|
927
|
+
access_date: 'access_date_example', # String | Filter on access date
|
|
928
|
+
gid: 'gid_example', # String | Filter on gid
|
|
929
|
+
uid: 'uid_example' # String | Filter on uid
|
|
930
|
+
}
|
|
931
|
+
|
|
932
|
+
begin
|
|
933
|
+
#Lists files on root.
|
|
934
|
+
result = api_instance.index_files_by_task(task_id, opts)
|
|
935
|
+
p result
|
|
936
|
+
rescue Nodeum::ApiError => e
|
|
937
|
+
puts "Exception when calling FilesApi->index_files_by_task: #{e}"
|
|
938
|
+
end
|
|
939
|
+
```
|
|
940
|
+
|
|
941
|
+
### Parameters
|
|
942
|
+
|
|
943
|
+
|
|
944
|
+
Name | Type | Description | Notes
|
|
945
|
+
------------- | ------------- | ------------- | -------------
|
|
946
|
+
**task_id** | **String**| Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID. |
|
|
947
|
+
**limit** | **Integer**| The number of items to display for pagination. | [optional]
|
|
948
|
+
**offset** | **Integer**| The number of items to skip for pagination. | [optional]
|
|
949
|
+
**file_id** | **String**| Filter on file id | [optional]
|
|
950
|
+
**name** | **String**| Filter on name | [optional]
|
|
951
|
+
**type** | **String**| Filter on type | [optional]
|
|
952
|
+
**permission** | **String**| Filter on permission | [optional]
|
|
953
|
+
**size** | **String**| Filter on size | [optional]
|
|
954
|
+
**change_date** | **String**| Filter on change date | [optional]
|
|
955
|
+
**modification_date** | **String**| Filter on modification date | [optional]
|
|
956
|
+
**access_date** | **String**| Filter on access date | [optional]
|
|
957
|
+
**gid** | **String**| Filter on gid | [optional]
|
|
958
|
+
**uid** | **String**| Filter on uid | [optional]
|
|
959
|
+
|
|
960
|
+
### Return type
|
|
961
|
+
|
|
962
|
+
[**NodeumFileCollection**](NodeumFileCollection.md)
|
|
963
|
+
|
|
964
|
+
### Authorization
|
|
965
|
+
|
|
966
|
+
[BasicAuth](../README.md#BasicAuth), [BearerAuth](../README.md#BearerAuth)
|
|
967
|
+
|
|
968
|
+
### HTTP request headers
|
|
969
|
+
|
|
970
|
+
- **Content-Type**: Not defined
|
|
971
|
+
- **Accept**: application/json
|
|
972
|
+
|
|
973
|
+
|
|
974
|
+
## index_files_by_task_execution
|
|
975
|
+
|
|
976
|
+
> NodeumFileCollection index_files_by_task_execution(task_execution_id, opts)
|
|
977
|
+
|
|
978
|
+
Lists files on root.
|
|
979
|
+
|
|
980
|
+
**API Key Scope**: files / index
|
|
981
|
+
|
|
982
|
+
### Example
|
|
983
|
+
|
|
984
|
+
```ruby
|
|
985
|
+
# load the gem
|
|
986
|
+
require 'nodeum_sdk'
|
|
987
|
+
# setup authorization
|
|
988
|
+
Nodeum.configure do |config|
|
|
989
|
+
# Configure HTTP basic authorization: BasicAuth
|
|
990
|
+
config.username = 'YOUR USERNAME'
|
|
991
|
+
config.password = 'YOUR PASSWORD'
|
|
992
|
+
|
|
993
|
+
# Configure API key authorization: BearerAuth
|
|
994
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
995
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
996
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
997
|
+
end
|
|
998
|
+
|
|
999
|
+
api_instance = Nodeum::FilesApi.new
|
|
1000
|
+
task_execution_id = 'task_execution_id_example' # String | Numeric ID of task execution.
|
|
1001
|
+
opts = {
|
|
1002
|
+
limit: 56, # Integer | The number of items to display for pagination.
|
|
1003
|
+
offset: 56, # Integer | The number of items to skip for pagination.
|
|
1004
|
+
file_id: 'file_id_example', # String | Filter on file id
|
|
1005
|
+
name: 'name_example', # String | Filter on name
|
|
1006
|
+
type: 'type_example', # String | Filter on type
|
|
1007
|
+
permission: 'permission_example', # String | Filter on permission
|
|
1008
|
+
size: 'size_example', # String | Filter on size
|
|
1009
|
+
change_date: 'change_date_example', # String | Filter on change date
|
|
1010
|
+
modification_date: 'modification_date_example', # String | Filter on modification date
|
|
1011
|
+
access_date: 'access_date_example', # String | Filter on access date
|
|
1012
|
+
gid: 'gid_example', # String | Filter on gid
|
|
1013
|
+
uid: 'uid_example' # String | Filter on uid
|
|
1014
|
+
}
|
|
1015
|
+
|
|
1016
|
+
begin
|
|
1017
|
+
#Lists files on root.
|
|
1018
|
+
result = api_instance.index_files_by_task_execution(task_execution_id, opts)
|
|
1019
|
+
p result
|
|
1020
|
+
rescue Nodeum::ApiError => e
|
|
1021
|
+
puts "Exception when calling FilesApi->index_files_by_task_execution: #{e}"
|
|
1022
|
+
end
|
|
1023
|
+
```
|
|
1024
|
+
|
|
1025
|
+
### Parameters
|
|
1026
|
+
|
|
1027
|
+
|
|
1028
|
+
Name | Type | Description | Notes
|
|
1029
|
+
------------- | ------------- | ------------- | -------------
|
|
1030
|
+
**task_execution_id** | **String**| Numeric ID of task execution. |
|
|
1031
|
+
**limit** | **Integer**| The number of items to display for pagination. | [optional]
|
|
1032
|
+
**offset** | **Integer**| The number of items to skip for pagination. | [optional]
|
|
1033
|
+
**file_id** | **String**| Filter on file id | [optional]
|
|
1034
|
+
**name** | **String**| Filter on name | [optional]
|
|
1035
|
+
**type** | **String**| Filter on type | [optional]
|
|
1036
|
+
**permission** | **String**| Filter on permission | [optional]
|
|
1037
|
+
**size** | **String**| Filter on size | [optional]
|
|
1038
|
+
**change_date** | **String**| Filter on change date | [optional]
|
|
1039
|
+
**modification_date** | **String**| Filter on modification date | [optional]
|
|
1040
|
+
**access_date** | **String**| Filter on access date | [optional]
|
|
1041
|
+
**gid** | **String**| Filter on gid | [optional]
|
|
1042
|
+
**uid** | **String**| Filter on uid | [optional]
|
|
1043
|
+
|
|
1044
|
+
### Return type
|
|
1045
|
+
|
|
1046
|
+
[**NodeumFileCollection**](NodeumFileCollection.md)
|
|
1047
|
+
|
|
1048
|
+
### Authorization
|
|
1049
|
+
|
|
1050
|
+
[BasicAuth](../README.md#BasicAuth), [BearerAuth](../README.md#BearerAuth)
|
|
1051
|
+
|
|
1052
|
+
### HTTP request headers
|
|
1053
|
+
|
|
1054
|
+
- **Content-Type**: Not defined
|
|
1055
|
+
- **Accept**: application/json
|
|
1056
|
+
|
|
1057
|
+
|
|
1058
|
+
## index_files_by_task_execution_by_task
|
|
1059
|
+
|
|
1060
|
+
> NodeumFileCollection index_files_by_task_execution_by_task(task_id, task_execution_id, opts)
|
|
1061
|
+
|
|
1062
|
+
Lists files on root.
|
|
1063
|
+
|
|
1064
|
+
**API Key Scope**: files / index
|
|
1065
|
+
|
|
1066
|
+
### Example
|
|
1067
|
+
|
|
1068
|
+
```ruby
|
|
1069
|
+
# load the gem
|
|
1070
|
+
require 'nodeum_sdk'
|
|
1071
|
+
# setup authorization
|
|
1072
|
+
Nodeum.configure do |config|
|
|
1073
|
+
# Configure HTTP basic authorization: BasicAuth
|
|
1074
|
+
config.username = 'YOUR USERNAME'
|
|
1075
|
+
config.password = 'YOUR PASSWORD'
|
|
1076
|
+
|
|
1077
|
+
# Configure API key authorization: BearerAuth
|
|
1078
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
1079
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1080
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
1081
|
+
end
|
|
1082
|
+
|
|
1083
|
+
api_instance = Nodeum::FilesApi.new
|
|
1084
|
+
task_id = 'task_id_example' # String | Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID.
|
|
1085
|
+
task_execution_id = 'task_execution_id_example' # String | Numeric ID of task execution.
|
|
1086
|
+
opts = {
|
|
1087
|
+
limit: 56, # Integer | The number of items to display for pagination.
|
|
1088
|
+
offset: 56, # Integer | The number of items to skip for pagination.
|
|
1089
|
+
file_id: 'file_id_example', # String | Filter on file id
|
|
1090
|
+
name: 'name_example', # String | Filter on name
|
|
1091
|
+
type: 'type_example', # String | Filter on type
|
|
1092
|
+
permission: 'permission_example', # String | Filter on permission
|
|
1093
|
+
size: 'size_example', # String | Filter on size
|
|
1094
|
+
change_date: 'change_date_example', # String | Filter on change date
|
|
1095
|
+
modification_date: 'modification_date_example', # String | Filter on modification date
|
|
1096
|
+
access_date: 'access_date_example', # String | Filter on access date
|
|
1097
|
+
gid: 'gid_example', # String | Filter on gid
|
|
1098
|
+
uid: 'uid_example' # String | Filter on uid
|
|
1099
|
+
}
|
|
1100
|
+
|
|
1101
|
+
begin
|
|
1102
|
+
#Lists files on root.
|
|
1103
|
+
result = api_instance.index_files_by_task_execution_by_task(task_id, task_execution_id, opts)
|
|
1104
|
+
p result
|
|
1105
|
+
rescue Nodeum::ApiError => e
|
|
1106
|
+
puts "Exception when calling FilesApi->index_files_by_task_execution_by_task: #{e}"
|
|
1107
|
+
end
|
|
1108
|
+
```
|
|
1109
|
+
|
|
1110
|
+
### Parameters
|
|
1111
|
+
|
|
1112
|
+
|
|
1113
|
+
Name | Type | Description | Notes
|
|
1114
|
+
------------- | ------------- | ------------- | -------------
|
|
1115
|
+
**task_id** | **String**| Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID. |
|
|
1116
|
+
**task_execution_id** | **String**| Numeric ID of task execution. |
|
|
1117
|
+
**limit** | **Integer**| The number of items to display for pagination. | [optional]
|
|
1118
|
+
**offset** | **Integer**| The number of items to skip for pagination. | [optional]
|
|
1119
|
+
**file_id** | **String**| Filter on file id | [optional]
|
|
1120
|
+
**name** | **String**| Filter on name | [optional]
|
|
1121
|
+
**type** | **String**| Filter on type | [optional]
|
|
1122
|
+
**permission** | **String**| Filter on permission | [optional]
|
|
1123
|
+
**size** | **String**| Filter on size | [optional]
|
|
1124
|
+
**change_date** | **String**| Filter on change date | [optional]
|
|
1125
|
+
**modification_date** | **String**| Filter on modification date | [optional]
|
|
1126
|
+
**access_date** | **String**| Filter on access date | [optional]
|
|
1127
|
+
**gid** | **String**| Filter on gid | [optional]
|
|
1128
|
+
**uid** | **String**| Filter on uid | [optional]
|
|
1129
|
+
|
|
1130
|
+
### Return type
|
|
1131
|
+
|
|
1132
|
+
[**NodeumFileCollection**](NodeumFileCollection.md)
|
|
1133
|
+
|
|
1134
|
+
### Authorization
|
|
1135
|
+
|
|
1136
|
+
[BasicAuth](../README.md#BasicAuth), [BearerAuth](../README.md#BearerAuth)
|
|
1137
|
+
|
|
1138
|
+
### HTTP request headers
|
|
1139
|
+
|
|
1140
|
+
- **Content-Type**: Not defined
|
|
1141
|
+
- **Accept**: application/json
|
|
1142
|
+
|
|
1143
|
+
|
|
1144
|
+
## index_import_files_by_pool
|
|
1145
|
+
|
|
1146
|
+
> ImportFileCollection index_import_files_by_pool(pool_id, opts)
|
|
1147
|
+
|
|
1148
|
+
Lists files on root of tape of pools, specific for Data Exchange.
|
|
1149
|
+
|
|
1150
|
+
**API Key Scope**: import_files / index
|
|
1151
|
+
|
|
1152
|
+
### Example
|
|
1153
|
+
|
|
1154
|
+
```ruby
|
|
1155
|
+
# load the gem
|
|
1156
|
+
require 'nodeum_sdk'
|
|
1157
|
+
# setup authorization
|
|
1158
|
+
Nodeum.configure do |config|
|
|
1159
|
+
# Configure HTTP basic authorization: BasicAuth
|
|
1160
|
+
config.username = 'YOUR USERNAME'
|
|
1161
|
+
config.password = 'YOUR PASSWORD'
|
|
1162
|
+
|
|
1163
|
+
# Configure API key authorization: BearerAuth
|
|
1164
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
1165
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1166
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
1167
|
+
end
|
|
1168
|
+
|
|
1169
|
+
api_instance = Nodeum::FilesApi.new
|
|
1170
|
+
pool_id = 'pool_id_example' # String | Numeric ID, or name of pool.
|
|
1171
|
+
opts = {
|
|
1172
|
+
limit: 56, # Integer | The number of items to display for pagination.
|
|
1173
|
+
offset: 56, # Integer | The number of items to skip for pagination.
|
|
1174
|
+
file_id: 'file_id_example', # String | Filter on file id
|
|
1175
|
+
name: 'name_example', # String | Filter on name
|
|
1176
|
+
type: 'type_example', # String | Filter on type
|
|
1177
|
+
permission: 'permission_example', # String | Filter on permission
|
|
1178
|
+
size: 'size_example', # String | Filter on size
|
|
1179
|
+
change_date: 'change_date_example', # String | Filter on change date
|
|
1180
|
+
modification_date: 'modification_date_example', # String | Filter on modification date
|
|
1181
|
+
access_date: 'access_date_example', # String | Filter on access date
|
|
1182
|
+
gid: 'gid_example', # String | Filter on gid
|
|
1183
|
+
uid: 'uid_example' # String | Filter on uid
|
|
1184
|
+
}
|
|
1185
|
+
|
|
1186
|
+
begin
|
|
1187
|
+
#Lists files on root of tape of pools, specific for Data Exchange.
|
|
1188
|
+
result = api_instance.index_import_files_by_pool(pool_id, opts)
|
|
1189
|
+
p result
|
|
1190
|
+
rescue Nodeum::ApiError => e
|
|
1191
|
+
puts "Exception when calling FilesApi->index_import_files_by_pool: #{e}"
|
|
1192
|
+
end
|
|
1193
|
+
```
|
|
1194
|
+
|
|
1195
|
+
### Parameters
|
|
1196
|
+
|
|
1197
|
+
|
|
1198
|
+
Name | Type | Description | Notes
|
|
1199
|
+
------------- | ------------- | ------------- | -------------
|
|
1200
|
+
**pool_id** | **String**| Numeric ID, or name of pool. |
|
|
1201
|
+
**limit** | **Integer**| The number of items to display for pagination. | [optional]
|
|
1202
|
+
**offset** | **Integer**| The number of items to skip for pagination. | [optional]
|
|
1203
|
+
**file_id** | **String**| Filter on file id | [optional]
|
|
1204
|
+
**name** | **String**| Filter on name | [optional]
|
|
1205
|
+
**type** | **String**| Filter on type | [optional]
|
|
1206
|
+
**permission** | **String**| Filter on permission | [optional]
|
|
1207
|
+
**size** | **String**| Filter on size | [optional]
|
|
1208
|
+
**change_date** | **String**| Filter on change date | [optional]
|
|
1209
|
+
**modification_date** | **String**| Filter on modification date | [optional]
|
|
1210
|
+
**access_date** | **String**| Filter on access date | [optional]
|
|
1211
|
+
**gid** | **String**| Filter on gid | [optional]
|
|
1212
|
+
**uid** | **String**| Filter on uid | [optional]
|
|
1213
|
+
|
|
1214
|
+
### Return type
|
|
1215
|
+
|
|
1216
|
+
[**ImportFileCollection**](ImportFileCollection.md)
|
|
1217
|
+
|
|
1218
|
+
### Authorization
|
|
1219
|
+
|
|
1220
|
+
[BasicAuth](../README.md#BasicAuth), [BearerAuth](../README.md#BearerAuth)
|
|
1221
|
+
|
|
1222
|
+
### HTTP request headers
|
|
1223
|
+
|
|
1224
|
+
- **Content-Type**: Not defined
|
|
1225
|
+
- **Accept**: application/json
|
|
1226
|
+
|
|
1227
|
+
|
|
1228
|
+
## index_on_tapes_files_by_pool
|
|
1229
|
+
|
|
1230
|
+
> OnTapesFileCollection index_on_tapes_files_by_pool(pool_id, opts)
|
|
1231
|
+
|
|
1232
|
+
Lists files on root of tape of pools, specific for Active and Offline.
|
|
1233
|
+
|
|
1234
|
+
**API Key Scope**: on_tapes_files / index
|
|
1235
|
+
|
|
1236
|
+
### Example
|
|
1237
|
+
|
|
1238
|
+
```ruby
|
|
1239
|
+
# load the gem
|
|
1240
|
+
require 'nodeum_sdk'
|
|
1241
|
+
# setup authorization
|
|
1242
|
+
Nodeum.configure do |config|
|
|
1243
|
+
# Configure HTTP basic authorization: BasicAuth
|
|
1244
|
+
config.username = 'YOUR USERNAME'
|
|
1245
|
+
config.password = 'YOUR PASSWORD'
|
|
1246
|
+
|
|
1247
|
+
# Configure API key authorization: BearerAuth
|
|
1248
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
1249
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1250
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
1251
|
+
end
|
|
1252
|
+
|
|
1253
|
+
api_instance = Nodeum::FilesApi.new
|
|
1254
|
+
pool_id = 'pool_id_example' # String | Numeric ID, or name of pool.
|
|
1255
|
+
opts = {
|
|
1256
|
+
limit: 56, # Integer | The number of items to display for pagination.
|
|
1257
|
+
offset: 56, # Integer | The number of items to skip for pagination.
|
|
1258
|
+
name: 'name_example', # String | Filter on name
|
|
1259
|
+
type: 'type_example', # String | Filter on type
|
|
1260
|
+
size: 'size_example' # String | Filter on size
|
|
1261
|
+
}
|
|
1262
|
+
|
|
1263
|
+
begin
|
|
1264
|
+
#Lists files on root of tape of pools, specific for Active and Offline.
|
|
1265
|
+
result = api_instance.index_on_tapes_files_by_pool(pool_id, opts)
|
|
1266
|
+
p result
|
|
1267
|
+
rescue Nodeum::ApiError => e
|
|
1268
|
+
puts "Exception when calling FilesApi->index_on_tapes_files_by_pool: #{e}"
|
|
1269
|
+
end
|
|
1270
|
+
```
|
|
1271
|
+
|
|
1272
|
+
### Parameters
|
|
1273
|
+
|
|
1274
|
+
|
|
1275
|
+
Name | Type | Description | Notes
|
|
1276
|
+
------------- | ------------- | ------------- | -------------
|
|
1277
|
+
**pool_id** | **String**| Numeric ID, or name of pool. |
|
|
1278
|
+
**limit** | **Integer**| The number of items to display for pagination. | [optional]
|
|
1279
|
+
**offset** | **Integer**| The number of items to skip for pagination. | [optional]
|
|
1280
|
+
**name** | **String**| Filter on name | [optional]
|
|
1281
|
+
**type** | **String**| Filter on type | [optional]
|
|
1282
|
+
**size** | **String**| Filter on size | [optional]
|
|
1283
|
+
|
|
1284
|
+
### Return type
|
|
1285
|
+
|
|
1286
|
+
[**OnTapesFileCollection**](OnTapesFileCollection.md)
|
|
1287
|
+
|
|
1288
|
+
### Authorization
|
|
1289
|
+
|
|
1290
|
+
[BasicAuth](../README.md#BasicAuth), [BearerAuth](../README.md#BearerAuth)
|
|
1291
|
+
|
|
1292
|
+
### HTTP request headers
|
|
1293
|
+
|
|
1294
|
+
- **Content-Type**: Not defined
|
|
1295
|
+
- **Accept**: application/json
|
|
1296
|
+
|
|
1297
|
+
|
|
1298
|
+
## index_tapes_by_file_by_pool
|
|
1299
|
+
|
|
1300
|
+
> TapeCollection index_tapes_by_file_by_pool(pool_id, file_id)
|
|
1301
|
+
|
|
1302
|
+
Displays tapes containing specific file, related to the specific pool.
|
|
1303
|
+
|
|
1304
|
+
**API Key Scope**: files / tapes
|
|
1305
|
+
|
|
1306
|
+
### Example
|
|
1307
|
+
|
|
1308
|
+
```ruby
|
|
1309
|
+
# load the gem
|
|
1310
|
+
require 'nodeum_sdk'
|
|
1311
|
+
# setup authorization
|
|
1312
|
+
Nodeum.configure do |config|
|
|
1313
|
+
# Configure HTTP basic authorization: BasicAuth
|
|
1314
|
+
config.username = 'YOUR USERNAME'
|
|
1315
|
+
config.password = 'YOUR PASSWORD'
|
|
1316
|
+
|
|
1317
|
+
# Configure API key authorization: BearerAuth
|
|
1318
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
1319
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1320
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
1321
|
+
end
|
|
1322
|
+
|
|
1323
|
+
api_instance = Nodeum::FilesApi.new
|
|
1324
|
+
pool_id = 'pool_id_example' # String | Numeric ID, or name of pool.
|
|
1325
|
+
file_id = 56 # Integer | Numeric ID of file.
|
|
1326
|
+
|
|
1327
|
+
begin
|
|
1328
|
+
#Displays tapes containing specific file, related to the specific pool.
|
|
1329
|
+
result = api_instance.index_tapes_by_file_by_pool(pool_id, file_id)
|
|
1330
|
+
p result
|
|
1331
|
+
rescue Nodeum::ApiError => e
|
|
1332
|
+
puts "Exception when calling FilesApi->index_tapes_by_file_by_pool: #{e}"
|
|
1333
|
+
end
|
|
1334
|
+
```
|
|
1335
|
+
|
|
1336
|
+
### Parameters
|
|
1337
|
+
|
|
1338
|
+
|
|
1339
|
+
Name | Type | Description | Notes
|
|
1340
|
+
------------- | ------------- | ------------- | -------------
|
|
1341
|
+
**pool_id** | **String**| Numeric ID, or name of pool. |
|
|
1342
|
+
**file_id** | **Integer**| Numeric ID of file. |
|
|
1343
|
+
|
|
1344
|
+
### Return type
|
|
1345
|
+
|
|
1346
|
+
[**TapeCollection**](TapeCollection.md)
|
|
1347
|
+
|
|
1348
|
+
### Authorization
|
|
1349
|
+
|
|
1350
|
+
[BasicAuth](../README.md#BasicAuth), [BearerAuth](../README.md#BearerAuth)
|
|
1351
|
+
|
|
1352
|
+
### HTTP request headers
|
|
1353
|
+
|
|
1354
|
+
- **Content-Type**: Not defined
|
|
1355
|
+
- **Accept**: application/json
|
|
1356
|
+
|
|
1357
|
+
|
|
1358
|
+
## index_tapes_by_file_by_task
|
|
1359
|
+
|
|
1360
|
+
> TapeCollection index_tapes_by_file_by_task(task_id, file_id)
|
|
1361
|
+
|
|
1362
|
+
Displays tapes containing specific file, related to the specific task.
|
|
1363
|
+
|
|
1364
|
+
**API Key Scope**: files / tapes
|
|
1365
|
+
|
|
1366
|
+
### Example
|
|
1367
|
+
|
|
1368
|
+
```ruby
|
|
1369
|
+
# load the gem
|
|
1370
|
+
require 'nodeum_sdk'
|
|
1371
|
+
# setup authorization
|
|
1372
|
+
Nodeum.configure do |config|
|
|
1373
|
+
# Configure HTTP basic authorization: BasicAuth
|
|
1374
|
+
config.username = 'YOUR USERNAME'
|
|
1375
|
+
config.password = 'YOUR PASSWORD'
|
|
1376
|
+
|
|
1377
|
+
# Configure API key authorization: BearerAuth
|
|
1378
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
1379
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1380
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
1381
|
+
end
|
|
1382
|
+
|
|
1383
|
+
api_instance = Nodeum::FilesApi.new
|
|
1384
|
+
task_id = 'task_id_example' # String | Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID.
|
|
1385
|
+
file_id = 56 # Integer | Numeric ID of file.
|
|
1386
|
+
|
|
1387
|
+
begin
|
|
1388
|
+
#Displays tapes containing specific file, related to the specific task.
|
|
1389
|
+
result = api_instance.index_tapes_by_file_by_task(task_id, file_id)
|
|
1390
|
+
p result
|
|
1391
|
+
rescue Nodeum::ApiError => e
|
|
1392
|
+
puts "Exception when calling FilesApi->index_tapes_by_file_by_task: #{e}"
|
|
1393
|
+
end
|
|
1394
|
+
```
|
|
1395
|
+
|
|
1396
|
+
### Parameters
|
|
1397
|
+
|
|
1398
|
+
|
|
1399
|
+
Name | Type | Description | Notes
|
|
1400
|
+
------------- | ------------- | ------------- | -------------
|
|
1401
|
+
**task_id** | **String**| Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID. |
|
|
1402
|
+
**file_id** | **Integer**| Numeric ID of file. |
|
|
1403
|
+
|
|
1404
|
+
### Return type
|
|
1405
|
+
|
|
1406
|
+
[**TapeCollection**](TapeCollection.md)
|
|
1407
|
+
|
|
1408
|
+
### Authorization
|
|
1409
|
+
|
|
1410
|
+
[BasicAuth](../README.md#BasicAuth), [BearerAuth](../README.md#BearerAuth)
|
|
1411
|
+
|
|
1412
|
+
### HTTP request headers
|
|
1413
|
+
|
|
1414
|
+
- **Content-Type**: Not defined
|
|
1415
|
+
- **Accept**: application/json
|
|
1416
|
+
|
|
1417
|
+
|
|
1418
|
+
## index_tapes_by_file_by_task_execution
|
|
1419
|
+
|
|
1420
|
+
> TapeCollection index_tapes_by_file_by_task_execution(task_execution_id, file_id)
|
|
1421
|
+
|
|
1422
|
+
Displays tapes containing specific file, related to the specific task.
|
|
1423
|
+
|
|
1424
|
+
**API Key Scope**: files / tapes
|
|
1425
|
+
|
|
1426
|
+
### Example
|
|
1427
|
+
|
|
1428
|
+
```ruby
|
|
1429
|
+
# load the gem
|
|
1430
|
+
require 'nodeum_sdk'
|
|
1431
|
+
# setup authorization
|
|
1432
|
+
Nodeum.configure do |config|
|
|
1433
|
+
# Configure HTTP basic authorization: BasicAuth
|
|
1434
|
+
config.username = 'YOUR USERNAME'
|
|
1435
|
+
config.password = 'YOUR PASSWORD'
|
|
1436
|
+
|
|
1437
|
+
# Configure API key authorization: BearerAuth
|
|
1438
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
1439
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1440
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
1441
|
+
end
|
|
1442
|
+
|
|
1443
|
+
api_instance = Nodeum::FilesApi.new
|
|
1444
|
+
task_execution_id = 'task_execution_id_example' # String | Numeric ID of task execution.
|
|
1445
|
+
file_id = 56 # Integer | Numeric ID of file.
|
|
1446
|
+
|
|
1447
|
+
begin
|
|
1448
|
+
#Displays tapes containing specific file, related to the specific task.
|
|
1449
|
+
result = api_instance.index_tapes_by_file_by_task_execution(task_execution_id, file_id)
|
|
1450
|
+
p result
|
|
1451
|
+
rescue Nodeum::ApiError => e
|
|
1452
|
+
puts "Exception when calling FilesApi->index_tapes_by_file_by_task_execution: #{e}"
|
|
1453
|
+
end
|
|
1454
|
+
```
|
|
1455
|
+
|
|
1456
|
+
### Parameters
|
|
1457
|
+
|
|
1458
|
+
|
|
1459
|
+
Name | Type | Description | Notes
|
|
1460
|
+
------------- | ------------- | ------------- | -------------
|
|
1461
|
+
**task_execution_id** | **String**| Numeric ID of task execution. |
|
|
1462
|
+
**file_id** | **Integer**| Numeric ID of file. |
|
|
1463
|
+
|
|
1464
|
+
### Return type
|
|
1465
|
+
|
|
1466
|
+
[**TapeCollection**](TapeCollection.md)
|
|
1467
|
+
|
|
1468
|
+
### Authorization
|
|
1469
|
+
|
|
1470
|
+
[BasicAuth](../README.md#BasicAuth), [BearerAuth](../README.md#BearerAuth)
|
|
1471
|
+
|
|
1472
|
+
### HTTP request headers
|
|
1473
|
+
|
|
1474
|
+
- **Content-Type**: Not defined
|
|
1475
|
+
- **Accept**: application/json
|
|
1476
|
+
|
|
1477
|
+
|
|
1478
|
+
## index_tapes_by_file_by_task_execution_by_task
|
|
1479
|
+
|
|
1480
|
+
> TapeCollection index_tapes_by_file_by_task_execution_by_task(task_id, task_execution_id, file_id)
|
|
1481
|
+
|
|
1482
|
+
Displays tapes containing specific file, related to the specific task.
|
|
1483
|
+
|
|
1484
|
+
**API Key Scope**: files / tapes
|
|
1485
|
+
|
|
1486
|
+
### Example
|
|
1487
|
+
|
|
1488
|
+
```ruby
|
|
1489
|
+
# load the gem
|
|
1490
|
+
require 'nodeum_sdk'
|
|
1491
|
+
# setup authorization
|
|
1492
|
+
Nodeum.configure do |config|
|
|
1493
|
+
# Configure HTTP basic authorization: BasicAuth
|
|
1494
|
+
config.username = 'YOUR USERNAME'
|
|
1495
|
+
config.password = 'YOUR PASSWORD'
|
|
1496
|
+
|
|
1497
|
+
# Configure API key authorization: BearerAuth
|
|
1498
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
1499
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1500
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
1501
|
+
end
|
|
1502
|
+
|
|
1503
|
+
api_instance = Nodeum::FilesApi.new
|
|
1504
|
+
task_id = 'task_id_example' # String | Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID.
|
|
1505
|
+
task_execution_id = 'task_execution_id_example' # String | Numeric ID of task execution.
|
|
1506
|
+
file_id = 56 # Integer | Numeric ID of file.
|
|
1507
|
+
|
|
1508
|
+
begin
|
|
1509
|
+
#Displays tapes containing specific file, related to the specific task.
|
|
1510
|
+
result = api_instance.index_tapes_by_file_by_task_execution_by_task(task_id, task_execution_id, file_id)
|
|
1511
|
+
p result
|
|
1512
|
+
rescue Nodeum::ApiError => e
|
|
1513
|
+
puts "Exception when calling FilesApi->index_tapes_by_file_by_task_execution_by_task: #{e}"
|
|
1514
|
+
end
|
|
1515
|
+
```
|
|
1516
|
+
|
|
1517
|
+
### Parameters
|
|
1518
|
+
|
|
1519
|
+
|
|
1520
|
+
Name | Type | Description | Notes
|
|
1521
|
+
------------- | ------------- | ------------- | -------------
|
|
1522
|
+
**task_id** | **String**| Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID. |
|
|
1523
|
+
**task_execution_id** | **String**| Numeric ID of task execution. |
|
|
1524
|
+
**file_id** | **Integer**| Numeric ID of file. |
|
|
1525
|
+
|
|
1526
|
+
### Return type
|
|
1527
|
+
|
|
1528
|
+
[**TapeCollection**](TapeCollection.md)
|
|
1529
|
+
|
|
1530
|
+
### Authorization
|
|
1531
|
+
|
|
1532
|
+
[BasicAuth](../README.md#BasicAuth), [BearerAuth](../README.md#BearerAuth)
|
|
1533
|
+
|
|
1534
|
+
### HTTP request headers
|
|
1535
|
+
|
|
1536
|
+
- **Content-Type**: Not defined
|
|
1537
|
+
- **Accept**: application/json
|
|
1538
|
+
|
|
1539
|
+
|
|
1540
|
+
## on_tapes_files_children_by_pool
|
|
1541
|
+
|
|
1542
|
+
> OnTapesFileCollection on_tapes_files_children_by_pool(pool_id, file_parent_id, opts)
|
|
1543
|
+
|
|
1544
|
+
Lists files under a specific folder on tape of pools, specific for Active and Offline.
|
|
1545
|
+
|
|
1546
|
+
**API Key Scope**: on_tapes_files / index
|
|
1547
|
+
|
|
1548
|
+
### Example
|
|
1549
|
+
|
|
1550
|
+
```ruby
|
|
1551
|
+
# load the gem
|
|
1552
|
+
require 'nodeum_sdk'
|
|
1553
|
+
# setup authorization
|
|
1554
|
+
Nodeum.configure do |config|
|
|
1555
|
+
# Configure HTTP basic authorization: BasicAuth
|
|
1556
|
+
config.username = 'YOUR USERNAME'
|
|
1557
|
+
config.password = 'YOUR PASSWORD'
|
|
1558
|
+
|
|
1559
|
+
# Configure API key authorization: BearerAuth
|
|
1560
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
1561
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1562
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
1563
|
+
end
|
|
1564
|
+
|
|
1565
|
+
api_instance = Nodeum::FilesApi.new
|
|
1566
|
+
pool_id = 'pool_id_example' # String | Numeric ID, or name of pool.
|
|
1567
|
+
file_parent_id = 56 # Integer | Numeric ID of parent folder.
|
|
1568
|
+
opts = {
|
|
1569
|
+
limit: 56, # Integer | The number of items to display for pagination.
|
|
1570
|
+
offset: 56, # Integer | The number of items to skip for pagination.
|
|
1571
|
+
name: 'name_example', # String | Filter on name
|
|
1572
|
+
type: 'type_example', # String | Filter on type
|
|
1573
|
+
size: 'size_example' # String | Filter on size
|
|
1574
|
+
}
|
|
1575
|
+
|
|
1576
|
+
begin
|
|
1577
|
+
#Lists files under a specific folder on tape of pools, specific for Active and Offline.
|
|
1578
|
+
result = api_instance.on_tapes_files_children_by_pool(pool_id, file_parent_id, opts)
|
|
1579
|
+
p result
|
|
1580
|
+
rescue Nodeum::ApiError => e
|
|
1581
|
+
puts "Exception when calling FilesApi->on_tapes_files_children_by_pool: #{e}"
|
|
1582
|
+
end
|
|
1583
|
+
```
|
|
1584
|
+
|
|
1585
|
+
### Parameters
|
|
1586
|
+
|
|
1587
|
+
|
|
1588
|
+
Name | Type | Description | Notes
|
|
1589
|
+
------------- | ------------- | ------------- | -------------
|
|
1590
|
+
**pool_id** | **String**| Numeric ID, or name of pool. |
|
|
1591
|
+
**file_parent_id** | **Integer**| Numeric ID of parent folder. |
|
|
1592
|
+
**limit** | **Integer**| The number of items to display for pagination. | [optional]
|
|
1593
|
+
**offset** | **Integer**| The number of items to skip for pagination. | [optional]
|
|
1594
|
+
**name** | **String**| Filter on name | [optional]
|
|
1595
|
+
**type** | **String**| Filter on type | [optional]
|
|
1596
|
+
**size** | **String**| Filter on size | [optional]
|
|
1597
|
+
|
|
1598
|
+
### Return type
|
|
1599
|
+
|
|
1600
|
+
[**OnTapesFileCollection**](OnTapesFileCollection.md)
|
|
1601
|
+
|
|
1602
|
+
### Authorization
|
|
1603
|
+
|
|
1604
|
+
[BasicAuth](../README.md#BasicAuth), [BearerAuth](../README.md#BearerAuth)
|
|
1605
|
+
|
|
1606
|
+
### HTTP request headers
|
|
1607
|
+
|
|
1608
|
+
- **Content-Type**: Not defined
|
|
1609
|
+
- **Accept**: application/json
|
|
1610
|
+
|
|
1611
|
+
|
|
1612
|
+
## show_file
|
|
1613
|
+
|
|
1614
|
+
> NodeumFileWithPath show_file(file_id)
|
|
1615
|
+
|
|
1616
|
+
Displays a specific file.
|
|
1617
|
+
|
|
1618
|
+
**API Key Scope**: files / show
|
|
1619
|
+
|
|
1620
|
+
### Example
|
|
1621
|
+
|
|
1622
|
+
```ruby
|
|
1623
|
+
# load the gem
|
|
1624
|
+
require 'nodeum_sdk'
|
|
1625
|
+
# setup authorization
|
|
1626
|
+
Nodeum.configure do |config|
|
|
1627
|
+
# Configure HTTP basic authorization: BasicAuth
|
|
1628
|
+
config.username = 'YOUR USERNAME'
|
|
1629
|
+
config.password = 'YOUR PASSWORD'
|
|
1630
|
+
|
|
1631
|
+
# Configure API key authorization: BearerAuth
|
|
1632
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
1633
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1634
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
1635
|
+
end
|
|
1636
|
+
|
|
1637
|
+
api_instance = Nodeum::FilesApi.new
|
|
1638
|
+
file_id = 56 # Integer | Numeric ID of file.
|
|
1639
|
+
|
|
1640
|
+
begin
|
|
1641
|
+
#Displays a specific file.
|
|
1642
|
+
result = api_instance.show_file(file_id)
|
|
1643
|
+
p result
|
|
1644
|
+
rescue Nodeum::ApiError => e
|
|
1645
|
+
puts "Exception when calling FilesApi->show_file: #{e}"
|
|
1646
|
+
end
|
|
1647
|
+
```
|
|
1648
|
+
|
|
1649
|
+
### Parameters
|
|
1650
|
+
|
|
1651
|
+
|
|
1652
|
+
Name | Type | Description | Notes
|
|
1653
|
+
------------- | ------------- | ------------- | -------------
|
|
1654
|
+
**file_id** | **Integer**| Numeric ID of file. |
|
|
1655
|
+
|
|
1656
|
+
### Return type
|
|
1657
|
+
|
|
1658
|
+
[**NodeumFileWithPath**](NodeumFileWithPath.md)
|
|
1659
|
+
|
|
1660
|
+
### Authorization
|
|
1661
|
+
|
|
1662
|
+
[BasicAuth](../README.md#BasicAuth), [BearerAuth](../README.md#BearerAuth)
|
|
1663
|
+
|
|
1664
|
+
### HTTP request headers
|
|
1665
|
+
|
|
1666
|
+
- **Content-Type**: Not defined
|
|
1667
|
+
- **Accept**: application/json
|
|
1668
|
+
|
|
1669
|
+
|
|
1670
|
+
## show_file_by_container
|
|
1671
|
+
|
|
1672
|
+
> NodeumFileWithPath show_file_by_container(container_id, file_id)
|
|
1673
|
+
|
|
1674
|
+
Displays a specific file.
|
|
1675
|
+
|
|
1676
|
+
**API Key Scope**: files / show
|
|
1677
|
+
|
|
1678
|
+
### Example
|
|
1679
|
+
|
|
1680
|
+
```ruby
|
|
1681
|
+
# load the gem
|
|
1682
|
+
require 'nodeum_sdk'
|
|
1683
|
+
# setup authorization
|
|
1684
|
+
Nodeum.configure do |config|
|
|
1685
|
+
# Configure HTTP basic authorization: BasicAuth
|
|
1686
|
+
config.username = 'YOUR USERNAME'
|
|
1687
|
+
config.password = 'YOUR PASSWORD'
|
|
1688
|
+
|
|
1689
|
+
# Configure API key authorization: BearerAuth
|
|
1690
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
1691
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1692
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
1693
|
+
end
|
|
1694
|
+
|
|
1695
|
+
api_instance = Nodeum::FilesApi.new
|
|
1696
|
+
container_id = 'container_id_example' # String | Numeric ID or name of container.
|
|
1697
|
+
file_id = 56 # Integer | Numeric ID of file.
|
|
1698
|
+
|
|
1699
|
+
begin
|
|
1700
|
+
#Displays a specific file.
|
|
1701
|
+
result = api_instance.show_file_by_container(container_id, file_id)
|
|
1702
|
+
p result
|
|
1703
|
+
rescue Nodeum::ApiError => e
|
|
1704
|
+
puts "Exception when calling FilesApi->show_file_by_container: #{e}"
|
|
1705
|
+
end
|
|
1706
|
+
```
|
|
1707
|
+
|
|
1708
|
+
### Parameters
|
|
1709
|
+
|
|
1710
|
+
|
|
1711
|
+
Name | Type | Description | Notes
|
|
1712
|
+
------------- | ------------- | ------------- | -------------
|
|
1713
|
+
**container_id** | **String**| Numeric ID or name of container. |
|
|
1714
|
+
**file_id** | **Integer**| Numeric ID of file. |
|
|
1715
|
+
|
|
1716
|
+
### Return type
|
|
1717
|
+
|
|
1718
|
+
[**NodeumFileWithPath**](NodeumFileWithPath.md)
|
|
1719
|
+
|
|
1720
|
+
### Authorization
|
|
1721
|
+
|
|
1722
|
+
[BasicAuth](../README.md#BasicAuth), [BearerAuth](../README.md#BearerAuth)
|
|
1723
|
+
|
|
1724
|
+
### HTTP request headers
|
|
1725
|
+
|
|
1726
|
+
- **Content-Type**: Not defined
|
|
1727
|
+
- **Accept**: application/json
|
|
1728
|
+
|
|
1729
|
+
|
|
1730
|
+
## show_file_by_pool
|
|
1731
|
+
|
|
1732
|
+
> NodeumFileWithPath show_file_by_pool(pool_id, file_id)
|
|
1733
|
+
|
|
1734
|
+
Displays a specific file.
|
|
1735
|
+
|
|
1736
|
+
**API Key Scope**: files / show
|
|
1737
|
+
|
|
1738
|
+
### Example
|
|
1739
|
+
|
|
1740
|
+
```ruby
|
|
1741
|
+
# load the gem
|
|
1742
|
+
require 'nodeum_sdk'
|
|
1743
|
+
# setup authorization
|
|
1744
|
+
Nodeum.configure do |config|
|
|
1745
|
+
# Configure HTTP basic authorization: BasicAuth
|
|
1746
|
+
config.username = 'YOUR USERNAME'
|
|
1747
|
+
config.password = 'YOUR PASSWORD'
|
|
1748
|
+
|
|
1749
|
+
# Configure API key authorization: BearerAuth
|
|
1750
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
1751
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1752
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
1753
|
+
end
|
|
1754
|
+
|
|
1755
|
+
api_instance = Nodeum::FilesApi.new
|
|
1756
|
+
pool_id = 'pool_id_example' # String | Numeric ID, or name of pool.
|
|
1757
|
+
file_id = 56 # Integer | Numeric ID of file.
|
|
1758
|
+
|
|
1759
|
+
begin
|
|
1760
|
+
#Displays a specific file.
|
|
1761
|
+
result = api_instance.show_file_by_pool(pool_id, file_id)
|
|
1762
|
+
p result
|
|
1763
|
+
rescue Nodeum::ApiError => e
|
|
1764
|
+
puts "Exception when calling FilesApi->show_file_by_pool: #{e}"
|
|
1765
|
+
end
|
|
1766
|
+
```
|
|
1767
|
+
|
|
1768
|
+
### Parameters
|
|
1769
|
+
|
|
1770
|
+
|
|
1771
|
+
Name | Type | Description | Notes
|
|
1772
|
+
------------- | ------------- | ------------- | -------------
|
|
1773
|
+
**pool_id** | **String**| Numeric ID, or name of pool. |
|
|
1774
|
+
**file_id** | **Integer**| Numeric ID of file. |
|
|
1775
|
+
|
|
1776
|
+
### Return type
|
|
1777
|
+
|
|
1778
|
+
[**NodeumFileWithPath**](NodeumFileWithPath.md)
|
|
1779
|
+
|
|
1780
|
+
### Authorization
|
|
1781
|
+
|
|
1782
|
+
[BasicAuth](../README.md#BasicAuth), [BearerAuth](../README.md#BearerAuth)
|
|
1783
|
+
|
|
1784
|
+
### HTTP request headers
|
|
1785
|
+
|
|
1786
|
+
- **Content-Type**: Not defined
|
|
1787
|
+
- **Accept**: application/json
|
|
1788
|
+
|
|
1789
|
+
|
|
1790
|
+
## show_file_by_task
|
|
1791
|
+
|
|
1792
|
+
> NodeumFileWithPath show_file_by_task(task_id, file_id)
|
|
1793
|
+
|
|
1794
|
+
Displays a specific file.
|
|
1795
|
+
|
|
1796
|
+
**API Key Scope**: files / show
|
|
1797
|
+
|
|
1798
|
+
### Example
|
|
1799
|
+
|
|
1800
|
+
```ruby
|
|
1801
|
+
# load the gem
|
|
1802
|
+
require 'nodeum_sdk'
|
|
1803
|
+
# setup authorization
|
|
1804
|
+
Nodeum.configure do |config|
|
|
1805
|
+
# Configure HTTP basic authorization: BasicAuth
|
|
1806
|
+
config.username = 'YOUR USERNAME'
|
|
1807
|
+
config.password = 'YOUR PASSWORD'
|
|
1808
|
+
|
|
1809
|
+
# Configure API key authorization: BearerAuth
|
|
1810
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
1811
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1812
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
1813
|
+
end
|
|
1814
|
+
|
|
1815
|
+
api_instance = Nodeum::FilesApi.new
|
|
1816
|
+
task_id = 'task_id_example' # String | Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID.
|
|
1817
|
+
file_id = 56 # Integer | Numeric ID of file.
|
|
1818
|
+
|
|
1819
|
+
begin
|
|
1820
|
+
#Displays a specific file.
|
|
1821
|
+
result = api_instance.show_file_by_task(task_id, file_id)
|
|
1822
|
+
p result
|
|
1823
|
+
rescue Nodeum::ApiError => e
|
|
1824
|
+
puts "Exception when calling FilesApi->show_file_by_task: #{e}"
|
|
1825
|
+
end
|
|
1826
|
+
```
|
|
1827
|
+
|
|
1828
|
+
### Parameters
|
|
1829
|
+
|
|
1830
|
+
|
|
1831
|
+
Name | Type | Description | Notes
|
|
1832
|
+
------------- | ------------- | ------------- | -------------
|
|
1833
|
+
**task_id** | **String**| Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID. |
|
|
1834
|
+
**file_id** | **Integer**| Numeric ID of file. |
|
|
1835
|
+
|
|
1836
|
+
### Return type
|
|
1837
|
+
|
|
1838
|
+
[**NodeumFileWithPath**](NodeumFileWithPath.md)
|
|
1839
|
+
|
|
1840
|
+
### Authorization
|
|
1841
|
+
|
|
1842
|
+
[BasicAuth](../README.md#BasicAuth), [BearerAuth](../README.md#BearerAuth)
|
|
1843
|
+
|
|
1844
|
+
### HTTP request headers
|
|
1845
|
+
|
|
1846
|
+
- **Content-Type**: Not defined
|
|
1847
|
+
- **Accept**: application/json
|
|
1848
|
+
|
|
1849
|
+
|
|
1850
|
+
## show_file_by_task_execution
|
|
1851
|
+
|
|
1852
|
+
> NodeumFileWithPath show_file_by_task_execution(task_execution_id, file_id)
|
|
1853
|
+
|
|
1854
|
+
Displays a specific file.
|
|
1855
|
+
|
|
1856
|
+
**API Key Scope**: files / show
|
|
1857
|
+
|
|
1858
|
+
### Example
|
|
1859
|
+
|
|
1860
|
+
```ruby
|
|
1861
|
+
# load the gem
|
|
1862
|
+
require 'nodeum_sdk'
|
|
1863
|
+
# setup authorization
|
|
1864
|
+
Nodeum.configure do |config|
|
|
1865
|
+
# Configure HTTP basic authorization: BasicAuth
|
|
1866
|
+
config.username = 'YOUR USERNAME'
|
|
1867
|
+
config.password = 'YOUR PASSWORD'
|
|
1868
|
+
|
|
1869
|
+
# Configure API key authorization: BearerAuth
|
|
1870
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
1871
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1872
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
1873
|
+
end
|
|
1874
|
+
|
|
1875
|
+
api_instance = Nodeum::FilesApi.new
|
|
1876
|
+
task_execution_id = 'task_execution_id_example' # String | Numeric ID of task execution.
|
|
1877
|
+
file_id = 56 # Integer | Numeric ID of file.
|
|
1878
|
+
|
|
1879
|
+
begin
|
|
1880
|
+
#Displays a specific file.
|
|
1881
|
+
result = api_instance.show_file_by_task_execution(task_execution_id, file_id)
|
|
1882
|
+
p result
|
|
1883
|
+
rescue Nodeum::ApiError => e
|
|
1884
|
+
puts "Exception when calling FilesApi->show_file_by_task_execution: #{e}"
|
|
1885
|
+
end
|
|
1886
|
+
```
|
|
1887
|
+
|
|
1888
|
+
### Parameters
|
|
1889
|
+
|
|
1890
|
+
|
|
1891
|
+
Name | Type | Description | Notes
|
|
1892
|
+
------------- | ------------- | ------------- | -------------
|
|
1893
|
+
**task_execution_id** | **String**| Numeric ID of task execution. |
|
|
1894
|
+
**file_id** | **Integer**| Numeric ID of file. |
|
|
1895
|
+
|
|
1896
|
+
### Return type
|
|
1897
|
+
|
|
1898
|
+
[**NodeumFileWithPath**](NodeumFileWithPath.md)
|
|
1899
|
+
|
|
1900
|
+
### Authorization
|
|
1901
|
+
|
|
1902
|
+
[BasicAuth](../README.md#BasicAuth), [BearerAuth](../README.md#BearerAuth)
|
|
1903
|
+
|
|
1904
|
+
### HTTP request headers
|
|
1905
|
+
|
|
1906
|
+
- **Content-Type**: Not defined
|
|
1907
|
+
- **Accept**: application/json
|
|
1908
|
+
|
|
1909
|
+
|
|
1910
|
+
## show_file_by_task_execution_by_task
|
|
1911
|
+
|
|
1912
|
+
> NodeumFileWithPath show_file_by_task_execution_by_task(task_id, task_execution_id, file_id)
|
|
1913
|
+
|
|
1914
|
+
Displays a specific file.
|
|
1915
|
+
|
|
1916
|
+
**API Key Scope**: files / show
|
|
1917
|
+
|
|
1918
|
+
### Example
|
|
1919
|
+
|
|
1920
|
+
```ruby
|
|
1921
|
+
# load the gem
|
|
1922
|
+
require 'nodeum_sdk'
|
|
1923
|
+
# setup authorization
|
|
1924
|
+
Nodeum.configure do |config|
|
|
1925
|
+
# Configure HTTP basic authorization: BasicAuth
|
|
1926
|
+
config.username = 'YOUR USERNAME'
|
|
1927
|
+
config.password = 'YOUR PASSWORD'
|
|
1928
|
+
|
|
1929
|
+
# Configure API key authorization: BearerAuth
|
|
1930
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
1931
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1932
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
1933
|
+
end
|
|
1934
|
+
|
|
1935
|
+
api_instance = Nodeum::FilesApi.new
|
|
1936
|
+
task_id = 'task_id_example' # String | Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID.
|
|
1937
|
+
task_execution_id = 'task_execution_id_example' # String | Numeric ID of task execution.
|
|
1938
|
+
file_id = 56 # Integer | Numeric ID of file.
|
|
1939
|
+
|
|
1940
|
+
begin
|
|
1941
|
+
#Displays a specific file.
|
|
1942
|
+
result = api_instance.show_file_by_task_execution_by_task(task_id, task_execution_id, file_id)
|
|
1943
|
+
p result
|
|
1944
|
+
rescue Nodeum::ApiError => e
|
|
1945
|
+
puts "Exception when calling FilesApi->show_file_by_task_execution_by_task: #{e}"
|
|
1946
|
+
end
|
|
1947
|
+
```
|
|
1948
|
+
|
|
1949
|
+
### Parameters
|
|
1950
|
+
|
|
1951
|
+
|
|
1952
|
+
Name | Type | Description | Notes
|
|
1953
|
+
------------- | ------------- | ------------- | -------------
|
|
1954
|
+
**task_id** | **String**| Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID. |
|
|
1955
|
+
**task_execution_id** | **String**| Numeric ID of task execution. |
|
|
1956
|
+
**file_id** | **Integer**| Numeric ID of file. |
|
|
1957
|
+
|
|
1958
|
+
### Return type
|
|
1959
|
+
|
|
1960
|
+
[**NodeumFileWithPath**](NodeumFileWithPath.md)
|
|
1961
|
+
|
|
1962
|
+
### Authorization
|
|
1963
|
+
|
|
1964
|
+
[BasicAuth](../README.md#BasicAuth), [BearerAuth](../README.md#BearerAuth)
|
|
1965
|
+
|
|
1966
|
+
### HTTP request headers
|
|
1967
|
+
|
|
1968
|
+
- **Content-Type**: Not defined
|
|
1969
|
+
- **Accept**: application/json
|
|
1970
|
+
|
|
1971
|
+
|
|
1972
|
+
## show_import_file_by_pool
|
|
1973
|
+
|
|
1974
|
+
> ImportFileWithPath show_import_file_by_pool(pool_id, file_id)
|
|
1975
|
+
|
|
1976
|
+
Displays a specific file on tape of pools, specific for Data Exchange.
|
|
1977
|
+
|
|
1978
|
+
**API Key Scope**: import_files / show
|
|
1979
|
+
|
|
1980
|
+
### Example
|
|
1981
|
+
|
|
1982
|
+
```ruby
|
|
1983
|
+
# load the gem
|
|
1984
|
+
require 'nodeum_sdk'
|
|
1985
|
+
# setup authorization
|
|
1986
|
+
Nodeum.configure do |config|
|
|
1987
|
+
# Configure HTTP basic authorization: BasicAuth
|
|
1988
|
+
config.username = 'YOUR USERNAME'
|
|
1989
|
+
config.password = 'YOUR PASSWORD'
|
|
1990
|
+
|
|
1991
|
+
# Configure API key authorization: BearerAuth
|
|
1992
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
1993
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1994
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
1995
|
+
end
|
|
1996
|
+
|
|
1997
|
+
api_instance = Nodeum::FilesApi.new
|
|
1998
|
+
pool_id = 'pool_id_example' # String | Numeric ID, or name of pool.
|
|
1999
|
+
file_id = 56 # Integer | Numeric ID of file.
|
|
2000
|
+
|
|
2001
|
+
begin
|
|
2002
|
+
#Displays a specific file on tape of pools, specific for Data Exchange.
|
|
2003
|
+
result = api_instance.show_import_file_by_pool(pool_id, file_id)
|
|
2004
|
+
p result
|
|
2005
|
+
rescue Nodeum::ApiError => e
|
|
2006
|
+
puts "Exception when calling FilesApi->show_import_file_by_pool: #{e}"
|
|
2007
|
+
end
|
|
2008
|
+
```
|
|
2009
|
+
|
|
2010
|
+
### Parameters
|
|
2011
|
+
|
|
2012
|
+
|
|
2013
|
+
Name | Type | Description | Notes
|
|
2014
|
+
------------- | ------------- | ------------- | -------------
|
|
2015
|
+
**pool_id** | **String**| Numeric ID, or name of pool. |
|
|
2016
|
+
**file_id** | **Integer**| Numeric ID of file. |
|
|
2017
|
+
|
|
2018
|
+
### Return type
|
|
2019
|
+
|
|
2020
|
+
[**ImportFileWithPath**](ImportFileWithPath.md)
|
|
2021
|
+
|
|
2022
|
+
### Authorization
|
|
2023
|
+
|
|
2024
|
+
[BasicAuth](../README.md#BasicAuth), [BearerAuth](../README.md#BearerAuth)
|
|
2025
|
+
|
|
2026
|
+
### HTTP request headers
|
|
2027
|
+
|
|
2028
|
+
- **Content-Type**: Not defined
|
|
2029
|
+
- **Accept**: application/json
|
|
2030
|
+
|
|
2031
|
+
|
|
2032
|
+
## show_on_tape_file_by_pool
|
|
2033
|
+
|
|
2034
|
+
> OnTapesFile show_on_tape_file_by_pool(pool_id, file_id)
|
|
2035
|
+
|
|
2036
|
+
Displays a specific file on tape of pools, specific for Active and Offline.
|
|
2037
|
+
|
|
2038
|
+
**API Key Scope**: on_tapes_files / show
|
|
2039
|
+
|
|
2040
|
+
### Example
|
|
2041
|
+
|
|
2042
|
+
```ruby
|
|
2043
|
+
# load the gem
|
|
2044
|
+
require 'nodeum_sdk'
|
|
2045
|
+
# setup authorization
|
|
2046
|
+
Nodeum.configure do |config|
|
|
2047
|
+
# Configure HTTP basic authorization: BasicAuth
|
|
2048
|
+
config.username = 'YOUR USERNAME'
|
|
2049
|
+
config.password = 'YOUR PASSWORD'
|
|
2050
|
+
|
|
2051
|
+
# Configure API key authorization: BearerAuth
|
|
2052
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
2053
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2054
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
2055
|
+
end
|
|
2056
|
+
|
|
2057
|
+
api_instance = Nodeum::FilesApi.new
|
|
2058
|
+
pool_id = 'pool_id_example' # String | Numeric ID, or name of pool.
|
|
2059
|
+
file_id = 56 # Integer | Numeric ID of file.
|
|
2060
|
+
|
|
2061
|
+
begin
|
|
2062
|
+
#Displays a specific file on tape of pools, specific for Active and Offline.
|
|
2063
|
+
result = api_instance.show_on_tape_file_by_pool(pool_id, file_id)
|
|
2064
|
+
p result
|
|
2065
|
+
rescue Nodeum::ApiError => e
|
|
2066
|
+
puts "Exception when calling FilesApi->show_on_tape_file_by_pool: #{e}"
|
|
2067
|
+
end
|
|
2068
|
+
```
|
|
2069
|
+
|
|
2070
|
+
### Parameters
|
|
2071
|
+
|
|
2072
|
+
|
|
2073
|
+
Name | Type | Description | Notes
|
|
2074
|
+
------------- | ------------- | ------------- | -------------
|
|
2075
|
+
**pool_id** | **String**| Numeric ID, or name of pool. |
|
|
2076
|
+
**file_id** | **Integer**| Numeric ID of file. |
|
|
2077
|
+
|
|
2078
|
+
### Return type
|
|
2079
|
+
|
|
2080
|
+
[**OnTapesFile**](OnTapesFile.md)
|
|
2081
|
+
|
|
2082
|
+
### Authorization
|
|
2083
|
+
|
|
2084
|
+
[BasicAuth](../README.md#BasicAuth), [BearerAuth](../README.md#BearerAuth)
|
|
2085
|
+
|
|
2086
|
+
### HTTP request headers
|
|
2087
|
+
|
|
2088
|
+
- **Content-Type**: Not defined
|
|
2089
|
+
- **Accept**: application/json
|
|
2090
|
+
|