IPWorks Cloud 2020 Python Edition

Questions / Feedback?

list_jobs Method

Lists the jobs in a vault.

Syntax

def list_jobs(vault_name: str) -> None: ...

Remarks

This method lists the jobs in the vault specified by VaultName.

The on_job_list event will fire once for each Job returned. In addition, the Job* properties will be populated.

By default up to 1000 jobs will be returned in a single set of results. The maximum number of results can be specified by setting MaxListJobResults. If the number of results exceeds the maximum the results are paged. The IsJobPaged setting will be set to True and job_marker will be populated.

To get all results simply call list_jobs again until IsJobPaged returns False and job_marker is empty string.

Note: The settings JobCompletionFilter and JobStatusFilter may be set to control what type of jobs are returned.

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks Cloud 2020 Python Edition - Version 20.0 [Build 8265]