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,388 @@
|
|
1
|
+
=begin
|
2
|
+
#Nodeum API
|
3
|
+
|
4
|
+
#The Nodeum API makes it easy to tap into the digital data mesh that runs across your organisation. Make requests to our API endpoints and we’ll give you everything you need to interconnect your business workflows with your storage. All production API requests are made to: http://nodeumhostname/api/ The current production version of the API is v1. **REST** The Nodeum API is a RESTful API. This means that the API is designed to allow you to get, create, update, & delete objects with the HTTP verbs GET, POST, PUT, PATCH, & DELETE. **JSON** The Nodeum API speaks exclusively in JSON. This means that you should always set the Content-Type header to application/json to ensure that your requests are properly accepted and processed by the API. **Authentication** All API calls require user-password authentication. **Cross-Origin Resource Sharing** The Nodeum API supports CORS for communicating from Javascript for these endpoints. You will need to specify an Origin URI when creating your application to allow for CORS to be whitelisted for your domain. **Pagination** Some endpoints such as File Listing return a potentially lengthy array of objects. In order to keep the response sizes manageable the API will take advantage of pagination. Pagination is a mechanism for returning a subset of the results for a request and allowing for subsequent requests to “page” through the rest of the results until the end is reached. Paginated endpoints follow a standard interface that accepts two query parameters, limit and offset, and return a payload that follows a standard form. These parameters names and their behavior are borrowed from SQL LIMIT and OFFSET keywords. **Versioning** The Nodeum API is constantly being worked on to add features, make improvements, and fix bugs. This means that you should expect changes to be introduced and documented. However, there are some changes or additions that are considered backwards-compatible and your applications should be flexible enough to handle them. These include: - Adding new endpoints to the API - Adding new attributes to the response of an existing endpoint - Changing the order of attributes of responses (JSON by definition is an object of unordered key/value pairs) **Filter parameters** When browsing a list of items, multiple filter parameters may be applied. Some operators can be added to the value as a prefix: - `=` value is equal. Default operator, may be omitted - `!=` value is different - `>` greater than - `>=` greater than or equal - `<` lower than - `>=` lower than or equal - `><` included in list, items should be separated by `|` - `!><` not included in list, items should be separated by `|` - `~` pattern matching, may include `%` (any characters) and `_` (one character) - `!~` pattern not matching, may include `%` (any characters) and `_` (one character)
|
5
|
+
|
6
|
+
The version of the OpenAPI document: 2.1.0
|
7
|
+
Contact: info@nodeum.io
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 4.3.0
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'cgi'
|
14
|
+
|
15
|
+
module Nodeum
|
16
|
+
class TaskSourcesApi
|
17
|
+
attr_accessor :api_client
|
18
|
+
|
19
|
+
def initialize(api_client = ApiClient.default)
|
20
|
+
@api_client = api_client
|
21
|
+
end
|
22
|
+
# Creates a new task source.
|
23
|
+
# **API Key Scope**: task_sources / create
|
24
|
+
# @param task_id [String] Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID.
|
25
|
+
# @param task_source_body [TaskSourceUp]
|
26
|
+
# @param [Hash] opts the optional parameters
|
27
|
+
# @return [TaskSourceDown]
|
28
|
+
def create_task_source(task_id, task_source_body, opts = {})
|
29
|
+
data, _status_code, _headers = create_task_source_with_http_info(task_id, task_source_body, opts)
|
30
|
+
data
|
31
|
+
end
|
32
|
+
|
33
|
+
# Creates a new task source.
|
34
|
+
# **API Key Scope**: task_sources / create
|
35
|
+
# @param task_id [String] Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID.
|
36
|
+
# @param task_source_body [TaskSourceUp]
|
37
|
+
# @param [Hash] opts the optional parameters
|
38
|
+
# @return [Array<(TaskSourceDown, Integer, Hash)>] TaskSourceDown data, response status code and response headers
|
39
|
+
def create_task_source_with_http_info(task_id, task_source_body, opts = {})
|
40
|
+
if @api_client.config.debugging
|
41
|
+
@api_client.config.logger.debug 'Calling API: TaskSourcesApi.create_task_source ...'
|
42
|
+
end
|
43
|
+
# verify the required parameter 'task_id' is set
|
44
|
+
if @api_client.config.client_side_validation && task_id.nil?
|
45
|
+
fail ArgumentError, "Missing the required parameter 'task_id' when calling TaskSourcesApi.create_task_source"
|
46
|
+
end
|
47
|
+
# verify the required parameter 'task_source_body' is set
|
48
|
+
if @api_client.config.client_side_validation && task_source_body.nil?
|
49
|
+
fail ArgumentError, "Missing the required parameter 'task_source_body' when calling TaskSourcesApi.create_task_source"
|
50
|
+
end
|
51
|
+
# resource path
|
52
|
+
local_var_path = '/tasks/{task_id}/task_sources'.sub('{' + 'task_id' + '}', CGI.escape(task_id.to_s))
|
53
|
+
|
54
|
+
# query parameters
|
55
|
+
query_params = opts[:query_params] || {}
|
56
|
+
|
57
|
+
# header parameters
|
58
|
+
header_params = opts[:header_params] || {}
|
59
|
+
# HTTP header 'Accept' (if needed)
|
60
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
61
|
+
# HTTP header 'Content-Type'
|
62
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
63
|
+
|
64
|
+
# form parameters
|
65
|
+
form_params = opts[:form_params] || {}
|
66
|
+
|
67
|
+
# http body (model)
|
68
|
+
post_body = opts[:body] || @api_client.object_to_http_body(task_source_body)
|
69
|
+
|
70
|
+
# return_type
|
71
|
+
return_type = opts[:return_type] || 'TaskSourceDown'
|
72
|
+
|
73
|
+
# auth_names
|
74
|
+
auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth']
|
75
|
+
|
76
|
+
new_options = opts.merge(
|
77
|
+
:header_params => header_params,
|
78
|
+
:query_params => query_params,
|
79
|
+
:form_params => form_params,
|
80
|
+
:body => post_body,
|
81
|
+
:auth_names => auth_names,
|
82
|
+
:return_type => return_type
|
83
|
+
)
|
84
|
+
|
85
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
86
|
+
if @api_client.config.debugging
|
87
|
+
@api_client.config.logger.debug "API called: TaskSourcesApi#create_task_source\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
88
|
+
end
|
89
|
+
return data, status_code, headers
|
90
|
+
end
|
91
|
+
|
92
|
+
# Destroys a specific task source.
|
93
|
+
# **API Key Scope**: task_sources / destroy
|
94
|
+
# @param task_id [String] Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID.
|
95
|
+
# @param task_source_id [Integer] Numeric ID of task source.
|
96
|
+
# @param [Hash] opts the optional parameters
|
97
|
+
# @return [nil]
|
98
|
+
def destroy_task_source(task_id, task_source_id, opts = {})
|
99
|
+
destroy_task_source_with_http_info(task_id, task_source_id, opts)
|
100
|
+
nil
|
101
|
+
end
|
102
|
+
|
103
|
+
# Destroys a specific task source.
|
104
|
+
# **API Key Scope**: task_sources / destroy
|
105
|
+
# @param task_id [String] Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID.
|
106
|
+
# @param task_source_id [Integer] Numeric ID of task source.
|
107
|
+
# @param [Hash] opts the optional parameters
|
108
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
109
|
+
def destroy_task_source_with_http_info(task_id, task_source_id, opts = {})
|
110
|
+
if @api_client.config.debugging
|
111
|
+
@api_client.config.logger.debug 'Calling API: TaskSourcesApi.destroy_task_source ...'
|
112
|
+
end
|
113
|
+
# verify the required parameter 'task_id' is set
|
114
|
+
if @api_client.config.client_side_validation && task_id.nil?
|
115
|
+
fail ArgumentError, "Missing the required parameter 'task_id' when calling TaskSourcesApi.destroy_task_source"
|
116
|
+
end
|
117
|
+
# verify the required parameter 'task_source_id' is set
|
118
|
+
if @api_client.config.client_side_validation && task_source_id.nil?
|
119
|
+
fail ArgumentError, "Missing the required parameter 'task_source_id' when calling TaskSourcesApi.destroy_task_source"
|
120
|
+
end
|
121
|
+
# resource path
|
122
|
+
local_var_path = '/tasks/{task_id}/task_sources/{task_source_id}'.sub('{' + 'task_id' + '}', CGI.escape(task_id.to_s)).sub('{' + 'task_source_id' + '}', CGI.escape(task_source_id.to_s))
|
123
|
+
|
124
|
+
# query parameters
|
125
|
+
query_params = opts[:query_params] || {}
|
126
|
+
|
127
|
+
# header parameters
|
128
|
+
header_params = opts[:header_params] || {}
|
129
|
+
|
130
|
+
# form parameters
|
131
|
+
form_params = opts[:form_params] || {}
|
132
|
+
|
133
|
+
# http body (model)
|
134
|
+
post_body = opts[:body]
|
135
|
+
|
136
|
+
# return_type
|
137
|
+
return_type = opts[:return_type]
|
138
|
+
|
139
|
+
# auth_names
|
140
|
+
auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth']
|
141
|
+
|
142
|
+
new_options = opts.merge(
|
143
|
+
:header_params => header_params,
|
144
|
+
:query_params => query_params,
|
145
|
+
:form_params => form_params,
|
146
|
+
:body => post_body,
|
147
|
+
:auth_names => auth_names,
|
148
|
+
:return_type => return_type
|
149
|
+
)
|
150
|
+
|
151
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
152
|
+
if @api_client.config.debugging
|
153
|
+
@api_client.config.logger.debug "API called: TaskSourcesApi#destroy_task_source\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
154
|
+
end
|
155
|
+
return data, status_code, headers
|
156
|
+
end
|
157
|
+
|
158
|
+
# Lists all task sources.
|
159
|
+
# **API Key Scope**: task_sources / index
|
160
|
+
# @param task_id [String] Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID.
|
161
|
+
# @param [Hash] opts the optional parameters
|
162
|
+
# @option opts [Integer] :limit The number of items to display for pagination.
|
163
|
+
# @option opts [Integer] :offset The number of items to skip for pagination.
|
164
|
+
# @option opts [Array<String>] :sort_by Sort results by attribute. Can sort on multiple attributes, separated by `|`. Order direction can be suffixing the attribute by either `:asc` (default) or `:desc`.
|
165
|
+
# @option opts [String] :id Filter on id
|
166
|
+
# @option opts [String] :file_id Filter on file id
|
167
|
+
# @option opts [String] :import_file_id Filter on import file id
|
168
|
+
# @option opts [String] :tape_id Filter on tape id
|
169
|
+
# @option opts [String] :pool_id Filter on a pool id
|
170
|
+
# @return [TaskSourceCollection]
|
171
|
+
def index_task_sources(task_id, opts = {})
|
172
|
+
data, _status_code, _headers = index_task_sources_with_http_info(task_id, opts)
|
173
|
+
data
|
174
|
+
end
|
175
|
+
|
176
|
+
# Lists all task sources.
|
177
|
+
# **API Key Scope**: task_sources / index
|
178
|
+
# @param task_id [String] Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID.
|
179
|
+
# @param [Hash] opts the optional parameters
|
180
|
+
# @option opts [Integer] :limit The number of items to display for pagination.
|
181
|
+
# @option opts [Integer] :offset The number of items to skip for pagination.
|
182
|
+
# @option opts [Array<String>] :sort_by Sort results by attribute. Can sort on multiple attributes, separated by `|`. Order direction can be suffixing the attribute by either `:asc` (default) or `:desc`.
|
183
|
+
# @option opts [String] :id Filter on id
|
184
|
+
# @option opts [String] :file_id Filter on file id
|
185
|
+
# @option opts [String] :import_file_id Filter on import file id
|
186
|
+
# @option opts [String] :tape_id Filter on tape id
|
187
|
+
# @option opts [String] :pool_id Filter on a pool id
|
188
|
+
# @return [Array<(TaskSourceCollection, Integer, Hash)>] TaskSourceCollection data, response status code and response headers
|
189
|
+
def index_task_sources_with_http_info(task_id, opts = {})
|
190
|
+
if @api_client.config.debugging
|
191
|
+
@api_client.config.logger.debug 'Calling API: TaskSourcesApi.index_task_sources ...'
|
192
|
+
end
|
193
|
+
# verify the required parameter 'task_id' is set
|
194
|
+
if @api_client.config.client_side_validation && task_id.nil?
|
195
|
+
fail ArgumentError, "Missing the required parameter 'task_id' when calling TaskSourcesApi.index_task_sources"
|
196
|
+
end
|
197
|
+
# resource path
|
198
|
+
local_var_path = '/tasks/{task_id}/task_sources'.sub('{' + 'task_id' + '}', CGI.escape(task_id.to_s))
|
199
|
+
|
200
|
+
# query parameters
|
201
|
+
query_params = opts[:query_params] || {}
|
202
|
+
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
203
|
+
query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
|
204
|
+
query_params[:'sort_by'] = @api_client.build_collection_param(opts[:'sort_by'], :pipe) if !opts[:'sort_by'].nil?
|
205
|
+
query_params[:'id'] = opts[:'id'] if !opts[:'id'].nil?
|
206
|
+
query_params[:'file_id'] = opts[:'file_id'] if !opts[:'file_id'].nil?
|
207
|
+
query_params[:'import_file_id'] = opts[:'import_file_id'] if !opts[:'import_file_id'].nil?
|
208
|
+
query_params[:'tape_id'] = opts[:'tape_id'] if !opts[:'tape_id'].nil?
|
209
|
+
query_params[:'pool_id'] = opts[:'pool_id'] if !opts[:'pool_id'].nil?
|
210
|
+
|
211
|
+
# header parameters
|
212
|
+
header_params = opts[:header_params] || {}
|
213
|
+
# HTTP header 'Accept' (if needed)
|
214
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
215
|
+
|
216
|
+
# form parameters
|
217
|
+
form_params = opts[:form_params] || {}
|
218
|
+
|
219
|
+
# http body (model)
|
220
|
+
post_body = opts[:body]
|
221
|
+
|
222
|
+
# return_type
|
223
|
+
return_type = opts[:return_type] || 'TaskSourceCollection'
|
224
|
+
|
225
|
+
# auth_names
|
226
|
+
auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth']
|
227
|
+
|
228
|
+
new_options = opts.merge(
|
229
|
+
:header_params => header_params,
|
230
|
+
:query_params => query_params,
|
231
|
+
:form_params => form_params,
|
232
|
+
:body => post_body,
|
233
|
+
:auth_names => auth_names,
|
234
|
+
:return_type => return_type
|
235
|
+
)
|
236
|
+
|
237
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
238
|
+
if @api_client.config.debugging
|
239
|
+
@api_client.config.logger.debug "API called: TaskSourcesApi#index_task_sources\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
240
|
+
end
|
241
|
+
return data, status_code, headers
|
242
|
+
end
|
243
|
+
|
244
|
+
# Displays a specific task source.
|
245
|
+
# **API Key Scope**: task_sources / show
|
246
|
+
# @param task_id [String] Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID.
|
247
|
+
# @param task_source_id [Integer] Numeric ID of task source.
|
248
|
+
# @param [Hash] opts the optional parameters
|
249
|
+
# @return [TaskSourceDown]
|
250
|
+
def show_task_source(task_id, task_source_id, opts = {})
|
251
|
+
data, _status_code, _headers = show_task_source_with_http_info(task_id, task_source_id, opts)
|
252
|
+
data
|
253
|
+
end
|
254
|
+
|
255
|
+
# Displays a specific task source.
|
256
|
+
# **API Key Scope**: task_sources / show
|
257
|
+
# @param task_id [String] Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID.
|
258
|
+
# @param task_source_id [Integer] Numeric ID of task source.
|
259
|
+
# @param [Hash] opts the optional parameters
|
260
|
+
# @return [Array<(TaskSourceDown, Integer, Hash)>] TaskSourceDown data, response status code and response headers
|
261
|
+
def show_task_source_with_http_info(task_id, task_source_id, opts = {})
|
262
|
+
if @api_client.config.debugging
|
263
|
+
@api_client.config.logger.debug 'Calling API: TaskSourcesApi.show_task_source ...'
|
264
|
+
end
|
265
|
+
# verify the required parameter 'task_id' is set
|
266
|
+
if @api_client.config.client_side_validation && task_id.nil?
|
267
|
+
fail ArgumentError, "Missing the required parameter 'task_id' when calling TaskSourcesApi.show_task_source"
|
268
|
+
end
|
269
|
+
# verify the required parameter 'task_source_id' is set
|
270
|
+
if @api_client.config.client_side_validation && task_source_id.nil?
|
271
|
+
fail ArgumentError, "Missing the required parameter 'task_source_id' when calling TaskSourcesApi.show_task_source"
|
272
|
+
end
|
273
|
+
# resource path
|
274
|
+
local_var_path = '/tasks/{task_id}/task_sources/{task_source_id}'.sub('{' + 'task_id' + '}', CGI.escape(task_id.to_s)).sub('{' + 'task_source_id' + '}', CGI.escape(task_source_id.to_s))
|
275
|
+
|
276
|
+
# query parameters
|
277
|
+
query_params = opts[:query_params] || {}
|
278
|
+
|
279
|
+
# header parameters
|
280
|
+
header_params = opts[:header_params] || {}
|
281
|
+
# HTTP header 'Accept' (if needed)
|
282
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
283
|
+
|
284
|
+
# form parameters
|
285
|
+
form_params = opts[:form_params] || {}
|
286
|
+
|
287
|
+
# http body (model)
|
288
|
+
post_body = opts[:body]
|
289
|
+
|
290
|
+
# return_type
|
291
|
+
return_type = opts[:return_type] || 'TaskSourceDown'
|
292
|
+
|
293
|
+
# auth_names
|
294
|
+
auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth']
|
295
|
+
|
296
|
+
new_options = opts.merge(
|
297
|
+
:header_params => header_params,
|
298
|
+
:query_params => query_params,
|
299
|
+
:form_params => form_params,
|
300
|
+
:body => post_body,
|
301
|
+
:auth_names => auth_names,
|
302
|
+
:return_type => return_type
|
303
|
+
)
|
304
|
+
|
305
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
306
|
+
if @api_client.config.debugging
|
307
|
+
@api_client.config.logger.debug "API called: TaskSourcesApi#show_task_source\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
308
|
+
end
|
309
|
+
return data, status_code, headers
|
310
|
+
end
|
311
|
+
|
312
|
+
# Updates a specific task source.
|
313
|
+
# **API Key Scope**: task_sources / update
|
314
|
+
# @param task_id [String] Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID.
|
315
|
+
# @param task_source_id [Integer] Numeric ID of task source.
|
316
|
+
# @param task_source_body [TaskSourceUp]
|
317
|
+
# @param [Hash] opts the optional parameters
|
318
|
+
# @return [TaskSourceDown]
|
319
|
+
def update_task_source(task_id, task_source_id, task_source_body, opts = {})
|
320
|
+
data, _status_code, _headers = update_task_source_with_http_info(task_id, task_source_id, task_source_body, opts)
|
321
|
+
data
|
322
|
+
end
|
323
|
+
|
324
|
+
# Updates a specific task source.
|
325
|
+
# **API Key Scope**: task_sources / update
|
326
|
+
# @param task_id [String] Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID.
|
327
|
+
# @param task_source_id [Integer] Numeric ID of task source.
|
328
|
+
# @param task_source_body [TaskSourceUp]
|
329
|
+
# @param [Hash] opts the optional parameters
|
330
|
+
# @return [Array<(TaskSourceDown, Integer, Hash)>] TaskSourceDown data, response status code and response headers
|
331
|
+
def update_task_source_with_http_info(task_id, task_source_id, task_source_body, opts = {})
|
332
|
+
if @api_client.config.debugging
|
333
|
+
@api_client.config.logger.debug 'Calling API: TaskSourcesApi.update_task_source ...'
|
334
|
+
end
|
335
|
+
# verify the required parameter 'task_id' is set
|
336
|
+
if @api_client.config.client_side_validation && task_id.nil?
|
337
|
+
fail ArgumentError, "Missing the required parameter 'task_id' when calling TaskSourcesApi.update_task_source"
|
338
|
+
end
|
339
|
+
# verify the required parameter 'task_source_id' is set
|
340
|
+
if @api_client.config.client_side_validation && task_source_id.nil?
|
341
|
+
fail ArgumentError, "Missing the required parameter 'task_source_id' when calling TaskSourcesApi.update_task_source"
|
342
|
+
end
|
343
|
+
# verify the required parameter 'task_source_body' is set
|
344
|
+
if @api_client.config.client_side_validation && task_source_body.nil?
|
345
|
+
fail ArgumentError, "Missing the required parameter 'task_source_body' when calling TaskSourcesApi.update_task_source"
|
346
|
+
end
|
347
|
+
# resource path
|
348
|
+
local_var_path = '/tasks/{task_id}/task_sources/{task_source_id}'.sub('{' + 'task_id' + '}', CGI.escape(task_id.to_s)).sub('{' + 'task_source_id' + '}', CGI.escape(task_source_id.to_s))
|
349
|
+
|
350
|
+
# query parameters
|
351
|
+
query_params = opts[:query_params] || {}
|
352
|
+
|
353
|
+
# header parameters
|
354
|
+
header_params = opts[:header_params] || {}
|
355
|
+
# HTTP header 'Accept' (if needed)
|
356
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
357
|
+
# HTTP header 'Content-Type'
|
358
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
359
|
+
|
360
|
+
# form parameters
|
361
|
+
form_params = opts[:form_params] || {}
|
362
|
+
|
363
|
+
# http body (model)
|
364
|
+
post_body = opts[:body] || @api_client.object_to_http_body(task_source_body)
|
365
|
+
|
366
|
+
# return_type
|
367
|
+
return_type = opts[:return_type] || 'TaskSourceDown'
|
368
|
+
|
369
|
+
# auth_names
|
370
|
+
auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth']
|
371
|
+
|
372
|
+
new_options = opts.merge(
|
373
|
+
:header_params => header_params,
|
374
|
+
:query_params => query_params,
|
375
|
+
:form_params => form_params,
|
376
|
+
:body => post_body,
|
377
|
+
:auth_names => auth_names,
|
378
|
+
:return_type => return_type
|
379
|
+
)
|
380
|
+
|
381
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
382
|
+
if @api_client.config.debugging
|
383
|
+
@api_client.config.logger.debug "API called: TaskSourcesApi#update_task_source\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
384
|
+
end
|
385
|
+
return data, status_code, headers
|
386
|
+
end
|
387
|
+
end
|
388
|
+
end
|
@@ -0,0 +1,951 @@
|
|
1
|
+
=begin
|
2
|
+
#Nodeum API
|
3
|
+
|
4
|
+
#The Nodeum API makes it easy to tap into the digital data mesh that runs across your organisation. Make requests to our API endpoints and we’ll give you everything you need to interconnect your business workflows with your storage. All production API requests are made to: http://nodeumhostname/api/ The current production version of the API is v1. **REST** The Nodeum API is a RESTful API. This means that the API is designed to allow you to get, create, update, & delete objects with the HTTP verbs GET, POST, PUT, PATCH, & DELETE. **JSON** The Nodeum API speaks exclusively in JSON. This means that you should always set the Content-Type header to application/json to ensure that your requests are properly accepted and processed by the API. **Authentication** All API calls require user-password authentication. **Cross-Origin Resource Sharing** The Nodeum API supports CORS for communicating from Javascript for these endpoints. You will need to specify an Origin URI when creating your application to allow for CORS to be whitelisted for your domain. **Pagination** Some endpoints such as File Listing return a potentially lengthy array of objects. In order to keep the response sizes manageable the API will take advantage of pagination. Pagination is a mechanism for returning a subset of the results for a request and allowing for subsequent requests to “page” through the rest of the results until the end is reached. Paginated endpoints follow a standard interface that accepts two query parameters, limit and offset, and return a payload that follows a standard form. These parameters names and their behavior are borrowed from SQL LIMIT and OFFSET keywords. **Versioning** The Nodeum API is constantly being worked on to add features, make improvements, and fix bugs. This means that you should expect changes to be introduced and documented. However, there are some changes or additions that are considered backwards-compatible and your applications should be flexible enough to handle them. These include: - Adding new endpoints to the API - Adding new attributes to the response of an existing endpoint - Changing the order of attributes of responses (JSON by definition is an object of unordered key/value pairs) **Filter parameters** When browsing a list of items, multiple filter parameters may be applied. Some operators can be added to the value as a prefix: - `=` value is equal. Default operator, may be omitted - `!=` value is different - `>` greater than - `>=` greater than or equal - `<` lower than - `>=` lower than or equal - `><` included in list, items should be separated by `|` - `!><` not included in list, items should be separated by `|` - `~` pattern matching, may include `%` (any characters) and `_` (one character) - `!~` pattern not matching, may include `%` (any characters) and `_` (one character)
|
5
|
+
|
6
|
+
The version of the OpenAPI document: 2.1.0
|
7
|
+
Contact: info@nodeum.io
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 4.3.0
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'cgi'
|
14
|
+
|
15
|
+
module Nodeum
|
16
|
+
class TasksApi
|
17
|
+
attr_accessor :api_client
|
18
|
+
|
19
|
+
def initialize(api_client = ApiClient.default)
|
20
|
+
@api_client = api_client
|
21
|
+
end
|
22
|
+
# Creates a new task.
|
23
|
+
# **API Key Scope**: tasks / create
|
24
|
+
# @param task_body [Task]
|
25
|
+
# @param [Hash] opts the optional parameters
|
26
|
+
# @return [Task]
|
27
|
+
def create_task(task_body, opts = {})
|
28
|
+
data, _status_code, _headers = create_task_with_http_info(task_body, opts)
|
29
|
+
data
|
30
|
+
end
|
31
|
+
|
32
|
+
# Creates a new task.
|
33
|
+
# **API Key Scope**: tasks / create
|
34
|
+
# @param task_body [Task]
|
35
|
+
# @param [Hash] opts the optional parameters
|
36
|
+
# @return [Array<(Task, Integer, Hash)>] Task data, response status code and response headers
|
37
|
+
def create_task_with_http_info(task_body, opts = {})
|
38
|
+
if @api_client.config.debugging
|
39
|
+
@api_client.config.logger.debug 'Calling API: TasksApi.create_task ...'
|
40
|
+
end
|
41
|
+
# verify the required parameter 'task_body' is set
|
42
|
+
if @api_client.config.client_side_validation && task_body.nil?
|
43
|
+
fail ArgumentError, "Missing the required parameter 'task_body' when calling TasksApi.create_task"
|
44
|
+
end
|
45
|
+
# resource path
|
46
|
+
local_var_path = '/tasks'
|
47
|
+
|
48
|
+
# query parameters
|
49
|
+
query_params = opts[:query_params] || {}
|
50
|
+
|
51
|
+
# header parameters
|
52
|
+
header_params = opts[:header_params] || {}
|
53
|
+
# HTTP header 'Accept' (if needed)
|
54
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
55
|
+
# HTTP header 'Content-Type'
|
56
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
57
|
+
|
58
|
+
# form parameters
|
59
|
+
form_params = opts[:form_params] || {}
|
60
|
+
|
61
|
+
# http body (model)
|
62
|
+
post_body = opts[:body] || @api_client.object_to_http_body(task_body)
|
63
|
+
|
64
|
+
# return_type
|
65
|
+
return_type = opts[:return_type] || 'Task'
|
66
|
+
|
67
|
+
# auth_names
|
68
|
+
auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth']
|
69
|
+
|
70
|
+
new_options = opts.merge(
|
71
|
+
:header_params => header_params,
|
72
|
+
:query_params => query_params,
|
73
|
+
:form_params => form_params,
|
74
|
+
:body => post_body,
|
75
|
+
:auth_names => auth_names,
|
76
|
+
:return_type => return_type
|
77
|
+
)
|
78
|
+
|
79
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
80
|
+
if @api_client.config.debugging
|
81
|
+
@api_client.config.logger.debug "API called: TasksApi#create_task\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
82
|
+
end
|
83
|
+
return data, status_code, headers
|
84
|
+
end
|
85
|
+
|
86
|
+
# Destroys a specific task.
|
87
|
+
# **API Key Scope**: tasks / destroy
|
88
|
+
# @param task_id [String] Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID.
|
89
|
+
# @param [Hash] opts the optional parameters
|
90
|
+
# @return [nil]
|
91
|
+
def destroy_task(task_id, opts = {})
|
92
|
+
destroy_task_with_http_info(task_id, opts)
|
93
|
+
nil
|
94
|
+
end
|
95
|
+
|
96
|
+
# Destroys a specific task.
|
97
|
+
# **API Key Scope**: tasks / destroy
|
98
|
+
# @param task_id [String] Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID.
|
99
|
+
# @param [Hash] opts the optional parameters
|
100
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
101
|
+
def destroy_task_with_http_info(task_id, opts = {})
|
102
|
+
if @api_client.config.debugging
|
103
|
+
@api_client.config.logger.debug 'Calling API: TasksApi.destroy_task ...'
|
104
|
+
end
|
105
|
+
# verify the required parameter 'task_id' is set
|
106
|
+
if @api_client.config.client_side_validation && task_id.nil?
|
107
|
+
fail ArgumentError, "Missing the required parameter 'task_id' when calling TasksApi.destroy_task"
|
108
|
+
end
|
109
|
+
# resource path
|
110
|
+
local_var_path = '/tasks/{task_id}'.sub('{' + 'task_id' + '}', CGI.escape(task_id.to_s))
|
111
|
+
|
112
|
+
# query parameters
|
113
|
+
query_params = opts[:query_params] || {}
|
114
|
+
|
115
|
+
# header parameters
|
116
|
+
header_params = opts[:header_params] || {}
|
117
|
+
|
118
|
+
# form parameters
|
119
|
+
form_params = opts[:form_params] || {}
|
120
|
+
|
121
|
+
# http body (model)
|
122
|
+
post_body = opts[:body]
|
123
|
+
|
124
|
+
# return_type
|
125
|
+
return_type = opts[:return_type]
|
126
|
+
|
127
|
+
# auth_names
|
128
|
+
auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth']
|
129
|
+
|
130
|
+
new_options = opts.merge(
|
131
|
+
:header_params => header_params,
|
132
|
+
:query_params => query_params,
|
133
|
+
:form_params => form_params,
|
134
|
+
:body => post_body,
|
135
|
+
:auth_names => auth_names,
|
136
|
+
:return_type => return_type
|
137
|
+
)
|
138
|
+
|
139
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
140
|
+
if @api_client.config.debugging
|
141
|
+
@api_client.config.logger.debug "API called: TasksApi#destroy_task\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
142
|
+
end
|
143
|
+
return data, status_code, headers
|
144
|
+
end
|
145
|
+
|
146
|
+
# Lists all tasks.
|
147
|
+
# **API Key Scope**: tasks / index
|
148
|
+
# @param [Hash] opts the optional parameters
|
149
|
+
# @option opts [Integer] :limit The number of items to display for pagination.
|
150
|
+
# @option opts [Integer] :offset The number of items to skip for pagination.
|
151
|
+
# @option opts [Array<String>] :sort_by Sort results by attribute. Can sort on multiple attributes, separated by `|`. Order direction can be suffixing the attribute by either `:asc` (default) or `:desc`.
|
152
|
+
# @option opts [String] :id Filter on id
|
153
|
+
# @option opts [String] :name Filter on name
|
154
|
+
# @option opts [String] :comment Filter on comment
|
155
|
+
# @option opts [String] :workflow_type Filter on task workflow type
|
156
|
+
# @option opts [String] :workflow_action Filter on task workflow action
|
157
|
+
# @option opts [String] :source_type Filter on task source type
|
158
|
+
# @option opts [String] :destination_type Filter on task destination type
|
159
|
+
# @option opts [String] :priority Filter on priority
|
160
|
+
# @option opts [String] :conflict_resolution Filter on conflict resolution
|
161
|
+
# @option opts [String] :action Filter on action
|
162
|
+
# @option opts [String] :activate Filter on activate
|
163
|
+
# @option opts [String] :creation_date Filter on creation date
|
164
|
+
# @option opts [String] :creation_username Filter on creation username
|
165
|
+
# @option opts [String] :modification_date Filter on modification date
|
166
|
+
# @option opts [String] :modification_username Filter on modification username
|
167
|
+
# @option opts [String] :job_started Filter on job started
|
168
|
+
# @option opts [String] :job_finished Filter on job finished
|
169
|
+
# @option opts [String] :status Filter on status
|
170
|
+
# @option opts [String] :processed_size Filter on processed size
|
171
|
+
# @option opts [String] :to_process_size Filter on to process size
|
172
|
+
# @option opts [String] :source_pool_id Filter on task source pool id
|
173
|
+
# @option opts [String] :source_pool_name Filter on task source pool name
|
174
|
+
# @option opts [String] :source_tape_id Filter on task source tape id
|
175
|
+
# @option opts [String] :source_tape_barcode Filter on task source tape barcode
|
176
|
+
# @option opts [String] :destination_pool_id Filter on task destination pool id
|
177
|
+
# @option opts [String] :destination_pool_name Filter on task destination pool name
|
178
|
+
# @option opts [String] :destination_tape_id Filter on task destination tape id
|
179
|
+
# @option opts [String] :destination_tape_barcode Filter on task destination tape barcode
|
180
|
+
# @return [TaskCollection]
|
181
|
+
def index_tasks(opts = {})
|
182
|
+
data, _status_code, _headers = index_tasks_with_http_info(opts)
|
183
|
+
data
|
184
|
+
end
|
185
|
+
|
186
|
+
# Lists all tasks.
|
187
|
+
# **API Key Scope**: tasks / index
|
188
|
+
# @param [Hash] opts the optional parameters
|
189
|
+
# @option opts [Integer] :limit The number of items to display for pagination.
|
190
|
+
# @option opts [Integer] :offset The number of items to skip for pagination.
|
191
|
+
# @option opts [Array<String>] :sort_by Sort results by attribute. Can sort on multiple attributes, separated by `|`. Order direction can be suffixing the attribute by either `:asc` (default) or `:desc`.
|
192
|
+
# @option opts [String] :id Filter on id
|
193
|
+
# @option opts [String] :name Filter on name
|
194
|
+
# @option opts [String] :comment Filter on comment
|
195
|
+
# @option opts [String] :workflow_type Filter on task workflow type
|
196
|
+
# @option opts [String] :workflow_action Filter on task workflow action
|
197
|
+
# @option opts [String] :source_type Filter on task source type
|
198
|
+
# @option opts [String] :destination_type Filter on task destination type
|
199
|
+
# @option opts [String] :priority Filter on priority
|
200
|
+
# @option opts [String] :conflict_resolution Filter on conflict resolution
|
201
|
+
# @option opts [String] :action Filter on action
|
202
|
+
# @option opts [String] :activate Filter on activate
|
203
|
+
# @option opts [String] :creation_date Filter on creation date
|
204
|
+
# @option opts [String] :creation_username Filter on creation username
|
205
|
+
# @option opts [String] :modification_date Filter on modification date
|
206
|
+
# @option opts [String] :modification_username Filter on modification username
|
207
|
+
# @option opts [String] :job_started Filter on job started
|
208
|
+
# @option opts [String] :job_finished Filter on job finished
|
209
|
+
# @option opts [String] :status Filter on status
|
210
|
+
# @option opts [String] :processed_size Filter on processed size
|
211
|
+
# @option opts [String] :to_process_size Filter on to process size
|
212
|
+
# @option opts [String] :source_pool_id Filter on task source pool id
|
213
|
+
# @option opts [String] :source_pool_name Filter on task source pool name
|
214
|
+
# @option opts [String] :source_tape_id Filter on task source tape id
|
215
|
+
# @option opts [String] :source_tape_barcode Filter on task source tape barcode
|
216
|
+
# @option opts [String] :destination_pool_id Filter on task destination pool id
|
217
|
+
# @option opts [String] :destination_pool_name Filter on task destination pool name
|
218
|
+
# @option opts [String] :destination_tape_id Filter on task destination tape id
|
219
|
+
# @option opts [String] :destination_tape_barcode Filter on task destination tape barcode
|
220
|
+
# @return [Array<(TaskCollection, Integer, Hash)>] TaskCollection data, response status code and response headers
|
221
|
+
def index_tasks_with_http_info(opts = {})
|
222
|
+
if @api_client.config.debugging
|
223
|
+
@api_client.config.logger.debug 'Calling API: TasksApi.index_tasks ...'
|
224
|
+
end
|
225
|
+
# resource path
|
226
|
+
local_var_path = '/tasks'
|
227
|
+
|
228
|
+
# query parameters
|
229
|
+
query_params = opts[:query_params] || {}
|
230
|
+
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
231
|
+
query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
|
232
|
+
query_params[:'sort_by'] = @api_client.build_collection_param(opts[:'sort_by'], :pipe) if !opts[:'sort_by'].nil?
|
233
|
+
query_params[:'id'] = opts[:'id'] if !opts[:'id'].nil?
|
234
|
+
query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
|
235
|
+
query_params[:'comment'] = opts[:'comment'] if !opts[:'comment'].nil?
|
236
|
+
query_params[:'workflow_type'] = opts[:'workflow_type'] if !opts[:'workflow_type'].nil?
|
237
|
+
query_params[:'workflow_action'] = opts[:'workflow_action'] if !opts[:'workflow_action'].nil?
|
238
|
+
query_params[:'source_type'] = opts[:'source_type'] if !opts[:'source_type'].nil?
|
239
|
+
query_params[:'destination_type'] = opts[:'destination_type'] if !opts[:'destination_type'].nil?
|
240
|
+
query_params[:'priority'] = opts[:'priority'] if !opts[:'priority'].nil?
|
241
|
+
query_params[:'conflict_resolution'] = opts[:'conflict_resolution'] if !opts[:'conflict_resolution'].nil?
|
242
|
+
query_params[:'action'] = opts[:'action'] if !opts[:'action'].nil?
|
243
|
+
query_params[:'activate'] = opts[:'activate'] if !opts[:'activate'].nil?
|
244
|
+
query_params[:'creation_date'] = opts[:'creation_date'] if !opts[:'creation_date'].nil?
|
245
|
+
query_params[:'creation_username'] = opts[:'creation_username'] if !opts[:'creation_username'].nil?
|
246
|
+
query_params[:'modification_date'] = opts[:'modification_date'] if !opts[:'modification_date'].nil?
|
247
|
+
query_params[:'modification_username'] = opts[:'modification_username'] if !opts[:'modification_username'].nil?
|
248
|
+
query_params[:'job_started'] = opts[:'job_started'] if !opts[:'job_started'].nil?
|
249
|
+
query_params[:'job_finished'] = opts[:'job_finished'] if !opts[:'job_finished'].nil?
|
250
|
+
query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
|
251
|
+
query_params[:'processed_size'] = opts[:'processed_size'] if !opts[:'processed_size'].nil?
|
252
|
+
query_params[:'to_process_size'] = opts[:'to_process_size'] if !opts[:'to_process_size'].nil?
|
253
|
+
query_params[:'source_pool_id'] = opts[:'source_pool_id'] if !opts[:'source_pool_id'].nil?
|
254
|
+
query_params[:'source_pool_name'] = opts[:'source_pool_name'] if !opts[:'source_pool_name'].nil?
|
255
|
+
query_params[:'source_tape_id'] = opts[:'source_tape_id'] if !opts[:'source_tape_id'].nil?
|
256
|
+
query_params[:'source_tape_barcode'] = opts[:'source_tape_barcode'] if !opts[:'source_tape_barcode'].nil?
|
257
|
+
query_params[:'destination_pool_id'] = opts[:'destination_pool_id'] if !opts[:'destination_pool_id'].nil?
|
258
|
+
query_params[:'destination_pool_name'] = opts[:'destination_pool_name'] if !opts[:'destination_pool_name'].nil?
|
259
|
+
query_params[:'destination_tape_id'] = opts[:'destination_tape_id'] if !opts[:'destination_tape_id'].nil?
|
260
|
+
query_params[:'destination_tape_barcode'] = opts[:'destination_tape_barcode'] if !opts[:'destination_tape_barcode'].nil?
|
261
|
+
|
262
|
+
# header parameters
|
263
|
+
header_params = opts[:header_params] || {}
|
264
|
+
# HTTP header 'Accept' (if needed)
|
265
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
266
|
+
|
267
|
+
# form parameters
|
268
|
+
form_params = opts[:form_params] || {}
|
269
|
+
|
270
|
+
# http body (model)
|
271
|
+
post_body = opts[:body]
|
272
|
+
|
273
|
+
# return_type
|
274
|
+
return_type = opts[:return_type] || 'TaskCollection'
|
275
|
+
|
276
|
+
# auth_names
|
277
|
+
auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth']
|
278
|
+
|
279
|
+
new_options = opts.merge(
|
280
|
+
:header_params => header_params,
|
281
|
+
:query_params => query_params,
|
282
|
+
:form_params => form_params,
|
283
|
+
:body => post_body,
|
284
|
+
:auth_names => auth_names,
|
285
|
+
:return_type => return_type
|
286
|
+
)
|
287
|
+
|
288
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
289
|
+
if @api_client.config.debugging
|
290
|
+
@api_client.config.logger.debug "API called: TasksApi#index_tasks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
291
|
+
end
|
292
|
+
return data, status_code, headers
|
293
|
+
end
|
294
|
+
|
295
|
+
# Pause a task.
|
296
|
+
# **API Key Scope**: tasks / action
|
297
|
+
# @param task_id [String] Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID.
|
298
|
+
# @param [Hash] opts the optional parameters
|
299
|
+
# @return [ActiveJobStatus]
|
300
|
+
def pause_task(task_id, opts = {})
|
301
|
+
data, _status_code, _headers = pause_task_with_http_info(task_id, opts)
|
302
|
+
data
|
303
|
+
end
|
304
|
+
|
305
|
+
# Pause a task.
|
306
|
+
# **API Key Scope**: tasks / action
|
307
|
+
# @param task_id [String] Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID.
|
308
|
+
# @param [Hash] opts the optional parameters
|
309
|
+
# @return [Array<(ActiveJobStatus, Integer, Hash)>] ActiveJobStatus data, response status code and response headers
|
310
|
+
def pause_task_with_http_info(task_id, opts = {})
|
311
|
+
if @api_client.config.debugging
|
312
|
+
@api_client.config.logger.debug 'Calling API: TasksApi.pause_task ...'
|
313
|
+
end
|
314
|
+
# verify the required parameter 'task_id' is set
|
315
|
+
if @api_client.config.client_side_validation && task_id.nil?
|
316
|
+
fail ArgumentError, "Missing the required parameter 'task_id' when calling TasksApi.pause_task"
|
317
|
+
end
|
318
|
+
# resource path
|
319
|
+
local_var_path = '/tasks/{task_id}/action/pause'.sub('{' + 'task_id' + '}', CGI.escape(task_id.to_s))
|
320
|
+
|
321
|
+
# query parameters
|
322
|
+
query_params = opts[:query_params] || {}
|
323
|
+
|
324
|
+
# header parameters
|
325
|
+
header_params = opts[:header_params] || {}
|
326
|
+
# HTTP header 'Accept' (if needed)
|
327
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'queued', 'working', 'failed'])
|
328
|
+
|
329
|
+
# form parameters
|
330
|
+
form_params = opts[:form_params] || {}
|
331
|
+
|
332
|
+
# http body (model)
|
333
|
+
post_body = opts[:body]
|
334
|
+
|
335
|
+
# return_type
|
336
|
+
return_type = opts[:return_type] || 'ActiveJobStatus'
|
337
|
+
|
338
|
+
# auth_names
|
339
|
+
auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth']
|
340
|
+
|
341
|
+
new_options = opts.merge(
|
342
|
+
:header_params => header_params,
|
343
|
+
:query_params => query_params,
|
344
|
+
:form_params => form_params,
|
345
|
+
:body => post_body,
|
346
|
+
:auth_names => auth_names,
|
347
|
+
:return_type => return_type
|
348
|
+
)
|
349
|
+
|
350
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
351
|
+
if @api_client.config.debugging
|
352
|
+
@api_client.config.logger.debug "API called: TasksApi#pause_task\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
353
|
+
end
|
354
|
+
return data, status_code, headers
|
355
|
+
end
|
356
|
+
|
357
|
+
# Check result of a task pause request.
|
358
|
+
# **API Key Scope**: tasks / action
|
359
|
+
# @param task_id [String] Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID.
|
360
|
+
# @param job_id [String] ID of active job
|
361
|
+
# @param [Hash] opts the optional parameters
|
362
|
+
# @return [ActiveJobStatus]
|
363
|
+
def pause_task_result(task_id, job_id, opts = {})
|
364
|
+
data, _status_code, _headers = pause_task_result_with_http_info(task_id, job_id, opts)
|
365
|
+
data
|
366
|
+
end
|
367
|
+
|
368
|
+
# Check result of a task pause request.
|
369
|
+
# **API Key Scope**: tasks / action
|
370
|
+
# @param task_id [String] Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID.
|
371
|
+
# @param job_id [String] ID of active job
|
372
|
+
# @param [Hash] opts the optional parameters
|
373
|
+
# @return [Array<(ActiveJobStatus, Integer, Hash)>] ActiveJobStatus data, response status code and response headers
|
374
|
+
def pause_task_result_with_http_info(task_id, job_id, opts = {})
|
375
|
+
if @api_client.config.debugging
|
376
|
+
@api_client.config.logger.debug 'Calling API: TasksApi.pause_task_result ...'
|
377
|
+
end
|
378
|
+
# verify the required parameter 'task_id' is set
|
379
|
+
if @api_client.config.client_side_validation && task_id.nil?
|
380
|
+
fail ArgumentError, "Missing the required parameter 'task_id' when calling TasksApi.pause_task_result"
|
381
|
+
end
|
382
|
+
# verify the required parameter 'job_id' is set
|
383
|
+
if @api_client.config.client_side_validation && job_id.nil?
|
384
|
+
fail ArgumentError, "Missing the required parameter 'job_id' when calling TasksApi.pause_task_result"
|
385
|
+
end
|
386
|
+
# resource path
|
387
|
+
local_var_path = '/tasks/{task_id}/action/pause'.sub('{' + 'task_id' + '}', CGI.escape(task_id.to_s))
|
388
|
+
|
389
|
+
# query parameters
|
390
|
+
query_params = opts[:query_params] || {}
|
391
|
+
query_params[:'job_id'] = job_id
|
392
|
+
|
393
|
+
# header parameters
|
394
|
+
header_params = opts[:header_params] || {}
|
395
|
+
# HTTP header 'Accept' (if needed)
|
396
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'queued', 'working', 'failed'])
|
397
|
+
|
398
|
+
# form parameters
|
399
|
+
form_params = opts[:form_params] || {}
|
400
|
+
|
401
|
+
# http body (model)
|
402
|
+
post_body = opts[:body]
|
403
|
+
|
404
|
+
# return_type
|
405
|
+
return_type = opts[:return_type] || 'ActiveJobStatus'
|
406
|
+
|
407
|
+
# auth_names
|
408
|
+
auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth']
|
409
|
+
|
410
|
+
new_options = opts.merge(
|
411
|
+
:header_params => header_params,
|
412
|
+
:query_params => query_params,
|
413
|
+
:form_params => form_params,
|
414
|
+
:body => post_body,
|
415
|
+
:auth_names => auth_names,
|
416
|
+
:return_type => return_type
|
417
|
+
)
|
418
|
+
|
419
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
420
|
+
if @api_client.config.debugging
|
421
|
+
@api_client.config.logger.debug "API called: TasksApi#pause_task_result\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
422
|
+
end
|
423
|
+
return data, status_code, headers
|
424
|
+
end
|
425
|
+
|
426
|
+
# Resume a task.
|
427
|
+
# **API Key Scope**: tasks / action
|
428
|
+
# @param task_id [String] Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID.
|
429
|
+
# @param [Hash] opts the optional parameters
|
430
|
+
# @return [ActiveJobStatus]
|
431
|
+
def resume_task(task_id, opts = {})
|
432
|
+
data, _status_code, _headers = resume_task_with_http_info(task_id, opts)
|
433
|
+
data
|
434
|
+
end
|
435
|
+
|
436
|
+
# Resume a task.
|
437
|
+
# **API Key Scope**: tasks / action
|
438
|
+
# @param task_id [String] Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID.
|
439
|
+
# @param [Hash] opts the optional parameters
|
440
|
+
# @return [Array<(ActiveJobStatus, Integer, Hash)>] ActiveJobStatus data, response status code and response headers
|
441
|
+
def resume_task_with_http_info(task_id, opts = {})
|
442
|
+
if @api_client.config.debugging
|
443
|
+
@api_client.config.logger.debug 'Calling API: TasksApi.resume_task ...'
|
444
|
+
end
|
445
|
+
# verify the required parameter 'task_id' is set
|
446
|
+
if @api_client.config.client_side_validation && task_id.nil?
|
447
|
+
fail ArgumentError, "Missing the required parameter 'task_id' when calling TasksApi.resume_task"
|
448
|
+
end
|
449
|
+
# resource path
|
450
|
+
local_var_path = '/tasks/{task_id}/action/resume'.sub('{' + 'task_id' + '}', CGI.escape(task_id.to_s))
|
451
|
+
|
452
|
+
# query parameters
|
453
|
+
query_params = opts[:query_params] || {}
|
454
|
+
|
455
|
+
# header parameters
|
456
|
+
header_params = opts[:header_params] || {}
|
457
|
+
# HTTP header 'Accept' (if needed)
|
458
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'queued', 'working', 'failed'])
|
459
|
+
|
460
|
+
# form parameters
|
461
|
+
form_params = opts[:form_params] || {}
|
462
|
+
|
463
|
+
# http body (model)
|
464
|
+
post_body = opts[:body]
|
465
|
+
|
466
|
+
# return_type
|
467
|
+
return_type = opts[:return_type] || 'ActiveJobStatus'
|
468
|
+
|
469
|
+
# auth_names
|
470
|
+
auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth']
|
471
|
+
|
472
|
+
new_options = opts.merge(
|
473
|
+
:header_params => header_params,
|
474
|
+
:query_params => query_params,
|
475
|
+
:form_params => form_params,
|
476
|
+
:body => post_body,
|
477
|
+
:auth_names => auth_names,
|
478
|
+
:return_type => return_type
|
479
|
+
)
|
480
|
+
|
481
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
482
|
+
if @api_client.config.debugging
|
483
|
+
@api_client.config.logger.debug "API called: TasksApi#resume_task\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
484
|
+
end
|
485
|
+
return data, status_code, headers
|
486
|
+
end
|
487
|
+
|
488
|
+
# Check result of a task resume request.
|
489
|
+
# **API Key Scope**: tasks / action
|
490
|
+
# @param task_id [String] Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID.
|
491
|
+
# @param job_id [String] ID of active job
|
492
|
+
# @param [Hash] opts the optional parameters
|
493
|
+
# @return [ActiveJobStatus]
|
494
|
+
def resume_task_result(task_id, job_id, opts = {})
|
495
|
+
data, _status_code, _headers = resume_task_result_with_http_info(task_id, job_id, opts)
|
496
|
+
data
|
497
|
+
end
|
498
|
+
|
499
|
+
# Check result of a task resume request.
|
500
|
+
# **API Key Scope**: tasks / action
|
501
|
+
# @param task_id [String] Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID.
|
502
|
+
# @param job_id [String] ID of active job
|
503
|
+
# @param [Hash] opts the optional parameters
|
504
|
+
# @return [Array<(ActiveJobStatus, Integer, Hash)>] ActiveJobStatus data, response status code and response headers
|
505
|
+
def resume_task_result_with_http_info(task_id, job_id, opts = {})
|
506
|
+
if @api_client.config.debugging
|
507
|
+
@api_client.config.logger.debug 'Calling API: TasksApi.resume_task_result ...'
|
508
|
+
end
|
509
|
+
# verify the required parameter 'task_id' is set
|
510
|
+
if @api_client.config.client_side_validation && task_id.nil?
|
511
|
+
fail ArgumentError, "Missing the required parameter 'task_id' when calling TasksApi.resume_task_result"
|
512
|
+
end
|
513
|
+
# verify the required parameter 'job_id' is set
|
514
|
+
if @api_client.config.client_side_validation && job_id.nil?
|
515
|
+
fail ArgumentError, "Missing the required parameter 'job_id' when calling TasksApi.resume_task_result"
|
516
|
+
end
|
517
|
+
# resource path
|
518
|
+
local_var_path = '/tasks/{task_id}/action/resume'.sub('{' + 'task_id' + '}', CGI.escape(task_id.to_s))
|
519
|
+
|
520
|
+
# query parameters
|
521
|
+
query_params = opts[:query_params] || {}
|
522
|
+
query_params[:'job_id'] = job_id
|
523
|
+
|
524
|
+
# header parameters
|
525
|
+
header_params = opts[:header_params] || {}
|
526
|
+
# HTTP header 'Accept' (if needed)
|
527
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'queued', 'working', 'failed'])
|
528
|
+
|
529
|
+
# form parameters
|
530
|
+
form_params = opts[:form_params] || {}
|
531
|
+
|
532
|
+
# http body (model)
|
533
|
+
post_body = opts[:body]
|
534
|
+
|
535
|
+
# return_type
|
536
|
+
return_type = opts[:return_type] || 'ActiveJobStatus'
|
537
|
+
|
538
|
+
# auth_names
|
539
|
+
auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth']
|
540
|
+
|
541
|
+
new_options = opts.merge(
|
542
|
+
:header_params => header_params,
|
543
|
+
:query_params => query_params,
|
544
|
+
:form_params => form_params,
|
545
|
+
:body => post_body,
|
546
|
+
:auth_names => auth_names,
|
547
|
+
:return_type => return_type
|
548
|
+
)
|
549
|
+
|
550
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
551
|
+
if @api_client.config.debugging
|
552
|
+
@api_client.config.logger.debug "API called: TasksApi#resume_task_result\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
553
|
+
end
|
554
|
+
return data, status_code, headers
|
555
|
+
end
|
556
|
+
|
557
|
+
# Run a task.
|
558
|
+
# **API Key Scope**: tasks / action
|
559
|
+
# @param task_id [String] Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID.
|
560
|
+
# @param [Hash] opts the optional parameters
|
561
|
+
# @return [ActiveJobStatus]
|
562
|
+
def run_task(task_id, opts = {})
|
563
|
+
data, _status_code, _headers = run_task_with_http_info(task_id, opts)
|
564
|
+
data
|
565
|
+
end
|
566
|
+
|
567
|
+
# Run a task.
|
568
|
+
# **API Key Scope**: tasks / action
|
569
|
+
# @param task_id [String] Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID.
|
570
|
+
# @param [Hash] opts the optional parameters
|
571
|
+
# @return [Array<(ActiveJobStatus, Integer, Hash)>] ActiveJobStatus data, response status code and response headers
|
572
|
+
def run_task_with_http_info(task_id, opts = {})
|
573
|
+
if @api_client.config.debugging
|
574
|
+
@api_client.config.logger.debug 'Calling API: TasksApi.run_task ...'
|
575
|
+
end
|
576
|
+
# verify the required parameter 'task_id' is set
|
577
|
+
if @api_client.config.client_side_validation && task_id.nil?
|
578
|
+
fail ArgumentError, "Missing the required parameter 'task_id' when calling TasksApi.run_task"
|
579
|
+
end
|
580
|
+
# resource path
|
581
|
+
local_var_path = '/tasks/{task_id}/action/run'.sub('{' + 'task_id' + '}', CGI.escape(task_id.to_s))
|
582
|
+
|
583
|
+
# query parameters
|
584
|
+
query_params = opts[:query_params] || {}
|
585
|
+
|
586
|
+
# header parameters
|
587
|
+
header_params = opts[:header_params] || {}
|
588
|
+
# HTTP header 'Accept' (if needed)
|
589
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'queued', 'working', 'failed'])
|
590
|
+
|
591
|
+
# form parameters
|
592
|
+
form_params = opts[:form_params] || {}
|
593
|
+
|
594
|
+
# http body (model)
|
595
|
+
post_body = opts[:body]
|
596
|
+
|
597
|
+
# return_type
|
598
|
+
return_type = opts[:return_type] || 'ActiveJobStatus'
|
599
|
+
|
600
|
+
# auth_names
|
601
|
+
auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth']
|
602
|
+
|
603
|
+
new_options = opts.merge(
|
604
|
+
:header_params => header_params,
|
605
|
+
:query_params => query_params,
|
606
|
+
:form_params => form_params,
|
607
|
+
:body => post_body,
|
608
|
+
:auth_names => auth_names,
|
609
|
+
:return_type => return_type
|
610
|
+
)
|
611
|
+
|
612
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
613
|
+
if @api_client.config.debugging
|
614
|
+
@api_client.config.logger.debug "API called: TasksApi#run_task\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
615
|
+
end
|
616
|
+
return data, status_code, headers
|
617
|
+
end
|
618
|
+
|
619
|
+
# Check result of a task run request.
|
620
|
+
# **API Key Scope**: tasks / action
|
621
|
+
# @param task_id [String] Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID.
|
622
|
+
# @param job_id [String] ID of active job
|
623
|
+
# @param [Hash] opts the optional parameters
|
624
|
+
# @return [ActiveJobStatus]
|
625
|
+
def run_task_result(task_id, job_id, opts = {})
|
626
|
+
data, _status_code, _headers = run_task_result_with_http_info(task_id, job_id, opts)
|
627
|
+
data
|
628
|
+
end
|
629
|
+
|
630
|
+
# Check result of a task run request.
|
631
|
+
# **API Key Scope**: tasks / action
|
632
|
+
# @param task_id [String] Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID.
|
633
|
+
# @param job_id [String] ID of active job
|
634
|
+
# @param [Hash] opts the optional parameters
|
635
|
+
# @return [Array<(ActiveJobStatus, Integer, Hash)>] ActiveJobStatus data, response status code and response headers
|
636
|
+
def run_task_result_with_http_info(task_id, job_id, opts = {})
|
637
|
+
if @api_client.config.debugging
|
638
|
+
@api_client.config.logger.debug 'Calling API: TasksApi.run_task_result ...'
|
639
|
+
end
|
640
|
+
# verify the required parameter 'task_id' is set
|
641
|
+
if @api_client.config.client_side_validation && task_id.nil?
|
642
|
+
fail ArgumentError, "Missing the required parameter 'task_id' when calling TasksApi.run_task_result"
|
643
|
+
end
|
644
|
+
# verify the required parameter 'job_id' is set
|
645
|
+
if @api_client.config.client_side_validation && job_id.nil?
|
646
|
+
fail ArgumentError, "Missing the required parameter 'job_id' when calling TasksApi.run_task_result"
|
647
|
+
end
|
648
|
+
# resource path
|
649
|
+
local_var_path = '/tasks/{task_id}/action/run'.sub('{' + 'task_id' + '}', CGI.escape(task_id.to_s))
|
650
|
+
|
651
|
+
# query parameters
|
652
|
+
query_params = opts[:query_params] || {}
|
653
|
+
query_params[:'job_id'] = job_id
|
654
|
+
|
655
|
+
# header parameters
|
656
|
+
header_params = opts[:header_params] || {}
|
657
|
+
# HTTP header 'Accept' (if needed)
|
658
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'queued', 'working', 'failed'])
|
659
|
+
|
660
|
+
# form parameters
|
661
|
+
form_params = opts[:form_params] || {}
|
662
|
+
|
663
|
+
# http body (model)
|
664
|
+
post_body = opts[:body]
|
665
|
+
|
666
|
+
# return_type
|
667
|
+
return_type = opts[:return_type] || 'ActiveJobStatus'
|
668
|
+
|
669
|
+
# auth_names
|
670
|
+
auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth']
|
671
|
+
|
672
|
+
new_options = opts.merge(
|
673
|
+
:header_params => header_params,
|
674
|
+
:query_params => query_params,
|
675
|
+
:form_params => form_params,
|
676
|
+
:body => post_body,
|
677
|
+
:auth_names => auth_names,
|
678
|
+
:return_type => return_type
|
679
|
+
)
|
680
|
+
|
681
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
682
|
+
if @api_client.config.debugging
|
683
|
+
@api_client.config.logger.debug "API called: TasksApi#run_task_result\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
684
|
+
end
|
685
|
+
return data, status_code, headers
|
686
|
+
end
|
687
|
+
|
688
|
+
# Displays a specific task.
|
689
|
+
# **API Key Scope**: tasks / show
|
690
|
+
# @param task_id [String] Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID.
|
691
|
+
# @param [Hash] opts the optional parameters
|
692
|
+
# @return [Task]
|
693
|
+
def show_task(task_id, opts = {})
|
694
|
+
data, _status_code, _headers = show_task_with_http_info(task_id, opts)
|
695
|
+
data
|
696
|
+
end
|
697
|
+
|
698
|
+
# Displays a specific task.
|
699
|
+
# **API Key Scope**: tasks / show
|
700
|
+
# @param task_id [String] Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID.
|
701
|
+
# @param [Hash] opts the optional parameters
|
702
|
+
# @return [Array<(Task, Integer, Hash)>] Task data, response status code and response headers
|
703
|
+
def show_task_with_http_info(task_id, opts = {})
|
704
|
+
if @api_client.config.debugging
|
705
|
+
@api_client.config.logger.debug 'Calling API: TasksApi.show_task ...'
|
706
|
+
end
|
707
|
+
# verify the required parameter 'task_id' is set
|
708
|
+
if @api_client.config.client_side_validation && task_id.nil?
|
709
|
+
fail ArgumentError, "Missing the required parameter 'task_id' when calling TasksApi.show_task"
|
710
|
+
end
|
711
|
+
# resource path
|
712
|
+
local_var_path = '/tasks/{task_id}'.sub('{' + 'task_id' + '}', CGI.escape(task_id.to_s))
|
713
|
+
|
714
|
+
# query parameters
|
715
|
+
query_params = opts[:query_params] || {}
|
716
|
+
|
717
|
+
# header parameters
|
718
|
+
header_params = opts[:header_params] || {}
|
719
|
+
# HTTP header 'Accept' (if needed)
|
720
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
721
|
+
|
722
|
+
# form parameters
|
723
|
+
form_params = opts[:form_params] || {}
|
724
|
+
|
725
|
+
# http body (model)
|
726
|
+
post_body = opts[:body]
|
727
|
+
|
728
|
+
# return_type
|
729
|
+
return_type = opts[:return_type] || 'Task'
|
730
|
+
|
731
|
+
# auth_names
|
732
|
+
auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth']
|
733
|
+
|
734
|
+
new_options = opts.merge(
|
735
|
+
:header_params => header_params,
|
736
|
+
:query_params => query_params,
|
737
|
+
:form_params => form_params,
|
738
|
+
:body => post_body,
|
739
|
+
:auth_names => auth_names,
|
740
|
+
:return_type => return_type
|
741
|
+
)
|
742
|
+
|
743
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
744
|
+
if @api_client.config.debugging
|
745
|
+
@api_client.config.logger.debug "API called: TasksApi#show_task\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
746
|
+
end
|
747
|
+
return data, status_code, headers
|
748
|
+
end
|
749
|
+
|
750
|
+
# Stop a task.
|
751
|
+
# **API Key Scope**: tasks / action
|
752
|
+
# @param task_id [String] Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID.
|
753
|
+
# @param [Hash] opts the optional parameters
|
754
|
+
# @return [ActiveJobStatus]
|
755
|
+
def stop_task(task_id, opts = {})
|
756
|
+
data, _status_code, _headers = stop_task_with_http_info(task_id, opts)
|
757
|
+
data
|
758
|
+
end
|
759
|
+
|
760
|
+
# Stop a task.
|
761
|
+
# **API Key Scope**: tasks / action
|
762
|
+
# @param task_id [String] Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID.
|
763
|
+
# @param [Hash] opts the optional parameters
|
764
|
+
# @return [Array<(ActiveJobStatus, Integer, Hash)>] ActiveJobStatus data, response status code and response headers
|
765
|
+
def stop_task_with_http_info(task_id, opts = {})
|
766
|
+
if @api_client.config.debugging
|
767
|
+
@api_client.config.logger.debug 'Calling API: TasksApi.stop_task ...'
|
768
|
+
end
|
769
|
+
# verify the required parameter 'task_id' is set
|
770
|
+
if @api_client.config.client_side_validation && task_id.nil?
|
771
|
+
fail ArgumentError, "Missing the required parameter 'task_id' when calling TasksApi.stop_task"
|
772
|
+
end
|
773
|
+
# resource path
|
774
|
+
local_var_path = '/tasks/{task_id}/action/stop'.sub('{' + 'task_id' + '}', CGI.escape(task_id.to_s))
|
775
|
+
|
776
|
+
# query parameters
|
777
|
+
query_params = opts[:query_params] || {}
|
778
|
+
|
779
|
+
# header parameters
|
780
|
+
header_params = opts[:header_params] || {}
|
781
|
+
# HTTP header 'Accept' (if needed)
|
782
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'queued', 'working', 'failed'])
|
783
|
+
|
784
|
+
# form parameters
|
785
|
+
form_params = opts[:form_params] || {}
|
786
|
+
|
787
|
+
# http body (model)
|
788
|
+
post_body = opts[:body]
|
789
|
+
|
790
|
+
# return_type
|
791
|
+
return_type = opts[:return_type] || 'ActiveJobStatus'
|
792
|
+
|
793
|
+
# auth_names
|
794
|
+
auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth']
|
795
|
+
|
796
|
+
new_options = opts.merge(
|
797
|
+
:header_params => header_params,
|
798
|
+
:query_params => query_params,
|
799
|
+
:form_params => form_params,
|
800
|
+
:body => post_body,
|
801
|
+
:auth_names => auth_names,
|
802
|
+
:return_type => return_type
|
803
|
+
)
|
804
|
+
|
805
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
806
|
+
if @api_client.config.debugging
|
807
|
+
@api_client.config.logger.debug "API called: TasksApi#stop_task\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
808
|
+
end
|
809
|
+
return data, status_code, headers
|
810
|
+
end
|
811
|
+
|
812
|
+
# Check result of a task stop request.
|
813
|
+
# **API Key Scope**: tasks / action
|
814
|
+
# @param task_id [String] Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID.
|
815
|
+
# @param job_id [String] ID of active job
|
816
|
+
# @param [Hash] opts the optional parameters
|
817
|
+
# @return [ActiveJobStatus]
|
818
|
+
def stop_task_result(task_id, job_id, opts = {})
|
819
|
+
data, _status_code, _headers = stop_task_result_with_http_info(task_id, job_id, opts)
|
820
|
+
data
|
821
|
+
end
|
822
|
+
|
823
|
+
# Check result of a task stop request.
|
824
|
+
# **API Key Scope**: tasks / action
|
825
|
+
# @param task_id [String] Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID.
|
826
|
+
# @param job_id [String] ID of active job
|
827
|
+
# @param [Hash] opts the optional parameters
|
828
|
+
# @return [Array<(ActiveJobStatus, Integer, Hash)>] ActiveJobStatus data, response status code and response headers
|
829
|
+
def stop_task_result_with_http_info(task_id, job_id, opts = {})
|
830
|
+
if @api_client.config.debugging
|
831
|
+
@api_client.config.logger.debug 'Calling API: TasksApi.stop_task_result ...'
|
832
|
+
end
|
833
|
+
# verify the required parameter 'task_id' is set
|
834
|
+
if @api_client.config.client_side_validation && task_id.nil?
|
835
|
+
fail ArgumentError, "Missing the required parameter 'task_id' when calling TasksApi.stop_task_result"
|
836
|
+
end
|
837
|
+
# verify the required parameter 'job_id' is set
|
838
|
+
if @api_client.config.client_side_validation && job_id.nil?
|
839
|
+
fail ArgumentError, "Missing the required parameter 'job_id' when calling TasksApi.stop_task_result"
|
840
|
+
end
|
841
|
+
# resource path
|
842
|
+
local_var_path = '/tasks/{task_id}/action/stop'.sub('{' + 'task_id' + '}', CGI.escape(task_id.to_s))
|
843
|
+
|
844
|
+
# query parameters
|
845
|
+
query_params = opts[:query_params] || {}
|
846
|
+
query_params[:'job_id'] = job_id
|
847
|
+
|
848
|
+
# header parameters
|
849
|
+
header_params = opts[:header_params] || {}
|
850
|
+
# HTTP header 'Accept' (if needed)
|
851
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'queued', 'working', 'failed'])
|
852
|
+
|
853
|
+
# form parameters
|
854
|
+
form_params = opts[:form_params] || {}
|
855
|
+
|
856
|
+
# http body (model)
|
857
|
+
post_body = opts[:body]
|
858
|
+
|
859
|
+
# return_type
|
860
|
+
return_type = opts[:return_type] || 'ActiveJobStatus'
|
861
|
+
|
862
|
+
# auth_names
|
863
|
+
auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth']
|
864
|
+
|
865
|
+
new_options = opts.merge(
|
866
|
+
:header_params => header_params,
|
867
|
+
:query_params => query_params,
|
868
|
+
:form_params => form_params,
|
869
|
+
:body => post_body,
|
870
|
+
:auth_names => auth_names,
|
871
|
+
:return_type => return_type
|
872
|
+
)
|
873
|
+
|
874
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
875
|
+
if @api_client.config.debugging
|
876
|
+
@api_client.config.logger.debug "API called: TasksApi#stop_task_result\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
877
|
+
end
|
878
|
+
return data, status_code, headers
|
879
|
+
end
|
880
|
+
|
881
|
+
# Updates a specific task.
|
882
|
+
# **API Key Scope**: tasks / update
|
883
|
+
# @param task_id [String] Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID.
|
884
|
+
# @param task_body [Task]
|
885
|
+
# @param [Hash] opts the optional parameters
|
886
|
+
# @return [Task]
|
887
|
+
def update_task(task_id, task_body, opts = {})
|
888
|
+
data, _status_code, _headers = update_task_with_http_info(task_id, task_body, opts)
|
889
|
+
data
|
890
|
+
end
|
891
|
+
|
892
|
+
# Updates a specific task.
|
893
|
+
# **API Key Scope**: tasks / update
|
894
|
+
# @param task_id [String] Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID.
|
895
|
+
# @param task_body [Task]
|
896
|
+
# @param [Hash] opts the optional parameters
|
897
|
+
# @return [Array<(Task, Integer, Hash)>] Task data, response status code and response headers
|
898
|
+
def update_task_with_http_info(task_id, task_body, opts = {})
|
899
|
+
if @api_client.config.debugging
|
900
|
+
@api_client.config.logger.debug 'Calling API: TasksApi.update_task ...'
|
901
|
+
end
|
902
|
+
# verify the required parameter 'task_id' is set
|
903
|
+
if @api_client.config.client_side_validation && task_id.nil?
|
904
|
+
fail ArgumentError, "Missing the required parameter 'task_id' when calling TasksApi.update_task"
|
905
|
+
end
|
906
|
+
# verify the required parameter 'task_body' is set
|
907
|
+
if @api_client.config.client_side_validation && task_body.nil?
|
908
|
+
fail ArgumentError, "Missing the required parameter 'task_body' when calling TasksApi.update_task"
|
909
|
+
end
|
910
|
+
# resource path
|
911
|
+
local_var_path = '/tasks/{task_id}'.sub('{' + 'task_id' + '}', CGI.escape(task_id.to_s))
|
912
|
+
|
913
|
+
# query parameters
|
914
|
+
query_params = opts[:query_params] || {}
|
915
|
+
|
916
|
+
# header parameters
|
917
|
+
header_params = opts[:header_params] || {}
|
918
|
+
# HTTP header 'Accept' (if needed)
|
919
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
920
|
+
# HTTP header 'Content-Type'
|
921
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
922
|
+
|
923
|
+
# form parameters
|
924
|
+
form_params = opts[:form_params] || {}
|
925
|
+
|
926
|
+
# http body (model)
|
927
|
+
post_body = opts[:body] || @api_client.object_to_http_body(task_body)
|
928
|
+
|
929
|
+
# return_type
|
930
|
+
return_type = opts[:return_type] || 'Task'
|
931
|
+
|
932
|
+
# auth_names
|
933
|
+
auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth']
|
934
|
+
|
935
|
+
new_options = opts.merge(
|
936
|
+
:header_params => header_params,
|
937
|
+
:query_params => query_params,
|
938
|
+
:form_params => form_params,
|
939
|
+
:body => post_body,
|
940
|
+
:auth_names => auth_names,
|
941
|
+
:return_type => return_type
|
942
|
+
)
|
943
|
+
|
944
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
945
|
+
if @api_client.config.debugging
|
946
|
+
@api_client.config.logger.debug "API called: TasksApi#update_task\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
947
|
+
end
|
948
|
+
return data, status_code, headers
|
949
|
+
end
|
950
|
+
end
|
951
|
+
end
|