Package com.carfey.ops.api.bean.job

Class JobListingParameters

  • public class JobListingParameters
extends java.lang.Object
    Used to filter a JobListing via JobManager.
    Since:
    2.3

    • Constructor Detail

      • JobListingParameters

        public JobListingParameters()

    • Method Detail

      • getActiveStatuses

        public java.util.List<JobStatus> getActiveStatuses()
        Limits the preview to the selected statuses.
        Returns:
        active statuses

      • setActiveStatuses

        public void setActiveStatuses​(java.util.List<JobStatus> activeStatuses)

      • getEffectiveDate

        public com.carfey.jdk.lang.DateTime getEffectiveDate()
        If querying by activeStatus, this allows you to indicate what point in time to compare against the job status. Defaults to next minute.
        Returns:
        effective date

      • setEffectiveDate

        public void setEffectiveDate​(com.carfey.jdk.lang.DateTime effectiveDate)

      • withEffectiveDate

        public JobListingParameters withEffectiveDate​(com.carfey.jdk.lang.DateTime effectiveDate)

      • getHosts

        public java.util.List<java.lang.String> getHosts()
        If specified, only jobs matching the supplied host name(s) are included.
        Returns:
        hosts

      • setHosts

        public void setHosts​(java.util.List<java.lang.String> hosts)

      • getNicknames

        public java.util.List<java.lang.String> getNicknames()
        If specified, only jobs matching the supplied nickname are returned. Wildcards may be included to support partial matches by using %, or exact literals can be used. For example, to find all jobs containing the word "order", use "%order%".
        Returns:
        nicknames

      • setNicknames

        public void setNicknames​(java.util.List<java.lang.String> nicknames)

      • withNicknames

        public JobListingParameters withNicknames​(java.util.List<java.lang.String> nicknames)

      • getJobClasses

        public java.util.List<java.lang.String> getJobClasses()
        If specified, only jobs matching the supplied job class are returned. Wildcards may be included to support partial matches by using %, or exact literals can be used. For example, to find all jobs with the job class "com.example.ExportJob", you could use "com.example.ExportJob" or "%Export%".
        Returns:
        job classes

      • setJobClasses

        public void setJobClasses​(java.util.List<java.lang.String> jobClasses)

      • withJobClasses

        public JobListingParameters withJobClasses​(java.util.List<java.lang.String> jobClasses)

      • getFolders

        public java.util.List<java.lang.String> getFolders()
        If specified, only jobs within the folders or its children will be returned. Folders should be supplied in the format: "parent" or "parent/child" without trailing slashes. Wildcards (%) may be used.
        Returns:
        folders
        Since:
        4.1

      • setFolders

        public void setFolders​(java.util.List<java.lang.String> folders)

      • withFolders

        public JobListingParameters withFolders​(java.util.List<java.lang.String> folders)

      • getFilterParameters

        public java.util.Map<java.lang.String,​java.util.List<java.lang.String>> getFilterParameters()
        Can be used to match only on jobs with specific job parameter values, either custom or defined. If multiple values for the same name are supplied, a job is matched if any of its configured values match one of the supplied values. If filters with separate names are used, each must have a matching value for the job to be returned.
        Returns:
        filter parameters

      • setFilterParameters

        public void setFilterParameters​(java.util.Map<java.lang.String,​java.util.List<java.lang.String>> filterParameters)

      • withFilterParameters

        public JobListingParameters withFilterParameters​(java.util.Map<java.lang.String,​java.util.List<java.lang.String>> filterParameters)

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object