Autogenerated API docs

This section contains the autogenerated API documentation for the ska_dlm_client package, including the directory watcher, ConfigDB watcher, and related utilities.

Contents:

• Package level members
  • CmdLineParameters
    • CmdLineParameters.__default_args__()
    • CmdLineParameters.__eq__()
    • CmdLineParameters.__exit__()
    • CmdLineParameters.__hash__
    • CmdLineParameters.__init__()
    • CmdLineParameters.__repr__()
    • CmdLineParameters.__weakref__
    • CmdLineParameters.parse_arguments()
    • CmdLineParameters.set_application_ready()
• Top-level modules
  • minimal_metadata_generator()
  • ItemType
    • ItemType.__format__()
    • ItemType.__new__()
    • ItemType.__repr__()
    • ItemType.__str__()
  • LocationCountry
    • LocationCountry.__format__()
    • LocationCountry.__new__()
    • LocationCountry.__repr__()
    • LocationCountry.__str__()
  • LocationName
    • LocationName.__format__()
    • LocationName.__new__()
    • LocationName.__repr__()
    • LocationName.__str__()
  • LocationType
    • LocationType.__format__()
    • LocationType.__new__()
    • LocationType.__repr__()
    • LocationType.__str__()
  • StorageInterface
    • StorageInterface.__format__()
    • StorageInterface.__new__()
    • StorageInterface.__repr__()
    • StorageInterface.__str__()
  • StorageType
    • StorageType.__format__()
    • StorageType.__new__()
    • StorageType.__repr__()
    • StorageType.__str__()
  • ClientConfig
    • ClientConfig.__eq__()
    • ClientConfig.__hash__
    • ClientConfig.__init__()
    • ClientConfig.__repr__()
    • ClientConfig.__weakref__
  • CmdLineParameters
    • CmdLineParameters.__default_args__()
    • CmdLineParameters.__eq__()
    • CmdLineParameters.__exit__()
    • CmdLineParameters.__hash__
    • CmdLineParameters.__init__()
    • CmdLineParameters.__repr__()
    • CmdLineParameters.__weakref__
    • CmdLineParameters.parse_arguments()
    • CmdLineParameters.set_application_ready()
  • Config
• Directory Watcher
  • amain()
  • create_directory_watcher()
  • main()
  • process_args()
  • DirectoryWatcher
    • DirectoryWatcher.stop()
    • DirectoryWatcher.watch()
  • INotifyDirectoryWatcher
    • INotifyDirectoryWatcher.watch()
  • LStatPollingEmitter
  • PollingDirectoryWatcher
    • PollingDirectoryWatcher.watch()
  • log_changes_with_diff()
  • monitor_directory_with_watchdog()
  • DataclassJSONEncoder
    • DataclassJSONEncoder.default()
  • DirectoryWatcherEntries
    • DirectoryWatcherEntries.add()
    • DirectoryWatcherEntries.read_from_file()
    • DirectoryWatcherEntries.save_to_file()
  • DirectoryWatcherEntry
  • WatcherEventHandler
    • WatcherEventHandler.on_closed()
    • WatcherEventHandler.on_closed_no_write()
    • WatcherEventHandler.on_created()
    • WatcherEventHandler.on_deleted()
    • WatcherEventHandler.on_modified()
    • WatcherEventHandler.on_moved()
    • WatcherEventHandler.on_opened()
  • WatcherArgs
  • WatcherConfig
• ConfigDB Watcher
  • main()
  • process_args()
  • sdp_to_dlm_ingest_and_migrate()
  • DataProductStatusWatcher
  • watch_dataproduct_status()
  • create_sdp_migration_dependency()
  • get_pvc_subpath()
  • log_configdb_backend_details()
  • log_flow_dependencies()
  • update_dependency_state()
• Register Storage Location
  • create_parser()
  • get_or_init_location()
  • get_or_init_storage()
  • install_ssh_key()
  • main()
  • setup_testing()
  • setup_volume()
• Startup Verification
  • StartupVerification
    • StartupVerification.__init__()
    • StartupVerification.__weakref__
    • StartupVerification.verify_registration()
  • main()
• Registration Processor
  • Item
    • Item.__eq__()
    • Item.__hash__
    • Item.__init__()
    • Item.__repr__()
    • Item.__weakref__
  • RegistrationProcessor
    • RegistrationProcessor.__init__()
    • RegistrationProcessor.__weakref__
    • RegistrationProcessor.add_path()
    • RegistrationProcessor.get_config()
    • RegistrationProcessor.register_data_products_from_watch_directory()
    • RegistrationProcessor.set_config()
  • directory_contains_metadata_file()