- All Implemented Interfaces:
- java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>
@Generated(value="io.swagger.codegen.languages.JavaClientCodegen",
date="2018-12-07T19:30:21.793Z")
public class Filter
extends java.util.HashMap<java.lang.String,java.lang.Object>
Filter objects serve to communicate the filters to be applied to a data query. Filter objects are simple JS objects containing a field for each filtered field. Filter fields are ANDed together along with the base filter (which presently filters by findings not pending a purge action). Fields may contain a single value or an array of values. The possible filter fields and their expected values are described below. The IDs provided by the grouped-counts data endpoint fit the expected values. - `cwe`: CWE ID (\"398\" or 398, must be positive) or \"none\" - `finding`: finding ID (\"1234\" or 1234) - `detectionMethod`: The ID value of the detection method (e.g. 1 for 'Static Analysis') - `path`: full path (\"/foo/bar/baz.java\"), may contain asterisks as wildcard (e.g., folder name (\"/foo/bar/\")); may begin with \"!{path-type}\" to narrow down on path type as well (see `pathType` below); `\\\\\\\\ and ! may be escaped with the backslash character to use them literally - `pathType`: path type to match (\"file\") - `descriptor`: descriptor ID (\"descriptor:123\"), descriptor code (\"code:FOO-BAR\"), or descriptor group ID (\"group:32\") - `resultDescriptor`: same as descriptor but matches findings containing a tool result with the given descriptor. Additionally accepts criteria regarding manually-entered results with no tool (\"manual-descriptor:no-tool\"), a specific tool (\"manual-descriptor:<url-encoded tool name>\" e.g. \"manual-descriptor:FindBugs\"), and specific manual descriptors with and without specific tools (\"manual-descriptor:FindBugs:123\", \"manual-descriptor:no-tool:123\"). - `severity`: formal name of severity (\"High\") or numeric value (\"2\" or 2) - `status`: Encoded triage status (\"6\" or \"8:3\" - these are provided by the Project Statuses endpoint), triage status name (\"new\", \"false-positive\", etc.), \"assigned:\" (to match findings assigned to the given username), \"assigned\" (or \"assigned:*\") (to match any assigned status regardless of the target) - `toolOverlap`: number of detecting tools (\"tool-count:2\") or group of detecting tools (\"tool-list:Findbugs;PMD\") - `issueTrackerAssociationExists`: whether or not an issue tracker assocation exists (true or false) - `issueTrackerAssociationStatus`: existence flag (\"exists:false\"), issue tracker status (\"status:new\"), or issue tracker key (\"issue-key:foo\") - `issueTrackerAssociationResolution`: existence flag (\"exists:false\"), resolved flag - true will return findings that have an associated issue that is resolved while false will return findings that have an associated issue that is not resolved - (\"exists:false\"), issue tracker resolution (\"resolution:resolution name\") - `age`: an age bucket specifier (described in more detail in the `countBy` section), without the title, e.g. `\"90d-30d\"` - `firstSeen`: a Date Range object indicating a time during which the matched findings were first seen (i.e. created) - `lastModified`: a Date Range object indicating a time during which the matched findings were last modified (e.g. edited, status changed). - `includeDescendantProjects`: must be either true or false (arrays are not supported with this field). If true, results will include all findings in all projects descending from (and including) the project with which the filter object is used, and which you have permission to view. In other words, all findings in the current project group. Filter object fields may be negated by prefixing a tilde (`~`) to the field name.
- See Also:
- Serialized Form