pyslk.submit_verify_job

pyslk.submit_verify_job#

pyslk.submit_verify_job(resources: str | Path | list[str] | list[pathlib.Path] | None = None, resource_ids: int | str | list[int] | list[str] | None = None, search_id: int | str | None = None, search_query: str | None = None, json_input_file: str | Path | None = None, recursive: bool = False, resume_on_page: int = 1, end_on_page: int = -1, save_mode: bool = False) SubmittedJobs#

Submit a verify job

Parameters:
  • resources (str or Path or list[str] or list[Path] or None) – provide a list of resources over which the verify job should be run

  • resource_ids (str or int or list[str] or list[int] or None) – provide a list of ids of resources over which the verify job should be run

  • search_id (str or int or None) – provide a search id pointing to files over which the verify job should be run

  • search_query (str or None) – provide a search query to select files over which the verify job should be run

  • json_input_file (str or Path or None) – read a JSON file which contains payload of the verify job (admin users only)

  • recursive (bool) – iterate namespaces recursively

  • resume_on_page (int) – resume the command and start with search result page resume_on_page; internally, 1000 search results are on one ‘page’ and fetched by one request; you do not necessarily have read permissions for all of these files

  • end_on_page (int) – end with search result page end_on_page; internally, 1000 search results are on one ‘page’ and fetched by one request; you do not necessarily have read permissions for all of these files

  • save_mode (bool) – save mode suggested to be used in times of many timeouts; please do not regularly use this parameter; start one verify job per page of search results instead of one verify job for 50 pages of search results

Returns:

submitted jobs and, if command failed due to timeout, restart information

Return type:

SubmittedJobs