org.sonarqube.ws.client.rules.SearchRequest Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sonar-ws Show documentation
Open source platform for continuous inspection of code quality
There is a newer version: 10.7.0.96327
/*
 * SonarQube
 * Copyright (C) 2009-2024 SonarSource SA
 * mailto:info AT sonarsource DOT com
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */
package org.sonarqube.ws.client.rules;

import java.util.List;
import javax.annotation.Generated;

/**
 * This is part of the internal API.
 * This is a POST request.
 * @see Further information about this action online (including a response example)
 * @since 4.4
 */
@Generated("sonar-ws-generator")
public class SearchRequest {

  private String activation;
  private List activeSeverities;
  private String asc;
  private String availableSince;
  private String compareToProfile;
  private List cwe;
  private List f;
  private List facets;
  private String includeExternal;
  private List inheritance;
  private String isTemplate;
  private List languages;
  private List owaspTop10;
  private String p;
  private String ps;
  private String q;
  private String qprofile;
  private List repositories;
  private String ruleKey;
  private String s;
  private List sansTop25;
  private List severities;
  private List sonarsourceSecurity;
  private List statuses;
  private List tags;
  private String templateKey;
  private List types;

  /**
   * Possible values:
   * 
   *   "true"
   *   "false"
   *   "yes"
   *   "no"
   * 
   */
  public SearchRequest setActivation(String activation) {
    this.activation = activation;
    return this;
  }

  public String getActivation() {
    return activation;
  }

  /**
   * Example value: "CRITICAL,BLOCKER"
   * Possible values:
   * 
   *   "INFO"
   *   "MINOR"
   *   "MAJOR"
   *   "CRITICAL"
   *   "BLOCKER"
   * 
   */
  public SearchRequest setActiveSeverities(List activeSeverities) {
    this.activeSeverities = activeSeverities;
    return this;
  }

  public List getActiveSeverities() {
    return activeSeverities;
  }

  /**
   * Possible values:
   * 
   *   "true"
   *   "false"
   *   "yes"
   *   "no"
   * 
   */
  public SearchRequest setAsc(String asc) {
    this.asc = asc;
    return this;
  }

  public String getAsc() {
    return asc;
  }

  /**
   * Example value: "2014-06-22"
   */
  public SearchRequest setAvailableSince(String availableSince) {
    this.availableSince = availableSince;
    return this;
  }

  public String getAvailableSince() {
    return availableSince;
  }

  /**
   * This is part of the internal API.
   * Example value: "AU-TpxcA-iU5OvuD2FLz"
   */
  public SearchRequest setCompareToProfile(String compareToProfile) {
    this.compareToProfile = compareToProfile;
    return this;
  }

  public String getCompareToProfile() {
    return compareToProfile;
  }

  /**
   * Example value: "12,125,unknown"
   */
  public SearchRequest setCwe(List cwe) {
    this.cwe = cwe;
    return this;
  }

  public List getCwe() {
    return cwe;
  }

  /**
   * Example value: "repo,name"
   * Possible values:
   * 
   *   "actives"
   *   "createdAt"
   *   "debtOverloaded"
   *   "debtRemFn"
   *   "defaultDebtRemFn"
   *   "defaultRemFn"
   *   "effortToFixDescription"
   *   "gapDescription"
   *   "htmlDesc"
   *   "htmlNote"
   *   "internalKey"
   *   "isExternal"
   *   "isTemplate"
   *   "lang"
   *   "langName"
   *   "mdDesc"
   *   "mdNote"
   *   "name"
   *   "noteLogin"
   *   "params"
   *   "remFn"
   *   "remFnOverloaded"
   *   "repo"
   *   "scope"
   *   "severity"
   *   "status"
   *   "sysTags"
   *   "tags"
   *   "templateKey"
   *   "updatedAt"
   * 
   */
  public SearchRequest setF(List f) {
    this.f = f;
    return this;
  }

  public List getF() {
    return f;
  }

  /**
   * Example value: "languages,repositories"
   * Possible values:
   * 
   *   "languages"
   *   "repositories"
   *   "tags"
   *   "severities"
   *   "active_severities"
   *   "statuses"
   *   "types"
   *   "true"
   *   "cwe"
   *   "owaspTop10"
   *   "sansTop25"
   *   "sonarsourceSecurity"
   * 
   */
  public SearchRequest setFacets(List facets) {
    this.facets = facets;
    return this;
  }

  public List getFacets() {
    return facets;
  }

  /**
   * Example value: "INHERITED,OVERRIDES"
   * Possible values:
   * 
   *   "NONE"
   *   "INHERITED"
   *   "OVERRIDES"
   * 
   */
  public SearchRequest setInheritance(List inheritance) {
    this.inheritance = inheritance;
    return this;
  }

  public List getInheritance() {
    return inheritance;
  }

  /**
   * Possible values:
   * 
   *   "true"
   *   "false"
   *   "yes"
   *   "no"
   * 
   */
  public SearchRequest setIsTemplate(String isTemplate) {
    this.isTemplate = isTemplate;
    return this;
  }

  public String getIsTemplate() {
    return isTemplate;
  }

  /**
   * Possible values:
   * 
   *   "true"
   *   "false"
   *   "yes"
   *   "no"
   * 
   */
  public SearchRequest setIncludeExternal(String includeExternal) {
    this.includeExternal = includeExternal;
    return this;
  }

  public String getIncludeExternal() {
    return includeExternal;
  }

  /**
   * Example value: "java,js"
   */
  public SearchRequest setLanguages(List languages) {
    this.languages = languages;
    return this;
  }

  public List getLanguages() {
    return languages;
  }

  /**
   * Possible values:
   * 
   *   "a1"
   *   "a2"
   *   "a3"
   *   "a4"
   *   "a5"
   *   "a6"
   *   "a7"
   *   "a8"
   *   "a9"
   *   "a10"
   *   "unknown"
   * 
   */
  public SearchRequest setOwaspTop10(List owaspTop10) {
    this.owaspTop10 = owaspTop10;
    return this;
  }

  public List getOwaspTop10() {
    return owaspTop10;
  }

  /**
   * Example value: "42"
   */
  public SearchRequest setP(String p) {
    this.p = p;
    return this;
  }

  public String getP() {
    return p;
  }

  /**
   * Example value: "20"
   */
  public SearchRequest setPs(String ps) {
    this.ps = ps;
    return this;
  }

  public String getPs() {
    return ps;
  }

  /**
   * Example value: "xpath"
   */
  public SearchRequest setQ(String q) {
    this.q = q;
    return this;
  }

  public String getQ() {
    return q;
  }

  /**
   * Example value: "AU-Tpxb--iU5OvuD2FLy"
   */
  public SearchRequest setQprofile(String qprofile) {
    this.qprofile = qprofile;
    return this;
  }

  public String getQprofile() {
    return qprofile;
  }

  /**
   * Example value: "checkstyle,findbugs"
   */
  public SearchRequest setRepositories(List repositories) {
    this.repositories = repositories;
    return this;
  }

  public List getRepositories() {
    return repositories;
  }

  /**
   * Example value: "java:S001"
   */
  public SearchRequest setRuleKey(String ruleKey) {
    this.ruleKey = ruleKey;
    return this;
  }

  public String getRuleKey() {
    return ruleKey;
  }

  /**
   * Example value: "name"
   * Possible values:
   * 
   *   "name"
   *   "updatedAt"
   *   "createdAt"
   *   "key"
   * 
   */
  public SearchRequest setS(String s) {
    this.s = s;
    return this;
  }

  public String getS() {
    return s;
  }

  /**
   * Possible values:
   * 
   *   "insecure-interaction"
   *   "risky-resource"
   *   "porous-defenses"
   * 
   */
  public SearchRequest setSansTop25(List sansTop25) {
    this.sansTop25 = sansTop25;
    return this;
  }

  public List getSansTop25() {
    return sansTop25;
  }

  /**
   * Example value: "CRITICAL,BLOCKER"
   * Possible values:
   * 
   *   "INFO"
   *   "MINOR"
   *   "MAJOR"
   *   "CRITICAL"
   *   "BLOCKER"
   * 
   */
  public SearchRequest setSeverities(List severities) {
    this.severities = severities;
    return this;
  }

  public List getSeverities() {
    return severities;
  }

  /**
   * Example value: "sql-injection,command-injection"
   * Possible values:
   * 
   *   "sql-injection"
   *   "command-injection"
   *   "path-traversal-injection"
   *   "ldap-injection"
   *   "xpath-injection"
   *   "expression-lang-injection"
   *   "rce"
   *   "dos"
   *   "ssrf"
   *   "csrf"
   *   "xss"
   *   "log-injection"
   *   "http-response-splitting"
   *   "open-redirect"
   *   "xxe"
   *   "object-injection"
   *   "weak-cryptography"
   *   "auth"
   *   "insecure-conf"
   *   "file-manipulation"
   * 
   */
  public SearchRequest setSonarsourceSecurity(List sonarsourceSecurity) {
    this.sonarsourceSecurity = sonarsourceSecurity;
    return this;
  }

  public List getSonarsourceSecurity() {
    return sonarsourceSecurity;
  }

  /**
   * Example value: "READY"
   * Possible values:
   * 
   *   "BETA"
   *   "DEPRECATED"
   *   "READY"
   *   "REMOVED"
   * 
   */
  public SearchRequest setStatuses(List statuses) {
    this.statuses = statuses;
    return this;
  }

  public List getStatuses() {
    return statuses;
  }

  /**
   * Example value: "security,java8"
   */
  public SearchRequest setTags(List tags) {
    this.tags = tags;
    return this;
  }

  public List getTags() {
    return tags;
  }

  /**
   * Example value: "java:S001"
   */
  public SearchRequest setTemplateKey(String templateKey) {
    this.templateKey = templateKey;
    return this;
  }

  public String getTemplateKey() {
    return templateKey;
  }

  /**
   * Example value: "BUG"
   * Possible values:
   * 
   *   "CODE_SMELL"
   *   "BUG"
   *   "VULNERABILITY"
   *   "SECURITY_HOTSPOT"
   * 
   */
  public SearchRequest setTypes(List types) {
    this.types = types;
    return this;
  }

  public List getTypes() {
    return types;
  }
}