immich 1.2.1__py3-none-any.whl
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.
- immich/.openapi-generator/FILES +372 -0
- immich/.openapi-generator/VERSION +1 -0
- immich/.openapi-generator-ignore +48 -0
- immich/__init__.py +3 -0
- immich/client/__init__.py +1162 -0
- immich/client/api/__init__.py +39 -0
- immich/client/api/activities_api.py +1092 -0
- immich/client/api/albums_api.py +3228 -0
- immich/client/api/api_keys_api.py +1484 -0
- immich/client/api/assets_api.py +5834 -0
- immich/client/api/authentication_admin_api.py +254 -0
- immich/client/api/authentication_api.py +3881 -0
- immich/client/api/deprecated_api.py +2199 -0
- immich/client/api/download_api.py +603 -0
- immich/client/api/duplicates_api.py +743 -0
- immich/client/api/faces_api.py +1053 -0
- immich/client/api/jobs_api.py +783 -0
- immich/client/api/libraries_api.py +2004 -0
- immich/client/api/maintenance_admin_api.py +533 -0
- immich/client/api/map_api.py +640 -0
- immich/client/api/memories_api.py +2250 -0
- immich/client/api/notifications_admin_api.py +808 -0
- immich/client/api/notifications_api.py +1564 -0
- immich/client/api/partners_api.py +1278 -0
- immich/client/api/people_api.py +2905 -0
- immich/client/api/plugins_api.py +730 -0
- immich/client/api/queues_api.py +1292 -0
- immich/client/api/search_api.py +3198 -0
- immich/client/api/server_api.py +3466 -0
- immich/client/api/sessions_api.py +1472 -0
- immich/client/api/shared_links_api.py +2177 -0
- immich/client/api/stacks_api.py +1769 -0
- immich/client/api/sync_api.py +1512 -0
- immich/client/api/system_config_api.py +967 -0
- immich/client/api/system_metadata_api.py +964 -0
- immich/client/api/tags_api.py +2296 -0
- immich/client/api/timeline_api.py +1193 -0
- immich/client/api/trash_api.py +739 -0
- immich/client/api/users_admin_api.py +2607 -0
- immich/client/api/users_api.py +3577 -0
- immich/client/api/views_api.py +503 -0
- immich/client/api/workflows_api.py +1257 -0
- immich/client/api_client.py +756 -0
- immich/client/api_response.py +20 -0
- immich/client/configuration.py +638 -0
- immich/client/exceptions.py +222 -0
- immich/client/models/__init__.py +424 -0
- immich/client/models/activity_create_dto.py +94 -0
- immich/client/models/activity_response_dto.py +121 -0
- immich/client/models/activity_statistics_response_dto.py +85 -0
- immich/client/models/add_users_dto.py +101 -0
- immich/client/models/admin_onboarding_update_dto.py +82 -0
- immich/client/models/album_response_dto.py +199 -0
- immich/client/models/album_statistics_response_dto.py +90 -0
- immich/client/models/album_user_add_dto.py +87 -0
- immich/client/models/album_user_create_dto.py +87 -0
- immich/client/models/album_user_response_dto.py +95 -0
- immich/client/models/album_user_role.py +34 -0
- immich/client/models/albums_add_assets_dto.py +86 -0
- immich/client/models/albums_add_assets_response_dto.py +86 -0
- immich/client/models/albums_response.py +83 -0
- immich/client/models/albums_update.py +85 -0
- immich/client/models/api_key_create_dto.py +87 -0
- immich/client/models/api_key_create_response_dto.py +94 -0
- immich/client/models/api_key_response_dto.py +102 -0
- immich/client/models/api_key_update_dto.py +87 -0
- immich/client/models/asset_bulk_delete_dto.py +84 -0
- immich/client/models/asset_bulk_update_dto.py +143 -0
- immich/client/models/asset_bulk_upload_check_dto.py +98 -0
- immich/client/models/asset_bulk_upload_check_item.py +85 -0
- immich/client/models/asset_bulk_upload_check_response_dto.py +101 -0
- immich/client/models/asset_bulk_upload_check_result.py +126 -0
- immich/client/models/asset_copy_dto.py +113 -0
- immich/client/models/asset_delta_sync_dto.py +87 -0
- immich/client/models/asset_delta_sync_response_dto.py +102 -0
- immich/client/models/asset_face_create_dto.py +110 -0
- immich/client/models/asset_face_delete_dto.py +82 -0
- immich/client/models/asset_face_response_dto.py +125 -0
- immich/client/models/asset_face_update_dto.py +96 -0
- immich/client/models/asset_face_update_item.py +86 -0
- immich/client/models/asset_face_without_person_response_dto.py +111 -0
- immich/client/models/asset_full_sync_dto.py +95 -0
- immich/client/models/asset_ids_dto.py +83 -0
- immich/client/models/asset_ids_response_dto.py +109 -0
- immich/client/models/asset_job_name.py +36 -0
- immich/client/models/asset_jobs_dto.py +87 -0
- immich/client/models/asset_media_response_dto.py +84 -0
- immich/client/models/asset_media_size.py +35 -0
- immich/client/models/asset_media_status.py +35 -0
- immich/client/models/asset_metadata_key.py +33 -0
- immich/client/models/asset_metadata_response_dto.py +92 -0
- immich/client/models/asset_metadata_upsert_dto.py +101 -0
- immich/client/models/asset_metadata_upsert_item_dto.py +84 -0
- immich/client/models/asset_ocr_response_dto.py +145 -0
- immich/client/models/asset_order.py +34 -0
- immich/client/models/asset_response_dto.py +291 -0
- immich/client/models/asset_stack_response_dto.py +90 -0
- immich/client/models/asset_stats_response_dto.py +90 -0
- immich/client/models/asset_type_enum.py +36 -0
- immich/client/models/asset_visibility.py +36 -0
- immich/client/models/audio_codec.py +36 -0
- immich/client/models/auth_status_response_dto.py +100 -0
- immich/client/models/avatar_update.py +83 -0
- immich/client/models/bulk_id_error_reason.py +36 -0
- immich/client/models/bulk_id_response_dto.py +102 -0
- immich/client/models/bulk_ids_dto.py +83 -0
- immich/client/models/cast_response.py +88 -0
- immich/client/models/cast_update.py +82 -0
- immich/client/models/change_password_dto.py +101 -0
- immich/client/models/check_existing_assets_dto.py +91 -0
- immich/client/models/check_existing_assets_response_dto.py +82 -0
- immich/client/models/clip_config.py +85 -0
- immich/client/models/colorspace.py +34 -0
- immich/client/models/contributor_count_response_dto.py +85 -0
- immich/client/models/cq_mode.py +35 -0
- immich/client/models/create_album_dto.py +112 -0
- immich/client/models/create_library_dto.py +103 -0
- immich/client/models/create_profile_image_response_dto.py +95 -0
- immich/client/models/database_backup_config.py +94 -0
- immich/client/models/download_archive_info.py +85 -0
- immich/client/models/download_info_dto.py +96 -0
- immich/client/models/download_response.py +90 -0
- immich/client/models/download_response_dto.py +100 -0
- immich/client/models/download_update.py +93 -0
- immich/client/models/duplicate_detection_config.py +89 -0
- immich/client/models/duplicate_response_dto.py +98 -0
- immich/client/models/email_notifications_response.py +90 -0
- immich/client/models/email_notifications_update.py +90 -0
- immich/client/models/exif_response_dto.py +284 -0
- immich/client/models/face_dto.py +83 -0
- immich/client/models/facial_recognition_config.py +107 -0
- immich/client/models/folders_response.py +92 -0
- immich/client/models/folders_update.py +85 -0
- immich/client/models/image_format.py +34 -0
- immich/client/models/job_create_dto.py +83 -0
- immich/client/models/job_name.py +87 -0
- immich/client/models/job_settings_dto.py +83 -0
- immich/client/models/library_response_dto.py +118 -0
- immich/client/models/library_stats_response_dto.py +92 -0
- immich/client/models/license_key_dto.py +98 -0
- immich/client/models/license_response_dto.py +101 -0
- immich/client/models/log_level.py +38 -0
- immich/client/models/login_credential_dto.py +85 -0
- immich/client/models/login_response_dto.py +109 -0
- immich/client/models/logout_response_dto.py +85 -0
- immich/client/models/machine_learning_availability_checks_dto.py +90 -0
- immich/client/models/maintenance_action.py +34 -0
- immich/client/models/maintenance_auth_dto.py +82 -0
- immich/client/models/maintenance_login_dto.py +82 -0
- immich/client/models/manual_job_name.py +38 -0
- immich/client/models/map_marker_response_dto.py +111 -0
- immich/client/models/map_reverse_geocode_response_dto.py +105 -0
- immich/client/models/memories_response.py +92 -0
- immich/client/models/memories_update.py +86 -0
- immich/client/models/memory_create_dto.py +112 -0
- immich/client/models/memory_response_dto.py +142 -0
- immich/client/models/memory_search_order.py +35 -0
- immich/client/models/memory_statistics_response_dto.py +82 -0
- immich/client/models/memory_type.py +33 -0
- immich/client/models/memory_update_dto.py +91 -0
- immich/client/models/merge_person_dto.py +83 -0
- immich/client/models/metadata_search_dto.py +277 -0
- immich/client/models/notification_create_dto.py +120 -0
- immich/client/models/notification_delete_all_dto.py +83 -0
- immich/client/models/notification_dto.py +112 -0
- immich/client/models/notification_level.py +36 -0
- immich/client/models/notification_type.py +38 -0
- immich/client/models/notification_update_all_dto.py +90 -0
- immich/client/models/notification_update_dto.py +88 -0
- immich/client/models/o_auth_authorize_response_dto.py +82 -0
- immich/client/models/o_auth_callback_dto.py +90 -0
- immich/client/models/o_auth_config_dto.py +90 -0
- immich/client/models/o_auth_token_endpoint_auth_method.py +34 -0
- immich/client/models/ocr_config.py +109 -0
- immich/client/models/on_this_day_dto.py +86 -0
- immich/client/models/onboarding_dto.py +82 -0
- immich/client/models/onboarding_response_dto.py +82 -0
- immich/client/models/partner_create_dto.py +83 -0
- immich/client/models/partner_direction.py +34 -0
- immich/client/models/partner_response_dto.py +108 -0
- immich/client/models/partner_update_dto.py +82 -0
- immich/client/models/people_response.py +92 -0
- immich/client/models/people_response_dto.py +104 -0
- immich/client/models/people_update.py +85 -0
- immich/client/models/people_update_dto.py +96 -0
- immich/client/models/people_update_item.py +128 -0
- immich/client/models/permission.py +177 -0
- immich/client/models/person_create_dto.py +117 -0
- immich/client/models/person_response_dto.py +115 -0
- immich/client/models/person_statistics_response_dto.py +82 -0
- immich/client/models/person_update_dto.py +125 -0
- immich/client/models/person_with_faces_response_dto.py +133 -0
- immich/client/models/pin_code_change_dto.py +90 -0
- immich/client/models/pin_code_reset_dto.py +85 -0
- immich/client/models/pin_code_setup_dto.py +82 -0
- immich/client/models/places_response_dto.py +100 -0
- immich/client/models/plugin_action_response_dto.py +112 -0
- immich/client/models/plugin_context_type.py +35 -0
- immich/client/models/plugin_filter_response_dto.py +112 -0
- immich/client/models/plugin_response_dto.py +139 -0
- immich/client/models/plugin_trigger_response_dto.py +87 -0
- immich/client/models/plugin_trigger_type.py +34 -0
- immich/client/models/purchase_response.py +88 -0
- immich/client/models/purchase_update.py +92 -0
- immich/client/models/queue_command.py +37 -0
- immich/client/models/queue_command_dto.py +86 -0
- immich/client/models/queue_delete_dto.py +85 -0
- immich/client/models/queue_job_response_dto.py +93 -0
- immich/client/models/queue_job_status.py +38 -0
- immich/client/models/queue_name.py +49 -0
- immich/client/models/queue_response_dto.py +97 -0
- immich/client/models/queue_response_legacy_dto.py +100 -0
- immich/client/models/queue_statistics_dto.py +103 -0
- immich/client/models/queue_status_legacy_dto.py +85 -0
- immich/client/models/queue_update_dto.py +82 -0
- immich/client/models/queues_response_legacy_dto.py +242 -0
- immich/client/models/random_search_dto.py +234 -0
- immich/client/models/ratings_response.py +84 -0
- immich/client/models/ratings_update.py +82 -0
- immich/client/models/reaction_level.py +34 -0
- immich/client/models/reaction_type.py +34 -0
- immich/client/models/reverse_geocoding_state_response_dto.py +101 -0
- immich/client/models/search_album_response_dto.py +114 -0
- immich/client/models/search_asset_response_dto.py +127 -0
- immich/client/models/search_explore_item.py +94 -0
- immich/client/models/search_explore_response_dto.py +98 -0
- immich/client/models/search_facet_count_response_dto.py +85 -0
- immich/client/models/search_facet_response_dto.py +103 -0
- immich/client/models/search_response_dto.py +100 -0
- immich/client/models/search_statistics_response_dto.py +82 -0
- immich/client/models/search_suggestion_type.py +38 -0
- immich/client/models/server_about_response_dto.py +156 -0
- immich/client/models/server_apk_links_dto.py +97 -0
- immich/client/models/server_config_dto.py +118 -0
- immich/client/models/server_features_dto.py +130 -0
- immich/client/models/server_media_types_response_dto.py +90 -0
- immich/client/models/server_ping_response.py +87 -0
- immich/client/models/server_stats_response_dto.py +119 -0
- immich/client/models/server_storage_response_dto.py +108 -0
- immich/client/models/server_theme_dto.py +82 -0
- immich/client/models/server_version_history_response_dto.py +91 -0
- immich/client/models/server_version_response_dto.py +90 -0
- immich/client/models/session_create_dto.py +96 -0
- immich/client/models/session_create_response_dto.py +120 -0
- immich/client/models/session_response_dto.py +117 -0
- immich/client/models/session_unlock_dto.py +85 -0
- immich/client/models/session_update_dto.py +84 -0
- immich/client/models/set_maintenance_mode_dto.py +83 -0
- immich/client/models/shared_link_create_dto.py +142 -0
- immich/client/models/shared_link_edit_dto.py +134 -0
- immich/client/models/shared_link_response_dto.py +173 -0
- immich/client/models/shared_link_type.py +34 -0
- immich/client/models/shared_links_response.py +92 -0
- immich/client/models/shared_links_update.py +85 -0
- immich/client/models/sign_up_dto.py +90 -0
- immich/client/models/smart_search_dto.py +245 -0
- immich/client/models/source_type.py +35 -0
- immich/client/models/stack_create_dto.py +86 -0
- immich/client/models/stack_response_dto.py +100 -0
- immich/client/models/stack_update_dto.py +83 -0
- immich/client/models/statistics_search_dto.py +217 -0
- immich/client/models/sync_ack_delete_dto.py +83 -0
- immich/client/models/sync_ack_dto.py +84 -0
- immich/client/models/sync_ack_set_dto.py +83 -0
- immich/client/models/sync_album_delete_v1.py +82 -0
- immich/client/models/sync_album_to_asset_delete_v1.py +85 -0
- immich/client/models/sync_album_to_asset_v1.py +85 -0
- immich/client/models/sync_album_user_delete_v1.py +85 -0
- immich/client/models/sync_album_user_v1.py +91 -0
- immich/client/models/sync_album_v1.py +122 -0
- immich/client/models/sync_asset_delete_v1.py +82 -0
- immich/client/models/sync_asset_exif_v1.py +296 -0
- immich/client/models/sync_asset_face_delete_v1.py +82 -0
- immich/client/models/sync_asset_face_v1.py +120 -0
- immich/client/models/sync_asset_metadata_delete_v1.py +86 -0
- immich/client/models/sync_asset_metadata_v1.py +91 -0
- immich/client/models/sync_asset_v1.py +187 -0
- immich/client/models/sync_auth_user_v1.py +154 -0
- immich/client/models/sync_entity_type.py +79 -0
- immich/client/models/sync_memory_asset_delete_v1.py +85 -0
- immich/client/models/sync_memory_asset_v1.py +85 -0
- immich/client/models/sync_memory_delete_v1.py +82 -0
- immich/client/models/sync_memory_v1.py +143 -0
- immich/client/models/sync_partner_delete_v1.py +88 -0
- immich/client/models/sync_partner_v1.py +90 -0
- immich/client/models/sync_person_delete_v1.py +82 -0
- immich/client/models/sync_person_v1.py +131 -0
- immich/client/models/sync_request_type.py +52 -0
- immich/client/models/sync_stack_delete_v1.py +82 -0
- immich/client/models/sync_stack_v1.py +101 -0
- immich/client/models/sync_stream_dto.py +86 -0
- immich/client/models/sync_user_delete_v1.py +82 -0
- immich/client/models/sync_user_metadata_delete_v1.py +84 -0
- immich/client/models/sync_user_metadata_v1.py +91 -0
- immich/client/models/sync_user_v1.py +118 -0
- immich/client/models/system_config_backups_dto.py +92 -0
- immich/client/models/system_config_dto.py +302 -0
- immich/client/models/system_config_f_fmpeg_dto.py +156 -0
- immich/client/models/system_config_faces_dto.py +82 -0
- immich/client/models/system_config_generated_fullsize_image_dto.py +92 -0
- immich/client/models/system_config_generated_image_dto.py +92 -0
- immich/client/models/system_config_image_dto.py +124 -0
- immich/client/models/system_config_job_dto.py +194 -0
- immich/client/models/system_config_library_dto.py +104 -0
- immich/client/models/system_config_library_scan_dto.py +85 -0
- immich/client/models/system_config_library_watch_dto.py +82 -0
- immich/client/models/system_config_logging_dto.py +86 -0
- immich/client/models/system_config_machine_learning_dto.py +147 -0
- immich/client/models/system_config_map_dto.py +90 -0
- immich/client/models/system_config_metadata_dto.py +92 -0
- immich/client/models/system_config_new_version_check_dto.py +82 -0
- immich/client/models/system_config_nightly_tasks_dto.py +103 -0
- immich/client/models/system_config_notifications_dto.py +92 -0
- immich/client/models/system_config_o_auth_dto.py +155 -0
- immich/client/models/system_config_password_login_dto.py +82 -0
- immich/client/models/system_config_reverse_geocoding_dto.py +82 -0
- immich/client/models/system_config_server_dto.py +94 -0
- immich/client/models/system_config_smtp_dto.py +100 -0
- immich/client/models/system_config_smtp_transport_dto.py +107 -0
- immich/client/models/system_config_storage_template_dto.py +94 -0
- immich/client/models/system_config_template_emails_dto.py +94 -0
- immich/client/models/system_config_template_storage_option_dto.py +109 -0
- immich/client/models/system_config_templates_dto.py +94 -0
- immich/client/models/system_config_theme_dto.py +82 -0
- immich/client/models/system_config_trash_dto.py +86 -0
- immich/client/models/system_config_user_dto.py +83 -0
- immich/client/models/tag_bulk_assets_dto.py +86 -0
- immich/client/models/tag_bulk_assets_response_dto.py +82 -0
- immich/client/models/tag_create_dto.py +111 -0
- immich/client/models/tag_response_dto.py +107 -0
- immich/client/models/tag_update_dto.py +87 -0
- immich/client/models/tag_upsert_dto.py +82 -0
- immich/client/models/tags_response.py +92 -0
- immich/client/models/tags_update.py +85 -0
- immich/client/models/template_dto.py +82 -0
- immich/client/models/template_response_dto.py +83 -0
- immich/client/models/test_email_response_dto.py +82 -0
- immich/client/models/time_bucket_asset_response_dto.py +195 -0
- immich/client/models/time_buckets_response_dto.py +88 -0
- immich/client/models/tone_mapping.py +36 -0
- immich/client/models/transcode_hw_accel.py +37 -0
- immich/client/models/transcode_policy.py +37 -0
- immich/client/models/trash_response_dto.py +82 -0
- immich/client/models/update_album_dto.py +106 -0
- immich/client/models/update_album_user_dto.py +83 -0
- immich/client/models/update_asset_dto.py +135 -0
- immich/client/models/update_library_dto.py +95 -0
- immich/client/models/usage_by_user_dto.py +117 -0
- immich/client/models/user_admin_create_dto.py +136 -0
- immich/client/models/user_admin_delete_dto.py +82 -0
- immich/client/models/user_admin_response_dto.py +176 -0
- immich/client/models/user_admin_update_dto.py +141 -0
- immich/client/models/user_avatar_color.py +42 -0
- immich/client/models/user_license.py +91 -0
- immich/client/models/user_metadata_key.py +35 -0
- immich/client/models/user_preferences_response_dto.py +186 -0
- immich/client/models/user_preferences_update_dto.py +197 -0
- immich/client/models/user_response_dto.py +105 -0
- immich/client/models/user_status.py +35 -0
- immich/client/models/user_update_me_dto.py +98 -0
- immich/client/models/validate_access_token_response_dto.py +82 -0
- immich/client/models/validate_library_dto.py +93 -0
- immich/client/models/validate_library_import_path_response_dto.py +92 -0
- immich/client/models/validate_library_response_dto.py +103 -0
- immich/client/models/version_check_state_response_dto.py +98 -0
- immich/client/models/video_codec.py +36 -0
- immich/client/models/video_container.py +36 -0
- immich/client/models/workflow_action_item_dto.py +89 -0
- immich/client/models/workflow_action_response_dto.py +105 -0
- immich/client/models/workflow_create_dto.py +128 -0
- immich/client/models/workflow_filter_item_dto.py +89 -0
- immich/client/models/workflow_filter_response_dto.py +105 -0
- immich/client/models/workflow_response_dto.py +144 -0
- immich/client/models/workflow_update_dto.py +128 -0
- immich/client/py.typed +0 -0
- immich/client/rest.py +199 -0
- immich/client_wrapper/__init__.py +15 -0
- immich/client_wrapper/assets_api_wrapped.py +87 -0
- immich/client_wrapper/download_api_wrapped.py +111 -0
- immich/client_wrapper/users_api_wrapped.py +41 -0
- immich/py.typed +0 -0
- immich/sdk.py +365 -0
- immich/utils.py +100 -0
- immich-1.2.1.dist-info/METADATA +166 -0
- immich-1.2.1.dist-info/RECORD +387 -0
- immich-1.2.1.dist-info/WHEEL +4 -0
- immich-1.2.1.dist-info/licenses/LICENSE +9 -0
|
@@ -0,0 +1,1292 @@
|
|
|
1
|
+
# coding: utf-8
|
|
2
|
+
|
|
3
|
+
"""
|
|
4
|
+
Immich
|
|
5
|
+
|
|
6
|
+
Immich API
|
|
7
|
+
|
|
8
|
+
The version of the OpenAPI document: 2.4.1
|
|
9
|
+
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
|
10
|
+
|
|
11
|
+
Do not edit the class manually.
|
|
12
|
+
""" # noqa: E501
|
|
13
|
+
|
|
14
|
+
from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
|
|
15
|
+
from typing import Any, Dict, List, Optional, Tuple, Union
|
|
16
|
+
from typing_extensions import Annotated
|
|
17
|
+
|
|
18
|
+
from immich.client.models.queue_delete_dto import QueueDeleteDto
|
|
19
|
+
from immich.client.models.queue_job_response_dto import QueueJobResponseDto
|
|
20
|
+
from immich.client.models.queue_job_status import QueueJobStatus
|
|
21
|
+
from immich.client.models.queue_name import QueueName
|
|
22
|
+
from immich.client.models.queue_response_dto import QueueResponseDto
|
|
23
|
+
from immich.client.models.queue_update_dto import QueueUpdateDto
|
|
24
|
+
|
|
25
|
+
from immich.client.api_client import ApiClient, RequestSerialized
|
|
26
|
+
from immich.client.api_response import ApiResponse
|
|
27
|
+
from immich.client.rest import RESTResponseType
|
|
28
|
+
|
|
29
|
+
|
|
30
|
+
class QueuesApi:
|
|
31
|
+
"""NOTE: This class is auto generated by OpenAPI Generator
|
|
32
|
+
Ref: https://openapi-generator.tech
|
|
33
|
+
|
|
34
|
+
Do not edit the class manually.
|
|
35
|
+
"""
|
|
36
|
+
|
|
37
|
+
def __init__(self, api_client=None) -> None:
|
|
38
|
+
if api_client is None:
|
|
39
|
+
api_client = ApiClient.get_default()
|
|
40
|
+
self.api_client = api_client
|
|
41
|
+
|
|
42
|
+
@validate_call
|
|
43
|
+
async def empty_queue(
|
|
44
|
+
self,
|
|
45
|
+
name: QueueName,
|
|
46
|
+
queue_delete_dto: QueueDeleteDto,
|
|
47
|
+
_request_timeout: Union[
|
|
48
|
+
None,
|
|
49
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
50
|
+
Tuple[
|
|
51
|
+
Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
|
|
52
|
+
],
|
|
53
|
+
] = None,
|
|
54
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
55
|
+
_content_type: Optional[StrictStr] = None,
|
|
56
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
57
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
58
|
+
) -> None:
|
|
59
|
+
"""Empty a queue
|
|
60
|
+
|
|
61
|
+
Removes all jobs from the specified queue.
|
|
62
|
+
|
|
63
|
+
:param name: (required)
|
|
64
|
+
:type name: QueueName
|
|
65
|
+
:param queue_delete_dto: (required)
|
|
66
|
+
:type queue_delete_dto: QueueDeleteDto
|
|
67
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
68
|
+
number provided, it will be total request
|
|
69
|
+
timeout. It can also be a pair (tuple) of
|
|
70
|
+
(connection, read) timeouts.
|
|
71
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
72
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
73
|
+
request; this effectively ignores the
|
|
74
|
+
authentication in the spec for a single request.
|
|
75
|
+
:type _request_auth: dict, optional
|
|
76
|
+
:param _content_type: force content-type for the request.
|
|
77
|
+
:type _content_type: str, Optional
|
|
78
|
+
:param _headers: set to override the headers for a single
|
|
79
|
+
request; this effectively ignores the headers
|
|
80
|
+
in the spec for a single request.
|
|
81
|
+
:type _headers: dict, optional
|
|
82
|
+
:param _host_index: set to override the host_index for a single
|
|
83
|
+
request; this effectively ignores the host_index
|
|
84
|
+
in the spec for a single request.
|
|
85
|
+
:type _host_index: int, optional
|
|
86
|
+
:return: Returns the result object.
|
|
87
|
+
""" # noqa: E501
|
|
88
|
+
|
|
89
|
+
_param = self._empty_queue_serialize(
|
|
90
|
+
name=name,
|
|
91
|
+
queue_delete_dto=queue_delete_dto,
|
|
92
|
+
_request_auth=_request_auth,
|
|
93
|
+
_content_type=_content_type,
|
|
94
|
+
_headers=_headers,
|
|
95
|
+
_host_index=_host_index,
|
|
96
|
+
)
|
|
97
|
+
|
|
98
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
99
|
+
"204": None,
|
|
100
|
+
}
|
|
101
|
+
response_data = await self.api_client.call_api(
|
|
102
|
+
*_param, _request_timeout=_request_timeout
|
|
103
|
+
)
|
|
104
|
+
await response_data.read()
|
|
105
|
+
return self.api_client.response_deserialize(
|
|
106
|
+
response_data=response_data,
|
|
107
|
+
response_types_map=_response_types_map,
|
|
108
|
+
).data
|
|
109
|
+
|
|
110
|
+
@validate_call
|
|
111
|
+
async def empty_queue_with_http_info(
|
|
112
|
+
self,
|
|
113
|
+
name: QueueName,
|
|
114
|
+
queue_delete_dto: QueueDeleteDto,
|
|
115
|
+
_request_timeout: Union[
|
|
116
|
+
None,
|
|
117
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
118
|
+
Tuple[
|
|
119
|
+
Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
|
|
120
|
+
],
|
|
121
|
+
] = None,
|
|
122
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
123
|
+
_content_type: Optional[StrictStr] = None,
|
|
124
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
125
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
126
|
+
) -> ApiResponse[None]:
|
|
127
|
+
"""Empty a queue
|
|
128
|
+
|
|
129
|
+
Removes all jobs from the specified queue.
|
|
130
|
+
|
|
131
|
+
:param name: (required)
|
|
132
|
+
:type name: QueueName
|
|
133
|
+
:param queue_delete_dto: (required)
|
|
134
|
+
:type queue_delete_dto: QueueDeleteDto
|
|
135
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
136
|
+
number provided, it will be total request
|
|
137
|
+
timeout. It can also be a pair (tuple) of
|
|
138
|
+
(connection, read) timeouts.
|
|
139
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
140
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
141
|
+
request; this effectively ignores the
|
|
142
|
+
authentication in the spec for a single request.
|
|
143
|
+
:type _request_auth: dict, optional
|
|
144
|
+
:param _content_type: force content-type for the request.
|
|
145
|
+
:type _content_type: str, Optional
|
|
146
|
+
:param _headers: set to override the headers for a single
|
|
147
|
+
request; this effectively ignores the headers
|
|
148
|
+
in the spec for a single request.
|
|
149
|
+
:type _headers: dict, optional
|
|
150
|
+
:param _host_index: set to override the host_index for a single
|
|
151
|
+
request; this effectively ignores the host_index
|
|
152
|
+
in the spec for a single request.
|
|
153
|
+
:type _host_index: int, optional
|
|
154
|
+
:return: Returns the result object.
|
|
155
|
+
""" # noqa: E501
|
|
156
|
+
|
|
157
|
+
_param = self._empty_queue_serialize(
|
|
158
|
+
name=name,
|
|
159
|
+
queue_delete_dto=queue_delete_dto,
|
|
160
|
+
_request_auth=_request_auth,
|
|
161
|
+
_content_type=_content_type,
|
|
162
|
+
_headers=_headers,
|
|
163
|
+
_host_index=_host_index,
|
|
164
|
+
)
|
|
165
|
+
|
|
166
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
167
|
+
"204": None,
|
|
168
|
+
}
|
|
169
|
+
response_data = await self.api_client.call_api(
|
|
170
|
+
*_param, _request_timeout=_request_timeout
|
|
171
|
+
)
|
|
172
|
+
await response_data.read()
|
|
173
|
+
return self.api_client.response_deserialize(
|
|
174
|
+
response_data=response_data,
|
|
175
|
+
response_types_map=_response_types_map,
|
|
176
|
+
)
|
|
177
|
+
|
|
178
|
+
@validate_call
|
|
179
|
+
async def empty_queue_without_preload_content(
|
|
180
|
+
self,
|
|
181
|
+
name: QueueName,
|
|
182
|
+
queue_delete_dto: QueueDeleteDto,
|
|
183
|
+
_request_timeout: Union[
|
|
184
|
+
None,
|
|
185
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
186
|
+
Tuple[
|
|
187
|
+
Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
|
|
188
|
+
],
|
|
189
|
+
] = None,
|
|
190
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
191
|
+
_content_type: Optional[StrictStr] = None,
|
|
192
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
193
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
194
|
+
) -> RESTResponseType:
|
|
195
|
+
"""Empty a queue
|
|
196
|
+
|
|
197
|
+
Removes all jobs from the specified queue.
|
|
198
|
+
|
|
199
|
+
:param name: (required)
|
|
200
|
+
:type name: QueueName
|
|
201
|
+
:param queue_delete_dto: (required)
|
|
202
|
+
:type queue_delete_dto: QueueDeleteDto
|
|
203
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
204
|
+
number provided, it will be total request
|
|
205
|
+
timeout. It can also be a pair (tuple) of
|
|
206
|
+
(connection, read) timeouts.
|
|
207
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
208
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
209
|
+
request; this effectively ignores the
|
|
210
|
+
authentication in the spec for a single request.
|
|
211
|
+
:type _request_auth: dict, optional
|
|
212
|
+
:param _content_type: force content-type for the request.
|
|
213
|
+
:type _content_type: str, Optional
|
|
214
|
+
:param _headers: set to override the headers for a single
|
|
215
|
+
request; this effectively ignores the headers
|
|
216
|
+
in the spec for a single request.
|
|
217
|
+
:type _headers: dict, optional
|
|
218
|
+
:param _host_index: set to override the host_index for a single
|
|
219
|
+
request; this effectively ignores the host_index
|
|
220
|
+
in the spec for a single request.
|
|
221
|
+
:type _host_index: int, optional
|
|
222
|
+
:return: Returns the result object.
|
|
223
|
+
""" # noqa: E501
|
|
224
|
+
|
|
225
|
+
_param = self._empty_queue_serialize(
|
|
226
|
+
name=name,
|
|
227
|
+
queue_delete_dto=queue_delete_dto,
|
|
228
|
+
_request_auth=_request_auth,
|
|
229
|
+
_content_type=_content_type,
|
|
230
|
+
_headers=_headers,
|
|
231
|
+
_host_index=_host_index,
|
|
232
|
+
)
|
|
233
|
+
|
|
234
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
235
|
+
"204": None,
|
|
236
|
+
}
|
|
237
|
+
response_data = await self.api_client.call_api(
|
|
238
|
+
*_param, _request_timeout=_request_timeout
|
|
239
|
+
)
|
|
240
|
+
return response_data.response
|
|
241
|
+
|
|
242
|
+
def _empty_queue_serialize(
|
|
243
|
+
self,
|
|
244
|
+
name,
|
|
245
|
+
queue_delete_dto,
|
|
246
|
+
_request_auth,
|
|
247
|
+
_content_type,
|
|
248
|
+
_headers,
|
|
249
|
+
_host_index,
|
|
250
|
+
) -> RequestSerialized:
|
|
251
|
+
_host = None
|
|
252
|
+
|
|
253
|
+
_collection_formats: Dict[str, str] = {}
|
|
254
|
+
|
|
255
|
+
_path_params: Dict[str, str] = {}
|
|
256
|
+
_query_params: List[Tuple[str, str]] = []
|
|
257
|
+
_header_params: Dict[str, Optional[str]] = _headers or {}
|
|
258
|
+
_form_params: List[Tuple[str, str]] = []
|
|
259
|
+
_files: Dict[
|
|
260
|
+
str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
|
|
261
|
+
] = {}
|
|
262
|
+
_body_params: Optional[bytes] = None
|
|
263
|
+
|
|
264
|
+
# process the path parameters
|
|
265
|
+
if name is not None:
|
|
266
|
+
_path_params["name"] = name.value
|
|
267
|
+
# process the query parameters
|
|
268
|
+
# process the header parameters
|
|
269
|
+
# process the form parameters
|
|
270
|
+
# process the body parameter
|
|
271
|
+
if queue_delete_dto is not None:
|
|
272
|
+
_body_params = queue_delete_dto
|
|
273
|
+
|
|
274
|
+
# set the HTTP header `Content-Type`
|
|
275
|
+
if _content_type:
|
|
276
|
+
_header_params["Content-Type"] = _content_type
|
|
277
|
+
else:
|
|
278
|
+
_default_content_type = self.api_client.select_header_content_type(
|
|
279
|
+
["application/json"]
|
|
280
|
+
)
|
|
281
|
+
if _default_content_type is not None:
|
|
282
|
+
_header_params["Content-Type"] = _default_content_type
|
|
283
|
+
|
|
284
|
+
# authentication setting
|
|
285
|
+
_auth_settings: List[str] = ["cookie", "api_key", "bearer"]
|
|
286
|
+
|
|
287
|
+
return self.api_client.param_serialize(
|
|
288
|
+
method="DELETE",
|
|
289
|
+
resource_path="/queues/{name}/jobs",
|
|
290
|
+
path_params=_path_params,
|
|
291
|
+
query_params=_query_params,
|
|
292
|
+
header_params=_header_params,
|
|
293
|
+
body=_body_params,
|
|
294
|
+
post_params=_form_params,
|
|
295
|
+
files=_files,
|
|
296
|
+
auth_settings=_auth_settings,
|
|
297
|
+
collection_formats=_collection_formats,
|
|
298
|
+
_host=_host,
|
|
299
|
+
_request_auth=_request_auth,
|
|
300
|
+
)
|
|
301
|
+
|
|
302
|
+
@validate_call
|
|
303
|
+
async def get_queue(
|
|
304
|
+
self,
|
|
305
|
+
name: QueueName,
|
|
306
|
+
_request_timeout: Union[
|
|
307
|
+
None,
|
|
308
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
309
|
+
Tuple[
|
|
310
|
+
Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
|
|
311
|
+
],
|
|
312
|
+
] = None,
|
|
313
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
314
|
+
_content_type: Optional[StrictStr] = None,
|
|
315
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
316
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
317
|
+
) -> QueueResponseDto:
|
|
318
|
+
"""Retrieve a queue
|
|
319
|
+
|
|
320
|
+
Retrieves a specific queue by its name.
|
|
321
|
+
|
|
322
|
+
:param name: (required)
|
|
323
|
+
:type name: QueueName
|
|
324
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
325
|
+
number provided, it will be total request
|
|
326
|
+
timeout. It can also be a pair (tuple) of
|
|
327
|
+
(connection, read) timeouts.
|
|
328
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
329
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
330
|
+
request; this effectively ignores the
|
|
331
|
+
authentication in the spec for a single request.
|
|
332
|
+
:type _request_auth: dict, optional
|
|
333
|
+
:param _content_type: force content-type for the request.
|
|
334
|
+
:type _content_type: str, Optional
|
|
335
|
+
:param _headers: set to override the headers for a single
|
|
336
|
+
request; this effectively ignores the headers
|
|
337
|
+
in the spec for a single request.
|
|
338
|
+
:type _headers: dict, optional
|
|
339
|
+
:param _host_index: set to override the host_index for a single
|
|
340
|
+
request; this effectively ignores the host_index
|
|
341
|
+
in the spec for a single request.
|
|
342
|
+
:type _host_index: int, optional
|
|
343
|
+
:return: Returns the result object.
|
|
344
|
+
""" # noqa: E501
|
|
345
|
+
|
|
346
|
+
_param = self._get_queue_serialize(
|
|
347
|
+
name=name,
|
|
348
|
+
_request_auth=_request_auth,
|
|
349
|
+
_content_type=_content_type,
|
|
350
|
+
_headers=_headers,
|
|
351
|
+
_host_index=_host_index,
|
|
352
|
+
)
|
|
353
|
+
|
|
354
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
355
|
+
"200": "QueueResponseDto",
|
|
356
|
+
}
|
|
357
|
+
response_data = await self.api_client.call_api(
|
|
358
|
+
*_param, _request_timeout=_request_timeout
|
|
359
|
+
)
|
|
360
|
+
await response_data.read()
|
|
361
|
+
return self.api_client.response_deserialize(
|
|
362
|
+
response_data=response_data,
|
|
363
|
+
response_types_map=_response_types_map,
|
|
364
|
+
).data
|
|
365
|
+
|
|
366
|
+
@validate_call
|
|
367
|
+
async def get_queue_with_http_info(
|
|
368
|
+
self,
|
|
369
|
+
name: QueueName,
|
|
370
|
+
_request_timeout: Union[
|
|
371
|
+
None,
|
|
372
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
373
|
+
Tuple[
|
|
374
|
+
Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
|
|
375
|
+
],
|
|
376
|
+
] = None,
|
|
377
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
378
|
+
_content_type: Optional[StrictStr] = None,
|
|
379
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
380
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
381
|
+
) -> ApiResponse[QueueResponseDto]:
|
|
382
|
+
"""Retrieve a queue
|
|
383
|
+
|
|
384
|
+
Retrieves a specific queue by its name.
|
|
385
|
+
|
|
386
|
+
:param name: (required)
|
|
387
|
+
:type name: QueueName
|
|
388
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
389
|
+
number provided, it will be total request
|
|
390
|
+
timeout. It can also be a pair (tuple) of
|
|
391
|
+
(connection, read) timeouts.
|
|
392
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
393
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
394
|
+
request; this effectively ignores the
|
|
395
|
+
authentication in the spec for a single request.
|
|
396
|
+
:type _request_auth: dict, optional
|
|
397
|
+
:param _content_type: force content-type for the request.
|
|
398
|
+
:type _content_type: str, Optional
|
|
399
|
+
:param _headers: set to override the headers for a single
|
|
400
|
+
request; this effectively ignores the headers
|
|
401
|
+
in the spec for a single request.
|
|
402
|
+
:type _headers: dict, optional
|
|
403
|
+
:param _host_index: set to override the host_index for a single
|
|
404
|
+
request; this effectively ignores the host_index
|
|
405
|
+
in the spec for a single request.
|
|
406
|
+
:type _host_index: int, optional
|
|
407
|
+
:return: Returns the result object.
|
|
408
|
+
""" # noqa: E501
|
|
409
|
+
|
|
410
|
+
_param = self._get_queue_serialize(
|
|
411
|
+
name=name,
|
|
412
|
+
_request_auth=_request_auth,
|
|
413
|
+
_content_type=_content_type,
|
|
414
|
+
_headers=_headers,
|
|
415
|
+
_host_index=_host_index,
|
|
416
|
+
)
|
|
417
|
+
|
|
418
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
419
|
+
"200": "QueueResponseDto",
|
|
420
|
+
}
|
|
421
|
+
response_data = await self.api_client.call_api(
|
|
422
|
+
*_param, _request_timeout=_request_timeout
|
|
423
|
+
)
|
|
424
|
+
await response_data.read()
|
|
425
|
+
return self.api_client.response_deserialize(
|
|
426
|
+
response_data=response_data,
|
|
427
|
+
response_types_map=_response_types_map,
|
|
428
|
+
)
|
|
429
|
+
|
|
430
|
+
@validate_call
|
|
431
|
+
async def get_queue_without_preload_content(
|
|
432
|
+
self,
|
|
433
|
+
name: QueueName,
|
|
434
|
+
_request_timeout: Union[
|
|
435
|
+
None,
|
|
436
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
437
|
+
Tuple[
|
|
438
|
+
Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
|
|
439
|
+
],
|
|
440
|
+
] = None,
|
|
441
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
442
|
+
_content_type: Optional[StrictStr] = None,
|
|
443
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
444
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
445
|
+
) -> RESTResponseType:
|
|
446
|
+
"""Retrieve a queue
|
|
447
|
+
|
|
448
|
+
Retrieves a specific queue by its name.
|
|
449
|
+
|
|
450
|
+
:param name: (required)
|
|
451
|
+
:type name: QueueName
|
|
452
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
453
|
+
number provided, it will be total request
|
|
454
|
+
timeout. It can also be a pair (tuple) of
|
|
455
|
+
(connection, read) timeouts.
|
|
456
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
457
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
458
|
+
request; this effectively ignores the
|
|
459
|
+
authentication in the spec for a single request.
|
|
460
|
+
:type _request_auth: dict, optional
|
|
461
|
+
:param _content_type: force content-type for the request.
|
|
462
|
+
:type _content_type: str, Optional
|
|
463
|
+
:param _headers: set to override the headers for a single
|
|
464
|
+
request; this effectively ignores the headers
|
|
465
|
+
in the spec for a single request.
|
|
466
|
+
:type _headers: dict, optional
|
|
467
|
+
:param _host_index: set to override the host_index for a single
|
|
468
|
+
request; this effectively ignores the host_index
|
|
469
|
+
in the spec for a single request.
|
|
470
|
+
:type _host_index: int, optional
|
|
471
|
+
:return: Returns the result object.
|
|
472
|
+
""" # noqa: E501
|
|
473
|
+
|
|
474
|
+
_param = self._get_queue_serialize(
|
|
475
|
+
name=name,
|
|
476
|
+
_request_auth=_request_auth,
|
|
477
|
+
_content_type=_content_type,
|
|
478
|
+
_headers=_headers,
|
|
479
|
+
_host_index=_host_index,
|
|
480
|
+
)
|
|
481
|
+
|
|
482
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
483
|
+
"200": "QueueResponseDto",
|
|
484
|
+
}
|
|
485
|
+
response_data = await self.api_client.call_api(
|
|
486
|
+
*_param, _request_timeout=_request_timeout
|
|
487
|
+
)
|
|
488
|
+
return response_data.response
|
|
489
|
+
|
|
490
|
+
def _get_queue_serialize(
|
|
491
|
+
self,
|
|
492
|
+
name,
|
|
493
|
+
_request_auth,
|
|
494
|
+
_content_type,
|
|
495
|
+
_headers,
|
|
496
|
+
_host_index,
|
|
497
|
+
) -> RequestSerialized:
|
|
498
|
+
_host = None
|
|
499
|
+
|
|
500
|
+
_collection_formats: Dict[str, str] = {}
|
|
501
|
+
|
|
502
|
+
_path_params: Dict[str, str] = {}
|
|
503
|
+
_query_params: List[Tuple[str, str]] = []
|
|
504
|
+
_header_params: Dict[str, Optional[str]] = _headers or {}
|
|
505
|
+
_form_params: List[Tuple[str, str]] = []
|
|
506
|
+
_files: Dict[
|
|
507
|
+
str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
|
|
508
|
+
] = {}
|
|
509
|
+
_body_params: Optional[bytes] = None
|
|
510
|
+
|
|
511
|
+
# process the path parameters
|
|
512
|
+
if name is not None:
|
|
513
|
+
_path_params["name"] = name.value
|
|
514
|
+
# process the query parameters
|
|
515
|
+
# process the header parameters
|
|
516
|
+
# process the form parameters
|
|
517
|
+
# process the body parameter
|
|
518
|
+
|
|
519
|
+
# set the HTTP header `Accept`
|
|
520
|
+
if "Accept" not in _header_params:
|
|
521
|
+
_header_params["Accept"] = self.api_client.select_header_accept(
|
|
522
|
+
["application/json"]
|
|
523
|
+
)
|
|
524
|
+
|
|
525
|
+
# authentication setting
|
|
526
|
+
_auth_settings: List[str] = ["cookie", "api_key", "bearer"]
|
|
527
|
+
|
|
528
|
+
return self.api_client.param_serialize(
|
|
529
|
+
method="GET",
|
|
530
|
+
resource_path="/queues/{name}",
|
|
531
|
+
path_params=_path_params,
|
|
532
|
+
query_params=_query_params,
|
|
533
|
+
header_params=_header_params,
|
|
534
|
+
body=_body_params,
|
|
535
|
+
post_params=_form_params,
|
|
536
|
+
files=_files,
|
|
537
|
+
auth_settings=_auth_settings,
|
|
538
|
+
collection_formats=_collection_formats,
|
|
539
|
+
_host=_host,
|
|
540
|
+
_request_auth=_request_auth,
|
|
541
|
+
)
|
|
542
|
+
|
|
543
|
+
@validate_call
|
|
544
|
+
async def get_queue_jobs(
|
|
545
|
+
self,
|
|
546
|
+
name: QueueName,
|
|
547
|
+
status: Optional[List[QueueJobStatus]] = None,
|
|
548
|
+
_request_timeout: Union[
|
|
549
|
+
None,
|
|
550
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
551
|
+
Tuple[
|
|
552
|
+
Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
|
|
553
|
+
],
|
|
554
|
+
] = None,
|
|
555
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
556
|
+
_content_type: Optional[StrictStr] = None,
|
|
557
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
558
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
559
|
+
) -> List[QueueJobResponseDto]:
|
|
560
|
+
"""Retrieve queue jobs
|
|
561
|
+
|
|
562
|
+
Retrieves a list of queue jobs from the specified queue.
|
|
563
|
+
|
|
564
|
+
:param name: (required)
|
|
565
|
+
:type name: QueueName
|
|
566
|
+
:param status:
|
|
567
|
+
:type status: List[QueueJobStatus]
|
|
568
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
569
|
+
number provided, it will be total request
|
|
570
|
+
timeout. It can also be a pair (tuple) of
|
|
571
|
+
(connection, read) timeouts.
|
|
572
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
573
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
574
|
+
request; this effectively ignores the
|
|
575
|
+
authentication in the spec for a single request.
|
|
576
|
+
:type _request_auth: dict, optional
|
|
577
|
+
:param _content_type: force content-type for the request.
|
|
578
|
+
:type _content_type: str, Optional
|
|
579
|
+
:param _headers: set to override the headers for a single
|
|
580
|
+
request; this effectively ignores the headers
|
|
581
|
+
in the spec for a single request.
|
|
582
|
+
:type _headers: dict, optional
|
|
583
|
+
:param _host_index: set to override the host_index for a single
|
|
584
|
+
request; this effectively ignores the host_index
|
|
585
|
+
in the spec for a single request.
|
|
586
|
+
:type _host_index: int, optional
|
|
587
|
+
:return: Returns the result object.
|
|
588
|
+
""" # noqa: E501
|
|
589
|
+
|
|
590
|
+
_param = self._get_queue_jobs_serialize(
|
|
591
|
+
name=name,
|
|
592
|
+
status=status,
|
|
593
|
+
_request_auth=_request_auth,
|
|
594
|
+
_content_type=_content_type,
|
|
595
|
+
_headers=_headers,
|
|
596
|
+
_host_index=_host_index,
|
|
597
|
+
)
|
|
598
|
+
|
|
599
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
600
|
+
"200": "List[QueueJobResponseDto]",
|
|
601
|
+
}
|
|
602
|
+
response_data = await self.api_client.call_api(
|
|
603
|
+
*_param, _request_timeout=_request_timeout
|
|
604
|
+
)
|
|
605
|
+
await response_data.read()
|
|
606
|
+
return self.api_client.response_deserialize(
|
|
607
|
+
response_data=response_data,
|
|
608
|
+
response_types_map=_response_types_map,
|
|
609
|
+
).data
|
|
610
|
+
|
|
611
|
+
@validate_call
|
|
612
|
+
async def get_queue_jobs_with_http_info(
|
|
613
|
+
self,
|
|
614
|
+
name: QueueName,
|
|
615
|
+
status: Optional[List[QueueJobStatus]] = None,
|
|
616
|
+
_request_timeout: Union[
|
|
617
|
+
None,
|
|
618
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
619
|
+
Tuple[
|
|
620
|
+
Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
|
|
621
|
+
],
|
|
622
|
+
] = None,
|
|
623
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
624
|
+
_content_type: Optional[StrictStr] = None,
|
|
625
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
626
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
627
|
+
) -> ApiResponse[List[QueueJobResponseDto]]:
|
|
628
|
+
"""Retrieve queue jobs
|
|
629
|
+
|
|
630
|
+
Retrieves a list of queue jobs from the specified queue.
|
|
631
|
+
|
|
632
|
+
:param name: (required)
|
|
633
|
+
:type name: QueueName
|
|
634
|
+
:param status:
|
|
635
|
+
:type status: List[QueueJobStatus]
|
|
636
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
637
|
+
number provided, it will be total request
|
|
638
|
+
timeout. It can also be a pair (tuple) of
|
|
639
|
+
(connection, read) timeouts.
|
|
640
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
641
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
642
|
+
request; this effectively ignores the
|
|
643
|
+
authentication in the spec for a single request.
|
|
644
|
+
:type _request_auth: dict, optional
|
|
645
|
+
:param _content_type: force content-type for the request.
|
|
646
|
+
:type _content_type: str, Optional
|
|
647
|
+
:param _headers: set to override the headers for a single
|
|
648
|
+
request; this effectively ignores the headers
|
|
649
|
+
in the spec for a single request.
|
|
650
|
+
:type _headers: dict, optional
|
|
651
|
+
:param _host_index: set to override the host_index for a single
|
|
652
|
+
request; this effectively ignores the host_index
|
|
653
|
+
in the spec for a single request.
|
|
654
|
+
:type _host_index: int, optional
|
|
655
|
+
:return: Returns the result object.
|
|
656
|
+
""" # noqa: E501
|
|
657
|
+
|
|
658
|
+
_param = self._get_queue_jobs_serialize(
|
|
659
|
+
name=name,
|
|
660
|
+
status=status,
|
|
661
|
+
_request_auth=_request_auth,
|
|
662
|
+
_content_type=_content_type,
|
|
663
|
+
_headers=_headers,
|
|
664
|
+
_host_index=_host_index,
|
|
665
|
+
)
|
|
666
|
+
|
|
667
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
668
|
+
"200": "List[QueueJobResponseDto]",
|
|
669
|
+
}
|
|
670
|
+
response_data = await self.api_client.call_api(
|
|
671
|
+
*_param, _request_timeout=_request_timeout
|
|
672
|
+
)
|
|
673
|
+
await response_data.read()
|
|
674
|
+
return self.api_client.response_deserialize(
|
|
675
|
+
response_data=response_data,
|
|
676
|
+
response_types_map=_response_types_map,
|
|
677
|
+
)
|
|
678
|
+
|
|
679
|
+
@validate_call
|
|
680
|
+
async def get_queue_jobs_without_preload_content(
|
|
681
|
+
self,
|
|
682
|
+
name: QueueName,
|
|
683
|
+
status: Optional[List[QueueJobStatus]] = None,
|
|
684
|
+
_request_timeout: Union[
|
|
685
|
+
None,
|
|
686
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
687
|
+
Tuple[
|
|
688
|
+
Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
|
|
689
|
+
],
|
|
690
|
+
] = None,
|
|
691
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
692
|
+
_content_type: Optional[StrictStr] = None,
|
|
693
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
694
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
695
|
+
) -> RESTResponseType:
|
|
696
|
+
"""Retrieve queue jobs
|
|
697
|
+
|
|
698
|
+
Retrieves a list of queue jobs from the specified queue.
|
|
699
|
+
|
|
700
|
+
:param name: (required)
|
|
701
|
+
:type name: QueueName
|
|
702
|
+
:param status:
|
|
703
|
+
:type status: List[QueueJobStatus]
|
|
704
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
705
|
+
number provided, it will be total request
|
|
706
|
+
timeout. It can also be a pair (tuple) of
|
|
707
|
+
(connection, read) timeouts.
|
|
708
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
709
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
710
|
+
request; this effectively ignores the
|
|
711
|
+
authentication in the spec for a single request.
|
|
712
|
+
:type _request_auth: dict, optional
|
|
713
|
+
:param _content_type: force content-type for the request.
|
|
714
|
+
:type _content_type: str, Optional
|
|
715
|
+
:param _headers: set to override the headers for a single
|
|
716
|
+
request; this effectively ignores the headers
|
|
717
|
+
in the spec for a single request.
|
|
718
|
+
:type _headers: dict, optional
|
|
719
|
+
:param _host_index: set to override the host_index for a single
|
|
720
|
+
request; this effectively ignores the host_index
|
|
721
|
+
in the spec for a single request.
|
|
722
|
+
:type _host_index: int, optional
|
|
723
|
+
:return: Returns the result object.
|
|
724
|
+
""" # noqa: E501
|
|
725
|
+
|
|
726
|
+
_param = self._get_queue_jobs_serialize(
|
|
727
|
+
name=name,
|
|
728
|
+
status=status,
|
|
729
|
+
_request_auth=_request_auth,
|
|
730
|
+
_content_type=_content_type,
|
|
731
|
+
_headers=_headers,
|
|
732
|
+
_host_index=_host_index,
|
|
733
|
+
)
|
|
734
|
+
|
|
735
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
736
|
+
"200": "List[QueueJobResponseDto]",
|
|
737
|
+
}
|
|
738
|
+
response_data = await self.api_client.call_api(
|
|
739
|
+
*_param, _request_timeout=_request_timeout
|
|
740
|
+
)
|
|
741
|
+
return response_data.response
|
|
742
|
+
|
|
743
|
+
def _get_queue_jobs_serialize(
|
|
744
|
+
self,
|
|
745
|
+
name,
|
|
746
|
+
status,
|
|
747
|
+
_request_auth,
|
|
748
|
+
_content_type,
|
|
749
|
+
_headers,
|
|
750
|
+
_host_index,
|
|
751
|
+
) -> RequestSerialized:
|
|
752
|
+
_host = None
|
|
753
|
+
|
|
754
|
+
_collection_formats: Dict[str, str] = {
|
|
755
|
+
"status": "multi",
|
|
756
|
+
}
|
|
757
|
+
|
|
758
|
+
_path_params: Dict[str, str] = {}
|
|
759
|
+
_query_params: List[Tuple[str, str]] = []
|
|
760
|
+
_header_params: Dict[str, Optional[str]] = _headers or {}
|
|
761
|
+
_form_params: List[Tuple[str, str]] = []
|
|
762
|
+
_files: Dict[
|
|
763
|
+
str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
|
|
764
|
+
] = {}
|
|
765
|
+
_body_params: Optional[bytes] = None
|
|
766
|
+
|
|
767
|
+
# process the path parameters
|
|
768
|
+
if name is not None:
|
|
769
|
+
_path_params["name"] = name.value
|
|
770
|
+
# process the query parameters
|
|
771
|
+
if status is not None:
|
|
772
|
+
_query_params.append(("status", status))
|
|
773
|
+
|
|
774
|
+
# process the header parameters
|
|
775
|
+
# process the form parameters
|
|
776
|
+
# process the body parameter
|
|
777
|
+
|
|
778
|
+
# set the HTTP header `Accept`
|
|
779
|
+
if "Accept" not in _header_params:
|
|
780
|
+
_header_params["Accept"] = self.api_client.select_header_accept(
|
|
781
|
+
["application/json"]
|
|
782
|
+
)
|
|
783
|
+
|
|
784
|
+
# authentication setting
|
|
785
|
+
_auth_settings: List[str] = ["cookie", "api_key", "bearer"]
|
|
786
|
+
|
|
787
|
+
return self.api_client.param_serialize(
|
|
788
|
+
method="GET",
|
|
789
|
+
resource_path="/queues/{name}/jobs",
|
|
790
|
+
path_params=_path_params,
|
|
791
|
+
query_params=_query_params,
|
|
792
|
+
header_params=_header_params,
|
|
793
|
+
body=_body_params,
|
|
794
|
+
post_params=_form_params,
|
|
795
|
+
files=_files,
|
|
796
|
+
auth_settings=_auth_settings,
|
|
797
|
+
collection_formats=_collection_formats,
|
|
798
|
+
_host=_host,
|
|
799
|
+
_request_auth=_request_auth,
|
|
800
|
+
)
|
|
801
|
+
|
|
802
|
+
@validate_call
|
|
803
|
+
async def get_queues(
|
|
804
|
+
self,
|
|
805
|
+
_request_timeout: Union[
|
|
806
|
+
None,
|
|
807
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
808
|
+
Tuple[
|
|
809
|
+
Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
|
|
810
|
+
],
|
|
811
|
+
] = None,
|
|
812
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
813
|
+
_content_type: Optional[StrictStr] = None,
|
|
814
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
815
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
816
|
+
) -> List[QueueResponseDto]:
|
|
817
|
+
"""List all queues
|
|
818
|
+
|
|
819
|
+
Retrieves a list of queues.
|
|
820
|
+
|
|
821
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
822
|
+
number provided, it will be total request
|
|
823
|
+
timeout. It can also be a pair (tuple) of
|
|
824
|
+
(connection, read) timeouts.
|
|
825
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
826
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
827
|
+
request; this effectively ignores the
|
|
828
|
+
authentication in the spec for a single request.
|
|
829
|
+
:type _request_auth: dict, optional
|
|
830
|
+
:param _content_type: force content-type for the request.
|
|
831
|
+
:type _content_type: str, Optional
|
|
832
|
+
:param _headers: set to override the headers for a single
|
|
833
|
+
request; this effectively ignores the headers
|
|
834
|
+
in the spec for a single request.
|
|
835
|
+
:type _headers: dict, optional
|
|
836
|
+
:param _host_index: set to override the host_index for a single
|
|
837
|
+
request; this effectively ignores the host_index
|
|
838
|
+
in the spec for a single request.
|
|
839
|
+
:type _host_index: int, optional
|
|
840
|
+
:return: Returns the result object.
|
|
841
|
+
""" # noqa: E501
|
|
842
|
+
|
|
843
|
+
_param = self._get_queues_serialize(
|
|
844
|
+
_request_auth=_request_auth,
|
|
845
|
+
_content_type=_content_type,
|
|
846
|
+
_headers=_headers,
|
|
847
|
+
_host_index=_host_index,
|
|
848
|
+
)
|
|
849
|
+
|
|
850
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
851
|
+
"200": "List[QueueResponseDto]",
|
|
852
|
+
}
|
|
853
|
+
response_data = await self.api_client.call_api(
|
|
854
|
+
*_param, _request_timeout=_request_timeout
|
|
855
|
+
)
|
|
856
|
+
await response_data.read()
|
|
857
|
+
return self.api_client.response_deserialize(
|
|
858
|
+
response_data=response_data,
|
|
859
|
+
response_types_map=_response_types_map,
|
|
860
|
+
).data
|
|
861
|
+
|
|
862
|
+
@validate_call
|
|
863
|
+
async def get_queues_with_http_info(
|
|
864
|
+
self,
|
|
865
|
+
_request_timeout: Union[
|
|
866
|
+
None,
|
|
867
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
868
|
+
Tuple[
|
|
869
|
+
Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
|
|
870
|
+
],
|
|
871
|
+
] = None,
|
|
872
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
873
|
+
_content_type: Optional[StrictStr] = None,
|
|
874
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
875
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
876
|
+
) -> ApiResponse[List[QueueResponseDto]]:
|
|
877
|
+
"""List all queues
|
|
878
|
+
|
|
879
|
+
Retrieves a list of queues.
|
|
880
|
+
|
|
881
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
882
|
+
number provided, it will be total request
|
|
883
|
+
timeout. It can also be a pair (tuple) of
|
|
884
|
+
(connection, read) timeouts.
|
|
885
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
886
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
887
|
+
request; this effectively ignores the
|
|
888
|
+
authentication in the spec for a single request.
|
|
889
|
+
:type _request_auth: dict, optional
|
|
890
|
+
:param _content_type: force content-type for the request.
|
|
891
|
+
:type _content_type: str, Optional
|
|
892
|
+
:param _headers: set to override the headers for a single
|
|
893
|
+
request; this effectively ignores the headers
|
|
894
|
+
in the spec for a single request.
|
|
895
|
+
:type _headers: dict, optional
|
|
896
|
+
:param _host_index: set to override the host_index for a single
|
|
897
|
+
request; this effectively ignores the host_index
|
|
898
|
+
in the spec for a single request.
|
|
899
|
+
:type _host_index: int, optional
|
|
900
|
+
:return: Returns the result object.
|
|
901
|
+
""" # noqa: E501
|
|
902
|
+
|
|
903
|
+
_param = self._get_queues_serialize(
|
|
904
|
+
_request_auth=_request_auth,
|
|
905
|
+
_content_type=_content_type,
|
|
906
|
+
_headers=_headers,
|
|
907
|
+
_host_index=_host_index,
|
|
908
|
+
)
|
|
909
|
+
|
|
910
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
911
|
+
"200": "List[QueueResponseDto]",
|
|
912
|
+
}
|
|
913
|
+
response_data = await self.api_client.call_api(
|
|
914
|
+
*_param, _request_timeout=_request_timeout
|
|
915
|
+
)
|
|
916
|
+
await response_data.read()
|
|
917
|
+
return self.api_client.response_deserialize(
|
|
918
|
+
response_data=response_data,
|
|
919
|
+
response_types_map=_response_types_map,
|
|
920
|
+
)
|
|
921
|
+
|
|
922
|
+
@validate_call
|
|
923
|
+
async def get_queues_without_preload_content(
|
|
924
|
+
self,
|
|
925
|
+
_request_timeout: Union[
|
|
926
|
+
None,
|
|
927
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
928
|
+
Tuple[
|
|
929
|
+
Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
|
|
930
|
+
],
|
|
931
|
+
] = None,
|
|
932
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
933
|
+
_content_type: Optional[StrictStr] = None,
|
|
934
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
935
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
936
|
+
) -> RESTResponseType:
|
|
937
|
+
"""List all queues
|
|
938
|
+
|
|
939
|
+
Retrieves a list of queues.
|
|
940
|
+
|
|
941
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
942
|
+
number provided, it will be total request
|
|
943
|
+
timeout. It can also be a pair (tuple) of
|
|
944
|
+
(connection, read) timeouts.
|
|
945
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
946
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
947
|
+
request; this effectively ignores the
|
|
948
|
+
authentication in the spec for a single request.
|
|
949
|
+
:type _request_auth: dict, optional
|
|
950
|
+
:param _content_type: force content-type for the request.
|
|
951
|
+
:type _content_type: str, Optional
|
|
952
|
+
:param _headers: set to override the headers for a single
|
|
953
|
+
request; this effectively ignores the headers
|
|
954
|
+
in the spec for a single request.
|
|
955
|
+
:type _headers: dict, optional
|
|
956
|
+
:param _host_index: set to override the host_index for a single
|
|
957
|
+
request; this effectively ignores the host_index
|
|
958
|
+
in the spec for a single request.
|
|
959
|
+
:type _host_index: int, optional
|
|
960
|
+
:return: Returns the result object.
|
|
961
|
+
""" # noqa: E501
|
|
962
|
+
|
|
963
|
+
_param = self._get_queues_serialize(
|
|
964
|
+
_request_auth=_request_auth,
|
|
965
|
+
_content_type=_content_type,
|
|
966
|
+
_headers=_headers,
|
|
967
|
+
_host_index=_host_index,
|
|
968
|
+
)
|
|
969
|
+
|
|
970
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
971
|
+
"200": "List[QueueResponseDto]",
|
|
972
|
+
}
|
|
973
|
+
response_data = await self.api_client.call_api(
|
|
974
|
+
*_param, _request_timeout=_request_timeout
|
|
975
|
+
)
|
|
976
|
+
return response_data.response
|
|
977
|
+
|
|
978
|
+
def _get_queues_serialize(
|
|
979
|
+
self,
|
|
980
|
+
_request_auth,
|
|
981
|
+
_content_type,
|
|
982
|
+
_headers,
|
|
983
|
+
_host_index,
|
|
984
|
+
) -> RequestSerialized:
|
|
985
|
+
_host = None
|
|
986
|
+
|
|
987
|
+
_collection_formats: Dict[str, str] = {}
|
|
988
|
+
|
|
989
|
+
_path_params: Dict[str, str] = {}
|
|
990
|
+
_query_params: List[Tuple[str, str]] = []
|
|
991
|
+
_header_params: Dict[str, Optional[str]] = _headers or {}
|
|
992
|
+
_form_params: List[Tuple[str, str]] = []
|
|
993
|
+
_files: Dict[
|
|
994
|
+
str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
|
|
995
|
+
] = {}
|
|
996
|
+
_body_params: Optional[bytes] = None
|
|
997
|
+
|
|
998
|
+
# process the path parameters
|
|
999
|
+
# process the query parameters
|
|
1000
|
+
# process the header parameters
|
|
1001
|
+
# process the form parameters
|
|
1002
|
+
# process the body parameter
|
|
1003
|
+
|
|
1004
|
+
# set the HTTP header `Accept`
|
|
1005
|
+
if "Accept" not in _header_params:
|
|
1006
|
+
_header_params["Accept"] = self.api_client.select_header_accept(
|
|
1007
|
+
["application/json"]
|
|
1008
|
+
)
|
|
1009
|
+
|
|
1010
|
+
# authentication setting
|
|
1011
|
+
_auth_settings: List[str] = ["cookie", "api_key", "bearer"]
|
|
1012
|
+
|
|
1013
|
+
return self.api_client.param_serialize(
|
|
1014
|
+
method="GET",
|
|
1015
|
+
resource_path="/queues",
|
|
1016
|
+
path_params=_path_params,
|
|
1017
|
+
query_params=_query_params,
|
|
1018
|
+
header_params=_header_params,
|
|
1019
|
+
body=_body_params,
|
|
1020
|
+
post_params=_form_params,
|
|
1021
|
+
files=_files,
|
|
1022
|
+
auth_settings=_auth_settings,
|
|
1023
|
+
collection_formats=_collection_formats,
|
|
1024
|
+
_host=_host,
|
|
1025
|
+
_request_auth=_request_auth,
|
|
1026
|
+
)
|
|
1027
|
+
|
|
1028
|
+
@validate_call
|
|
1029
|
+
async def update_queue(
|
|
1030
|
+
self,
|
|
1031
|
+
name: QueueName,
|
|
1032
|
+
queue_update_dto: QueueUpdateDto,
|
|
1033
|
+
_request_timeout: Union[
|
|
1034
|
+
None,
|
|
1035
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
1036
|
+
Tuple[
|
|
1037
|
+
Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
|
|
1038
|
+
],
|
|
1039
|
+
] = None,
|
|
1040
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
1041
|
+
_content_type: Optional[StrictStr] = None,
|
|
1042
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
1043
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
1044
|
+
) -> QueueResponseDto:
|
|
1045
|
+
"""Update a queue
|
|
1046
|
+
|
|
1047
|
+
Change the paused status of a specific queue.
|
|
1048
|
+
|
|
1049
|
+
:param name: (required)
|
|
1050
|
+
:type name: QueueName
|
|
1051
|
+
:param queue_update_dto: (required)
|
|
1052
|
+
:type queue_update_dto: QueueUpdateDto
|
|
1053
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
1054
|
+
number provided, it will be total request
|
|
1055
|
+
timeout. It can also be a pair (tuple) of
|
|
1056
|
+
(connection, read) timeouts.
|
|
1057
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
1058
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
1059
|
+
request; this effectively ignores the
|
|
1060
|
+
authentication in the spec for a single request.
|
|
1061
|
+
:type _request_auth: dict, optional
|
|
1062
|
+
:param _content_type: force content-type for the request.
|
|
1063
|
+
:type _content_type: str, Optional
|
|
1064
|
+
:param _headers: set to override the headers for a single
|
|
1065
|
+
request; this effectively ignores the headers
|
|
1066
|
+
in the spec for a single request.
|
|
1067
|
+
:type _headers: dict, optional
|
|
1068
|
+
:param _host_index: set to override the host_index for a single
|
|
1069
|
+
request; this effectively ignores the host_index
|
|
1070
|
+
in the spec for a single request.
|
|
1071
|
+
:type _host_index: int, optional
|
|
1072
|
+
:return: Returns the result object.
|
|
1073
|
+
""" # noqa: E501
|
|
1074
|
+
|
|
1075
|
+
_param = self._update_queue_serialize(
|
|
1076
|
+
name=name,
|
|
1077
|
+
queue_update_dto=queue_update_dto,
|
|
1078
|
+
_request_auth=_request_auth,
|
|
1079
|
+
_content_type=_content_type,
|
|
1080
|
+
_headers=_headers,
|
|
1081
|
+
_host_index=_host_index,
|
|
1082
|
+
)
|
|
1083
|
+
|
|
1084
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
1085
|
+
"200": "QueueResponseDto",
|
|
1086
|
+
}
|
|
1087
|
+
response_data = await self.api_client.call_api(
|
|
1088
|
+
*_param, _request_timeout=_request_timeout
|
|
1089
|
+
)
|
|
1090
|
+
await response_data.read()
|
|
1091
|
+
return self.api_client.response_deserialize(
|
|
1092
|
+
response_data=response_data,
|
|
1093
|
+
response_types_map=_response_types_map,
|
|
1094
|
+
).data
|
|
1095
|
+
|
|
1096
|
+
@validate_call
|
|
1097
|
+
async def update_queue_with_http_info(
|
|
1098
|
+
self,
|
|
1099
|
+
name: QueueName,
|
|
1100
|
+
queue_update_dto: QueueUpdateDto,
|
|
1101
|
+
_request_timeout: Union[
|
|
1102
|
+
None,
|
|
1103
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
1104
|
+
Tuple[
|
|
1105
|
+
Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
|
|
1106
|
+
],
|
|
1107
|
+
] = None,
|
|
1108
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
1109
|
+
_content_type: Optional[StrictStr] = None,
|
|
1110
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
1111
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
1112
|
+
) -> ApiResponse[QueueResponseDto]:
|
|
1113
|
+
"""Update a queue
|
|
1114
|
+
|
|
1115
|
+
Change the paused status of a specific queue.
|
|
1116
|
+
|
|
1117
|
+
:param name: (required)
|
|
1118
|
+
:type name: QueueName
|
|
1119
|
+
:param queue_update_dto: (required)
|
|
1120
|
+
:type queue_update_dto: QueueUpdateDto
|
|
1121
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
1122
|
+
number provided, it will be total request
|
|
1123
|
+
timeout. It can also be a pair (tuple) of
|
|
1124
|
+
(connection, read) timeouts.
|
|
1125
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
1126
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
1127
|
+
request; this effectively ignores the
|
|
1128
|
+
authentication in the spec for a single request.
|
|
1129
|
+
:type _request_auth: dict, optional
|
|
1130
|
+
:param _content_type: force content-type for the request.
|
|
1131
|
+
:type _content_type: str, Optional
|
|
1132
|
+
:param _headers: set to override the headers for a single
|
|
1133
|
+
request; this effectively ignores the headers
|
|
1134
|
+
in the spec for a single request.
|
|
1135
|
+
:type _headers: dict, optional
|
|
1136
|
+
:param _host_index: set to override the host_index for a single
|
|
1137
|
+
request; this effectively ignores the host_index
|
|
1138
|
+
in the spec for a single request.
|
|
1139
|
+
:type _host_index: int, optional
|
|
1140
|
+
:return: Returns the result object.
|
|
1141
|
+
""" # noqa: E501
|
|
1142
|
+
|
|
1143
|
+
_param = self._update_queue_serialize(
|
|
1144
|
+
name=name,
|
|
1145
|
+
queue_update_dto=queue_update_dto,
|
|
1146
|
+
_request_auth=_request_auth,
|
|
1147
|
+
_content_type=_content_type,
|
|
1148
|
+
_headers=_headers,
|
|
1149
|
+
_host_index=_host_index,
|
|
1150
|
+
)
|
|
1151
|
+
|
|
1152
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
1153
|
+
"200": "QueueResponseDto",
|
|
1154
|
+
}
|
|
1155
|
+
response_data = await self.api_client.call_api(
|
|
1156
|
+
*_param, _request_timeout=_request_timeout
|
|
1157
|
+
)
|
|
1158
|
+
await response_data.read()
|
|
1159
|
+
return self.api_client.response_deserialize(
|
|
1160
|
+
response_data=response_data,
|
|
1161
|
+
response_types_map=_response_types_map,
|
|
1162
|
+
)
|
|
1163
|
+
|
|
1164
|
+
@validate_call
|
|
1165
|
+
async def update_queue_without_preload_content(
|
|
1166
|
+
self,
|
|
1167
|
+
name: QueueName,
|
|
1168
|
+
queue_update_dto: QueueUpdateDto,
|
|
1169
|
+
_request_timeout: Union[
|
|
1170
|
+
None,
|
|
1171
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
1172
|
+
Tuple[
|
|
1173
|
+
Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
|
|
1174
|
+
],
|
|
1175
|
+
] = None,
|
|
1176
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
1177
|
+
_content_type: Optional[StrictStr] = None,
|
|
1178
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
1179
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
1180
|
+
) -> RESTResponseType:
|
|
1181
|
+
"""Update a queue
|
|
1182
|
+
|
|
1183
|
+
Change the paused status of a specific queue.
|
|
1184
|
+
|
|
1185
|
+
:param name: (required)
|
|
1186
|
+
:type name: QueueName
|
|
1187
|
+
:param queue_update_dto: (required)
|
|
1188
|
+
:type queue_update_dto: QueueUpdateDto
|
|
1189
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
1190
|
+
number provided, it will be total request
|
|
1191
|
+
timeout. It can also be a pair (tuple) of
|
|
1192
|
+
(connection, read) timeouts.
|
|
1193
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
1194
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
1195
|
+
request; this effectively ignores the
|
|
1196
|
+
authentication in the spec for a single request.
|
|
1197
|
+
:type _request_auth: dict, optional
|
|
1198
|
+
:param _content_type: force content-type for the request.
|
|
1199
|
+
:type _content_type: str, Optional
|
|
1200
|
+
:param _headers: set to override the headers for a single
|
|
1201
|
+
request; this effectively ignores the headers
|
|
1202
|
+
in the spec for a single request.
|
|
1203
|
+
:type _headers: dict, optional
|
|
1204
|
+
:param _host_index: set to override the host_index for a single
|
|
1205
|
+
request; this effectively ignores the host_index
|
|
1206
|
+
in the spec for a single request.
|
|
1207
|
+
:type _host_index: int, optional
|
|
1208
|
+
:return: Returns the result object.
|
|
1209
|
+
""" # noqa: E501
|
|
1210
|
+
|
|
1211
|
+
_param = self._update_queue_serialize(
|
|
1212
|
+
name=name,
|
|
1213
|
+
queue_update_dto=queue_update_dto,
|
|
1214
|
+
_request_auth=_request_auth,
|
|
1215
|
+
_content_type=_content_type,
|
|
1216
|
+
_headers=_headers,
|
|
1217
|
+
_host_index=_host_index,
|
|
1218
|
+
)
|
|
1219
|
+
|
|
1220
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
1221
|
+
"200": "QueueResponseDto",
|
|
1222
|
+
}
|
|
1223
|
+
response_data = await self.api_client.call_api(
|
|
1224
|
+
*_param, _request_timeout=_request_timeout
|
|
1225
|
+
)
|
|
1226
|
+
return response_data.response
|
|
1227
|
+
|
|
1228
|
+
def _update_queue_serialize(
|
|
1229
|
+
self,
|
|
1230
|
+
name,
|
|
1231
|
+
queue_update_dto,
|
|
1232
|
+
_request_auth,
|
|
1233
|
+
_content_type,
|
|
1234
|
+
_headers,
|
|
1235
|
+
_host_index,
|
|
1236
|
+
) -> RequestSerialized:
|
|
1237
|
+
_host = None
|
|
1238
|
+
|
|
1239
|
+
_collection_formats: Dict[str, str] = {}
|
|
1240
|
+
|
|
1241
|
+
_path_params: Dict[str, str] = {}
|
|
1242
|
+
_query_params: List[Tuple[str, str]] = []
|
|
1243
|
+
_header_params: Dict[str, Optional[str]] = _headers or {}
|
|
1244
|
+
_form_params: List[Tuple[str, str]] = []
|
|
1245
|
+
_files: Dict[
|
|
1246
|
+
str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
|
|
1247
|
+
] = {}
|
|
1248
|
+
_body_params: Optional[bytes] = None
|
|
1249
|
+
|
|
1250
|
+
# process the path parameters
|
|
1251
|
+
if name is not None:
|
|
1252
|
+
_path_params["name"] = name.value
|
|
1253
|
+
# process the query parameters
|
|
1254
|
+
# process the header parameters
|
|
1255
|
+
# process the form parameters
|
|
1256
|
+
# process the body parameter
|
|
1257
|
+
if queue_update_dto is not None:
|
|
1258
|
+
_body_params = queue_update_dto
|
|
1259
|
+
|
|
1260
|
+
# set the HTTP header `Accept`
|
|
1261
|
+
if "Accept" not in _header_params:
|
|
1262
|
+
_header_params["Accept"] = self.api_client.select_header_accept(
|
|
1263
|
+
["application/json"]
|
|
1264
|
+
)
|
|
1265
|
+
|
|
1266
|
+
# set the HTTP header `Content-Type`
|
|
1267
|
+
if _content_type:
|
|
1268
|
+
_header_params["Content-Type"] = _content_type
|
|
1269
|
+
else:
|
|
1270
|
+
_default_content_type = self.api_client.select_header_content_type(
|
|
1271
|
+
["application/json"]
|
|
1272
|
+
)
|
|
1273
|
+
if _default_content_type is not None:
|
|
1274
|
+
_header_params["Content-Type"] = _default_content_type
|
|
1275
|
+
|
|
1276
|
+
# authentication setting
|
|
1277
|
+
_auth_settings: List[str] = ["cookie", "api_key", "bearer"]
|
|
1278
|
+
|
|
1279
|
+
return self.api_client.param_serialize(
|
|
1280
|
+
method="PUT",
|
|
1281
|
+
resource_path="/queues/{name}",
|
|
1282
|
+
path_params=_path_params,
|
|
1283
|
+
query_params=_query_params,
|
|
1284
|
+
header_params=_header_params,
|
|
1285
|
+
body=_body_params,
|
|
1286
|
+
post_params=_form_params,
|
|
1287
|
+
files=_files,
|
|
1288
|
+
auth_settings=_auth_settings,
|
|
1289
|
+
collection_formats=_collection_formats,
|
|
1290
|
+
_host=_host,
|
|
1291
|
+
_request_auth=_request_auth,
|
|
1292
|
+
)
|