Package com.carfey.ops.api.bean.history

Class RuntimeListingParameters

    • Constructor Detail

      • RuntimeListingParameters

        public RuntimeListingParameters()

    • Method Detail

      • getJobIds

        public java.util.List<java.lang.Long> getJobIds()
        Limits the listing to the selected jobs
        Returns:
        jobIds for search

      • setJobIds

        public void setJobIds​(java.util.List<java.lang.Long> jobIds)

      • getHosts

        public java.util.List<java.lang.String> getHosts()
        Limits the listing to the selected hosts
        Returns:
        hosts for search

      • setHosts

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

      • getStatuses

        public java.util.List<JobRuntimeStatus> getStatuses()
        Limits the listing to the selected statuses
        Returns:
        runtime statuses for search

      • setStatuses

        public void setStatuses​(java.util.List<JobRuntimeStatus> statuses)

      • 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 for search
        Since:
        4.1

      • setFolders

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

      • getStartDate

        public com.carfey.jdk.lang.DateTime getStartDate()
        Limits the listing to the selected start time (based on scheduled time). Defaults to 24 hours ago.
        Returns:
        start date for search

      • setStartDate

        public void setStartDate​(com.carfey.jdk.lang.DateTime startDate)

      • getEndDate

        public com.carfey.jdk.lang.DateTime getEndDate()
        Limits the listing to the selected end time (based on scheduled time). Defaults to 24 hours after start date.
        Returns:
        end date for search

      • setEndDate

        public void setEndDate​(com.carfey.jdk.lang.DateTime endDate)

      • getStartKey

        public java.lang.String getStartKey()
        Used to fetch a subsequent page of results, based on the key returned by RuntimeListing.
        Returns:
        start key for search

      • setStartKey

        public void setStartKey​(java.lang.String startKey)

      • getSortDirection

        public SortDirection getSortDirection()
        Used to override the default ascending ordering, which is based on scheduled time.
        Returns:
        sort direction for search

      • setSortDirection

        public void setSortDirection​(SortDirection sortDirection)

      • getQuantity

        public java.lang.Integer getQuantity()
        Can be used to specify the number of results to return. If unspecified, the installation's value for the maxRecords parameter is used.
        Returns:
        max records to return

      • setQuantity

        public void setQuantity​(java.lang.Integer quantity)

      • getFilterParameters

        public java.util.Map<java.lang.String,​java.util.List<java.lang.String>> getFilterParameters()
        Can be used to match only on runtimes with specific runtime parameter values. If multiple values for the same name are supplied, a runtime 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. Note that this does not match on parameters configured at the job level.
        Returns:
        filter parameters for search

      • setFilterParameters

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

      • withFilterParameters

        public RuntimeListingParameters 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