Package com.carfey.ops.api.bean.history
Class JobDashboardListingParameters
- java.lang.Object
-
- com.carfey.ops.api.bean.history.JobDashboardListingParameters
-
public class JobDashboardListingParameters extends java.lang.ObjectUsed to filter aJobDashboardListingviaJobManager.- Since:
- 4.10.2
-
-
Constructor Summary
Constructors Constructor Description JobDashboardListingParameters()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.util.List<java.lang.String>getFolders()If specified, only jobs within the folders or its children will be returned.java.util.List<java.lang.String>getHosts()Limits the listing to the selected hostsjava.util.List<java.lang.String>getJobClasses()java.util.List<java.lang.Long>getJobIds()Limits the listing to the selected jobsjava.util.List<java.lang.String>getJobNicknames()Limits the listing to the selected jobsjava.lang.IntegergetQuantity()Can be used to specify the number of results to return.SortDirectiongetSortDirection()Used to override the default ascending ordering, which is based on scheduled time.java.lang.StringgetStartKey()Used to fetch a subsequent page of results, based on the key returned byJobDashboardListing.voidsetFolders(java.util.List<java.lang.String> folders)voidsetHosts(java.util.List<java.lang.String> hosts)voidsetJobClasses(java.util.List<java.lang.String> jobClasses)voidsetJobIds(java.util.List<java.lang.Long> jobIds)voidsetJobNicknames(java.util.List<java.lang.String> jobNicknames)voidsetQuantity(java.lang.Integer quantity)voidsetSortDirection(SortDirection sortDirection)voidsetStartKey(java.lang.String startKey)java.lang.StringtoString()JobDashboardListingParameterswithFolders(java.util.List<java.lang.String> folders)JobDashboardListingParameterswithHosts(java.util.List<java.lang.String> hosts)JobDashboardListingParameterswithJobClasses(java.util.List<java.lang.String> jobClasses)JobDashboardListingParameterswithJobIds(java.util.List<java.lang.Long> jobIds)JobDashboardListingParameterswithJobNicknames(java.util.List<java.lang.String> jobNicknames)JobDashboardListingParameterswithQuantity(java.lang.Integer quantity)JobDashboardListingParameterswithSortDirection(SortDirection sortDirection)JobDashboardListingParameterswithStartKey(java.lang.String startKey)
-
-
-
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)
-
withJobIds
public JobDashboardListingParameters withJobIds(java.util.List<java.lang.Long> jobIds)
-
getJobNicknames
public java.util.List<java.lang.String> getJobNicknames()
Limits the listing to the selected jobs- Returns:
- nicknames for search
-
setJobNicknames
public void setJobNicknames(java.util.List<java.lang.String> jobNicknames)
-
withJobNicknames
public JobDashboardListingParameters withJobNicknames(java.util.List<java.lang.String> jobNicknames)
-
getJobClasses
public java.util.List<java.lang.String> getJobClasses()
-
setJobClasses
public void setJobClasses(java.util.List<java.lang.String> jobClasses)
-
withJobClasses
public JobDashboardListingParameters withJobClasses(java.util.List<java.lang.String> jobClasses)
-
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)
-
withHosts
public JobDashboardListingParameters withHosts(java.util.List<java.lang.String> hosts)
-
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)
-
withFolders
public JobDashboardListingParameters withFolders(java.util.List<java.lang.String> folders)
-
getStartKey
public java.lang.String getStartKey()
Used to fetch a subsequent page of results, based on the key returned byJobDashboardListing.- Returns:
- start key for search
-
setStartKey
public void setStartKey(java.lang.String startKey)
-
withStartKey
public JobDashboardListingParameters withStartKey(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)
-
withSortDirection
public JobDashboardListingParameters withSortDirection(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)
-
withQuantity
public JobDashboardListingParameters withQuantity(java.lang.Integer quantity)
-
toString
public java.lang.String toString()
- Overrides:
toStringin classjava.lang.Object
-
-