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,783 @@
|
|
|
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
|
+
import warnings
|
|
15
|
+
from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
|
|
16
|
+
from typing import Any, Dict, List, Optional, Tuple, Union
|
|
17
|
+
from typing_extensions import Annotated
|
|
18
|
+
|
|
19
|
+
from immich.client.models.job_create_dto import JobCreateDto
|
|
20
|
+
from immich.client.models.queue_command_dto import QueueCommandDto
|
|
21
|
+
from immich.client.models.queue_name import QueueName
|
|
22
|
+
from immich.client.models.queue_response_legacy_dto import QueueResponseLegacyDto
|
|
23
|
+
from immich.client.models.queues_response_legacy_dto import QueuesResponseLegacyDto
|
|
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 JobsApi:
|
|
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 create_job(
|
|
44
|
+
self,
|
|
45
|
+
job_create_dto: JobCreateDto,
|
|
46
|
+
_request_timeout: Union[
|
|
47
|
+
None,
|
|
48
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
49
|
+
Tuple[
|
|
50
|
+
Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
|
|
51
|
+
],
|
|
52
|
+
] = None,
|
|
53
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
54
|
+
_content_type: Optional[StrictStr] = None,
|
|
55
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
56
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
57
|
+
) -> None:
|
|
58
|
+
"""Create a manual job
|
|
59
|
+
|
|
60
|
+
Run a specific job. Most jobs are queued automatically, but this endpoint allows for manual creation of a handful of jobs, including various cleanup tasks, as well as creating a new database backup.
|
|
61
|
+
|
|
62
|
+
:param job_create_dto: (required)
|
|
63
|
+
:type job_create_dto: JobCreateDto
|
|
64
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
65
|
+
number provided, it will be total request
|
|
66
|
+
timeout. It can also be a pair (tuple) of
|
|
67
|
+
(connection, read) timeouts.
|
|
68
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
69
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
70
|
+
request; this effectively ignores the
|
|
71
|
+
authentication in the spec for a single request.
|
|
72
|
+
:type _request_auth: dict, optional
|
|
73
|
+
:param _content_type: force content-type for the request.
|
|
74
|
+
:type _content_type: str, Optional
|
|
75
|
+
:param _headers: set to override the headers for a single
|
|
76
|
+
request; this effectively ignores the headers
|
|
77
|
+
in the spec for a single request.
|
|
78
|
+
:type _headers: dict, optional
|
|
79
|
+
:param _host_index: set to override the host_index for a single
|
|
80
|
+
request; this effectively ignores the host_index
|
|
81
|
+
in the spec for a single request.
|
|
82
|
+
:type _host_index: int, optional
|
|
83
|
+
:return: Returns the result object.
|
|
84
|
+
""" # noqa: E501
|
|
85
|
+
|
|
86
|
+
_param = self._create_job_serialize(
|
|
87
|
+
job_create_dto=job_create_dto,
|
|
88
|
+
_request_auth=_request_auth,
|
|
89
|
+
_content_type=_content_type,
|
|
90
|
+
_headers=_headers,
|
|
91
|
+
_host_index=_host_index,
|
|
92
|
+
)
|
|
93
|
+
|
|
94
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
95
|
+
"204": None,
|
|
96
|
+
}
|
|
97
|
+
response_data = await self.api_client.call_api(
|
|
98
|
+
*_param, _request_timeout=_request_timeout
|
|
99
|
+
)
|
|
100
|
+
await response_data.read()
|
|
101
|
+
return self.api_client.response_deserialize(
|
|
102
|
+
response_data=response_data,
|
|
103
|
+
response_types_map=_response_types_map,
|
|
104
|
+
).data
|
|
105
|
+
|
|
106
|
+
@validate_call
|
|
107
|
+
async def create_job_with_http_info(
|
|
108
|
+
self,
|
|
109
|
+
job_create_dto: JobCreateDto,
|
|
110
|
+
_request_timeout: Union[
|
|
111
|
+
None,
|
|
112
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
113
|
+
Tuple[
|
|
114
|
+
Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
|
|
115
|
+
],
|
|
116
|
+
] = None,
|
|
117
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
118
|
+
_content_type: Optional[StrictStr] = None,
|
|
119
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
120
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
121
|
+
) -> ApiResponse[None]:
|
|
122
|
+
"""Create a manual job
|
|
123
|
+
|
|
124
|
+
Run a specific job. Most jobs are queued automatically, but this endpoint allows for manual creation of a handful of jobs, including various cleanup tasks, as well as creating a new database backup.
|
|
125
|
+
|
|
126
|
+
:param job_create_dto: (required)
|
|
127
|
+
:type job_create_dto: JobCreateDto
|
|
128
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
129
|
+
number provided, it will be total request
|
|
130
|
+
timeout. It can also be a pair (tuple) of
|
|
131
|
+
(connection, read) timeouts.
|
|
132
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
133
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
134
|
+
request; this effectively ignores the
|
|
135
|
+
authentication in the spec for a single request.
|
|
136
|
+
:type _request_auth: dict, optional
|
|
137
|
+
:param _content_type: force content-type for the request.
|
|
138
|
+
:type _content_type: str, Optional
|
|
139
|
+
:param _headers: set to override the headers for a single
|
|
140
|
+
request; this effectively ignores the headers
|
|
141
|
+
in the spec for a single request.
|
|
142
|
+
:type _headers: dict, optional
|
|
143
|
+
:param _host_index: set to override the host_index for a single
|
|
144
|
+
request; this effectively ignores the host_index
|
|
145
|
+
in the spec for a single request.
|
|
146
|
+
:type _host_index: int, optional
|
|
147
|
+
:return: Returns the result object.
|
|
148
|
+
""" # noqa: E501
|
|
149
|
+
|
|
150
|
+
_param = self._create_job_serialize(
|
|
151
|
+
job_create_dto=job_create_dto,
|
|
152
|
+
_request_auth=_request_auth,
|
|
153
|
+
_content_type=_content_type,
|
|
154
|
+
_headers=_headers,
|
|
155
|
+
_host_index=_host_index,
|
|
156
|
+
)
|
|
157
|
+
|
|
158
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
159
|
+
"204": None,
|
|
160
|
+
}
|
|
161
|
+
response_data = await self.api_client.call_api(
|
|
162
|
+
*_param, _request_timeout=_request_timeout
|
|
163
|
+
)
|
|
164
|
+
await response_data.read()
|
|
165
|
+
return self.api_client.response_deserialize(
|
|
166
|
+
response_data=response_data,
|
|
167
|
+
response_types_map=_response_types_map,
|
|
168
|
+
)
|
|
169
|
+
|
|
170
|
+
@validate_call
|
|
171
|
+
async def create_job_without_preload_content(
|
|
172
|
+
self,
|
|
173
|
+
job_create_dto: JobCreateDto,
|
|
174
|
+
_request_timeout: Union[
|
|
175
|
+
None,
|
|
176
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
177
|
+
Tuple[
|
|
178
|
+
Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
|
|
179
|
+
],
|
|
180
|
+
] = None,
|
|
181
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
182
|
+
_content_type: Optional[StrictStr] = None,
|
|
183
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
184
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
185
|
+
) -> RESTResponseType:
|
|
186
|
+
"""Create a manual job
|
|
187
|
+
|
|
188
|
+
Run a specific job. Most jobs are queued automatically, but this endpoint allows for manual creation of a handful of jobs, including various cleanup tasks, as well as creating a new database backup.
|
|
189
|
+
|
|
190
|
+
:param job_create_dto: (required)
|
|
191
|
+
:type job_create_dto: JobCreateDto
|
|
192
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
193
|
+
number provided, it will be total request
|
|
194
|
+
timeout. It can also be a pair (tuple) of
|
|
195
|
+
(connection, read) timeouts.
|
|
196
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
197
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
198
|
+
request; this effectively ignores the
|
|
199
|
+
authentication in the spec for a single request.
|
|
200
|
+
:type _request_auth: dict, optional
|
|
201
|
+
:param _content_type: force content-type for the request.
|
|
202
|
+
:type _content_type: str, Optional
|
|
203
|
+
:param _headers: set to override the headers for a single
|
|
204
|
+
request; this effectively ignores the headers
|
|
205
|
+
in the spec for a single request.
|
|
206
|
+
:type _headers: dict, optional
|
|
207
|
+
:param _host_index: set to override the host_index for a single
|
|
208
|
+
request; this effectively ignores the host_index
|
|
209
|
+
in the spec for a single request.
|
|
210
|
+
:type _host_index: int, optional
|
|
211
|
+
:return: Returns the result object.
|
|
212
|
+
""" # noqa: E501
|
|
213
|
+
|
|
214
|
+
_param = self._create_job_serialize(
|
|
215
|
+
job_create_dto=job_create_dto,
|
|
216
|
+
_request_auth=_request_auth,
|
|
217
|
+
_content_type=_content_type,
|
|
218
|
+
_headers=_headers,
|
|
219
|
+
_host_index=_host_index,
|
|
220
|
+
)
|
|
221
|
+
|
|
222
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
223
|
+
"204": None,
|
|
224
|
+
}
|
|
225
|
+
response_data = await self.api_client.call_api(
|
|
226
|
+
*_param, _request_timeout=_request_timeout
|
|
227
|
+
)
|
|
228
|
+
return response_data.response
|
|
229
|
+
|
|
230
|
+
def _create_job_serialize(
|
|
231
|
+
self,
|
|
232
|
+
job_create_dto,
|
|
233
|
+
_request_auth,
|
|
234
|
+
_content_type,
|
|
235
|
+
_headers,
|
|
236
|
+
_host_index,
|
|
237
|
+
) -> RequestSerialized:
|
|
238
|
+
_host = None
|
|
239
|
+
|
|
240
|
+
_collection_formats: Dict[str, str] = {}
|
|
241
|
+
|
|
242
|
+
_path_params: Dict[str, str] = {}
|
|
243
|
+
_query_params: List[Tuple[str, str]] = []
|
|
244
|
+
_header_params: Dict[str, Optional[str]] = _headers or {}
|
|
245
|
+
_form_params: List[Tuple[str, str]] = []
|
|
246
|
+
_files: Dict[
|
|
247
|
+
str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
|
|
248
|
+
] = {}
|
|
249
|
+
_body_params: Optional[bytes] = None
|
|
250
|
+
|
|
251
|
+
# process the path parameters
|
|
252
|
+
# process the query parameters
|
|
253
|
+
# process the header parameters
|
|
254
|
+
# process the form parameters
|
|
255
|
+
# process the body parameter
|
|
256
|
+
if job_create_dto is not None:
|
|
257
|
+
_body_params = job_create_dto
|
|
258
|
+
|
|
259
|
+
# set the HTTP header `Content-Type`
|
|
260
|
+
if _content_type:
|
|
261
|
+
_header_params["Content-Type"] = _content_type
|
|
262
|
+
else:
|
|
263
|
+
_default_content_type = self.api_client.select_header_content_type(
|
|
264
|
+
["application/json"]
|
|
265
|
+
)
|
|
266
|
+
if _default_content_type is not None:
|
|
267
|
+
_header_params["Content-Type"] = _default_content_type
|
|
268
|
+
|
|
269
|
+
# authentication setting
|
|
270
|
+
_auth_settings: List[str] = ["cookie", "api_key", "bearer"]
|
|
271
|
+
|
|
272
|
+
return self.api_client.param_serialize(
|
|
273
|
+
method="POST",
|
|
274
|
+
resource_path="/jobs",
|
|
275
|
+
path_params=_path_params,
|
|
276
|
+
query_params=_query_params,
|
|
277
|
+
header_params=_header_params,
|
|
278
|
+
body=_body_params,
|
|
279
|
+
post_params=_form_params,
|
|
280
|
+
files=_files,
|
|
281
|
+
auth_settings=_auth_settings,
|
|
282
|
+
collection_formats=_collection_formats,
|
|
283
|
+
_host=_host,
|
|
284
|
+
_request_auth=_request_auth,
|
|
285
|
+
)
|
|
286
|
+
|
|
287
|
+
@validate_call
|
|
288
|
+
async def get_queues_legacy(
|
|
289
|
+
self,
|
|
290
|
+
_request_timeout: Union[
|
|
291
|
+
None,
|
|
292
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
293
|
+
Tuple[
|
|
294
|
+
Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
|
|
295
|
+
],
|
|
296
|
+
] = None,
|
|
297
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
298
|
+
_content_type: Optional[StrictStr] = None,
|
|
299
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
300
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
301
|
+
) -> QueuesResponseLegacyDto:
|
|
302
|
+
"""(Deprecated) Retrieve queue counts and status
|
|
303
|
+
|
|
304
|
+
Retrieve the counts of the current queue, as well as the current status.
|
|
305
|
+
|
|
306
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
307
|
+
number provided, it will be total request
|
|
308
|
+
timeout. It can also be a pair (tuple) of
|
|
309
|
+
(connection, read) timeouts.
|
|
310
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
311
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
312
|
+
request; this effectively ignores the
|
|
313
|
+
authentication in the spec for a single request.
|
|
314
|
+
:type _request_auth: dict, optional
|
|
315
|
+
:param _content_type: force content-type for the request.
|
|
316
|
+
:type _content_type: str, Optional
|
|
317
|
+
:param _headers: set to override the headers for a single
|
|
318
|
+
request; this effectively ignores the headers
|
|
319
|
+
in the spec for a single request.
|
|
320
|
+
:type _headers: dict, optional
|
|
321
|
+
:param _host_index: set to override the host_index for a single
|
|
322
|
+
request; this effectively ignores the host_index
|
|
323
|
+
in the spec for a single request.
|
|
324
|
+
:type _host_index: int, optional
|
|
325
|
+
:return: Returns the result object.
|
|
326
|
+
""" # noqa: E501
|
|
327
|
+
warnings.warn("GET /jobs is deprecated.", DeprecationWarning)
|
|
328
|
+
|
|
329
|
+
_param = self._get_queues_legacy_serialize(
|
|
330
|
+
_request_auth=_request_auth,
|
|
331
|
+
_content_type=_content_type,
|
|
332
|
+
_headers=_headers,
|
|
333
|
+
_host_index=_host_index,
|
|
334
|
+
)
|
|
335
|
+
|
|
336
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
337
|
+
"200": "QueuesResponseLegacyDto",
|
|
338
|
+
}
|
|
339
|
+
response_data = await self.api_client.call_api(
|
|
340
|
+
*_param, _request_timeout=_request_timeout
|
|
341
|
+
)
|
|
342
|
+
await response_data.read()
|
|
343
|
+
return self.api_client.response_deserialize(
|
|
344
|
+
response_data=response_data,
|
|
345
|
+
response_types_map=_response_types_map,
|
|
346
|
+
).data
|
|
347
|
+
|
|
348
|
+
@validate_call
|
|
349
|
+
async def get_queues_legacy_with_http_info(
|
|
350
|
+
self,
|
|
351
|
+
_request_timeout: Union[
|
|
352
|
+
None,
|
|
353
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
354
|
+
Tuple[
|
|
355
|
+
Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
|
|
356
|
+
],
|
|
357
|
+
] = None,
|
|
358
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
359
|
+
_content_type: Optional[StrictStr] = None,
|
|
360
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
361
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
362
|
+
) -> ApiResponse[QueuesResponseLegacyDto]:
|
|
363
|
+
"""(Deprecated) Retrieve queue counts and status
|
|
364
|
+
|
|
365
|
+
Retrieve the counts of the current queue, as well as the current status.
|
|
366
|
+
|
|
367
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
368
|
+
number provided, it will be total request
|
|
369
|
+
timeout. It can also be a pair (tuple) of
|
|
370
|
+
(connection, read) timeouts.
|
|
371
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
372
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
373
|
+
request; this effectively ignores the
|
|
374
|
+
authentication in the spec for a single request.
|
|
375
|
+
:type _request_auth: dict, optional
|
|
376
|
+
:param _content_type: force content-type for the request.
|
|
377
|
+
:type _content_type: str, Optional
|
|
378
|
+
:param _headers: set to override the headers for a single
|
|
379
|
+
request; this effectively ignores the headers
|
|
380
|
+
in the spec for a single request.
|
|
381
|
+
:type _headers: dict, optional
|
|
382
|
+
:param _host_index: set to override the host_index for a single
|
|
383
|
+
request; this effectively ignores the host_index
|
|
384
|
+
in the spec for a single request.
|
|
385
|
+
:type _host_index: int, optional
|
|
386
|
+
:return: Returns the result object.
|
|
387
|
+
""" # noqa: E501
|
|
388
|
+
warnings.warn("GET /jobs is deprecated.", DeprecationWarning)
|
|
389
|
+
|
|
390
|
+
_param = self._get_queues_legacy_serialize(
|
|
391
|
+
_request_auth=_request_auth,
|
|
392
|
+
_content_type=_content_type,
|
|
393
|
+
_headers=_headers,
|
|
394
|
+
_host_index=_host_index,
|
|
395
|
+
)
|
|
396
|
+
|
|
397
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
398
|
+
"200": "QueuesResponseLegacyDto",
|
|
399
|
+
}
|
|
400
|
+
response_data = await self.api_client.call_api(
|
|
401
|
+
*_param, _request_timeout=_request_timeout
|
|
402
|
+
)
|
|
403
|
+
await response_data.read()
|
|
404
|
+
return self.api_client.response_deserialize(
|
|
405
|
+
response_data=response_data,
|
|
406
|
+
response_types_map=_response_types_map,
|
|
407
|
+
)
|
|
408
|
+
|
|
409
|
+
@validate_call
|
|
410
|
+
async def get_queues_legacy_without_preload_content(
|
|
411
|
+
self,
|
|
412
|
+
_request_timeout: Union[
|
|
413
|
+
None,
|
|
414
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
415
|
+
Tuple[
|
|
416
|
+
Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
|
|
417
|
+
],
|
|
418
|
+
] = None,
|
|
419
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
420
|
+
_content_type: Optional[StrictStr] = None,
|
|
421
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
422
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
423
|
+
) -> RESTResponseType:
|
|
424
|
+
"""(Deprecated) Retrieve queue counts and status
|
|
425
|
+
|
|
426
|
+
Retrieve the counts of the current queue, as well as the current status.
|
|
427
|
+
|
|
428
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
429
|
+
number provided, it will be total request
|
|
430
|
+
timeout. It can also be a pair (tuple) of
|
|
431
|
+
(connection, read) timeouts.
|
|
432
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
433
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
434
|
+
request; this effectively ignores the
|
|
435
|
+
authentication in the spec for a single request.
|
|
436
|
+
:type _request_auth: dict, optional
|
|
437
|
+
:param _content_type: force content-type for the request.
|
|
438
|
+
:type _content_type: str, Optional
|
|
439
|
+
:param _headers: set to override the headers for a single
|
|
440
|
+
request; this effectively ignores the headers
|
|
441
|
+
in the spec for a single request.
|
|
442
|
+
:type _headers: dict, optional
|
|
443
|
+
:param _host_index: set to override the host_index for a single
|
|
444
|
+
request; this effectively ignores the host_index
|
|
445
|
+
in the spec for a single request.
|
|
446
|
+
:type _host_index: int, optional
|
|
447
|
+
:return: Returns the result object.
|
|
448
|
+
""" # noqa: E501
|
|
449
|
+
warnings.warn("GET /jobs is deprecated.", DeprecationWarning)
|
|
450
|
+
|
|
451
|
+
_param = self._get_queues_legacy_serialize(
|
|
452
|
+
_request_auth=_request_auth,
|
|
453
|
+
_content_type=_content_type,
|
|
454
|
+
_headers=_headers,
|
|
455
|
+
_host_index=_host_index,
|
|
456
|
+
)
|
|
457
|
+
|
|
458
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
459
|
+
"200": "QueuesResponseLegacyDto",
|
|
460
|
+
}
|
|
461
|
+
response_data = await self.api_client.call_api(
|
|
462
|
+
*_param, _request_timeout=_request_timeout
|
|
463
|
+
)
|
|
464
|
+
return response_data.response
|
|
465
|
+
|
|
466
|
+
def _get_queues_legacy_serialize(
|
|
467
|
+
self,
|
|
468
|
+
_request_auth,
|
|
469
|
+
_content_type,
|
|
470
|
+
_headers,
|
|
471
|
+
_host_index,
|
|
472
|
+
) -> RequestSerialized:
|
|
473
|
+
_host = None
|
|
474
|
+
|
|
475
|
+
_collection_formats: Dict[str, str] = {}
|
|
476
|
+
|
|
477
|
+
_path_params: Dict[str, str] = {}
|
|
478
|
+
_query_params: List[Tuple[str, str]] = []
|
|
479
|
+
_header_params: Dict[str, Optional[str]] = _headers or {}
|
|
480
|
+
_form_params: List[Tuple[str, str]] = []
|
|
481
|
+
_files: Dict[
|
|
482
|
+
str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
|
|
483
|
+
] = {}
|
|
484
|
+
_body_params: Optional[bytes] = None
|
|
485
|
+
|
|
486
|
+
# process the path parameters
|
|
487
|
+
# process the query parameters
|
|
488
|
+
# process the header parameters
|
|
489
|
+
# process the form parameters
|
|
490
|
+
# process the body parameter
|
|
491
|
+
|
|
492
|
+
# set the HTTP header `Accept`
|
|
493
|
+
if "Accept" not in _header_params:
|
|
494
|
+
_header_params["Accept"] = self.api_client.select_header_accept(
|
|
495
|
+
["application/json"]
|
|
496
|
+
)
|
|
497
|
+
|
|
498
|
+
# authentication setting
|
|
499
|
+
_auth_settings: List[str] = ["cookie", "api_key", "bearer"]
|
|
500
|
+
|
|
501
|
+
return self.api_client.param_serialize(
|
|
502
|
+
method="GET",
|
|
503
|
+
resource_path="/jobs",
|
|
504
|
+
path_params=_path_params,
|
|
505
|
+
query_params=_query_params,
|
|
506
|
+
header_params=_header_params,
|
|
507
|
+
body=_body_params,
|
|
508
|
+
post_params=_form_params,
|
|
509
|
+
files=_files,
|
|
510
|
+
auth_settings=_auth_settings,
|
|
511
|
+
collection_formats=_collection_formats,
|
|
512
|
+
_host=_host,
|
|
513
|
+
_request_auth=_request_auth,
|
|
514
|
+
)
|
|
515
|
+
|
|
516
|
+
@validate_call
|
|
517
|
+
async def run_queue_command_legacy(
|
|
518
|
+
self,
|
|
519
|
+
name: QueueName,
|
|
520
|
+
queue_command_dto: QueueCommandDto,
|
|
521
|
+
_request_timeout: Union[
|
|
522
|
+
None,
|
|
523
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
524
|
+
Tuple[
|
|
525
|
+
Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
|
|
526
|
+
],
|
|
527
|
+
] = None,
|
|
528
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
529
|
+
_content_type: Optional[StrictStr] = None,
|
|
530
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
531
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
532
|
+
) -> QueueResponseLegacyDto:
|
|
533
|
+
"""(Deprecated) Run jobs
|
|
534
|
+
|
|
535
|
+
Queue all assets for a specific job type. Defaults to only queueing assets that have not yet been processed, but the force command can be used to re-process all assets.
|
|
536
|
+
|
|
537
|
+
:param name: (required)
|
|
538
|
+
:type name: QueueName
|
|
539
|
+
:param queue_command_dto: (required)
|
|
540
|
+
:type queue_command_dto: QueueCommandDto
|
|
541
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
542
|
+
number provided, it will be total request
|
|
543
|
+
timeout. It can also be a pair (tuple) of
|
|
544
|
+
(connection, read) timeouts.
|
|
545
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
546
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
547
|
+
request; this effectively ignores the
|
|
548
|
+
authentication in the spec for a single request.
|
|
549
|
+
:type _request_auth: dict, optional
|
|
550
|
+
:param _content_type: force content-type for the request.
|
|
551
|
+
:type _content_type: str, Optional
|
|
552
|
+
:param _headers: set to override the headers for a single
|
|
553
|
+
request; this effectively ignores the headers
|
|
554
|
+
in the spec for a single request.
|
|
555
|
+
:type _headers: dict, optional
|
|
556
|
+
:param _host_index: set to override the host_index for a single
|
|
557
|
+
request; this effectively ignores the host_index
|
|
558
|
+
in the spec for a single request.
|
|
559
|
+
:type _host_index: int, optional
|
|
560
|
+
:return: Returns the result object.
|
|
561
|
+
""" # noqa: E501
|
|
562
|
+
warnings.warn("PUT /jobs/{name} is deprecated.", DeprecationWarning)
|
|
563
|
+
|
|
564
|
+
_param = self._run_queue_command_legacy_serialize(
|
|
565
|
+
name=name,
|
|
566
|
+
queue_command_dto=queue_command_dto,
|
|
567
|
+
_request_auth=_request_auth,
|
|
568
|
+
_content_type=_content_type,
|
|
569
|
+
_headers=_headers,
|
|
570
|
+
_host_index=_host_index,
|
|
571
|
+
)
|
|
572
|
+
|
|
573
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
574
|
+
"200": "QueueResponseLegacyDto",
|
|
575
|
+
}
|
|
576
|
+
response_data = await self.api_client.call_api(
|
|
577
|
+
*_param, _request_timeout=_request_timeout
|
|
578
|
+
)
|
|
579
|
+
await response_data.read()
|
|
580
|
+
return self.api_client.response_deserialize(
|
|
581
|
+
response_data=response_data,
|
|
582
|
+
response_types_map=_response_types_map,
|
|
583
|
+
).data
|
|
584
|
+
|
|
585
|
+
@validate_call
|
|
586
|
+
async def run_queue_command_legacy_with_http_info(
|
|
587
|
+
self,
|
|
588
|
+
name: QueueName,
|
|
589
|
+
queue_command_dto: QueueCommandDto,
|
|
590
|
+
_request_timeout: Union[
|
|
591
|
+
None,
|
|
592
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
593
|
+
Tuple[
|
|
594
|
+
Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
|
|
595
|
+
],
|
|
596
|
+
] = None,
|
|
597
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
598
|
+
_content_type: Optional[StrictStr] = None,
|
|
599
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
600
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
601
|
+
) -> ApiResponse[QueueResponseLegacyDto]:
|
|
602
|
+
"""(Deprecated) Run jobs
|
|
603
|
+
|
|
604
|
+
Queue all assets for a specific job type. Defaults to only queueing assets that have not yet been processed, but the force command can be used to re-process all assets.
|
|
605
|
+
|
|
606
|
+
:param name: (required)
|
|
607
|
+
:type name: QueueName
|
|
608
|
+
:param queue_command_dto: (required)
|
|
609
|
+
:type queue_command_dto: QueueCommandDto
|
|
610
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
611
|
+
number provided, it will be total request
|
|
612
|
+
timeout. It can also be a pair (tuple) of
|
|
613
|
+
(connection, read) timeouts.
|
|
614
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
615
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
616
|
+
request; this effectively ignores the
|
|
617
|
+
authentication in the spec for a single request.
|
|
618
|
+
:type _request_auth: dict, optional
|
|
619
|
+
:param _content_type: force content-type for the request.
|
|
620
|
+
:type _content_type: str, Optional
|
|
621
|
+
:param _headers: set to override the headers for a single
|
|
622
|
+
request; this effectively ignores the headers
|
|
623
|
+
in the spec for a single request.
|
|
624
|
+
:type _headers: dict, optional
|
|
625
|
+
:param _host_index: set to override the host_index for a single
|
|
626
|
+
request; this effectively ignores the host_index
|
|
627
|
+
in the spec for a single request.
|
|
628
|
+
:type _host_index: int, optional
|
|
629
|
+
:return: Returns the result object.
|
|
630
|
+
""" # noqa: E501
|
|
631
|
+
warnings.warn("PUT /jobs/{name} is deprecated.", DeprecationWarning)
|
|
632
|
+
|
|
633
|
+
_param = self._run_queue_command_legacy_serialize(
|
|
634
|
+
name=name,
|
|
635
|
+
queue_command_dto=queue_command_dto,
|
|
636
|
+
_request_auth=_request_auth,
|
|
637
|
+
_content_type=_content_type,
|
|
638
|
+
_headers=_headers,
|
|
639
|
+
_host_index=_host_index,
|
|
640
|
+
)
|
|
641
|
+
|
|
642
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
643
|
+
"200": "QueueResponseLegacyDto",
|
|
644
|
+
}
|
|
645
|
+
response_data = await self.api_client.call_api(
|
|
646
|
+
*_param, _request_timeout=_request_timeout
|
|
647
|
+
)
|
|
648
|
+
await response_data.read()
|
|
649
|
+
return self.api_client.response_deserialize(
|
|
650
|
+
response_data=response_data,
|
|
651
|
+
response_types_map=_response_types_map,
|
|
652
|
+
)
|
|
653
|
+
|
|
654
|
+
@validate_call
|
|
655
|
+
async def run_queue_command_legacy_without_preload_content(
|
|
656
|
+
self,
|
|
657
|
+
name: QueueName,
|
|
658
|
+
queue_command_dto: QueueCommandDto,
|
|
659
|
+
_request_timeout: Union[
|
|
660
|
+
None,
|
|
661
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
662
|
+
Tuple[
|
|
663
|
+
Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
|
|
664
|
+
],
|
|
665
|
+
] = None,
|
|
666
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
667
|
+
_content_type: Optional[StrictStr] = None,
|
|
668
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
669
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
670
|
+
) -> RESTResponseType:
|
|
671
|
+
"""(Deprecated) Run jobs
|
|
672
|
+
|
|
673
|
+
Queue all assets for a specific job type. Defaults to only queueing assets that have not yet been processed, but the force command can be used to re-process all assets.
|
|
674
|
+
|
|
675
|
+
:param name: (required)
|
|
676
|
+
:type name: QueueName
|
|
677
|
+
:param queue_command_dto: (required)
|
|
678
|
+
:type queue_command_dto: QueueCommandDto
|
|
679
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
680
|
+
number provided, it will be total request
|
|
681
|
+
timeout. It can also be a pair (tuple) of
|
|
682
|
+
(connection, read) timeouts.
|
|
683
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
684
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
685
|
+
request; this effectively ignores the
|
|
686
|
+
authentication in the spec for a single request.
|
|
687
|
+
:type _request_auth: dict, optional
|
|
688
|
+
:param _content_type: force content-type for the request.
|
|
689
|
+
:type _content_type: str, Optional
|
|
690
|
+
:param _headers: set to override the headers for a single
|
|
691
|
+
request; this effectively ignores the headers
|
|
692
|
+
in the spec for a single request.
|
|
693
|
+
:type _headers: dict, optional
|
|
694
|
+
:param _host_index: set to override the host_index for a single
|
|
695
|
+
request; this effectively ignores the host_index
|
|
696
|
+
in the spec for a single request.
|
|
697
|
+
:type _host_index: int, optional
|
|
698
|
+
:return: Returns the result object.
|
|
699
|
+
""" # noqa: E501
|
|
700
|
+
warnings.warn("PUT /jobs/{name} is deprecated.", DeprecationWarning)
|
|
701
|
+
|
|
702
|
+
_param = self._run_queue_command_legacy_serialize(
|
|
703
|
+
name=name,
|
|
704
|
+
queue_command_dto=queue_command_dto,
|
|
705
|
+
_request_auth=_request_auth,
|
|
706
|
+
_content_type=_content_type,
|
|
707
|
+
_headers=_headers,
|
|
708
|
+
_host_index=_host_index,
|
|
709
|
+
)
|
|
710
|
+
|
|
711
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
712
|
+
"200": "QueueResponseLegacyDto",
|
|
713
|
+
}
|
|
714
|
+
response_data = await self.api_client.call_api(
|
|
715
|
+
*_param, _request_timeout=_request_timeout
|
|
716
|
+
)
|
|
717
|
+
return response_data.response
|
|
718
|
+
|
|
719
|
+
def _run_queue_command_legacy_serialize(
|
|
720
|
+
self,
|
|
721
|
+
name,
|
|
722
|
+
queue_command_dto,
|
|
723
|
+
_request_auth,
|
|
724
|
+
_content_type,
|
|
725
|
+
_headers,
|
|
726
|
+
_host_index,
|
|
727
|
+
) -> RequestSerialized:
|
|
728
|
+
_host = None
|
|
729
|
+
|
|
730
|
+
_collection_formats: Dict[str, str] = {}
|
|
731
|
+
|
|
732
|
+
_path_params: Dict[str, str] = {}
|
|
733
|
+
_query_params: List[Tuple[str, str]] = []
|
|
734
|
+
_header_params: Dict[str, Optional[str]] = _headers or {}
|
|
735
|
+
_form_params: List[Tuple[str, str]] = []
|
|
736
|
+
_files: Dict[
|
|
737
|
+
str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
|
|
738
|
+
] = {}
|
|
739
|
+
_body_params: Optional[bytes] = None
|
|
740
|
+
|
|
741
|
+
# process the path parameters
|
|
742
|
+
if name is not None:
|
|
743
|
+
_path_params["name"] = name.value
|
|
744
|
+
# process the query parameters
|
|
745
|
+
# process the header parameters
|
|
746
|
+
# process the form parameters
|
|
747
|
+
# process the body parameter
|
|
748
|
+
if queue_command_dto is not None:
|
|
749
|
+
_body_params = queue_command_dto
|
|
750
|
+
|
|
751
|
+
# set the HTTP header `Accept`
|
|
752
|
+
if "Accept" not in _header_params:
|
|
753
|
+
_header_params["Accept"] = self.api_client.select_header_accept(
|
|
754
|
+
["application/json"]
|
|
755
|
+
)
|
|
756
|
+
|
|
757
|
+
# set the HTTP header `Content-Type`
|
|
758
|
+
if _content_type:
|
|
759
|
+
_header_params["Content-Type"] = _content_type
|
|
760
|
+
else:
|
|
761
|
+
_default_content_type = self.api_client.select_header_content_type(
|
|
762
|
+
["application/json"]
|
|
763
|
+
)
|
|
764
|
+
if _default_content_type is not None:
|
|
765
|
+
_header_params["Content-Type"] = _default_content_type
|
|
766
|
+
|
|
767
|
+
# authentication setting
|
|
768
|
+
_auth_settings: List[str] = ["cookie", "api_key", "bearer"]
|
|
769
|
+
|
|
770
|
+
return self.api_client.param_serialize(
|
|
771
|
+
method="PUT",
|
|
772
|
+
resource_path="/jobs/{name}",
|
|
773
|
+
path_params=_path_params,
|
|
774
|
+
query_params=_query_params,
|
|
775
|
+
header_params=_header_params,
|
|
776
|
+
body=_body_params,
|
|
777
|
+
post_params=_form_params,
|
|
778
|
+
files=_files,
|
|
779
|
+
auth_settings=_auth_settings,
|
|
780
|
+
collection_formats=_collection_formats,
|
|
781
|
+
_host=_host,
|
|
782
|
+
_request_auth=_request_auth,
|
|
783
|
+
)
|