import javax.annotation.Generated;
/**
- * $action.description.asString
- *
#if ($action.internal)
* This is part of the internal API.
#end
#foreach($param in $action.params)
/**
-#if ($param.description.asString)
- * $param.description.asString
- *
-#end
#if ($param.required.asBoolean)
* This is a mandatory parameter.
#end
#end
/**
- * $webService.description.asString
* @see <a href="$helper.apiDocUrl($webService.path.asString)">Further information about this web service online</a>
*/
@Generated("sonar-ws-generator")
#foreach($action in $webService.actions)
/**
- * $action.description.asString
*
#if ($action.internal)
* This is part of the internal API.
import org.sonarqube.ws.client.WsConnector;
/**
- * Get details about Compute Engine tasks.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/analysis_reports">Further information about this web service online</a>
*/
@Generated("sonar-ws-generator")
}
/**
- * Check if the queue of Compute Engine is empty
*
* This is part of the internal API.
* This is a GET request.
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
@ParametersAreNonnullByDefault
+@Generated("sonar-ws-generator")
package org.sonarqube.ws.client.analysisreports;
import javax.annotation.ParametersAreNonnullByDefault;
+import javax.annotation.Generated;
*/
package org.sonarqube.ws.client.authentication;
+import java.util.stream.Collectors;
import javax.annotation.Generated;
import org.sonarqube.ws.MediaTypes;
import org.sonarqube.ws.client.BaseService;
import org.sonarqube.ws.client.WsConnector;
/**
- * Handle authentication.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/authentication">Further information about this web service online</a>
*/
@Generated("sonar-ws-generator")
}
/**
- * Authenticate a user.
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * Logout a user.
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * Check credentials.
*
* This is part of the internal API.
* This is a GET request.
*/
package org.sonarqube.ws.client.authentication;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Authenticate a user.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/authentication/login">Further information about this action online (including a response example)</a>
private String password;
/**
- * Login of the user
- *
* This is a mandatory parameter.
*/
public LoginRequest setLogin(String login) {
}
/**
- * Password of the user
- *
* This is a mandatory parameter.
*/
public LoginRequest setPassword(String password) {
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
@ParametersAreNonnullByDefault
+@Generated("sonar-ws-generator")
package org.sonarqube.ws.client.authentication;
import javax.annotation.ParametersAreNonnullByDefault;
+import javax.annotation.Generated;
*/
package org.sonarqube.ws.client.batch;
+import java.util.stream.Collectors;
import javax.annotation.Generated;
import org.sonarqube.ws.MediaTypes;
import org.sonarqube.ws.client.BaseService;
import org.sonarqube.ws.client.GetRequest;
+import org.sonarqube.ws.client.PostRequest;
import org.sonarqube.ws.client.WsConnector;
import org.sonarqube.ws.Batch.WsProjectResponse;
/**
- * Get JAR files and referentials for batch
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/batch">Further information about this web service online</a>
*/
@Generated("sonar-ws-generator")
}
/**
- * Download a JAR file listed in the index (see batch/index)
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * List the JAR files to be downloaded by scanners
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * Return open issues
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * Return project repository
*
* This is part of the internal API.
* This is a GET request.
import javax.annotation.Generated;
/**
- * Download a JAR file listed in the index (see batch/index)
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/batch/file">Further information about this action online (including a response example)</a>
private String name;
/**
- * File name
- *
* Example value: "batch-library-2.3.jar"
*/
public FileRequest setName(String name) {
*/
package org.sonarqube.ws.client.batch;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Return open issues
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/batch/issues">Further information about this action online (including a response example)</a>
private String key;
/**
- * Branch key
- *
* Example value: "feature/my_branch"
*/
public IssuesRequest setBranch(String branch) {
}
/**
- * Project, module or file key
- *
* This is a mandatory parameter.
* Example value: "my_project"
*/
*/
package org.sonarqube.ws.client.batch;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Return project repository
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/batch/project">Further information about this action online (including a response example)</a>
private String profile;
/**
- * Branch key
- *
* Example value: "feature/my_branch"
*/
public ProjectRequest setBranch(String branch) {
}
/**
- * Issues mode or not
- *
* Possible values:
* <ul>
* <li>"true"</li>
}
/**
- * Project or module key
- *
* This is a mandatory parameter.
* Example value: "my_project"
*/
}
/**
- * Profile name
- *
* Example value: "SonarQube Way"
*/
public ProjectRequest setProfile(String profile) {
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
@ParametersAreNonnullByDefault
+@Generated("sonar-ws-generator")
package org.sonarqube.ws.client.batch;
import javax.annotation.ParametersAreNonnullByDefault;
+import javax.annotation.Generated;
import javax.annotation.Generated;
/**
- * Search for tasks.<br> Requires the system administration permission, or project administration permission if componentId is set.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/ce/activity">Further information about this action online (including a response example)</a>
private String type;
/**
- * Id of the component (project) to filter on
- *
* Example value: "AU-TpxcA-iU5OvuD2FL0"
*/
public ActivityRequest setComponentId(String componentId) {
}
/**
- * Limit search to: <ul><li>component names that contain the supplied string</li><li>component keys that are exactly the same as the supplied string</li></ul>Must not be set together with componentId.<br />Deprecated and replaced by 'q'
- *
* Example value: "Apache"
* @deprecated since 5.5
*/
}
/**
- * Maximum date of end of task processing (inclusive)
- *
- * Example value: "2017-11-23T15:56:03+0100"
+ * Example value: "2017-10-19T13:00:00+0200"
*/
public ActivityRequest setMaxExecutedAt(String maxExecutedAt) {
this.maxExecutedAt = maxExecutedAt;
}
/**
- * Minimum date of task submission (inclusive)
- *
- * Example value: "2017-11-23T15:56:03+0100"
+ * Example value: "2017-10-19T13:00:00+0200"
*/
public ActivityRequest setMinSubmittedAt(String minSubmittedAt) {
this.minSubmittedAt = minSubmittedAt;
}
/**
- * Filter on the last tasks (only the most recent finished task by project)
- *
* Possible values:
* <ul>
* <li>"true"</li>
}
/**
- * Deprecated parameter
- *
* @deprecated since 5.5
*/
@Deprecated
}
/**
- * Page size. Must be greater than 0 and less than 1000
- *
* Example value: "20"
*/
public ActivityRequest setPs(String ps) {
}
/**
- * Limit search to: <ul><li>component names that contain the supplied string</li><li>component keys that are exactly the same as the supplied string</li><li>task ids that are exactly the same as the supplied string</li></ul>Must not be set together with componentId
- *
* Example value: "Apache"
*/
public ActivityRequest setQ(String q) {
}
/**
- * Comma separated list of task statuses
- *
* Example value: "IN_PROGRESS,SUCCESS"
* Possible values:
* <ul>
}
/**
- * Task type
- *
* Example value: "REPORT"
* Possible values:
* <ul>
*/
package org.sonarqube.ws.client.ce;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Return CE activity related metrics.<br>Requires 'Administer System' permission or 'Administer' rights on the specified project.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/ce/activity_status">Further information about this action online (including a response example)</a>
private String componentKey;
/**
- * Id of the component (project) to filter on
- *
* Example value: "AU-TpxcA-iU5OvuD2FL0"
*/
public ActivityStatusRequest setComponentId(String componentId) {
}
/**
- * Key of the component (project) to filter on
- *
* Example value: "my_project"
*/
public ActivityStatusRequest setComponentKey(String componentKey) {
*/
package org.sonarqube.ws.client.ce;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Cancels a pending task.<br/>In-progress tasks cannot be canceled.<br/>Requires one of the following permissions:<ul><li>'Administer System'</li><li>'Administer' rights on the project related to the task</li></ul>
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/ce/cancel">Further information about this action online (including a response example)</a>
private String id;
/**
- * Id of the task to cancel.
- *
* This is a mandatory parameter.
* Example value: "AU-Tpxb--iU5OvuD2FLy"
*/
import org.sonarqube.ws.Ce.WorkerCountResponse;
/**
- * Get information on Compute Engine tasks.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/ce">Further information about this web service online</a>
*/
@Generated("sonar-ws-generator")
}
/**
- * Search for tasks.<br> Requires the system administration permission, or project administration permission if componentId is set.
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * Return CE activity related metrics.<br>Requires 'Administer System' permission or 'Administer' rights on the specified project.
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * Cancels a pending task.<br/>In-progress tasks cannot be canceled.<br/>Requires one of the following permissions:<ul><li>'Administer System'</li><li>'Administer' rights on the project related to the task</li></ul>
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * Cancels all pending tasks. Requires system administration permission. In-progress tasks are not canceled.
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * Get the pending tasks, in-progress tasks and the last executed task of a given component (usually a project).<br>Requires the following permission: 'Browse' on the specified component.<br>Either 'componentId' or 'component' must be provided.
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * Submits a scanner report to the queue. Report is processed asynchronously. Requires analysis permission. If the project does not exist, then the provisioning permission is also required.
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * Give Compute Engine task details such as type, status, duration and associated component.<br />Requires 'Administer System' or 'Execute Analysis' permission.<br/>Since 6.1, field "logs" is deprecated and its value is always false.
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * List available task types
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * Return number of Compute Engine workers.<br/>Requires the system administration permission
*
* This is part of the internal API.
* This is a GET request.
*/
package org.sonarqube.ws.client.ce;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Get the pending tasks, in-progress tasks and the last executed task of a given component (usually a project).<br>Requires the following permission: 'Browse' on the specified component.<br>Either 'componentId' or 'component' must be provided.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/ce/component">Further information about this action online (including a response example)</a>
*/
package org.sonarqube.ws.client.ce;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Submits a scanner report to the queue. Report is processed asynchronously. Requires analysis permission. If the project does not exist, then the provisioning permission is also required.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/ce/submit">Further information about this action online (including a response example)</a>
private String report;
/**
- * Optional characteristic of the analysis. Can be repeated to define multiple characteristics.
- *
* Example value: "branchType=long"
*/
public SubmitRequest setCharacteristic(String characteristic) {
}
/**
- * Key of the organization the project belongs to
- *
* This is part of the internal API.
* Example value: "my-org"
*/
}
/**
- * Optional branch of project
- *
* Example value: "branch-1.x"
*/
public SubmitRequest setProjectBranch(String projectBranch) {
}
/**
- * Key of project
- *
* This is a mandatory parameter.
* Example value: "my_project"
*/
}
/**
- * Optional name of the project, used only if the project does not exist yet.
- *
* Example value: "My Project"
*/
public SubmitRequest setProjectName(String projectName) {
}
/**
- * Report file. Format is not an API, it changes among SonarQube versions.
- *
* This is a mandatory parameter.
*/
public SubmitRequest setReport(String report) {
import javax.annotation.Generated;
/**
- * Give Compute Engine task details such as type, status, duration and associated component.<br />Requires 'Administer System' or 'Execute Analysis' permission.<br/>Since 6.1, field "logs" is deprecated and its value is always false.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/ce/task">Further information about this action online (including a response example)</a>
private String id;
/**
- * Comma-separated list of the optional fields to be returned in response.
- *
* Possible values:
* <ul>
* <li>"stacktrace"</li>
}
/**
- * Id of task
- *
* This is a mandatory parameter.
* Example value: "AU-Tpxb--iU5OvuD2FLy"
*/
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
@ParametersAreNonnullByDefault
+@Generated("sonar-ws-generator")
package org.sonarqube.ws.client.ce;
import javax.annotation.ParametersAreNonnullByDefault;
+import javax.annotation.Generated;
*/
package org.sonarqube.ws.client.components;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Coverage data required for rendering the component viewer.<br>Requires the following permission: 'Browse'.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/components/app">Further information about this action online (including a response example)</a>
private String componentId;
/**
- * Branch key
- *
* This is part of the internal API.
* Example value: "feature/my_branch"
*/
}
/**
- * Component key
- *
* Example value: "my_project"
*/
public AppRequest setComponent(String component) {
}
/**
- * Component ID
- *
* Example value: "AU-Tpxb--iU5OvuD2FLy"
* @deprecated since 6.4
*/
import org.sonarqube.ws.MediaTypes;
import org.sonarqube.ws.client.BaseService;
import org.sonarqube.ws.client.GetRequest;
+import org.sonarqube.ws.client.PostRequest;
import org.sonarqube.ws.client.WsConnector;
import org.sonarqube.ws.Components.SearchWsResponse;
import org.sonarqube.ws.Components.SearchProjectsWsResponse;
import org.sonarqube.ws.Components.TreeWsResponse;
/**
- * Get information about a component (file, directory, project, ...) and its ancestors or descendants. Update a project or module key.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/components">Further information about this web service online</a>
*/
@Generated("sonar-ws-generator")
}
/**
- * Coverage data required for rendering the component viewer.<br>Requires the following permission: 'Browse'.
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * Search for components
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * Search for projects
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * Returns a component (file, directory, project, view?) and its ancestors. The ancestors are ordered from the parent to the root project. The 'componentId' or 'component' parameter must be provided.<br>Requires the following permission: 'Browse' on the project of the specified component.
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * Internal WS for the top-right search engine. The result will contain component search results, grouped by their qualifiers.<p>Each result contains:<ul><li>the organization key</li><li>the component key</li><li>the component's name (unescaped)</li><li>optionally a display name, which puts emphasis to matching characters (this text contains html tags and parts of the html-escaped name)</li></ul>
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * Navigate through components based on the chosen strategy. The componentId or the component parameter must be provided.<br>Requires the following permission: 'Browse' on the specified project.<br>When limiting search with the q parameter, directories are not returned.
*
* This is part of the internal API.
* This is a GET request.
import javax.annotation.Generated;
/**
- * Search for projects
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/components/search_projects">Further information about this action online (including a response example)</a>
private String s;
/**
- * Ascending sort
- *
* Possible values:
* <ul>
* <li>"true"</li>
}
/**
- * Comma-separated list of the fields to be returned in response
- *
* Possible values:
* <ul>
* <li>"analysisDate"</li>
}
/**
- * Comma-separated list of the facets to be computed. No facet is computed by default.
- *
* Possible values:
* <ul>
* <li>"alert_status"</li>
}
/**
- * Filter of projects on name, key, measure value, quality gate, language, tag or whether a project is a favorite or not.<br>The filter must be encoded to form a valid URL (for example '=' must be replaced by '%3D').<br>Examples of use:<ul> <li>to filter my favorite projects with a failed quality gate and a coverage greater than or equals to 60% and a coverage strictly lower than 80%:<br> <code>filter="alert_status = ERROR and isFavorite and coverage >= 60 and coverage < 80"</code></li> <li>to filter projects with a reliability, security and maintainability rating equals or worse than B:<br> <code>filter="reliability_rating>=2 and security_rating>=2 and sqale_rating>=2"</code></li> <li>to filter projects without duplication data:<br> <code>filter="duplicated_lines_density = NO_DATA"</code></li></ul>To filter on project name or key, use the 'query' keyword, for instance : <code>filter='query = "Sonar"'</code>.<br><br>To filter on a numeric metric, provide the metric key.<br>These are the supported metric keys:<br><ul><li>alert_status</li><li>coverage</li><li>duplicated_lines_density</li><li>lines</li><li>ncloc</li><li>ncloc_language_distribution</li><li>new_coverage</li><li>new_duplicated_lines_density</li><li>new_lines</li><li>new_maintainability_rating</li><li>new_reliability_rating</li><li>new_security_rating</li><li>reliability_rating</li><li>security_rating</li><li>sqale_rating</li></ul><br>To filter on a rating, provide the corresponding metric key (ex: reliability_rating for reliability rating).<br>The possible values are:<ul> <li>'1' for rating A</li> <li>'2' for rating B</li> <li>'3' for rating C</li> <li>'4' for rating D</li> <li>'5' for rating E</li></ul>To filter on a Quality Gate status use the metric key 'alert_status'. Only the '=' operator can be used.<br>The possible values are:<ul> <li>'OK' for Passed</li> <li>'WARN' for Warning</li> <li>'ERROR' for Failed</li></ul>To filter on language keys use the language key: <ul> <li>to filter on a single language you can use 'language = java'</li> <li>to filter on several languages you must use 'language IN (java, js)'</li></ul>Use the WS api/languages/list to find the key of a language.<br> To filter on tags use the 'tag' keyword:<ul> <li>to filter on one tag you can use <code>tag = finance</code></li> <li>to filter on several tags you must use <code>tag in (offshore, java)</code></li></ul>
- *
*/
public SearchProjectsRequest setFilter(String filter) {
this.filter = filter;
}
/**
- * the organization to search projects in
- *
* This is part of the internal API.
*/
public SearchProjectsRequest setOrganization(String organization) {
}
/**
- * 1-based page number
- *
* Example value: "42"
*/
public SearchProjectsRequest setP(String p) {
}
/**
- * Page size. Must be greater than 0 and less than 500
- *
* Example value: "20"
*/
public SearchProjectsRequest setPs(String ps) {
}
/**
- * Sort projects by numeric metric key, quality gate status (using 'alert_status'), last analysis date (using 'analysisDate'), or by project name.
- *
* Possible values:
* <ul>
* <li>"alert_status"</li>
import javax.annotation.Generated;
/**
- * Search for components
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/components/search">Further information about this action online (including a response example)</a>
private List<String> qualifiers;
/**
- * Language key. If provided, only components for the given language are returned.
- *
* Example value: ""
*/
public SearchRequest setLanguage(String language) {
}
/**
- * Organization key
- *
* This is part of the internal API.
* Example value: "my-org"
*/
}
/**
- * 1-based page number
- *
* Example value: "42"
*/
public SearchRequest setP(String p) {
}
/**
- * Page size. Must be greater than 0.
- *
* Example value: "20"
*/
public SearchRequest setPs(String ps) {
}
/**
- * Limit search to: <ul><li>component names that contain the supplied string</li><li>component keys that are exactly the same as the supplied string</li></ul>
- *
* Example value: "sonar"
*/
public SearchRequest setQ(String q) {
}
/**
- * Comma-separated list of component qualifiers. Filter the results with the specified qualifiers. Possible values are:<ul><li>BRC - Sub-projects</li><li>DIR - Directories</li><li>FIL - Files</li><li>TRK - Projects</li><li>UTS - Test Files</li></ul>
- *
* This is a mandatory parameter.
* Possible values:
* <ul>
*/
package org.sonarqube.ws.client.components;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Returns a component (file, directory, project, view?) and its ancestors. The ancestors are ordered from the parent to the root project. The 'componentId' or 'component' parameter must be provided.<br>Requires the following permission: 'Browse' on the project of the specified component.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/components/show">Further information about this action online (including a response example)</a>
private String componentId;
/**
- * Branch key
- *
* This is part of the internal API.
* Example value: "feature/my_branch"
*/
}
/**
- * Component key
- *
* Example value: "my_project"
*/
public ShowRequest setComponent(String component) {
}
/**
- * Component id
- *
* Example value: "AU-Tpxb--iU5OvuD2FLy"
* @deprecated since 6.4
*/
import javax.annotation.Generated;
/**
- * Internal WS for the top-right search engine. The result will contain component search results, grouped by their qualifiers.<p>Each result contains:<ul><li>the organization key</li><li>the component key</li><li>the component's name (unescaped)</li><li>optionally a display name, which puts emphasis to matching characters (this text contains html tags and parts of the html-escaped name)</li></ul>
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/components/suggestions">Further information about this action online (including a response example)</a>
private String s;
/**
- * Category, for which to display the next 20 results (skipping the first 6 results)
- *
* Possible values:
* <ul>
* <li>"VW"</li>
}
/**
- * Comma separated list of component keys, that have recently been browsed by the user. Only the first 50 items will be used. Order is not taken into account.
- *
* Example value: "org.sonarsource:sonarqube,some.other:project"
*/
public SuggestionsRequest setRecentlyBrowsed(List<String> recentlyBrowsed) {
}
/**
- * Search query: can contain several search tokens separated by spaces.
- *
* Example value: "sonar"
*/
public SuggestionsRequest setS(String s) {
import javax.annotation.Generated;
/**
- * Navigate through components based on the chosen strategy. The componentId or the component parameter must be provided.<br>Requires the following permission: 'Browse' on the specified project.<br>When limiting search with the q parameter, directories are not returned.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/components/tree">Further information about this action online (including a response example)</a>
private String strategy;
/**
- * Ascending sort
- *
* Possible values:
* <ul>
* <li>"true"</li>
}
/**
- * Branch key
- *
* This is part of the internal API.
* Example value: "feature/my_branch"
*/
}
/**
- * Base component key. The search is based on this component.
- *
* Example value: "my_project"
*/
public TreeRequest setComponent(String component) {
}
/**
- * Base component id. The search is based on this component.
- *
* Example value: "AU-TpxcA-iU5OvuD2FLz"
* @deprecated since 6.4
*/
}
/**
- * 1-based page number
- *
* Example value: "42"
*/
public TreeRequest setP(String p) {
}
/**
- * Page size. Must be greater than 0 and less than 500
- *
* Example value: "20"
*/
public TreeRequest setPs(String ps) {
}
/**
- * Limit search to: <ul><li>component names that contain the supplied string</li><li>component keys that are exactly the same as the supplied string</li></ul>
- *
* Example value: "FILE_NAM"
*/
public TreeRequest setQ(String q) {
}
/**
- * Comma-separated list of component qualifiers. Filter the results with the specified qualifiers. Possible values are:<ul><li>BRC - Sub-projects</li><li>DIR - Directories</li><li>FIL - Files</li><li>TRK - Projects</li><li>UTS - Test Files</li></ul>
- *
* Possible values:
* <ul>
* <li>"BRC"</li>
}
/**
- * Comma-separated list of sort fields
- *
* Example value: "name, path"
* Possible values:
* <ul>
}
/**
- * Strategy to search for base component descendants:<ul><li>children: return the children components of the base component. Grandchildren components are not returned</li><li>all: return all the descendants components of the base component. Grandchildren are returned.</li><li>leaves: return all the descendant components (files, in general) which don't have other children. They are the leaves of the component tree.</li></ul>
- *
* Possible values:
* <ul>
* <li>"all"</li>
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
@ParametersAreNonnullByDefault
+@Generated("sonar-ws-generator")
package org.sonarqube.ws.client.components;
import javax.annotation.ParametersAreNonnullByDefault;
+import javax.annotation.Generated;
*/
package org.sonarqube.ws.client.custommeasures;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Create a custom measure.<br /> The project id or the project key must be provided (only project and module custom measures can be created). The metric id or the metric key must be provided.<br/>Requires 'Administer System' permission or 'Administer' permission on the project.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/custom_measures/create">Further information about this action online (including a response example)</a>
private String value;
/**
- * Description
- *
* Example value: "Team size growing."
*/
public CreateRequest setDescription(String description) {
}
/**
- * Metric id
- *
* Example value: "16"
*/
public CreateRequest setMetricId(String metricId) {
}
/**
- * Metric key
- *
* Example value: "ncloc"
*/
public CreateRequest setMetricKey(String metricKey) {
}
/**
- * Project id
- *
* Example value: "ce4c03d6-430f-40a9-b777-ad877c00aa4d"
*/
public CreateRequest setProjectId(String projectId) {
}
/**
- * Project key
- *
* Example value: "my_project"
*/
public CreateRequest setProjectKey(String projectKey) {
}
/**
- * Measure value. Value type depends on metric type:<ul><li>INT - type: integer</li><li>FLOAT - type: double</li><li>PERCENT - type: double</li><li>BOOL - the possible values are true or false</li><li>STRING - type: string</li><li>MILLISEC - type: integer</li><li>DATA - type: string</li><li>LEVEL - the possible values are OK, WARN, ERROR</li><li>DISTRIB - type: string</li><li>RATING - type: double</li><li>WORK_DUR - long representing the number of minutes</li></ul>
- *
* This is a mandatory parameter.
* Example value: "47"
*/
import org.sonarqube.ws.client.WsConnector;
/**
- * Manage custom measures for a project. See also api/metrics.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/custom_measures">Further information about this web service online</a>
*/
@Generated("sonar-ws-generator")
}
/**
- * Create a custom measure.<br /> The project id or the project key must be provided (only project and module custom measures can be created). The metric id or the metric key must be provided.<br/>Requires 'Administer System' permission or 'Administer' permission on the project.
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * Delete a custom measure.<br /> Requires 'Administer System' permission or 'Administer' permission on the project.
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * List all custom metrics for which no custom measure already exists on a given project.<br /> The project id or project key must be provided.<br />Requires 'Administer System' permission or 'Administer' permission on the project.
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * List custom measures. The project id or project key must be provided.<br />Requires 'Administer System' permission or 'Administer' permission on the project.
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * Update a custom measure. Value and/or description must be provided<br />Requires 'Administer System' permission or 'Administer' permission on the project.
*
* This is part of the internal API.
* This is a POST request.
*/
package org.sonarqube.ws.client.custommeasures;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Delete a custom measure.<br /> Requires 'Administer System' permission or 'Administer' permission on the project.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/custom_measures/delete">Further information about this action online (including a response example)</a>
private String id;
/**
- * Id
- *
* This is a mandatory parameter.
* Example value: "24"
*/
*/
package org.sonarqube.ws.client.custommeasures;
+import java.util.List;
import javax.annotation.Generated;
/**
- * List all custom metrics for which no custom measure already exists on a given project.<br /> The project id or project key must be provided.<br />Requires 'Administer System' permission or 'Administer' permission on the project.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/custom_measures/metrics">Further information about this action online (including a response example)</a>
private String projectKey;
/**
- * Project id
- *
* Example value: "ce4c03d6-430f-40a9-b777-ad877c00aa4d"
*/
public MetricsRequest setProjectId(String projectId) {
}
/**
- * Project key
- *
* Example value: "my_project"
*/
public MetricsRequest setProjectKey(String projectKey) {
import javax.annotation.Generated;
/**
- * List custom measures. The project id or project key must be provided.<br />Requires 'Administer System' permission or 'Administer' permission on the project.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/custom_measures/search">Further information about this action online (including a response example)</a>
private String ps;
/**
- * Comma-separated list of the fields to be returned in response. All the fields are returned by default.
- *
* Possible values:
* <ul>
* <li>"projectId"</li>
}
/**
- * 1-based page number
- *
* Example value: "42"
*/
public SearchRequest setP(String p) {
}
/**
- * Project id
- *
* Example value: "ce4c03d6-430f-40a9-b777-ad877c00aa4d"
*/
public SearchRequest setProjectId(String projectId) {
}
/**
- * Project key
- *
* Example value: "my_project"
*/
public SearchRequest setProjectKey(String projectKey) {
}
/**
- * Page size. Must be greater than 0 and less than 500
- *
* Example value: "20"
*/
public SearchRequest setPs(String ps) {
*/
package org.sonarqube.ws.client.custommeasures;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Update a custom measure. Value and/or description must be provided<br />Requires 'Administer System' permission or 'Administer' permission on the project.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/custom_measures/update">Further information about this action online (including a response example)</a>
}
/**
- * id
- *
* This is a mandatory parameter.
* Example value: "42"
*/
}
/**
- * Measure value. Value type depends on metric type:<ul><li>INT - type: integer</li><li>FLOAT - type: double</li><li>PERCENT - type: double</li><li>BOOL - the possible values are true or false</li><li>STRING - type: string</li><li>MILLISEC - type: integer</li><li>DATA - type: string</li><li>LEVEL - the possible values are OK, WARN, ERROR</li><li>DISTRIB - type: string</li><li>RATING - type: double</li><li>WORK_DUR - long representing the number of minutes</li></ul>
- *
* Example value: "true"
*/
public UpdateRequest setValue(String value) {
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
@ParametersAreNonnullByDefault
+@Generated("sonar-ws-generator")
package org.sonarqube.ws.client.custommeasures;
import javax.annotation.ParametersAreNonnullByDefault;
+import javax.annotation.Generated;
*/
package org.sonarqube.ws.client.duplications;
+import java.util.stream.Collectors;
import javax.annotation.Generated;
+import org.sonarqube.ws.MediaTypes;
import org.sonarqube.ws.client.BaseService;
import org.sonarqube.ws.client.GetRequest;
+import org.sonarqube.ws.client.PostRequest;
import org.sonarqube.ws.client.WsConnector;
import org.sonarqube.ws.Duplications.ShowResponse;
/**
- * Get duplication information for a project.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/duplications">Further information about this web service online</a>
*/
@Generated("sonar-ws-generator")
}
/**
- * Get duplications. Require Browse permission on file's project
*
* This is part of the internal API.
* This is a GET request.
*/
package org.sonarqube.ws.client.duplications;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Get duplications. Require Browse permission on file's project
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/duplications/show">Further information about this action online (including a response example)</a>
private String uuid;
/**
- * Branch key
- *
* This is part of the internal API.
* Example value: "feature/my_branch"
*/
}
/**
- * File key
- *
* Example value: "my_project:/src/foo/Bar.php"
*/
public ShowRequest setKey(String key) {
}
/**
- * File ID. If provided, 'key' must not be provided.
- *
* Example value: "584a89f2-8037-4f7b-b82c-8b45d2d63fb2"
* @deprecated since 6.5
*/
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
@ParametersAreNonnullByDefault
+@Generated("sonar-ws-generator")
package org.sonarqube.ws.client.duplications;
import javax.annotation.ParametersAreNonnullByDefault;
+import javax.annotation.Generated;
*/
package org.sonarqube.ws.client.editions;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Apply changes to SonarQube to match the specified license. Clear error message of previous automatic install of an edition, if there is any. Require 'Administer System' permission.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/editions/apply_license">Further information about this action online (including a response example)</a>
private String license;
/**
- * the license
- *
* This is a mandatory parameter.
*/
public ApplyLicenseRequest setLicense(String license) {
*/
package org.sonarqube.ws.client.editions;
+import java.util.stream.Collectors;
import javax.annotation.Generated;
import org.sonarqube.ws.MediaTypes;
import org.sonarqube.ws.client.BaseService;
import org.sonarqube.ws.Editions.StatusResponse;
/**
- * Manage SonarSource commercial editions.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/editions">Further information about this web service online</a>
*/
@Generated("sonar-ws-generator")
}
/**
- * Apply changes to SonarQube to match the specified license. Clear error message of previous automatic install of an edition, if there is any. Require 'Administer System' permission.
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * Clear error message of last install of an edition (if any). Require 'Administer System' permission.
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * Provide data to prefill license request forms: the server ID and the total number of lines of code.
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * Preview the changes to SonarQube to match the specified license. Requires 'Administer System' permission.
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * Provide status of SonarSource commercial edition of the current SonarQube. Requires 'Administer System' permission.
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * Uninstall the currently installed edition. Requires 'Administer System' permission.
*
* This is part of the internal API.
* This is a POST request.
*/
package org.sonarqube.ws.client.editions;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Preview the changes to SonarQube to match the specified license. Requires 'Administer System' permission.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/editions/preview">Further information about this action online (including a response example)</a>
private String license;
/**
- * the license
- *
* This is a mandatory parameter.
*/
public PreviewRequest setLicense(String license) {
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
@ParametersAreNonnullByDefault
+@Generated("sonar-ws-generator")
package org.sonarqube.ws.client.editions;
import javax.annotation.ParametersAreNonnullByDefault;
+import javax.annotation.Generated;
*/
package org.sonarqube.ws.client.emails;
+import java.util.stream.Collectors;
import javax.annotation.Generated;
import org.sonarqube.ws.MediaTypes;
import org.sonarqube.ws.client.BaseService;
+import org.sonarqube.ws.client.GetRequest;
import org.sonarqube.ws.client.PostRequest;
import org.sonarqube.ws.client.WsConnector;
/**
- * Manage emails
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/emails">Further information about this web service online</a>
*/
@Generated("sonar-ws-generator")
}
/**
- * Test email configuration by sending an email<br>Requires 'Administer System' permission.
*
* This is part of the internal API.
* This is a POST request.
*/
package org.sonarqube.ws.client.emails;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Test email configuration by sending an email<br>Requires 'Administer System' permission.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/emails/send">Further information about this action online (including a response example)</a>
private String to;
/**
- * Content of the email
- *
* This is a mandatory parameter.
*/
public SendRequest setMessage(String message) {
}
/**
- * Subject of the email
- *
* Example value: "Test Message from SonarQube"
*/
public SendRequest setSubject(String subject) {
}
/**
- * Email address
- *
* This is a mandatory parameter.
* Example value: "john@doo.com"
*/
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
@ParametersAreNonnullByDefault
+@Generated("sonar-ws-generator")
package org.sonarqube.ws.client.emails;
import javax.annotation.ParametersAreNonnullByDefault;
+import javax.annotation.Generated;
*/
package org.sonarqube.ws.client.favorites;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Add a component (project, directory, file etc.) as favorite for the authenticated user.<br>Requires authentication and the following permission: 'Browse' on the project of the specified component.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/favorites/add">Further information about this action online (including a response example)</a>
private String component;
/**
- * Component key
- *
* This is a mandatory parameter.
* Example value: "my_project:/src/foo/Bar.php"
*/
*/
package org.sonarqube.ws.client.favorites;
+import java.util.stream.Collectors;
import javax.annotation.Generated;
import org.sonarqube.ws.MediaTypes;
import org.sonarqube.ws.client.BaseService;
import org.sonarqube.ws.Favorites.SearchResponse;
/**
- * Manage user favorites
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/favorites">Further information about this web service online</a>
*/
@Generated("sonar-ws-generator")
}
/**
- * Add a component (project, directory, file etc.) as favorite for the authenticated user.<br>Requires authentication and the following permission: 'Browse' on the project of the specified component.
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * Remove a component (project, directory, file etc.) as favorite for the authenticated user.<br>Requires authentication.
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * Search for the authenticated user favorites.<br>Requires authentication.
*
* This is part of the internal API.
* This is a GET request.
import javax.annotation.Generated;
/**
- * Remove a component (project, directory, file etc.) as favorite for the authenticated user.<br>Requires authentication.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/favorites/remove">Further information about this action online (including a response example)</a>
private String component;
/**
- * Component key
- *
* This is a mandatory parameter.
* Example value: "my_project"
*/
*/
package org.sonarqube.ws.client.favorites;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Search for the authenticated user favorites.<br>Requires authentication.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/favorites/search">Further information about this action online (including a response example)</a>
private String ps;
/**
- * 1-based page number
- *
* Example value: "42"
*/
public SearchRequest setP(String p) {
}
/**
- * Page size. Must be greater than 0 and less than 500
- *
* Example value: "20"
*/
public SearchRequest setPs(String ps) {
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
@ParametersAreNonnullByDefault
+@Generated("sonar-ws-generator")
package org.sonarqube.ws.client.favorites;
import javax.annotation.ParametersAreNonnullByDefault;
+import javax.annotation.Generated;
import org.sonarqube.ws.client.WsConnector;
/**
- * Removed since 6.3, please use api/favorites instead
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/favourites">Further information about this web service online</a>
*/
@Generated("sonar-ws-generator")
}
/**
- * The web service is removed and you're invited to use api/favorites instead
*
* This is part of the internal API.
* This is a GET request.
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
@ParametersAreNonnullByDefault
+@Generated("sonar-ws-generator")
package org.sonarqube.ws.client.favourites;
import javax.annotation.ParametersAreNonnullByDefault;
+import javax.annotation.Generated;
*/
package org.sonarqube.ws.client.issues;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Add a comment.<br/>Requires authentication and the following permission: 'Browse' on the project of the specified issue.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/issues/add_comment">Further information about this action online (including a response example)</a>
private String text;
/**
- * Issue key
- *
* This is a mandatory parameter.
* Example value: "AU-Tpxb--iU5OvuD2FLy"
*/
}
/**
- * Comment text
- *
* This is a mandatory parameter.
* Example value: "Won't fix because it doesn't apply to the context"
*/
*/
package org.sonarqube.ws.client.issues;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Assign/Unassign an issue. Requires authentication and Browse permission on project
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/issues/assign">Further information about this action online (including a response example)</a>
private String me;
/**
- * Login of the assignee. When not set, it will unassign the issue. Use '_me' to assign to current user
- *
* Example value: "admin"
*/
public AssignRequest setAssignee(String assignee) {
}
/**
- * Issue key
- *
* This is a mandatory parameter.
* Example value: "AU-Tpxb--iU5OvuD2FLy"
*/
}
/**
- * (deprecated) Assign the issue to the logged-in user. Replaced by the parameter assignee=_me
- *
* Possible values:
* <ul>
* <li>"true"</li>
*/
package org.sonarqube.ws.client.issues;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Search SCM accounts which match a given query
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/issues/authors">Further information about this action online (including a response example)</a>
private String q;
/**
- * The size of the list to return
- *
* Example value: "25"
*/
public AuthorsRequest setPs(String ps) {
}
/**
- * A pattern to match SCM accounts against
- *
* Example value: "luke"
*/
public AuthorsRequest setQ(String q) {
import javax.annotation.Generated;
/**
- * Bulk change on issues.<br/>Requires authentication.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/issues/bulk_change">Further information about this action online (including a response example)</a>
public class BulkChangeRequest {
private String addTags;
- private String assign;
- private String comment;
+ private List<String> assign;
+ private List<String> comment;
private String doTransition;
private List<String> issues;
- private String plan;
+ private List<String> plan;
private String removeTags;
private String sendNotifications;
- private String setSeverity;
- private String setType;
+ private List<String> setSeverity;
+ private List<String> setType;
/**
- * Add tags
- *
* Example value: "security,java8"
*/
public BulkChangeRequest setAddTags(String addTags) {
}
/**
- * To assign the list of issues to a specific user (login), or un-assign all the issues
- *
* Example value: "john.smith"
*/
- public BulkChangeRequest setAssign(String assign) {
+ public BulkChangeRequest setAssign(List<String> assign) {
this.assign = assign;
return this;
}
- public String getAssign() {
+ public List<String> getAssign() {
return assign;
}
/**
- * To add a comment to a list of issues
- *
* Example value: "Here is my comment"
*/
- public BulkChangeRequest setComment(String comment) {
+ public BulkChangeRequest setComment(List<String> comment) {
this.comment = comment;
return this;
}
- public String getComment() {
+ public List<String> getComment() {
return comment;
}
/**
- * Transition
- *
* Example value: "reopen"
* Possible values:
* <ul>
}
/**
- * Comma-separated list of issue keys
- *
* This is a mandatory parameter.
* Example value: "AU-Tpxb--iU5OvuD2FLy,AU-TpxcA-iU5OvuD2FLz"
*/
}
/**
- * In 5.5, action plans are dropped. Has no effect. To plan the list of issues to a specific action plan (key), or unlink all the issues from an action plan
- *
* @deprecated since 5.5
*/
@Deprecated
- public BulkChangeRequest setPlan(String plan) {
+ public BulkChangeRequest setPlan(List<String> plan) {
this.plan = plan;
return this;
}
- public String getPlan() {
+ public List<String> getPlan() {
return plan;
}
/**
- * Remove tags
- *
* Example value: "security,java8"
*/
public BulkChangeRequest setRemoveTags(String removeTags) {
}
/**
- * To change the severity of the list of issues
- *
* Example value: "BLOCKER"
* Possible values:
* <ul>
* <li>"BLOCKER"</li>
* </ul>
*/
- public BulkChangeRequest setSetSeverity(String setSeverity) {
+ public BulkChangeRequest setSetSeverity(List<String> setSeverity) {
this.setSeverity = setSeverity;
return this;
}
- public String getSetSeverity() {
+ public List<String> getSetSeverity() {
return setSeverity;
}
/**
- * To change the type of the list of issues
- *
* Example value: "BUG"
* Possible values:
* <ul>
* <li>"VULNERABILITY"</li>
* </ul>
*/
- public BulkChangeRequest setSetType(String setType) {
+ public BulkChangeRequest setSetType(List<String> setType) {
this.setType = setType;
return this;
}
- public String getSetType() {
+ public List<String> getSetType() {
return setType;
}
}
*/
package org.sonarqube.ws.client.issues;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Display changelog of an issue.<br/>Requires the 'Browse' permission on the project of the specified issue.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/issues/changelog">Further information about this action online (including a response example)</a>
private String issue;
/**
- * Issue key
- *
* This is a mandatory parameter.
* Example value: "AU-Tpxb--iU5OvuD2FLy"
*/
*/
package org.sonarqube.ws.client.issues;
+import java.util.List;
import javax.annotation.Generated;
/**
- * List tags for the issues under a given component (including issues on the descendants of the component)
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/issues/component_tags">Further information about this action online (including a response example)</a>
private String ps;
/**
- * A component UUID
- *
* This is a mandatory parameter.
* Example value: "7d8749e8-3070-4903-9188-bdd82933bb92"
*/
}
/**
- * To retrieve tags on issues created after the given date (inclusive). <br>Either a date (server timezone) or datetime can be provided.
- *
* Example value: "2017-10-19 or 2017-10-19T13:00:00+0200"
*/
public ComponentTagsRequest setCreatedAfter(String createdAfter) {
}
/**
- * The maximum size of the list to return
- *
* Example value: "25"
*/
public ComponentTagsRequest setPs(String ps) {
*/
package org.sonarqube.ws.client.issues;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Delete a comment.<br/>Requires authentication and the following permission: 'Browse' on the project of the specified issue.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/issues/delete_comment">Further information about this action online (including a response example)</a>
private String comment;
/**
- * Comment key
- *
* This is a mandatory parameter.
* Example value: "AU-Tpxb--iU5OvuD2FLy"
*/
*/
package org.sonarqube.ws.client.issues;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Do workflow transition on an issue. Requires authentication and Browse permission on project.<br/>The transitions 'wontfix' and 'falsepositive' require the permission 'Administer Issues'.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/issues/do_transition">Further information about this action online (including a response example)</a>
private String transition;
/**
- * Issue key
- *
* This is a mandatory parameter.
* Example value: "AU-Tpxb--iU5OvuD2FLy"
*/
}
/**
- * Transition
- *
* This is a mandatory parameter.
* Possible values:
* <ul>
*/
package org.sonarqube.ws.client.issues;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Edit a comment.<br/>Requires authentication and the following permission: 'Browse' on the project of the specified issue.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/issues/edit_comment">Further information about this action online (including a response example)</a>
private String text;
/**
- * Comment key
- *
* This is a mandatory parameter.
* Example value: "AU-Tpxb--iU5OvuD2FLy"
*/
}
/**
- * Comment text
- *
* This is a mandatory parameter.
* Example value: "Won't fix because it doesn't apply to the context"
*/
import org.sonarqube.ws.Issues.SearchWsResponse;
/**
- * Read and update issues.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/issues">Further information about this web service online</a>
*/
@Generated("sonar-ws-generator")
}
/**
- * Add a comment.<br/>Requires authentication and the following permission: 'Browse' on the project of the specified issue.
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * Assign/Unassign an issue. Requires authentication and Browse permission on project
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * Search SCM accounts which match a given query
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * Bulk change on issues.<br/>Requires authentication.
*
* This is part of the internal API.
* This is a POST request.
return call(
new PostRequest(path("bulk_change"))
.setParam("add_tags", request.getAddTags())
- .setParam("assign", request.getAssign())
- .setParam("comment", request.getComment())
+ .setParam("assign", request.getAssign() == null ? null : request.getAssign().stream().collect(Collectors.joining(",")))
+ .setParam("comment", request.getComment() == null ? null : request.getComment().stream().collect(Collectors.joining(",")))
.setParam("do_transition", request.getDoTransition())
.setParam("issues", request.getIssues() == null ? null : request.getIssues().stream().collect(Collectors.joining(",")))
- .setParam("plan", request.getPlan())
+ .setParam("plan", request.getPlan() == null ? null : request.getPlan().stream().collect(Collectors.joining(",")))
.setParam("remove_tags", request.getRemoveTags())
.setParam("sendNotifications", request.getSendNotifications())
- .setParam("set_severity", request.getSetSeverity())
- .setParam("set_type", request.getSetType()),
+ .setParam("set_severity", request.getSetSeverity() == null ? null : request.getSetSeverity().stream().collect(Collectors.joining(",")))
+ .setParam("set_type", request.getSetType() == null ? null : request.getSetType().stream().collect(Collectors.joining(","))),
BulkChangeWsResponse.parser());
}
/**
- * Display changelog of an issue.<br/>Requires the 'Browse' permission on the project of the specified issue.
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * List tags for the issues under a given component (including issues on the descendants of the component)
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * Delete a comment.<br/>Requires authentication and the following permission: 'Browse' on the project of the specified issue.
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * Do workflow transition on an issue. Requires authentication and Browse permission on project.<br/>The transitions 'wontfix' and 'falsepositive' require the permission 'Administer Issues'.
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * Edit a comment.<br/>Requires authentication and the following permission: 'Browse' on the project of the specified issue.
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * Search for issues.<br>At most one of the following parameters can be provided at the same time: componentKeys, componentUuids, components, componentRootUuids, componentRoots.<br>Requires the 'Browse' permission on the specified project(s).
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * Change severity.<br/>Requires the following permissions:<ul> <li>'Authentication'</li> <li>'Browse' rights on project of the specified issue</li> <li>'Administer Issues' rights on project of the specified issue</li></ul>
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * Set tags on an issue. <br/>Requires authentication and Browse permission on project
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * Change type of issue, for instance from 'code smell' to 'bug'.<br/>Requires the following permissions:<ul> <li>'Authentication'</li> <li>'Browse' rights on project of the specified issue</li> <li>'Administer Issues' rights on project of the specified issue</li></ul>
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * List tags matching a given query
*
* This is part of the internal API.
* This is a GET request.
import javax.annotation.Generated;
/**
- * Search for issues.<br>At most one of the following parameters can be provided at the same time: componentKeys, componentUuids, components, componentRootUuids, componentRoots.<br>Requires the 'Browse' permission on the specified project(s).
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/issues/search">Further information about this action online (including a response example)</a>
private List<String> types;
/**
- * Comma-separated list of the optional fields to be returned in response. Action plans are dropped in 5.5, it is not returned in the response.
- *
* Possible values:
* <ul>
* <li>"_all"</li>
}
/**
- * Ascending sort
- *
* Possible values:
* <ul>
* <li>"true"</li>
}
/**
- * To retrieve assigned or unassigned issues
- *
* Possible values:
* <ul>
* <li>"true"</li>
}
/**
- * Comma-separated list of assignee logins. The value '__me__' can be used as a placeholder for user who performs the request
- *
* Example value: "admin,usera,__me__"
*/
public SearchRequest setAssignees(List<String> assignees) {
}
/**
- * Comma-separated list of SCM accounts
- *
* Example value: "torvalds@linux-foundation.org"
*/
public SearchRequest setAuthors(List<String> authors) {
}
/**
- * Branch key
- *
* This is part of the internal API.
* Example value: "feature/my_branch"
*/
}
/**
- * Comma-separated list of component keys. Retrieve issues associated to a specific list of components (and all its descendants). A component can be a portfolio, project, module, directory or file.
- *
* Example value: "my_project"
*/
public SearchRequest setComponentKeys(List<String> componentKeys) {
}
/**
- * If used, will have the same meaning as componentUuids AND onComponentOnly=false.
- *
* @deprecated since 5.1
*/
@Deprecated
}
/**
- * If used, will have the same meaning as componentKeys AND onComponentOnly=false.
- *
* @deprecated since 5.1
*/
@Deprecated
}
/**
- * To retrieve issues associated to a specific list of components their sub-components (comma-separated list of component IDs). This parameter is mostly used by the Issues page, please prefer usage of the componentKeys parameter. A component can be a project, module, directory or file.
- *
* Example value: "584a89f2-8037-4f7b-b82c-8b45d2d63fb2"
* @deprecated since 6.5
*/
}
/**
- * If used, will have the same meaning as componentKeys AND onComponentOnly=true.
- *
* @deprecated since 5.1
*/
@Deprecated
}
/**
- * To retrieve issues created after the given date (inclusive). <br>Either a date (server timezone) or datetime can be provided. <br>If this parameter is set, createdSince must not be set
- *
* Example value: "2017-10-19 or 2017-10-19T13:00:00+0200"
*/
public SearchRequest setCreatedAfter(String createdAfter) {
}
/**
- * Datetime to retrieve issues created during a specific analysis
- *
* Example value: "2017-10-19T13:00:00+0200"
*/
public SearchRequest setCreatedAt(String createdAt) {
}
/**
- * To retrieve issues created before the given date (inclusive). <br>Either a date (server timezone) or datetime can be provided.
- *
* Example value: "2017-10-19 or 2017-10-19T13:00:00+0200"
*/
public SearchRequest setCreatedBefore(String createdBefore) {
}
/**
- * To retrieve issues created during a time span before the current time (exclusive). Accepted units are 'y' for year, 'm' for month, 'w' for week and 'd' for day. If this parameter is set, createdAfter must not be set
- *
* Example value: "1m2w (1 month 2 weeks)"
*/
public SearchRequest setCreatedInLast(String createdInLast) {
}
/**
- * To retrieve issues associated to a specific list of directories (comma-separated list of directory paths). This parameter is only meaningful when a module is selected. This parameter is mostly used by the Issues page, please prefer usage of the componentKeys parameter.
- *
* This is part of the internal API.
* Example value: "src/main/java/org/sonar/server/"
*/
}
/**
- * Choose the returned value for facet items, either count of issues or sum of debt.<br/>Since 5.5, 'debt' mode is deprecated and replaced by 'effort'
- *
* Possible values:
* <ul>
* <li>"count"</li>
}
/**
- * Comma-separated list of the facets to be computed. No facet is computed by default.<br/>Since 5.5, facet 'actionPlans' is deprecated.<br/>Since 5.5, facet 'reporters' is deprecated.
- *
* Possible values:
* <ul>
* <li>"severities"</li>
}
/**
- * To retrieve issues associated to a specific list of files (comma-separated list of file IDs). This parameter is mostly used by the Issues page, please prefer usage of the componentKeys parameter.
- *
* This is part of the internal API.
* Example value: "bdd82933-3070-4903-9188-7d8749e8bb92"
*/
}
/**
- * Comma-separated list of issue keys
- *
* Example value: "5bccd6e8-f525-43a2-8d76-fcb13dde79ef"
*/
public SearchRequest setIssues(List<String> issues) {
}
/**
- * Comma-separated list of languages. Available since 4.4
- *
* Example value: "java,js"
*/
public SearchRequest setLanguages(List<String> languages) {
}
/**
- * To retrieve issues associated to a specific list of modules (comma-separated list of module IDs). This parameter is mostly used by the Issues page, please prefer usage of the componentKeys parameter.
- *
* This is part of the internal API.
* Example value: "7d8749e8-3070-4903-9188-bdd82933bb92"
*/
}
/**
- * Return only issues at a component's level, not on its descendants (modules, directories, files, etc). This parameter is only considered when componentKeys or componentUuids is set. Using the deprecated componentRoots or componentRootUuids parameters will set this parameter to false. Using the deprecated components parameter will set this parameter to true.
- *
* Possible values:
* <ul>
* <li>"true"</li>
}
/**
- * Organization key
- *
* This is part of the internal API.
* Example value: "my-org"
*/
}
/**
- * 1-based page number
- *
* Example value: "42"
*/
public SearchRequest setP(String p) {
}
/**
- * To retrieve issues associated to a specific list of projects (comma-separated list of project IDs). This parameter is mostly used by the Issues page, please prefer usage of the componentKeys parameter. Portfolios are not supported. If this parameter is set, 'projects' must not be set.
- *
* This is part of the internal API.
* Example value: "7d8749e8-3070-4903-9188-bdd82933bb92"
*/
}
/**
- * To retrieve issues associated to a specific list of projects (comma-separated list of project keys). This parameter is mostly used by the Issues page, please prefer usage of the componentKeys parameter. If this parameter is set, projectUuids must not be set.
- *
* This is part of the internal API.
* Example value: "my_project"
*/
}
/**
- * Page size. Must be greater than 0 and less than 500
- *
* Example value: "20"
*/
public SearchRequest setPs(String ps) {
}
/**
- * Comma-separated list of resolutions
- *
* Example value: "FIXED,REMOVED"
* Possible values:
* <ul>
}
/**
- * To match resolved or unresolved issues
- *
* Possible values:
* <ul>
* <li>"true"</li>
}
/**
- * Comma-separated list of coding rule keys. Format is <repository>:<rule>
- *
* Example value: "squid:AvoidCycles"
*/
public SearchRequest setRules(List<String> rules) {
}
/**
- * Sort field
- *
* Possible values:
* <ul>
* <li>"CREATION_DATE"</li>
}
/**
- * Comma-separated list of severities
- *
* Example value: "BLOCKER,CRITICAL"
* Possible values:
* <ul>
}
/**
- * To retrieve issues created since the leak period.<br>If this parameter is set to a truthy value, createdAfter must not be set and one component id or key must be provided.
- *
* Possible values:
* <ul>
* <li>"true"</li>
}
/**
- * Comma-separated list of statuses
- *
* Example value: "OPEN,REOPENED"
* Possible values:
* <ul>
}
/**
- * Comma-separated list of tags.
- *
* Example value: "security,convention"
*/
public SearchRequest setTags(List<String> tags) {
}
/**
- * Comma-separated list of types.
- *
* Example value: "CODE_SMELL,BUG"
* Possible values:
* <ul>
*/
package org.sonarqube.ws.client.issues;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Change severity.<br/>Requires the following permissions:<ul> <li>'Authentication'</li> <li>'Browse' rights on project of the specified issue</li> <li>'Administer Issues' rights on project of the specified issue</li></ul>
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/issues/set_severity">Further information about this action online (including a response example)</a>
private String severity;
/**
- * Issue key
- *
* This is a mandatory parameter.
* Example value: "AU-Tpxb--iU5OvuD2FLy"
*/
}
/**
- * New severity
- *
* This is a mandatory parameter.
* Possible values:
* <ul>
import javax.annotation.Generated;
/**
- * Set tags on an issue. <br/>Requires authentication and Browse permission on project
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/issues/set_tags">Further information about this action online (including a response example)</a>
private List<String> tags;
/**
- * Issue key
- *
* This is a mandatory parameter.
* Example value: "AU-Tpxb--iU5OvuD2FLy"
*/
}
/**
- * Comma-separated list of tags. All tags are removed if parameter is empty or not set.
- *
* Example value: "security,cwe,misra-c"
*/
public SetTagsRequest setTags(List<String> tags) {
*/
package org.sonarqube.ws.client.issues;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Change type of issue, for instance from 'code smell' to 'bug'.<br/>Requires the following permissions:<ul> <li>'Authentication'</li> <li>'Browse' rights on project of the specified issue</li> <li>'Administer Issues' rights on project of the specified issue</li></ul>
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/issues/set_type">Further information about this action online (including a response example)</a>
private String type;
/**
- * Issue key
- *
* This is a mandatory parameter.
* Example value: "AU-Tpxb--iU5OvuD2FLy"
*/
}
/**
- * New type
- *
* This is a mandatory parameter.
* Possible values:
* <ul>
*/
package org.sonarqube.ws.client.issues;
+import java.util.List;
import javax.annotation.Generated;
/**
- * List tags matching a given query
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/issues/tags">Further information about this action online (including a response example)</a>
private String q;
/**
- * Organization key
- *
* This is part of the internal API.
* Example value: "my-org"
*/
}
/**
- * Page size. Must be greater than 0 and less than 100
- *
* Example value: "20"
*/
public TagsRequest setPs(String ps) {
}
/**
- * Limit search to tags that contain the supplied string.
- *
* Example value: "misra"
*/
public TagsRequest setQ(String q) {
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
@ParametersAreNonnullByDefault
+@Generated("sonar-ws-generator")
package org.sonarqube.ws.client.issues;
import javax.annotation.ParametersAreNonnullByDefault;
+import javax.annotation.Generated;
*/
package org.sonarqube.ws.client.l10n;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Get all localization messages for a given locale
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/l10n/index">Further information about this action online (including a response example)</a>
private String ts;
/**
- * BCP47 language tag, used to override the browser Accept-Language header
- *
* Example value: "fr-CH"
*/
public IndexRequest setLocale(String locale) {
}
/**
- * Date of the last cache update.
- *
* Example value: "2014-06-04T09:31:42+0000"
*/
public IndexRequest setTs(String ts) {
*/
package org.sonarqube.ws.client.l10n;
+import java.util.stream.Collectors;
import javax.annotation.Generated;
import org.sonarqube.ws.MediaTypes;
import org.sonarqube.ws.client.BaseService;
import org.sonarqube.ws.client.GetRequest;
+import org.sonarqube.ws.client.PostRequest;
import org.sonarqube.ws.client.WsConnector;
/**
- * Manage localization.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/l10n">Further information about this web service online</a>
*/
@Generated("sonar-ws-generator")
}
/**
- * Get all localization messages for a given locale
*
* This is part of the internal API.
* This is a GET request.
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
@ParametersAreNonnullByDefault
+@Generated("sonar-ws-generator")
package org.sonarqube.ws.client.l10n;
import javax.annotation.ParametersAreNonnullByDefault;
+import javax.annotation.Generated;
*/
package org.sonarqube.ws.client.languages;
+import java.util.stream.Collectors;
import javax.annotation.Generated;
import org.sonarqube.ws.MediaTypes;
import org.sonarqube.ws.client.BaseService;
import org.sonarqube.ws.client.GetRequest;
+import org.sonarqube.ws.client.PostRequest;
import org.sonarqube.ws.client.WsConnector;
/**
- * Get the list of programming languages supported in this instance.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/languages">Further information about this web service online</a>
*/
@Generated("sonar-ws-generator")
}
/**
- * List supported programming languages
*
* This is part of the internal API.
* This is a GET request.
*/
package org.sonarqube.ws.client.languages;
+import java.util.List;
import javax.annotation.Generated;
/**
- * List supported programming languages
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/languages/list">Further information about this action online (including a response example)</a>
private String q;
/**
- * The size of the list to return, 0 for all languages
- *
* Example value: "25"
*/
public ListRequest setPs(String ps) {
}
/**
- * A pattern to match language keys/names against
- *
* Example value: "java"
*/
public ListRequest setQ(String q) {
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
@ParametersAreNonnullByDefault
+@Generated("sonar-ws-generator")
package org.sonarqube.ws.client.languages;
import javax.annotation.ParametersAreNonnullByDefault;
+import javax.annotation.Generated;
import javax.annotation.Generated;
/**
- * Return component with specified measures. The componentId or the component parameter must be provided.<br>Requires the following permission: 'Browse' on the project of specified component.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/measures/component">Further information about this action online (including a response example)</a>
private String metricKeys;
/**
- * Comma-separated list of additional fields that can be returned in the response.
- *
* Example value: "periods,metrics"
* Possible values:
* <ul>
}
/**
- * Branch key
- *
* This is part of the internal API.
* Example value: "feature/my_branch"
*/
}
/**
- * Component key
- *
* Example value: "my_project"
*/
public ComponentRequest setComponent(String component) {
}
/**
- * Component id
- *
* Example value: "AU-Tpxb--iU5OvuD2FLy"
* @deprecated since 6.6
*/
}
/**
- * Deprecated parameter, used previously with the Developer Cockpit plugin. No measures are returned if parameter is set.
- *
* @deprecated since 6.4
*/
@Deprecated
}
/**
- * Deprecated parameter, used previously with the Developer Cockpit plugin. No measures are returned if parameter is set.
- *
* @deprecated since 6.4
*/
@Deprecated
}
/**
- * Metric keys
- *
* This is a mandatory parameter.
* Example value: "ncloc,complexity,violations"
*/
import javax.annotation.Generated;
/**
- * Navigate through components based on the chosen strategy with specified measures. The baseComponentId or the component parameter must be provided.<br>Requires the following permission: 'Browse' on the specified project.<br>When limiting search with the q parameter, directories are not returned.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/measures/component_tree">Further information about this action online (including a response example)</a>
private String strategy;
/**
- * Comma-separated list of additional fields that can be returned in the response.
- *
* Example value: "periods,metrics"
* Possible values:
* <ul>
}
/**
- * Ascending sort
- *
* Possible values:
* <ul>
* <li>"true"</li>
}
/**
- * Base component id. The search is based on this component.
- *
* Example value: "AU-TpxcA-iU5OvuD2FLz"
* @deprecated since 6.6
*/
}
/**
- * Branch key
- *
* This is part of the internal API.
* Example value: "feature/my_branch"
*/
}
/**
- * Component key. The search is based on this component.
- *
* Example value: "my_project"
*/
public ComponentTreeRequest setComponent(String component) {
}
/**
- * Deprecated parameter, used previously with the Developer Cockpit plugin. No measures are returned if parameter is set.
- *
* @deprecated since 6.4
*/
@Deprecated
}
/**
- * Deprecated parameter, used previously with the Developer Cockpit plugin. No measures are returned if parameter is set.
- *
* @deprecated since 6.4
*/
@Deprecated
}
/**
- * Metric keys. Types DISTRIB, DATA are not allowed
- *
* This is a mandatory parameter.
* Example value: "ncloc,complexity,violations"
*/
}
/**
- * Sort measures by leak period or not ?. The 's' parameter must contain the 'metricPeriod' value.
- *
* Possible values:
* <ul>
* <li>"1"</li>
}
/**
- * Metric key to sort by. The 's' parameter must contain the 'metric' or 'metricPeriod' value. It must be part of the 'metricKeys' parameter
- *
* Example value: "ncloc"
*/
public ComponentTreeRequest setMetricSort(String metricSort) {
}
/**
- * Filter components. Sort must be on a metric. Possible values are: <ul><li>all: return all components</li><li>withMeasuresOnly: filter out components that do not have a measure on the sorted metric</li></ul>
- *
* Possible values:
* <ul>
* <li>"all"</li>
}
/**
- * 1-based page number
- *
* Example value: "42"
*/
public ComponentTreeRequest setP(String p) {
}
/**
- * Page size. Must be greater than 0 and less than 500
- *
* Example value: "20"
*/
public ComponentTreeRequest setPs(String ps) {
}
/**
- * Limit search to: <ul><li>component names that contain the supplied string</li><li>component keys that are exactly the same as the supplied string</li></ul>
- *
* Example value: "FILE_NAM"
*/
public ComponentTreeRequest setQ(String q) {
}
/**
- * Comma-separated list of component qualifiers. Filter the results with the specified qualifiers. Possible values are:<ul><li>BRC - Sub-projects</li><li>DIR - Directories</li><li>FIL - Files</li><li>TRK - Projects</li><li>UTS - Test Files</li></ul>
- *
* Possible values:
* <ul>
* <li>"BRC"</li>
}
/**
- * Comma-separated list of sort fields
- *
* Example value: "name,path"
* Possible values:
* <ul>
}
/**
- * Strategy to search for base component descendants:<ul><li>children: return the children components of the base component. Grandchildren components are not returned</li><li>all: return all the descendants components of the base component. Grandchildren are returned.</li><li>leaves: return all the descendant components (files, in general) which don't have other children. They are the leaves of the component tree.</li></ul>
- *
* Possible values:
* <ul>
* <li>"all"</li>
import java.util.stream.Collectors;
import javax.annotation.Generated;
+import org.sonarqube.ws.MediaTypes;
import org.sonarqube.ws.client.BaseService;
import org.sonarqube.ws.client.GetRequest;
+import org.sonarqube.ws.client.PostRequest;
import org.sonarqube.ws.client.WsConnector;
import org.sonarqube.ws.Measures.ComponentWsResponse;
import org.sonarqube.ws.Measures.ComponentTreeWsResponse;
import org.sonarqube.ws.Measures.SearchHistoryResponse;
/**
- * Get components or children with specified measures.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/measures">Further information about this web service online</a>
*/
@Generated("sonar-ws-generator")
}
/**
- * Return component with specified measures. The componentId or the component parameter must be provided.<br>Requires the following permission: 'Browse' on the project of specified component.
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * Navigate through components based on the chosen strategy with specified measures. The baseComponentId or the component parameter must be provided.<br>Requires the following permission: 'Browse' on the specified project.<br>When limiting search with the q parameter, directories are not returned.
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * Search for project measures ordered by project names.<br>At most 100 projects can be provided.<br>Returns the projects with the 'Browse' permission.
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * Search measures history of a component.<br>Measures are ordered chronologically.<br>Pagination applies to the number of measures for each metric.<br>Requires the following permission: 'Browse' on the specified component
*
* This is part of the internal API.
* This is a GET request.
import javax.annotation.Generated;
/**
- * Search measures history of a component.<br>Measures are ordered chronologically.<br>Pagination applies to the number of measures for each metric.<br>Requires the following permission: 'Browse' on the specified component
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/measures/search_history">Further information about this action online (including a response example)</a>
private String to;
/**
- * Branch key
- *
* This is part of the internal API.
* Example value: "feature/my_branch"
*/
}
/**
- * Component key
- *
* This is a mandatory parameter.
* Example value: "my_project"
*/
}
/**
- * Filter measures created after the given date (inclusive). <br>Either a date (server timezone) or datetime can be provided
- *
* Example value: "2017-10-19 or 2017-10-19T13:00:00+0200"
*/
public SearchHistoryRequest setFrom(String from) {
}
/**
- * Comma-separated list of metric keys
- *
* This is a mandatory parameter.
* Example value: "ncloc,coverage,new_violations"
*/
}
/**
- * 1-based page number
- *
* Example value: "42"
*/
public SearchHistoryRequest setP(String p) {
}
/**
- * Page size. Must be greater than 0 and less than 1000
- *
* Example value: "20"
*/
public SearchHistoryRequest setPs(String ps) {
}
/**
- * Filter measures created before the given date (inclusive). <br>Either a date (server timezone) or datetime can be provided
- *
* Example value: "2017-10-19 or 2017-10-19T13:00:00+0200"
*/
public SearchHistoryRequest setTo(String to) {
import javax.annotation.Generated;
/**
- * Search for project measures ordered by project names.<br>At most 100 projects can be provided.<br>Returns the projects with the 'Browse' permission.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/measures/search">Further information about this action online (including a response example)</a>
private List<String> projectKeys;
/**
- * Metric keys
- *
* This is a mandatory parameter.
* Example value: "ncloc,complexity,violations"
*/
}
/**
- * Comma-separated list of project, view or sub-view keys
- *
* This is a mandatory parameter.
* Example value: "my_project,another_project"
*/
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
@ParametersAreNonnullByDefault
+@Generated("sonar-ws-generator")
package org.sonarqube.ws.client.measures;
import javax.annotation.ParametersAreNonnullByDefault;
+import javax.annotation.Generated;
*/
package org.sonarqube.ws.client.metrics;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Create custom metric.<br /> Requires 'Administer System' permission.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/metrics/create">Further information about this action online (including a response example)</a>
private String type;
/**
- * Description
- *
* Example value: "Size of the team"
*/
public CreateRequest setDescription(String description) {
}
/**
- * Domain
- *
* Example value: "Tests"
*/
public CreateRequest setDomain(String domain) {
}
/**
- * Key
- *
* This is a mandatory parameter.
* Example value: "team_size"
*/
}
/**
- * Name
- *
* This is a mandatory parameter.
* Example value: "Team Size"
*/
}
/**
- * Metric type key
- *
* This is a mandatory parameter.
* Example value: "INT"
* Possible values:
*/
package org.sonarqube.ws.client.metrics;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Delete metrics and associated measures. Delete only custom metrics.<br />Ids or keys must be provided. <br />Requires 'Administer System' permission.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/metrics/delete">Further information about this action online (including a response example)</a>
public class DeleteRequest {
private String ids;
- private String keys;
+ private List<String> keys;
/**
- * Metrics ids to delete.
- *
* Example value: "5, 23, 42"
*/
public DeleteRequest setIds(String ids) {
}
/**
- * Metrics keys to delete
- *
* Example value: "team_size, business_value"
*/
- public DeleteRequest setKeys(String keys) {
+ public DeleteRequest setKeys(List<String> keys) {
this.keys = keys;
return this;
}
- public String getKeys() {
+ public List<String> getKeys() {
return keys;
}
}
import org.sonarqube.ws.client.WsConnector;
/**
- * Get information on automatic metrics, and manage custom metrics. See also api/custom_measures.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/metrics">Further information about this web service online</a>
*/
@Generated("sonar-ws-generator")
}
/**
- * Create custom metric.<br /> Requires 'Administer System' permission.
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * Delete metrics and associated measures. Delete only custom metrics.<br />Ids or keys must be provided. <br />Requires 'Administer System' permission.
*
* This is part of the internal API.
* This is a POST request.
call(
new PostRequest(path("delete"))
.setParam("ids", request.getIds())
- .setParam("keys", request.getKeys())
+ .setParam("keys", request.getKeys() == null ? null : request.getKeys().stream().collect(Collectors.joining(",")))
.setMediaType(MediaTypes.JSON)
).content();
}
/**
- * List all custom metric domains.
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * Search for metrics
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * List all available metric types.
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * Update a custom metric.<br /> Requires 'Administer System' permission.
*
* This is part of the internal API.
* This is a POST request.
import javax.annotation.Generated;
/**
- * Search for metrics
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/metrics/search">Further information about this action online (including a response example)</a>
private String ps;
/**
- * Comma-separated list of the fields to be returned in response. All the fields are returned by default.
- *
* Possible values:
* <ul>
* <li>"name"</li>
}
/**
- * Choose custom metrics following 3 cases:<ul><li>true: only custom metrics are returned</li><li>false: only non custom metrics are returned</li><li>not specified: all metrics are returned</li></ul>
- *
* Example value: "true"
*/
public SearchRequest setIsCustom(String isCustom) {
}
/**
- * 1-based page number
- *
* Example value: "42"
*/
public SearchRequest setP(String p) {
}
/**
- * Page size. Must be greater than 0 and less than 500
- *
* Example value: "20"
*/
public SearchRequest setPs(String ps) {
*/
package org.sonarqube.ws.client.metrics;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Update a custom metric.<br /> Requires 'Administer System' permission.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/metrics/update">Further information about this action online (including a response example)</a>
private String type;
/**
- * Description
- *
* Example value: "Size of the team"
*/
public UpdateRequest setDescription(String description) {
}
/**
- * Domain
- *
* Example value: "Tests"
*/
public UpdateRequest setDomain(String domain) {
}
/**
- * Id of the custom metric to update
- *
* This is a mandatory parameter.
* Example value: "42"
*/
}
/**
- * Key
- *
* Example value: "team_size"
*/
public UpdateRequest setKey(String key) {
}
/**
- * Name
- *
*/
public UpdateRequest setName(String name) {
this.name = name;
}
/**
- * Metric type key
- *
* Example value: "INT"
* Possible values:
* <ul>
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
@ParametersAreNonnullByDefault
+@Generated("sonar-ws-generator")
package org.sonarqube.ws.client.metrics;
import javax.annotation.ParametersAreNonnullByDefault;
+import javax.annotation.Generated;
*/
package org.sonarqube.ws.client.navigation;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Get information concerning component navigation for the current user. Requires the 'Browse' permission on the component's project.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/navigation/component">Further information about this action online (including a response example)</a>
private String component;
/**
- * Branch key
- *
* This is part of the internal API.
* Example value: "feature/my_branch"
*/
}
/**
- * A component key.
- *
* Example value: "my_project"
*/
public ComponentRequest setComponent(String component) {
*/
package org.sonarqube.ws.client.navigation;
+import java.util.stream.Collectors;
import javax.annotation.Generated;
import org.sonarqube.ws.MediaTypes;
import org.sonarqube.ws.client.BaseService;
import org.sonarqube.ws.client.GetRequest;
+import org.sonarqube.ws.client.PostRequest;
import org.sonarqube.ws.client.WsConnector;
/**
- * Get information required to build navigation UI components
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/navigation">Further information about this web service online</a>
*/
@Generated("sonar-ws-generator")
}
/**
- * Get information concerning component navigation for the current user. Requires the 'Browse' permission on the component's project.
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * Get information concerning global navigation for the current user.
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * Get information concerning organization navigation for the current user
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * Get configuration information for the settings page:<ul> <li>List plugin-contributed pages</li> <li>Show update center (or not)</li></ul>
*
* This is part of the internal API.
* This is a GET request.
*/
package org.sonarqube.ws.client.navigation;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Get information concerning organization navigation for the current user
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/navigation/organization">Further information about this action online (including a response example)</a>
private String organization;
/**
- * the organization key
- *
* This is a mandatory parameter.
* Example value: "my-org"
*/
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
@ParametersAreNonnullByDefault
+@Generated("sonar-ws-generator")
package org.sonarqube.ws.client.navigation;
import javax.annotation.ParametersAreNonnullByDefault;
+import javax.annotation.Generated;
*/
package org.sonarqube.ws.client.notifications;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Add a notification for the authenticated user.<br>Requires one of the following permissions:<ul> <li>Authentication if no login is provided. If a project is provided, requires the 'Browse' permission on the specified project.</li> <li>System administration if a login is provided. If a project is provided, requires the 'Browse' permission on the specified project.</li></ul>
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/notifications/add">Further information about this action online (including a response example)</a>
private String type;
/**
- * Channel through which the notification is sent. For example, notifications can be sent by email.
- *
* Possible values:
* <ul>
* <li>"EmailNotificationChannel"</li>
}
/**
- * User login
- *
*/
public AddRequest setLogin(String login) {
this.login = login;
}
/**
- * Project key
- *
* Example value: "my_project"
*/
public AddRequest setProject(String project) {
}
/**
- * Notification type. Possible values are for:<ul> <li>Global notifications: CeReportTaskFailure, ChangesOnMyIssue, NewAlerts, NewFalsePositiveIssue, NewIssues, SQ-MyNewIssues</li> <li>Per project notifications: CeReportTaskFailure, ChangesOnMyIssue, NewAlerts, NewFalsePositiveIssue, NewIssues, SQ-MyNewIssues</li></ul>
- *
* This is a mandatory parameter.
* Example value: "SQ-MyNewIssues"
*/
*/
package org.sonarqube.ws.client.notifications;
+import java.util.List;
import javax.annotation.Generated;
/**
- * List notifications of the authenticated user.<br>Requires one of the following permissions:<ul> <li>Authentication if no login is provided</li> <li>System administration if a login is provided</li></ul>
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/notifications/list">Further information about this action online (including a response example)</a>
private String login;
/**
- * User login
- *
*/
public ListRequest setLogin(String login) {
this.login = login;
*/
package org.sonarqube.ws.client.notifications;
+import java.util.stream.Collectors;
import javax.annotation.Generated;
import org.sonarqube.ws.MediaTypes;
import org.sonarqube.ws.client.BaseService;
import org.sonarqube.ws.Notifications.ListResponse;
/**
- * Manage notifications of the authenticated user
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/notifications">Further information about this web service online</a>
*/
@Generated("sonar-ws-generator")
}
/**
- * Add a notification for the authenticated user.<br>Requires one of the following permissions:<ul> <li>Authentication if no login is provided. If a project is provided, requires the 'Browse' permission on the specified project.</li> <li>System administration if a login is provided. If a project is provided, requires the 'Browse' permission on the specified project.</li></ul>
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * List notifications of the authenticated user.<br>Requires one of the following permissions:<ul> <li>Authentication if no login is provided</li> <li>System administration if a login is provided</li></ul>
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * Remove a notification for the authenticated user.<br>Requires one of the following permissions:<ul> <li>Authentication if no login is provided</li> <li>System administration if a login is provided</li></ul>
*
* This is part of the internal API.
* This is a POST request.
*/
package org.sonarqube.ws.client.notifications;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Remove a notification for the authenticated user.<br>Requires one of the following permissions:<ul> <li>Authentication if no login is provided</li> <li>System administration if a login is provided</li></ul>
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/notifications/remove">Further information about this action online (including a response example)</a>
private String type;
/**
- * Channel through which the notification is sent. For example, notifications can be sent by email.
- *
* Possible values:
* <ul>
* <li>"EmailNotificationChannel"</li>
}
/**
- * User login
- *
*/
public RemoveRequest setLogin(String login) {
this.login = login;
}
/**
- * Project key
- *
* Example value: "my_project"
*/
public RemoveRequest setProject(String project) {
}
/**
- * Notification type. Possible values are for:<ul> <li>Global notifications: CeReportTaskFailure, ChangesOnMyIssue, NewAlerts, NewFalsePositiveIssue, NewIssues, SQ-MyNewIssues</li> <li>Per project notifications: CeReportTaskFailure, ChangesOnMyIssue, NewAlerts, NewFalsePositiveIssue, NewIssues, SQ-MyNewIssues</li></ul>
- *
* This is a mandatory parameter.
* Example value: "SQ-MyNewIssues"
*/
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
@ParametersAreNonnullByDefault
+@Generated("sonar-ws-generator")
package org.sonarqube.ws.client.notifications;
import javax.annotation.ParametersAreNonnullByDefault;
+import javax.annotation.Generated;
*/
package org.sonarqube.ws.client.organizations;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Add a user as a member of an organization.<br>Requires 'Administer System' permission on the specified organization.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/organizations/add_member">Further information about this action online (including a response example)</a>
private String organization;
/**
- * User login
- *
* This is a mandatory parameter.
* Example value: "ray.bradbury"
*/
}
/**
- * Organization key
- *
* This is a mandatory parameter.
* Example value: "my-org"
*/
*/
package org.sonarqube.ws.client.organizations;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Create an organization.<br />Requires 'Administer System' permission unless any logged in user is allowed to create an organization (see appropriate setting). Organization support must be enabled.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/organizations/create">Further information about this action online (including a response example)</a>
private String url;
/**
- * URL of the organization avatar.<br/> It must be less than 256 chars long.
- *
* Example value: "https://www.foo.com/foo.png"
*/
public CreateRequest setAvatar(String avatar) {
}
/**
- * Description of the organization.<br/> It must be less than 256 chars long.
- *
* Example value: "The Foo company produces quality software for Bar."
*/
public CreateRequest setDescription(String description) {
}
/**
- * Key of the organization. <br />The key is unique to the whole SonarQube. <br/>When not specified, the key is computed from the name. <br />Otherwise, it must be between 2 and 32 chars long. All chars must be lower-case letters (a to z), digits or dash (but dash can neither be trailing nor heading)
- *
* Example value: "foo-company"
*/
public CreateRequest setKey(String key) {
}
/**
- * Name of the organization. <br />It must be between 2 and 64 chars longs.
- *
* This is a mandatory parameter.
* Example value: "Foo Company"
*/
}
/**
- * URL of the organization.<br/> It must be less than 256 chars long.
- *
* Example value: "https://www.foo.com"
*/
public CreateRequest setUrl(String url) {
*/
package org.sonarqube.ws.client.organizations;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Delete an organization.<br/>Require 'Administer System' permission on the specified organization. Organization support must be enabled.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/organizations/delete">Further information about this action online (including a response example)</a>
private String organization;
/**
- * Organization key
- *
* This is a mandatory parameter.
* Example value: "foo-company"
*/
import org.sonarqube.ws.Organizations.UpdateWsResponse;
/**
- * Manage organizations.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/organizations">Further information about this web service online</a>
*/
@Generated("sonar-ws-generator")
}
/**
- * Add a user as a member of an organization.<br>Requires 'Administer System' permission on the specified organization.
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * Create an organization.<br />Requires 'Administer System' permission unless any logged in user is allowed to create an organization (see appropriate setting). Organization support must be enabled.
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * Delete an organization.<br/>Require 'Administer System' permission on the specified organization. Organization support must be enabled.
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * Enable support of organizations.<br />'Administer System' permission is required. The logged-in user will be flagged as root and will be able to manage organizations and other root users.
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * Remove a member from an organization.<br>Requires 'Administer System' permission on the specified organization.
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * Search for organizations
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * Search members of an organization
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * List keys of the organizations for which the currently authenticated user has the System Administer permission for.
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * Update an organization.<br/>Require 'Administer System' permission. Organization support must be enabled.
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * Update the default visibility for new projects of the specified organization.
*
* This is part of the internal API.
* This is a POST request.
*/
package org.sonarqube.ws.client.organizations;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Remove a member from an organization.<br>Requires 'Administer System' permission on the specified organization.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/organizations/remove_member">Further information about this action online (including a response example)</a>
private String organization;
/**
- * User login
- *
* This is a mandatory parameter.
* Example value: "ray.bradbury"
*/
}
/**
- * Organization key
- *
* This is a mandatory parameter.
* Example value: "my-org"
*/
*/
package org.sonarqube.ws.client.organizations;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Search members of an organization
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/organizations/search_members">Further information about this action online (including a response example)</a>
private String selected;
/**
- * Organization key
- *
* This is part of the internal API.
*/
public SearchMembersRequest setOrganization(String organization) {
}
/**
- * 1-based page number
- *
* Example value: "42"
*/
public SearchMembersRequest setP(String p) {
}
/**
- * Page size. Must be greater than 0 and less than 500
- *
* Example value: "20"
*/
public SearchMembersRequest setPs(String ps) {
}
/**
- * Limit search to names or logins that contain the supplied string.
- *
* Example value: "orwe"
*/
public SearchMembersRequest setQ(String q) {
}
/**
- * Depending on the value, show only selected items (selected=selected) or deselected items (selected=deselected).
- *
* This is part of the internal API.
* Possible values:
* <ul>
import javax.annotation.Generated;
/**
- * Search for organizations
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/organizations/search">Further information about this action online (including a response example)</a>
}
/**
- * Comma-separated list of organization keys
- *
* Example value: "my-org-1,foocorp"
*/
public SearchRequest setOrganizations(List<String> organizations) {
}
/**
- * 1-based page number
- *
* Example value: "42"
*/
public SearchRequest setP(String p) {
}
/**
- * Page size. Must be greater than 0 and less than 500
- *
* Example value: "20"
*/
public SearchRequest setPs(String ps) {
*/
package org.sonarqube.ws.client.organizations;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Update the default visibility for new projects of the specified organization.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/organizations/update_project_visibility">Further information about this action online (including a response example)</a>
private String projectVisibility;
/**
- * Organization key
- *
* This is a mandatory parameter.
* Example value: "foo-company"
*/
}
/**
- * Default visibility for projects
- *
* This is a mandatory parameter.
* Possible values:
* <ul>
*/
package org.sonarqube.ws.client.organizations;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Update an organization.<br/>Require 'Administer System' permission. Organization support must be enabled.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/organizations/update">Further information about this action online (including a response example)</a>
private String url;
/**
- * URL of the organization avatar.<br/> It must be less than 256 chars long.
- *
* Example value: "https://www.foo.com/foo.png"
*/
public UpdateRequest setAvatar(String avatar) {
}
/**
- * Description of the organization.<br/> It must be less than 256 chars long.
- *
* Example value: "The Foo company produces quality software for Bar."
*/
public UpdateRequest setDescription(String description) {
}
/**
- * Organization key
- *
* This is a mandatory parameter.
* Example value: "foo-company"
*/
}
/**
- * Name of the organization. <br />It must be between 2 and 64 chars longs.
- *
* Example value: "Foo Company"
*/
public UpdateRequest setName(String name) {
}
/**
- * URL of the organization.<br/> It must be less than 256 chars long.
- *
* Example value: "https://www.foo.com"
*/
public UpdateRequest setUrl(String url) {
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
@ParametersAreNonnullByDefault
+@Generated("sonar-ws-generator")
package org.sonarqube.ws.client.organizations;
import javax.annotation.ParametersAreNonnullByDefault;
+import javax.annotation.Generated;
*/
package org.sonarqube.ws.client.permissions;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Add permission to a group.<br /> This service defaults to global permissions, but can be limited to project permissions by providing project id or project key.<br /> The group name or group id must be provided. <br />Requires one of the following permissions:<ul><li>'Administer System'</li><li>'Administer' rights on the specified project</li></ul>
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/permissions/add_group">Further information about this action online (including a response example)</a>
private String projectKey;
/**
- * Group id
- *
* Example value: "42"
*/
public AddGroupRequest setGroupId(String groupId) {
}
/**
- * Group name or 'anyone' (case insensitive)
- *
* Example value: "sonar-administrators"
*/
public AddGroupRequest setGroupName(String groupName) {
}
/**
- * Key of organization, used when group name is set
- *
* This is part of the internal API.
* Example value: "my-org"
*/
}
/**
- * Permission<ul><li>Possible values for global permissions: admin, profileadmin, gateadmin, scan, provisioning</li><li>Possible values for project permissions admin, codeviewer, issueadmin, scan, user</li></ul>
- *
* This is a mandatory parameter.
*/
public AddGroupRequest setPermission(String permission) {
}
/**
- * Project id
- *
* Example value: "ce4c03d6-430f-40a9-b777-ad877c00aa4d"
*/
public AddGroupRequest setProjectId(String projectId) {
}
/**
- * Project key
- *
* Example value: "my_project"
*/
public AddGroupRequest setProjectKey(String projectKey) {
*/
package org.sonarqube.ws.client.permissions;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Add a group to a permission template.<br /> The group id or group name must be provided. <br />Requires the following permission: 'Administer System'.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/permissions/add_group_to_template">Further information about this action online (including a response example)</a>
private String templateName;
/**
- * Group id
- *
* Example value: "42"
*/
public AddGroupToTemplateRequest setGroupId(String groupId) {
}
/**
- * Group name or 'anyone' (case insensitive)
- *
* Example value: "sonar-administrators"
*/
public AddGroupToTemplateRequest setGroupName(String groupName) {
}
/**
- * Key of organization, used when group name is set
- *
* This is part of the internal API.
* Example value: "my-org"
*/
}
/**
- * Permission<ul><li>Possible values for project permissions admin, codeviewer, issueadmin, scan, user</li></ul>
- *
* This is a mandatory parameter.
* Possible values:
* <ul>
}
/**
- * Template id
- *
* Example value: "AU-Tpxb--iU5OvuD2FLy"
*/
public AddGroupToTemplateRequest setTemplateId(String templateId) {
}
/**
- * Template name
- *
* Example value: "Default Permission Template for Projects"
*/
public AddGroupToTemplateRequest setTemplateName(String templateName) {
*/
package org.sonarqube.ws.client.permissions;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Add a project creator to a permission template.<br>Requires the following permission: 'Administer System'.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/permissions/add_project_creator_to_template">Further information about this action online (including a response example)</a>
private String templateName;
/**
- * Key of organization, used when group name is set
- *
* This is part of the internal API.
* Example value: "my-org"
*/
}
/**
- * Permission<ul><li>Possible values for project permissions admin, codeviewer, issueadmin, scan, user</li></ul>
- *
* This is a mandatory parameter.
* Possible values:
* <ul>
}
/**
- * Template id
- *
* Example value: "AU-Tpxb--iU5OvuD2FLy"
*/
public AddProjectCreatorToTemplateRequest setTemplateId(String templateId) {
}
/**
- * Template name
- *
* Example value: "Default Permission Template for Projects"
*/
public AddProjectCreatorToTemplateRequest setTemplateName(String templateName) {
*/
package org.sonarqube.ws.client.permissions;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Add permission to a user.<br /> This service defaults to global permissions, but can be limited to project permissions by providing project id or project key.<br />Requires one of the following permissions:<ul><li>'Administer System'</li><li>'Administer' rights on the specified project</li></ul>
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/permissions/add_user">Further information about this action online (including a response example)</a>
private String projectKey;
/**
- * User login
- *
* This is a mandatory parameter.
* Example value: "g.hopper"
*/
}
/**
- * Key of organization, cannot be used at the same time with projectId and projectKey
- *
* This is part of the internal API.
* Example value: "my-org"
*/
}
/**
- * Permission<ul><li>Possible values for global permissions: admin, profileadmin, gateadmin, scan, provisioning</li><li>Possible values for project permissions admin, codeviewer, issueadmin, scan, user</li></ul>
- *
* This is a mandatory parameter.
*/
public AddUserRequest setPermission(String permission) {
}
/**
- * Project id
- *
* Example value: "ce4c03d6-430f-40a9-b777-ad877c00aa4d"
*/
public AddUserRequest setProjectId(String projectId) {
}
/**
- * Project key
- *
* Example value: "my_project"
*/
public AddUserRequest setProjectKey(String projectKey) {
*/
package org.sonarqube.ws.client.permissions;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Add a user to a permission template.<br /> Requires the following permission: 'Administer System'.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/permissions/add_user_to_template">Further information about this action online (including a response example)</a>
private String templateName;
/**
- * User login
- *
* This is a mandatory parameter.
* Example value: "g.hopper"
*/
}
/**
- * Key of organization, used when group name is set
- *
* This is part of the internal API.
* Example value: "my-org"
*/
}
/**
- * Permission<ul><li>Possible values for project permissions admin, codeviewer, issueadmin, scan, user</li></ul>
- *
* This is a mandatory parameter.
* Possible values:
* <ul>
}
/**
- * Template id
- *
* Example value: "AU-Tpxb--iU5OvuD2FLy"
*/
public AddUserToTemplateRequest setTemplateId(String templateId) {
}
/**
- * Template name
- *
* Example value: "Default Permission Template for Projects"
*/
public AddUserToTemplateRequest setTemplateName(String templateName) {
*/
package org.sonarqube.ws.client.permissions;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Apply a permission template to one project.<br>The project id or project key must be provided.<br>The template id or name must be provided.<br>Requires the following permission: 'Administer System'.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/permissions/apply_template">Further information about this action online (including a response example)</a>
private String templateName;
/**
- * Key of organization, used when group name is set
- *
* This is part of the internal API.
* Example value: "my-org"
*/
}
/**
- * Project id
- *
* Example value: "ce4c03d6-430f-40a9-b777-ad877c00aa4d"
*/
public ApplyTemplateRequest setProjectId(String projectId) {
}
/**
- * Project key
- *
* Example value: "my_project"
*/
public ApplyTemplateRequest setProjectKey(String projectKey) {
}
/**
- * Template id
- *
* Example value: "AU-Tpxb--iU5OvuD2FLy"
*/
public ApplyTemplateRequest setTemplateId(String templateId) {
}
/**
- * Template name
- *
* Example value: "Default Permission Template for Projects"
*/
public ApplyTemplateRequest setTemplateName(String templateName) {
import javax.annotation.Generated;
/**
- * Apply a permission template to several projects.<br />The template id or name must be provided.<br />Requires the following permission: 'Administer System'.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/permissions/bulk_apply_template">Further information about this action online (including a response example)</a>
private String visibility;
/**
- * Filter the projects for which last analysis is older than the given date (exclusive).<br> Either a date (server timezone) or datetime can be provided.
- *
* Example value: "2017-10-19 or 2017-10-19T13:00:00+0200"
*/
public BulkApplyTemplateRequest setAnalyzedBefore(String analyzedBefore) {
}
/**
- * Filter the projects that are provisioned
- *
* Possible values:
* <ul>
* <li>"true"</li>
}
/**
- * Key of organization, used when group name is set
- *
* This is part of the internal API.
* Example value: "my-org"
*/
}
/**
- * Comma-separated list of project keys
- *
* Example value: "my_project,another_project"
*/
public BulkApplyTemplateRequest setProjects(List<String> projects) {
}
/**
- * Limit search to: <ul><li>project names that contain the supplied string</li><li>project keys that are exactly the same as the supplied string</li></ul>
- *
* Example value: "apac"
*/
public BulkApplyTemplateRequest setQ(String q) {
}
/**
- * Comma-separated list of component qualifiers. Filter the results with the specified qualifiers. Possible values are:<ul><li>TRK - Projects</li></ul>
- *
* Possible values:
* <ul>
* <li>"TRK"</li>
}
/**
- * Template id
- *
* Example value: "AU-Tpxb--iU5OvuD2FLy"
*/
public BulkApplyTemplateRequest setTemplateId(String templateId) {
}
/**
- * Template name
- *
* Example value: "Default Permission Template for Projects"
*/
public BulkApplyTemplateRequest setTemplateName(String templateName) {
}
/**
- * Filter the projects that should be visible to everyone (public), or only specific user/groups (private).<br/>If no visibility is specified, the default project visibility of the organization will be used.
- *
* This is part of the internal API.
* Possible values:
* <ul>
*/
package org.sonarqube.ws.client.permissions;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Create a permission template.<br />Requires the following permission: 'Administer System'.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/permissions/create_template">Further information about this action online (including a response example)</a>
private String projectKeyPattern;
/**
- * Description
- *
* Example value: "Permissions for all projects related to the financial service"
*/
public CreateTemplateRequest setDescription(String description) {
}
/**
- * Name
- *
* This is a mandatory parameter.
* Example value: "Financial Service Permissions"
*/
}
/**
- * Key of organization, used when group name is set
- *
* This is part of the internal API.
* Example value: "my-org"
*/
}
/**
- * Project key pattern. Must be a valid Java regular expression
- *
* Example value: ".*\\.finance\\..*"
*/
public CreateTemplateRequest setProjectKeyPattern(String projectKeyPattern) {
*/
package org.sonarqube.ws.client.permissions;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Delete a permission template.<br />Requires the following permission: 'Administer System'.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/permissions/delete_template">Further information about this action online (including a response example)</a>
private String templateName;
/**
- * Key of organization, used when group name is set
- *
* This is part of the internal API.
* Example value: "my-org"
*/
}
/**
- * Template id
- *
* Example value: "AU-Tpxb--iU5OvuD2FLy"
*/
public DeleteTemplateRequest setTemplateId(String templateId) {
}
/**
- * Template name
- *
* Example value: "Default Permission Template for Projects"
*/
public DeleteTemplateRequest setTemplateName(String templateName) {
*/
package org.sonarqube.ws.client.permissions;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Lists the groups with their permissions.<br>This service defaults to global permissions, but can be limited to project permissions by providing project id or project key.<br> This service defaults to all groups, but can be limited to groups with a specific permission by providing the desired permission.<br>Requires one of the following permissions:<ul><li>'Administer System'</li><li>'Administer' rights on the specified project</li></ul>
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/permissions/groups">Further information about this action online (including a response example)</a>
private String q;
/**
- * Key of organization, used when group name is set
- *
* This is part of the internal API.
* Example value: "my-org"
*/
}
/**
- * 1-based page number
- *
* Example value: "42"
*/
public GroupsRequest setP(String p) {
}
/**
- * Permission<ul><li>Possible values for global permissions: admin, profileadmin, gateadmin, scan, provisioning</li><li>Possible values for project permissions admin, codeviewer, issueadmin, scan, user</li></ul>
- *
*/
public GroupsRequest setPermission(String permission) {
this.permission = permission;
}
/**
- * Project id
- *
* Example value: "ce4c03d6-430f-40a9-b777-ad877c00aa4d"
*/
public GroupsRequest setProjectId(String projectId) {
}
/**
- * Project key
- *
* Example value: "my_project"
*/
public GroupsRequest setProjectKey(String projectKey) {
}
/**
- * Page size. Must be greater than 0 and less than 100
- *
* Example value: "20"
*/
public GroupsRequest setPs(String ps) {
}
/**
- * Limit search to group names that contain the supplied string. When this parameter is not set, only groups having at least one permission are returned.
- *
* Example value: "sonar"
*/
public GroupsRequest setQ(String q) {
import org.sonarqube.ws.Permissions.UsersWsResponse;
/**
- * Manage permission templates, and the granting and revoking of permissions at the global and project levels.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/permissions">Further information about this web service online</a>
*/
@Generated("sonar-ws-generator")
}
/**
- * Add permission to a group.<br /> This service defaults to global permissions, but can be limited to project permissions by providing project id or project key.<br /> The group name or group id must be provided. <br />Requires one of the following permissions:<ul><li>'Administer System'</li><li>'Administer' rights on the specified project</li></ul>
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * Add a group to a permission template.<br /> The group id or group name must be provided. <br />Requires the following permission: 'Administer System'.
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * Add a project creator to a permission template.<br>Requires the following permission: 'Administer System'.
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * Add permission to a user.<br /> This service defaults to global permissions, but can be limited to project permissions by providing project id or project key.<br />Requires one of the following permissions:<ul><li>'Administer System'</li><li>'Administer' rights on the specified project</li></ul>
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * Add a user to a permission template.<br /> Requires the following permission: 'Administer System'.
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * Apply a permission template to one project.<br>The project id or project key must be provided.<br>The template id or name must be provided.<br>Requires the following permission: 'Administer System'.
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * Apply a permission template to several projects.<br />The template id or name must be provided.<br />Requires the following permission: 'Administer System'.
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * Create a permission template.<br />Requires the following permission: 'Administer System'.
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * Delete a permission template.<br />Requires the following permission: 'Administer System'.
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * Lists the groups with their permissions.<br>This service defaults to global permissions, but can be limited to project permissions by providing project id or project key.<br> This service defaults to all groups, but can be limited to groups with a specific permission by providing the desired permission.<br>Requires one of the following permissions:<ul><li>'Administer System'</li><li>'Administer' rights on the specified project</li></ul>
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * Remove a permission from a group.<br /> This service defaults to global permissions, but can be limited to project permissions by providing project id or project key.<br /> The group id or group name must be provided, not both.<br />Requires one of the following permissions:<ul><li>'Administer System'</li><li>'Administer' rights on the specified project</li></ul>
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * Remove a group from a permission template.<br /> The group id or group name must be provided. <br />Requires the following permission: 'Administer System'.
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * Remove a project creator from a permission template.<br>Requires the following permission: 'Administer System'.
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * Remove permission from a user.<br /> This service defaults to global permissions, but can be limited to project permissions by providing project id or project key.<br /> Requires one of the following permissions:<ul><li>'Administer System'</li><li>'Administer' rights on the specified project</li></ul>
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * Remove a user from a permission template.<br /> Requires the following permission: 'Administer System'.
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * List global permissions. <br />Requires the following permission: 'Administer System'
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * List project permissions. A project can be a technical project, a view or a developer.<br />Requires one of the following permissions:<ul><li>'Administer System'</li><li>'Administer' rights on the specified project</li></ul>
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * List permission templates.<br />Requires the following permission: 'Administer System'.
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * Set a permission template as default.<br />Requires the following permission: 'Administer System'.
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * Lists the groups with their permission as individual groups rather than through user affiliation on the chosen template.<br />This service defaults to all groups, but can be limited to groups with a specific permission by providing the desired permission.<br>Requires the following permission: 'Administer System'.
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * Lists the users with their permission as individual users rather than through group affiliation on the chosen template. <br />This service defaults to all users, but can be limited to users with a specific permission by providing the desired permission.<br>Requires the following permission: 'Administer System'.
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * Update a permission template.<br />Requires the following permission: 'Administer System'.
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * Lists the users with their permissions as individual users rather than through group affiliation.<br>This service defaults to global permissions, but can be limited to project permissions by providing project id or project key.<br> This service defaults to all users, but can be limited to users with a specific permission by providing the desired permission.<br>Requires one of the following permissions:<ul><li>'Administer System'</li><li>'Administer' rights on the specified project</li></ul>
*
* This is part of the internal API.
* This is a GET request.
*/
package org.sonarqube.ws.client.permissions;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Remove a group from a permission template.<br /> The group id or group name must be provided. <br />Requires the following permission: 'Administer System'.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/permissions/remove_group_from_template">Further information about this action online (including a response example)</a>
private String templateName;
/**
- * Group id
- *
* Example value: "42"
*/
public RemoveGroupFromTemplateRequest setGroupId(String groupId) {
}
/**
- * Group name or 'anyone' (case insensitive)
- *
* Example value: "sonar-administrators"
*/
public RemoveGroupFromTemplateRequest setGroupName(String groupName) {
}
/**
- * Key of organization, used when group name is set
- *
* This is part of the internal API.
* Example value: "my-org"
*/
}
/**
- * Permission<ul><li>Possible values for project permissions admin, codeviewer, issueadmin, scan, user</li></ul>
- *
* This is a mandatory parameter.
* Possible values:
* <ul>
}
/**
- * Template id
- *
* Example value: "AU-Tpxb--iU5OvuD2FLy"
*/
public RemoveGroupFromTemplateRequest setTemplateId(String templateId) {
}
/**
- * Template name
- *
* Example value: "Default Permission Template for Projects"
*/
public RemoveGroupFromTemplateRequest setTemplateName(String templateName) {
*/
package org.sonarqube.ws.client.permissions;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Remove a permission from a group.<br /> This service defaults to global permissions, but can be limited to project permissions by providing project id or project key.<br /> The group id or group name must be provided, not both.<br />Requires one of the following permissions:<ul><li>'Administer System'</li><li>'Administer' rights on the specified project</li></ul>
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/permissions/remove_group">Further information about this action online (including a response example)</a>
private String projectKey;
/**
- * Group id
- *
* Example value: "42"
*/
public RemoveGroupRequest setGroupId(String groupId) {
}
/**
- * Group name or 'anyone' (case insensitive)
- *
* Example value: "sonar-administrators"
*/
public RemoveGroupRequest setGroupName(String groupName) {
}
/**
- * Key of organization, used when group name is set
- *
* This is part of the internal API.
* Example value: "my-org"
*/
}
/**
- * Permission<ul><li>Possible values for global permissions: admin, profileadmin, gateadmin, scan, provisioning</li><li>Possible values for project permissions admin, codeviewer, issueadmin, scan, user</li></ul>
- *
* This is a mandatory parameter.
*/
public RemoveGroupRequest setPermission(String permission) {
}
/**
- * Project id
- *
* Example value: "ce4c03d6-430f-40a9-b777-ad877c00aa4d"
*/
public RemoveGroupRequest setProjectId(String projectId) {
}
/**
- * Project key
- *
* Example value: "my_project"
*/
public RemoveGroupRequest setProjectKey(String projectKey) {
*/
package org.sonarqube.ws.client.permissions;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Remove a project creator from a permission template.<br>Requires the following permission: 'Administer System'.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/permissions/remove_project_creator_from_template">Further information about this action online (including a response example)</a>
private String templateName;
/**
- * Key of organization, used when group name is set
- *
* This is part of the internal API.
* Example value: "my-org"
*/
}
/**
- * Permission<ul><li>Possible values for project permissions admin, codeviewer, issueadmin, scan, user</li></ul>
- *
* This is a mandatory parameter.
* Possible values:
* <ul>
}
/**
- * Template id
- *
* Example value: "AU-Tpxb--iU5OvuD2FLy"
*/
public RemoveProjectCreatorFromTemplateRequest setTemplateId(String templateId) {
}
/**
- * Template name
- *
* Example value: "Default Permission Template for Projects"
*/
public RemoveProjectCreatorFromTemplateRequest setTemplateName(String templateName) {
*/
package org.sonarqube.ws.client.permissions;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Remove a user from a permission template.<br /> Requires the following permission: 'Administer System'.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/permissions/remove_user_from_template">Further information about this action online (including a response example)</a>
private String templateName;
/**
- * User login
- *
* This is a mandatory parameter.
* Example value: "g.hopper"
*/
}
/**
- * Key of organization, used when group name is set
- *
* This is part of the internal API.
* Example value: "my-org"
*/
}
/**
- * Permission<ul><li>Possible values for project permissions admin, codeviewer, issueadmin, scan, user</li></ul>
- *
* This is a mandatory parameter.
* Possible values:
* <ul>
}
/**
- * Template id
- *
* Example value: "AU-Tpxb--iU5OvuD2FLy"
*/
public RemoveUserFromTemplateRequest setTemplateId(String templateId) {
}
/**
- * Template name
- *
* Example value: "Default Permission Template for Projects"
*/
public RemoveUserFromTemplateRequest setTemplateName(String templateName) {
*/
package org.sonarqube.ws.client.permissions;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Remove permission from a user.<br /> This service defaults to global permissions, but can be limited to project permissions by providing project id or project key.<br /> Requires one of the following permissions:<ul><li>'Administer System'</li><li>'Administer' rights on the specified project</li></ul>
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/permissions/remove_user">Further information about this action online (including a response example)</a>
private String projectKey;
/**
- * User login
- *
* This is a mandatory parameter.
* Example value: "g.hopper"
*/
}
/**
- * Key of organization, used when group name is set
- *
* This is part of the internal API.
* Example value: "my-org"
*/
}
/**
- * Permission<ul><li>Possible values for global permissions: admin, profileadmin, gateadmin, scan, provisioning</li><li>Possible values for project permissions admin, codeviewer, issueadmin, scan, user</li></ul>
- *
* This is a mandatory parameter.
*/
public RemoveUserRequest setPermission(String permission) {
}
/**
- * Project id
- *
* Example value: "ce4c03d6-430f-40a9-b777-ad877c00aa4d"
*/
public RemoveUserRequest setProjectId(String projectId) {
}
/**
- * Project key
- *
* Example value: "my_project"
*/
public RemoveUserRequest setProjectKey(String projectKey) {
*/
package org.sonarqube.ws.client.permissions;
+import java.util.List;
import javax.annotation.Generated;
/**
- * List global permissions. <br />Requires the following permission: 'Administer System'
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/permissions/search_global_permissions">Further information about this action online (including a response example)</a>
private String organization;
/**
- * Key of organization, used when group name is set
- *
* This is part of the internal API.
* Example value: "my-org"
*/
*/
package org.sonarqube.ws.client.permissions;
+import java.util.List;
import javax.annotation.Generated;
/**
- * List project permissions. A project can be a technical project, a view or a developer.<br />Requires one of the following permissions:<ul><li>'Administer System'</li><li>'Administer' rights on the specified project</li></ul>
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/permissions/search_project_permissions">Further information about this action online (including a response example)</a>
private String qualifier;
/**
- * 1-based page number
- *
* Example value: "42"
*/
public SearchProjectPermissionsRequest setP(String p) {
}
/**
- * Project id
- *
* Example value: "ce4c03d6-430f-40a9-b777-ad877c00aa4d"
*/
public SearchProjectPermissionsRequest setProjectId(String projectId) {
}
/**
- * Project key
- *
* Example value: "my_project"
*/
public SearchProjectPermissionsRequest setProjectKey(String projectKey) {
}
/**
- * Page size. Must be greater than 0.
- *
* Example value: "20"
*/
public SearchProjectPermissionsRequest setPs(String ps) {
}
/**
- * Limit search to: <ul><li>project names that contain the supplied string</li><li>project keys that are exactly the same as the supplied string</li></ul>
- *
* Example value: "apac"
*/
public SearchProjectPermissionsRequest setQ(String q) {
}
/**
- * Project qualifier. Filter the results with the specified qualifier. Possible values are:<ul><li>TRK - Projects</li></ul>
- *
* Possible values:
* <ul>
* <li>"TRK"</li>
*/
package org.sonarqube.ws.client.permissions;
+import java.util.List;
import javax.annotation.Generated;
/**
- * List permission templates.<br />Requires the following permission: 'Administer System'.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/permissions/search_templates">Further information about this action online (including a response example)</a>
private String q;
/**
- * Key of organization, used when group name is set
- *
* This is part of the internal API.
* Example value: "my-org"
*/
}
/**
- * Limit search to permission template names that contain the supplied string.
- *
* Example value: "defau"
*/
public SearchTemplatesRequest setQ(String q) {
*/
package org.sonarqube.ws.client.permissions;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Set a permission template as default.<br />Requires the following permission: 'Administer System'.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/permissions/set_default_template">Further information about this action online (including a response example)</a>
private String templateName;
/**
- * Key of organization, used when group name is set
- *
* This is part of the internal API.
* Example value: "my-org"
*/
}
/**
- * Project qualifier. Filter the results with the specified qualifier. Possible values are:<ul><li>TRK - Projects</li></ul>
- *
* Possible values:
* <ul>
* <li>"TRK"</li>
}
/**
- * Template id
- *
* Example value: "AU-Tpxb--iU5OvuD2FLy"
*/
public SetDefaultTemplateRequest setTemplateId(String templateId) {
}
/**
- * Template name
- *
* Example value: "Default Permission Template for Projects"
*/
public SetDefaultTemplateRequest setTemplateName(String templateName) {
*/
package org.sonarqube.ws.client.permissions;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Lists the groups with their permission as individual groups rather than through user affiliation on the chosen template.<br />This service defaults to all groups, but can be limited to groups with a specific permission by providing the desired permission.<br>Requires the following permission: 'Administer System'.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/permissions/template_groups">Further information about this action online (including a response example)</a>
private String templateName;
/**
- * Key of organization, used when group name is set
- *
* This is part of the internal API.
* Example value: "my-org"
*/
}
/**
- * 1-based page number
- *
* Example value: "42"
*/
public TemplateGroupsRequest setP(String p) {
}
/**
- * Permission<ul><li>Possible values for project permissions admin, codeviewer, issueadmin, scan, user</li></ul>
- *
* This is a mandatory parameter.
* Possible values:
* <ul>
}
/**
- * Page size. Must be greater than 0 and less than 100
- *
* Example value: "20"
*/
public TemplateGroupsRequest setPs(String ps) {
}
/**
- * Limit search to group names that contain the supplied string. <br/>When this parameter is not set, only group having at least one permission are returned.
- *
* Example value: "eri"
*/
public TemplateGroupsRequest setQ(String q) {
}
/**
- * Template id
- *
* Example value: "AU-Tpxb--iU5OvuD2FLy"
*/
public TemplateGroupsRequest setTemplateId(String templateId) {
}
/**
- * Template name
- *
* Example value: "Default Permission Template for Projects"
*/
public TemplateGroupsRequest setTemplateName(String templateName) {
*/
package org.sonarqube.ws.client.permissions;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Lists the users with their permission as individual users rather than through group affiliation on the chosen template. <br />This service defaults to all users, but can be limited to users with a specific permission by providing the desired permission.<br>Requires the following permission: 'Administer System'.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/permissions/template_users">Further information about this action online (including a response example)</a>
private String templateName;
/**
- * Key of organization, used when group name is set
- *
* This is part of the internal API.
* Example value: "my-org"
*/
}
/**
- * 1-based page number
- *
* Example value: "42"
*/
public TemplateUsersRequest setP(String p) {
}
/**
- * Permission<ul><li>Possible values for project permissions admin, codeviewer, issueadmin, scan, user</li></ul>
- *
* Possible values:
* <ul>
* <li>"admin"</li>
}
/**
- * Page size. Must be greater than 0 and less than 100
- *
* Example value: "20"
*/
public TemplateUsersRequest setPs(String ps) {
}
/**
- * Limit search to user names that contain the supplied string. <br/>When this parameter is not set, only users having at least one permission are returned.
- *
* Example value: "eri"
*/
public TemplateUsersRequest setQ(String q) {
}
/**
- * Template id
- *
* Example value: "AU-Tpxb--iU5OvuD2FLy"
*/
public TemplateUsersRequest setTemplateId(String templateId) {
}
/**
- * Template name
- *
* Example value: "Default Permission Template for Projects"
*/
public TemplateUsersRequest setTemplateName(String templateName) {
*/
package org.sonarqube.ws.client.permissions;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Update a permission template.<br />Requires the following permission: 'Administer System'.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/permissions/update_template">Further information about this action online (including a response example)</a>
private String projectKeyPattern;
/**
- * Description
- *
* Example value: "Permissions for all projects related to the financial service"
*/
public UpdateTemplateRequest setDescription(String description) {
}
/**
- * Id
- *
* This is a mandatory parameter.
* Example value: "af8cb8cc-1e78-4c4e-8c00-ee8e814009a5"
*/
}
/**
- * Name
- *
* Example value: "Financial Service Permissions"
*/
public UpdateTemplateRequest setName(String name) {
}
/**
- * Project key pattern. Must be a valid Java regular expression
- *
* Example value: ".*\\.finance\\..*"
*/
public UpdateTemplateRequest setProjectKeyPattern(String projectKeyPattern) {
*/
package org.sonarqube.ws.client.permissions;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Lists the users with their permissions as individual users rather than through group affiliation.<br>This service defaults to global permissions, but can be limited to project permissions by providing project id or project key.<br> This service defaults to all users, but can be limited to users with a specific permission by providing the desired permission.<br>Requires one of the following permissions:<ul><li>'Administer System'</li><li>'Administer' rights on the specified project</li></ul>
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/permissions/users">Further information about this action online (including a response example)</a>
private String q;
/**
- * Key of organization, used when group name is set
- *
* This is part of the internal API.
* Example value: "my-org"
*/
}
/**
- * 1-based page number
- *
* Example value: "42"
*/
public UsersRequest setP(String p) {
}
/**
- * Permission<ul><li>Possible values for global permissions: admin, profileadmin, gateadmin, scan, provisioning</li><li>Possible values for project permissions admin, codeviewer, issueadmin, scan, user</li></ul>
- *
*/
public UsersRequest setPermission(String permission) {
this.permission = permission;
}
/**
- * Project id
- *
* Example value: "ce4c03d6-430f-40a9-b777-ad877c00aa4d"
*/
public UsersRequest setProjectId(String projectId) {
}
/**
- * Project key
- *
* Example value: "my_project"
*/
public UsersRequest setProjectKey(String projectKey) {
}
/**
- * Page size. Must be greater than 0 and less than 100
- *
* Example value: "20"
*/
public UsersRequest setPs(String ps) {
}
/**
- * Limit search to user names that contain the supplied string. <br/>When this parameter is not set, only users having at least one permission are returned.
- *
* Example value: "eri"
*/
public UsersRequest setQ(String q) {
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
@ParametersAreNonnullByDefault
+@Generated("sonar-ws-generator")
package org.sonarqube.ws.client.permissions;
import javax.annotation.ParametersAreNonnullByDefault;
+import javax.annotation.Generated;
*/
package org.sonarqube.ws.client.plugins;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Installs the latest version of a plugin specified by its key.<br/>Plugin information is retrieved from Update Center.<br/>Requires user to be authenticated with Administer System permissions
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/plugins/install">Further information about this action online (including a response example)</a>
private String key;
/**
- * The key identifying the plugin to install
- *
* This is a mandatory parameter.
*/
public InstallRequest setKey(String key) {
import javax.annotation.Generated;
/**
- * Get the list of all the plugins installed on the SonarQube instance, sorted by plugin name.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/plugins/installed">Further information about this action online (including a response example)</a>
private List<String> f;
/**
- * Comma-separated list of the additional fields to be returned in response. No additional field is returned by default. Possible values are:<ul><li>category - category as defined in the Update Center. A connection to the Update Center is needed</li></lu>
- *
* Possible values:
* <ul>
* <li>"category"</li>
import org.sonarqube.ws.client.WsConnector;
/**
- * Manage the plugins on the server, including installing, uninstalling, and upgrading.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/plugins">Further information about this web service online</a>
*/
@Generated("sonar-ws-generator")
}
/**
- * Get the list of all the plugins available for installation on the SonarQube instance, sorted by plugin name.<br/>Plugin information is retrieved from Update Center. Date and time at which Update Center was last refreshed is provided in the response.<br/>Update status values are: <ul><li>COMPATIBLE: plugin is compatible with current SonarQube instance.</li><li>INCOMPATIBLE: plugin is not compatible with current SonarQube instance.</li><li>REQUIRES_SYSTEM_UPGRADE: plugin requires SonarQube to be upgraded before being installed.</li><li>DEPS_REQUIRE_SYSTEM_UPGRADE: at least one plugin on which the plugin is dependent requires SonarQube to be upgraded.</li></ul>Require 'Administer System' permission.
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * Cancels any operation pending on any plugin (install, update or uninstall)<br/>Requires user to be authenticated with Administer System permissions
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * Installs the latest version of a plugin specified by its key.<br/>Plugin information is retrieved from Update Center.<br/>Requires user to be authenticated with Administer System permissions
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * Get the list of all the plugins installed on the SonarQube instance, sorted by plugin name.
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * Get the list of plugins which will either be installed or removed at the next startup of the SonarQube instance, sorted by plugin name.<br/>Require 'Administer System' permission.
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * Uninstalls the plugin specified by its key.<br/>Requires user to be authenticated with Administer System permissions.
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * Updates a plugin specified by its key to the latest version compatible with the SonarQube instance.<br/>Plugin information is retrieved from Update Center.<br/>Requires user to be authenticated with Administer System permissions
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * Lists plugins installed on the SonarQube instance for which at least one newer version is available, sorted by plugin name.<br/>Each newer version is listed, ordered from the oldest to the newest, with its own update/compatibility status.<br/>Plugin information is retrieved from Update Center. Date and time at which Update Center was last refreshed is provided in the response.<br/>Update status values are: [COMPATIBLE, INCOMPATIBLE, REQUIRES_UPGRADE, DEPS_REQUIRE_UPGRADE].<br/>Require 'Administer System' permission.
*
* This is part of the internal API.
* This is a GET request.
*/
package org.sonarqube.ws.client.plugins;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Uninstalls the plugin specified by its key.<br/>Requires user to be authenticated with Administer System permissions.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/plugins/uninstall">Further information about this action online (including a response example)</a>
private String key;
/**
- * The key identifying the plugin to uninstall
- *
* This is a mandatory parameter.
*/
public UninstallRequest setKey(String key) {
*/
package org.sonarqube.ws.client.plugins;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Updates a plugin specified by its key to the latest version compatible with the SonarQube instance.<br/>Plugin information is retrieved from Update Center.<br/>Requires user to be authenticated with Administer System permissions
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/plugins/update">Further information about this action online (including a response example)</a>
private String key;
/**
- * The key identifying the plugin to update
- *
* This is a mandatory parameter.
*/
public UpdateRequest setKey(String key) {
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
@ParametersAreNonnullByDefault
+@Generated("sonar-ws-generator")
package org.sonarqube.ws.client.plugins;
import javax.annotation.ParametersAreNonnullByDefault;
+import javax.annotation.Generated;
import org.sonarqube.ws.client.WsConnector;
/**
- * Removed since 6.3, please use api/qualityprofiles instead
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/profiles">Further information about this web service online</a>
*/
@Generated("sonar-ws-generator")
}
/**
- * Get a profile.<br/>The web service is removed and you're invited to use api/qualityprofiles/search instead
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * Get a list of profiles.<br/>The web service is removed and you're invited to use api/qualityprofiles/search instead
*
* This is part of the internal API.
* This is a GET request.
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
@ParametersAreNonnullByDefault
+@Generated("sonar-ws-generator")
package org.sonarqube.ws.client.profiles;
import javax.annotation.ParametersAreNonnullByDefault;
+import javax.annotation.Generated;
*/
package org.sonarqube.ws.client.projectanalyses;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Create a project analysis event.<br>Only event of category 'VERSION' and 'OTHER' can be created.<br>Requires one of the following permissions:<ul> <li>'Administer System'</li> <li>'Administer' rights on the specified project</li></ul>
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/project_analyses/create_event">Further information about this action online (including a response example)</a>
private String name;
/**
- * Analysis key
- *
* This is a mandatory parameter.
* Example value: "AU-Tpxb--iU5OvuD2FLy"
*/
}
/**
- * Category
- *
* Possible values:
* <ul>
* <li>"VERSION"</li>
}
/**
- * Name
- *
* This is a mandatory parameter.
* Example value: "5.6"
*/
*/
package org.sonarqube.ws.client.projectanalyses;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Delete a project analysis event.<br>Only event of category 'VERSION' and 'OTHER' can be deleted.<br>Requires one of the following permissions:<ul> <li>'Administer System'</li> <li>'Administer' rights on the specified project</li></ul>
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/project_analyses/delete_event">Further information about this action online (including a response example)</a>
private String event;
/**
- * Event key
- *
* This is a mandatory parameter.
* Example value: "AU-TpxcA-iU5OvuD2FLz"
*/
*/
package org.sonarqube.ws.client.projectanalyses;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Delete a project analysis.<br>Requires one of the following permissions:<ul> <li>'Administer System'</li> <li>'Administer' rights on the project of the specified analysis</li></ul>
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/project_analyses/delete">Further information about this action online (including a response example)</a>
private String analysis;
/**
- * Analysis key
- *
* This is a mandatory parameter.
* Example value: "AU-TpxcA-iU5OvuD2FL1"
*/
*/
package org.sonarqube.ws.client.projectanalyses;
+import java.util.stream.Collectors;
import javax.annotation.Generated;
import org.sonarqube.ws.MediaTypes;
import org.sonarqube.ws.client.BaseService;
import org.sonarqube.ws.ProjectAnalyses.UpdateEventResponse;
/**
- * Manage project analyses.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/project_analyses">Further information about this web service online</a>
*/
@Generated("sonar-ws-generator")
}
/**
- * Create a project analysis event.<br>Only event of category 'VERSION' and 'OTHER' can be created.<br>Requires one of the following permissions:<ul> <li>'Administer System'</li> <li>'Administer' rights on the specified project</li></ul>
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * Delete a project analysis.<br>Requires one of the following permissions:<ul> <li>'Administer System'</li> <li>'Administer' rights on the project of the specified analysis</li></ul>
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * Delete a project analysis event.<br>Only event of category 'VERSION' and 'OTHER' can be deleted.<br>Requires one of the following permissions:<ul> <li>'Administer System'</li> <li>'Administer' rights on the specified project</li></ul>
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * Search a project analyses and attached events.<br>Requires the following permission: 'Browse' on the specified project
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * Update a project analysis event.<br>Only events of category 'VERSION' and 'OTHER' can be updated.<br>Requires one of the following permissions:<ul> <li>'Administer System'</li> <li>'Administer' rights on the specified project</li></ul>
*
* This is part of the internal API.
* This is a POST request.
*/
package org.sonarqube.ws.client.projectanalyses;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Search a project analyses and attached events.<br>Requires the following permission: 'Browse' on the specified project
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/project_analyses/search">Further information about this action online (including a response example)</a>
private String to;
/**
- * Branch key
- *
* This is part of the internal API.
* Example value: "feature/my_branch"
*/
}
/**
- * Event category. Filter analyses that have at least one event of the category specified.
- *
* Example value: "OTHER"
* Possible values:
* <ul>
}
/**
- * Filter analyses created after the given date (inclusive). <br>Either a date (server timezone) or datetime can be provided
- *
* Example value: "2013-05-01"
*/
public SearchRequest setFrom(String from) {
}
/**
- * 1-based page number
- *
* Example value: "42"
*/
public SearchRequest setP(String p) {
}
/**
- * Project key
- *
* This is a mandatory parameter.
* Example value: "my_project"
*/
}
/**
- * Page size. Must be greater than 0 and less than 500
- *
* Example value: "20"
*/
public SearchRequest setPs(String ps) {
}
/**
- * Filter analyses created before the given date (inclusive). <br>Either a date (server timezone) or datetime can be provided
- *
* Example value: "2017-10-19 or 2017-10-19T13:00:00+0200"
*/
public SearchRequest setTo(String to) {
*/
package org.sonarqube.ws.client.projectanalyses;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Update a project analysis event.<br>Only events of category 'VERSION' and 'OTHER' can be updated.<br>Requires one of the following permissions:<ul> <li>'Administer System'</li> <li>'Administer' rights on the specified project</li></ul>
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/project_analyses/update_event">Further information about this action online (including a response example)</a>
private String name;
/**
- * Event key
- *
* This is a mandatory parameter.
* Example value: "AU-TpxcA-iU5OvuD2FL5"
*/
}
/**
- * New name
- *
* Example value: "5.6"
*/
public UpdateEventRequest setName(String name) {
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
@ParametersAreNonnullByDefault
+@Generated("sonar-ws-generator")
package org.sonarqube.ws.client.projectanalyses;
import javax.annotation.ParametersAreNonnullByDefault;
+import javax.annotation.Generated;
*/
package org.sonarqube.ws.client.projectbranches;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Delete a non-main branch of a project.<br/>Requires 'Administer' rights on the specified project.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/project_branches/delete">Further information about this action online (including a response example)</a>
private String project;
/**
- * Name of the branch
- *
* This is a mandatory parameter.
* Example value: "branch1"
*/
}
/**
- * Project key
- *
* This is a mandatory parameter.
* Example value: "my_project"
*/
*/
package org.sonarqube.ws.client.projectbranches;
+import java.util.List;
import javax.annotation.Generated;
/**
- * List the branches of a project.<br/>Requires 'Administer' rights on the specified project.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/project_branches/list">Further information about this action online (including a response example)</a>
private String project;
/**
- * Project key
- *
* This is a mandatory parameter.
* Example value: "my_project"
*/
*/
package org.sonarqube.ws.client.projectbranches;
+import java.util.stream.Collectors;
import javax.annotation.Generated;
import org.sonarqube.ws.MediaTypes;
import org.sonarqube.ws.client.BaseService;
import org.sonarqube.ws.ProjectBranches.ListWsResponse;
/**
- * Manage branch (only available when the Branch plugin is installed)
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/project_branches">Further information about this web service online</a>
*/
@Generated("sonar-ws-generator")
}
/**
- * Delete a non-main branch of a project.<br/>Requires 'Administer' rights on the specified project.
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * List the branches of a project.<br/>Requires 'Administer' rights on the specified project.
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * Rename the main branch of a project.<br/>Requires 'Administer' permission on the specified project.
*
* This is part of the internal API.
* This is a POST request.
*/
package org.sonarqube.ws.client.projectbranches;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Rename the main branch of a project.<br/>Requires 'Administer' permission on the specified project.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/project_branches/rename">Further information about this action online (including a response example)</a>
private String project;
/**
- * New name of the main branch
- *
* This is a mandatory parameter.
* Example value: "branch1"
*/
}
/**
- * Project key
- *
* This is a mandatory parameter.
* Example value: "my_project"
*/
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
@ParametersAreNonnullByDefault
+@Generated("sonar-ws-generator")
package org.sonarqube.ws.client.projectbranches;
import javax.annotation.ParametersAreNonnullByDefault;
+import javax.annotation.Generated;
*/
package org.sonarqube.ws.client.projectlinks;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Create a new project link.<br>Requires 'Administer' permission on the specified project, or global 'Administer' permission.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/project_links/create">Further information about this action online (including a response example)</a>
private String url;
/**
- * Link name
- *
* This is a mandatory parameter.
* Example value: "Custom"
*/
}
/**
- * Project id
- *
* Example value: "AU-Tpxb--iU5OvuD2FLy"
*/
public CreateRequest setProjectId(String projectId) {
}
/**
- * Project key
- *
* Example value: "my_project"
*/
public CreateRequest setProjectKey(String projectKey) {
}
/**
- * Link url
- *
* This is a mandatory parameter.
* Example value: "http://example.com"
*/
*/
package org.sonarqube.ws.client.projectlinks;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Delete existing project link.<br>Requires 'Administer' permission on the specified project, or global 'Administer' permission.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/project_links/delete">Further information about this action online (including a response example)</a>
private String id;
/**
- * Link id
- *
* This is a mandatory parameter.
* Example value: "17"
*/
*/
package org.sonarqube.ws.client.projectlinks;
+import java.util.stream.Collectors;
import javax.annotation.Generated;
import org.sonarqube.ws.MediaTypes;
import org.sonarqube.ws.client.BaseService;
import org.sonarqube.ws.ProjectLinks.SearchWsResponse;
/**
- * Manage projects links.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/project_links">Further information about this web service online</a>
*/
@Generated("sonar-ws-generator")
}
/**
- * Create a new project link.<br>Requires 'Administer' permission on the specified project, or global 'Administer' permission.
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * Delete existing project link.<br>Requires 'Administer' permission on the specified project, or global 'Administer' permission.
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * List links of a project.<br>The 'projectId' or 'projectKey' must be provided.<br>Requires one of the following permissions:<ul><li>'Administer System'</li><li>'Administer' rights on the specified project</li><li>'Browse' on the specified project</li></ul>
*
* This is part of the internal API.
* This is a GET request.
*/
package org.sonarqube.ws.client.projectlinks;
+import java.util.List;
import javax.annotation.Generated;
/**
- * List links of a project.<br>The 'projectId' or 'projectKey' must be provided.<br>Requires one of the following permissions:<ul><li>'Administer System'</li><li>'Administer' rights on the specified project</li><li>'Browse' on the specified project</li></ul>
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/project_links/search">Further information about this action online (including a response example)</a>
private String projectKey;
/**
- * Project Id
- *
* Example value: "AU-Tpxb--iU5OvuD2FLy"
*/
public SearchRequest setProjectId(String projectId) {
}
/**
- * Project Key
- *
* Example value: "my_project"
*/
public SearchRequest setProjectKey(String projectKey) {
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
@ParametersAreNonnullByDefault
+@Generated("sonar-ws-generator")
package org.sonarqube.ws.client.projectlinks;
import javax.annotation.ParametersAreNonnullByDefault;
+import javax.annotation.Generated;
import javax.annotation.Generated;
/**
- * Delete one or several projects.<br />Requires 'Administer System' permission.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/projects/bulk_delete">Further information about this action online (including a response example)</a>
private String visibility;
/**
- * Filter the projects for which last analysis is older than the given date (exclusive).<br> Either a date (server timezone) or datetime can be provided.
- *
* Example value: "2017-10-19 or 2017-10-19T13:00:00+0200"
*/
public BulkDeleteRequest setAnalyzedBefore(String analyzedBefore) {
}
/**
- * Filter the projects that are provisioned
- *
* Possible values:
* <ul>
* <li>"true"</li>
}
/**
- * The key of the organization
- *
* This is part of the internal API.
*/
public BulkDeleteRequest setOrganization(String organization) {
}
/**
- * Comma-separated list of project ids
- *
* Example value: "AU-Tpxb--iU5OvuD2FLy,AU-TpxcA-iU5OvuD2FLz"
* @deprecated since 6.4
*/
}
/**
- * Comma-separated list of project keys
- *
* Example value: "my_project,another_project"
*/
public BulkDeleteRequest setProjects(List<String> projects) {
}
/**
- * Limit to: <ul><li>component names that contain the supplied string</li><li>component keys that contain the supplied string</li></ul>
- *
* Example value: "sonar"
*/
public BulkDeleteRequest setQ(String q) {
}
/**
- * Comma-separated list of component qualifiers. Filter the results with the specified qualifiers
- *
* Possible values:
* <ul>
* <li>"TRK"</li>
}
/**
- * Filter the projects that should be visible to everyone (public), or only specific user/groups (private).<br/>If no visibility is specified, the default project visibility of the organization will be used.
- *
* This is part of the internal API.
* Possible values:
* <ul>
*/
package org.sonarqube.ws.client.projects;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Bulk update a project or module key and all its sub-components keys. The bulk update allows to replace a part of the current key by another string on the current project and all its sub-modules.<br>It's possible to simulate the bulk update by setting the parameter 'dryRun' at true. No key is updated with a dry run.<br>Ex: to rename a project with key 'my_project' to 'my_new_project' and all its sub-components keys, call the WS with parameters:<ul> <li>project: my_project</li> <li>from: my_</li> <li>to: my_new_</li></ul>Either 'projectId' or 'project' must be provided.<br> Requires one of the following permissions: <ul><li>'Administer System'</li><li>'Administer' rights on the specified project</li></ul>
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/projects/bulk_update_key">Further information about this action online (including a response example)</a>
private String to;
/**
- * Simulate bulk update. No component key is updated.
- *
* Possible values:
* <ul>
* <li>"true"</li>
}
/**
- * String to match in components keys
- *
* This is a mandatory parameter.
* Example value: "_old"
*/
}
/**
- * Project or module key
- *
* Example value: "my_old_project"
*/
public BulkUpdateKeyRequest setProject(String project) {
}
/**
- * Project or module ID
- *
* Example value: "AU-Tpxb--iU5OvuD2FLy"
* @deprecated since 6.4
*/
}
/**
- * String replacement in components keys
- *
* This is a mandatory parameter.
* Example value: "_new"
*/
*/
package org.sonarqube.ws.client.projects;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Create a project.<br/>Requires 'Create Projects' permission
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/projects/create">Further information about this action online (including a response example)</a>
private String visibility;
/**
- * SCM Branch of the project. The key of the project will become key:branch, for instance 'SonarQube:branch-5.0'
- *
* Example value: "branch-5.0"
*/
public CreateRequest setBranch(String branch) {
}
/**
- * Name of the project
- *
* This is a mandatory parameter.
* Example value: "SonarQube"
*/
}
/**
- * The key of the organization
- *
* This is part of the internal API.
*/
public CreateRequest setOrganization(String organization) {
}
/**
- * Key of the project
- *
* This is a mandatory parameter.
* Example value: "my_project"
*/
}
/**
- * Whether the created project should be visible to everyone, or only specific user/groups.<br/>If no visibility is specified, the default project visibility of the organization will be used.
- *
* This is part of the internal API.
* Possible values:
* <ul>
*/
package org.sonarqube.ws.client.projects;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Delete a project.<br> Requires 'Administer System' permission or 'Administer' permission on the project.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/projects/delete">Further information about this action online (including a response example)</a>
private String projectId;
/**
- * Project key
- *
* Example value: "my_project"
*/
public DeleteRequest setProject(String project) {
}
/**
- * Project ID
- *
* Example value: "ce4c03d6-430f-40a9-b777-ad877c00aa4d"
* @deprecated since 6.4
*/
import javax.annotation.Generated;
/**
- * List ghost projects.<br> With the current architecture, it's no more possible to have invisible ghost projects. Therefore, the web service is deprecated.<br> Requires 'Administer System' permission.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/projects/ghosts">Further information about this action online (including a response example)</a>
private String q;
/**
- * Comma-separated list of the fields to be returned in response. All the fields are returned by default.
- *
* Possible values:
* <ul>
* <li>"name"</li>
}
/**
- * Organization key
- *
* This is part of the internal API.
*/
public GhostsRequest setOrganization(String organization) {
}
/**
- * 1-based page number
- *
* Example value: "42"
*/
public GhostsRequest setP(String p) {
}
/**
- * Page size. Must be greater than 0 and less than 500
- *
* Example value: "20"
*/
public GhostsRequest setPs(String ps) {
}
/**
- * Limit search to names or keys that contain the supplied string.
- *
* Example value: "sonar"
*/
public GhostsRequest setQ(String q) {
*/
package org.sonarqube.ws.client.projects;
+import java.util.List;
import javax.annotation.Generated;
/**
- * This web service is deprecated, please use api/components/search instead
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/projects/index">Further information about this action online (including a response example)</a>
private String views;
/**
- * Since 6.3, this parameter has no effect
- *
* @deprecated since 6.3
*/
@Deprecated
}
/**
- * Only json response format is available
- *
* Possible values:
* <ul>
* <li>"json"</li>
}
/**
- * Since 6.3, this parameter has no effect
- *
* @deprecated since 6.3
*/
@Deprecated
}
/**
- * key or ID of the project
- *
* Example value: "my_project"
*/
public IndexRequest setProject(String project) {
}
/**
- * Substring of project name, case insensitive. Ignored if the parameter key is set
- *
* Example value: "Sonar"
*/
public IndexRequest setSearch(String search) {
}
/**
- * Load sub-projects. Ignored if the parameter key is set
- *
* Possible values:
* <ul>
* <li>"true"</li>
}
/**
- * Since 6.3, this parameter has no effect
- *
* @deprecated since 6.3
*/
@Deprecated
}
/**
- * Since 6.3, this parameter has no effect
- *
* @deprecated since 6.3
*/
@Deprecated
import org.sonarqube.ws.Projects.SearchMyProjectsWsResponse;
/**
- * Manage project existence.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/projects">Further information about this web service online</a>
*/
@Generated("sonar-ws-generator")
}
/**
- * Delete one or several projects.<br />Requires 'Administer System' permission.
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * Bulk update a project or module key and all its sub-components keys. The bulk update allows to replace a part of the current key by another string on the current project and all its sub-modules.<br>It's possible to simulate the bulk update by setting the parameter 'dryRun' at true. No key is updated with a dry run.<br>Ex: to rename a project with key 'my_project' to 'my_new_project' and all its sub-components keys, call the WS with parameters:<ul> <li>project: my_project</li> <li>from: my_</li> <li>to: my_new_</li></ul>Either 'projectId' or 'project' must be provided.<br> Requires one of the following permissions: <ul><li>'Administer System'</li><li>'Administer' rights on the specified project</li></ul>
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * Create a project.<br/>Requires 'Create Projects' permission
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * Delete a project.<br> Requires 'Administer System' permission or 'Administer' permission on the project.
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * List ghost projects.<br> With the current architecture, it's no more possible to have invisible ghost projects. Therefore, the web service is deprecated.<br> Requires 'Administer System' permission.
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * This web service is deprecated, please use api/components/search instead
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * Get the list of provisioned projects.<br> Web service is deprecated. Use api/projects/search instead, with onProvisionedOnly=true.<br> Require 'Create Projects' permission.
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * Search for projects or views to administrate them.<br>Requires 'System Administrator' permission
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * Return list of projects for which the current user has 'Administer' permission.
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * Update a project or module key and all its sub-components keys.<br>Either 'from' or 'projectId' must be provided.<br> Requires one of the following permissions: <ul><li>'Administer System'</li><li>'Administer' rights on the specified project</li></ul>
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * Updates visibility of a project.<br>Requires 'Project administer' permission on the specified project
*
* This is part of the internal API.
* This is a POST request.
import javax.annotation.Generated;
/**
- * Get the list of provisioned projects.<br> Web service is deprecated. Use api/projects/search instead, with onProvisionedOnly=true.<br> Require 'Create Projects' permission.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/projects/provisioned">Further information about this action online (including a response example)</a>
private String q;
/**
- * Comma-separated list of the fields to be returned in response. All the fields are returned by default.
- *
* Possible values:
* <ul>
* <li>"name"</li>
}
/**
- * The key of the organization
- *
* This is part of the internal API.
*/
public ProvisionedRequest setOrganization(String organization) {
}
/**
- * 1-based page number
- *
* Example value: "42"
*/
public ProvisionedRequest setP(String p) {
}
/**
- * Page size. Must be greater than 0 and less than 500
- *
* Example value: "20"
*/
public ProvisionedRequest setPs(String ps) {
}
/**
- * Limit search to names or keys that contain the supplied string.
- *
* Example value: "sonar"
*/
public ProvisionedRequest setQ(String q) {
*/
package org.sonarqube.ws.client.projects;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Return list of projects for which the current user has 'Administer' permission.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/projects/search_my_projects">Further information about this action online (including a response example)</a>
private String ps;
/**
- * 1-based page number
- *
* Example value: "42"
*/
public SearchMyProjectsRequest setP(String p) {
}
/**
- * Page size. Must be greater than 0 and less than 500
- *
* Example value: "20"
*/
public SearchMyProjectsRequest setPs(String ps) {
import javax.annotation.Generated;
/**
- * Search for projects or views to administrate them.<br>Requires 'System Administrator' permission
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/projects/search">Further information about this action online (including a response example)</a>
private String visibility;
/**
- * Filter the projects for which last analysis is older than the given date (exclusive).<br> Either a date (server timezone) or datetime can be provided.
- *
* Example value: "2017-10-19 or 2017-10-19T13:00:00+0200"
*/
public SearchRequest setAnalyzedBefore(String analyzedBefore) {
}
/**
- * Filter the projects that are provisioned
- *
* Possible values:
* <ul>
* <li>"true"</li>
}
/**
- * The key of the organization
- *
* This is part of the internal API.
*/
public SearchRequest setOrganization(String organization) {
}
/**
- * 1-based page number
- *
* Example value: "42"
*/
public SearchRequest setP(String p) {
}
/**
- * Comma-separated list of project ids
- *
* Example value: "AU-Tpxb--iU5OvuD2FLy,AU-TpxcA-iU5OvuD2FLz"
* @deprecated since 6.6
*/
}
/**
- * Comma-separated list of project keys
- *
* Example value: "my_project,another_project"
*/
public SearchRequest setProjects(List<String> projects) {
}
/**
- * Page size. Must be greater than 0 and less than 500
- *
* Example value: "20"
*/
public SearchRequest setPs(String ps) {
}
/**
- * Limit search to: <ul><li>component names that contain the supplied string</li><li>component keys that contain the supplied string</li></ul>
- *
* Example value: "sonar"
*/
public SearchRequest setQ(String q) {
}
/**
- * Comma-separated list of component qualifiers. Filter the results with the specified qualifiers
- *
* Possible values:
* <ul>
* <li>"TRK"</li>
}
/**
- * Filter the projects that should be visible to everyone (public), or only specific user/groups (private).<br/>If no visibility is specified, the default project visibility of the organization will be used.
- *
* This is part of the internal API.
* Possible values:
* <ul>
*/
package org.sonarqube.ws.client.projects;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Update a project or module key and all its sub-components keys.<br>Either 'from' or 'projectId' must be provided.<br> Requires one of the following permissions: <ul><li>'Administer System'</li><li>'Administer' rights on the specified project</li></ul>
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/projects/update_key">Further information about this action online (including a response example)</a>
private String to;
/**
- * Project or module key
- *
* Example value: "my_old_project"
*/
public UpdateKeyRequest setFrom(String from) {
}
/**
- * Project or module id
- *
* Example value: "AU-Tpxb--iU5OvuD2FLy"
* @deprecated since 6.4
*/
}
/**
- * New component key
- *
* This is a mandatory parameter.
* Example value: "my_new_project"
*/
*/
package org.sonarqube.ws.client.projects;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Updates visibility of a project.<br>Requires 'Project administer' permission on the specified project
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/projects/update_visibility">Further information about this action online (including a response example)</a>
private String visibility;
/**
- * Project key
- *
* This is a mandatory parameter.
* Example value: "my_project"
*/
}
/**
- * New visibility
- *
* This is a mandatory parameter.
* Possible values:
* <ul>
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
@ParametersAreNonnullByDefault
+@Generated("sonar-ws-generator")
package org.sonarqube.ws.client.projects;
import javax.annotation.ParametersAreNonnullByDefault;
+import javax.annotation.Generated;
import org.sonarqube.ws.ProjectTags.SearchResponse;
/**
- * Manage project tags
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/project_tags">Further information about this web service online</a>
*/
@Generated("sonar-ws-generator")
}
/**
- * Search tags
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * Set tags on a project.<br>Requires the following permission: 'Administer' rights on the specified project
*
* This is part of the internal API.
* This is a POST request.
*/
package org.sonarqube.ws.client.projecttags;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Search tags
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/project_tags/search">Further information about this action online (including a response example)</a>
private String q;
/**
- * Page size. Must be greater than 0 and less than 100
- *
* Example value: "20"
*/
public SearchRequest setPs(String ps) {
}
/**
- * Limit search to tags that contain the supplied string.
- *
* Example value: "off"
*/
public SearchRequest setQ(String q) {
import javax.annotation.Generated;
/**
- * Set tags on a project.<br>Requires the following permission: 'Administer' rights on the specified project
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/project_tags/set">Further information about this action online (including a response example)</a>
private List<String> tags;
/**
- * Project key
- *
* This is a mandatory parameter.
* Example value: "my_project"
*/
}
/**
- * Comma-separated list of tags
- *
* This is a mandatory parameter.
* Example value: "finance, offshore"
*/
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
@ParametersAreNonnullByDefault
+@Generated("sonar-ws-generator")
package org.sonarqube.ws.client.projecttags;
import javax.annotation.ParametersAreNonnullByDefault;
+import javax.annotation.Generated;
*/
package org.sonarqube.ws.client.properties;
+import java.util.List;
import javax.annotation.Generated;
/**
- * This web service is deprecated, please use api/settings/values instead.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/properties/index">Further information about this action online (including a response example)</a>
private String resource;
/**
- * Only json response format is available
- *
* Possible values:
* <ul>
* <li>"json"</li>
}
/**
- * Setting key
- *
* Example value: "sonar.test.inclusions"
*/
public IndexRequest setId(String id) {
}
/**
- * Component key or database id
- *
* Example value: "my_project"
*/
public IndexRequest setResource(String resource) {
*/
package org.sonarqube.ws.client.properties;
+import java.util.stream.Collectors;
import javax.annotation.Generated;
import org.sonarqube.ws.MediaTypes;
import org.sonarqube.ws.client.BaseService;
import org.sonarqube.ws.client.GetRequest;
+import org.sonarqube.ws.client.PostRequest;
import org.sonarqube.ws.client.WsConnector;
/**
- * This web service is deprecated, please use api/settings instead.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/properties">Further information about this web service online</a>
*/
@Generated("sonar-ws-generator")
}
/**
- * This web service is deprecated, please use api/settings/values instead.
*
* This is part of the internal API.
* This is a GET request.
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
@ParametersAreNonnullByDefault
+@Generated("sonar-ws-generator")
package org.sonarqube.ws.client.properties;
import javax.annotation.ParametersAreNonnullByDefault;
+import javax.annotation.Generated;
*/
package org.sonarqube.ws.client.qualitygates;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Copy a Quality Gate.<br>Requires the 'Administer Quality Gates' permission.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/qualitygates/copy">Further information about this action online (including a response example)</a>
private String name;
/**
- * The ID of the source quality gate
- *
* This is a mandatory parameter.
* Example value: "1"
*/
}
/**
- * The name of the quality gate to create
- *
* This is a mandatory parameter.
* Example value: "My Quality Gate"
*/
*/
package org.sonarqube.ws.client.qualitygates;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Add a new condition to a quality gate.<br>Requires the 'Administer Quality Gates' permission.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/qualitygates/create_condition">Further information about this action online (including a response example)</a>
private String warning;
/**
- * Condition error threshold
- *
* Example value: "10"
*/
public CreateConditionRequest setError(String error) {
}
/**
- * ID of the quality gate
- *
* This is a mandatory parameter.
* Example value: "1"
*/
}
/**
- * Condition metric
- *
* This is a mandatory parameter.
* Example value: "blocker_violations"
*/
}
/**
- * Condition operator:<br/><ul><li>EQ = equals</li><li>NE = is not</li><li>LT = is lower than</li><li>GT = is greater than</li></ui>
- *
* Example value: "EQ"
* Possible values:
* <ul>
}
/**
- * Condition period. If not set, the absolute value is considered.
- *
* Possible values:
* <ul>
* <li>"1"</li>
}
/**
- * Condition warning threshold
- *
* Example value: "5"
*/
public CreateConditionRequest setWarning(String warning) {
*/
package org.sonarqube.ws.client.qualitygates;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Create a Quality Gate.<br>Requires the 'Administer Quality Gates' permission.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/qualitygates/create">Further information about this action online (including a response example)</a>
private String name;
/**
- * The name of the quality gate to create
- *
* This is a mandatory parameter.
* Example value: "My Quality Gate"
*/
*/
package org.sonarqube.ws.client.qualitygates;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Delete a condition from a quality gate.<br>Requires the 'Administer Quality Gates' permission.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/qualitygates/delete_condition">Further information about this action online (including a response example)</a>
private String id;
/**
- * Condition ID
- *
* This is a mandatory parameter.
* Example value: "2"
*/
*/
package org.sonarqube.ws.client.qualitygates;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Remove the association of a project from a quality gate.<br>Requires the 'Administer Quality Gates' permission.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/qualitygates/deselect">Further information about this action online (including a response example)</a>
private String projectKey;
/**
- * Project id
- *
* Example value: "AU-Tpxb--iU5OvuD2FLy"
* @deprecated since 6.1
*/
}
/**
- * Project key
- *
* Example value: "my_project"
*/
public DeselectRequest setProjectKey(String projectKey) {
*/
package org.sonarqube.ws.client.qualitygates;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Delete a Quality Gate.<br>Requires the 'Administer Quality Gates' permission.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/qualitygates/destroy">Further information about this action online (including a response example)</a>
private String id;
/**
- * ID of the quality gate to delete
- *
* This is a mandatory parameter.
* Example value: "1"
*/
*/
package org.sonarqube.ws.client.qualitygates;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Get the quality gate of a project.<br />Requires one of the following permissions:<ul><li>'Administer System'</li><li>'Administer' rights on the specified project</li><li>'Browse' on the specified project</li></ul>
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/qualitygates/get_by_project">Further information about this action online (including a response example)</a>
private String project;
/**
- * Project key
- *
* This is a mandatory parameter.
* Example value: "my_project"
*/
*/
package org.sonarqube.ws.client.qualitygates;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Get the quality gate status of a project or a Compute Engine task.<br />Either 'analysisId', 'projectId' or 'projectKey' must be provided<br />The different statuses returned are: OK, WARN, ERROR, NONE. The NONE status is returned when there is no quality gate associated with the analysis.<br />Returns an HTTP code 404 if the analysis associated with the task is not found or does not exist.<br />Requires one of the following permissions:<ul><li>'Administer System'</li><li>'Administer' rights on the specified project</li><li>'Browse' on the specified project</li></ul>
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/qualitygates/project_status">Further information about this action online (including a response example)</a>
private String projectKey;
/**
- * Analysis id
- *
* Example value: "AU-TpxcA-iU5OvuD2FL1"
*/
public ProjectStatusRequest setAnalysisId(String analysisId) {
}
/**
- * Project id
- *
* Example value: "AU-Tpxb--iU5OvuD2FLy"
*/
public ProjectStatusRequest setProjectId(String projectId) {
}
/**
- * Project key
- *
* Example value: "my_project"
*/
public ProjectStatusRequest setProjectKey(String projectKey) {
*/
package org.sonarqube.ws.client.qualitygates;
+import java.util.stream.Collectors;
import javax.annotation.Generated;
import org.sonarqube.ws.MediaTypes;
-import org.sonarqube.ws.Qualitygates;
+import org.sonarqube.ws.client.BaseService;
+import org.sonarqube.ws.client.GetRequest;
+import org.sonarqube.ws.client.PostRequest;
+import org.sonarqube.ws.client.WsConnector;
import org.sonarqube.ws.Qualitygates.AppResponse;
-import org.sonarqube.ws.Qualitygates.CreateConditionResponse;
import org.sonarqube.ws.Qualitygates.CreateResponse;
+import org.sonarqube.ws.Qualitygates.CreateConditionResponse;
import org.sonarqube.ws.Qualitygates.GetByProjectResponse;
import org.sonarqube.ws.Qualitygates.ProjectStatusResponse;
import org.sonarqube.ws.Qualitygates.UpdateConditionResponse;
-import org.sonarqube.ws.client.BaseService;
-import org.sonarqube.ws.client.GetRequest;
-import org.sonarqube.ws.client.PostRequest;
-import org.sonarqube.ws.client.WsConnector;
/**
- * Manage quality gates, including conditions and project association.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/qualitygates">Further information about this web service online</a>
*/
@Generated("sonar-ws-generator")
}
/**
- * Get initialization items for the admin UI. For internal use
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * Copy a Quality Gate.<br>Requires the 'Administer Quality Gates' permission.
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * Create a Quality Gate.<br>Requires the 'Administer Quality Gates' permission.
*
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/qualitygates/create">Further information about this action online (including a response example)</a>
* @since 4.3
*/
- public Qualitygates.CreateResponse create(CreateRequest request) {
+ public CreateResponse create(CreateRequest request) {
return call(
new PostRequest(path("create"))
.setParam("name", request.getName()),
}
/**
- * Add a new condition to a quality gate.<br>Requires the 'Administer Quality Gates' permission.
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * Delete a condition from a quality gate.<br>Requires the 'Administer Quality Gates' permission.
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * Remove the association of a project from a quality gate.<br>Requires the 'Administer Quality Gates' permission.
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * Delete a Quality Gate.<br>Requires the 'Administer Quality Gates' permission.
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * Get the quality gate of a project.<br />Requires one of the following permissions:<ul><li>'Administer System'</li><li>'Administer' rights on the specified project</li><li>'Browse' on the specified project</li></ul>
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * Get a list of quality gates
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * Get the quality gate status of a project or a Compute Engine task.<br />Either 'analysisId', 'projectId' or 'projectKey' must be provided<br />The different statuses returned are: OK, WARN, ERROR, NONE. The NONE status is returned when there is no quality gate associated with the analysis.<br />Returns an HTTP code 404 if the analysis associated with the task is not found or does not exist.<br />Requires one of the following permissions:<ul><li>'Administer System'</li><li>'Administer' rights on the specified project</li><li>'Browse' on the specified project</li></ul>
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * Rename a Quality Gate.<br>Requires the 'Administer Quality Gates' permission.
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * Search for projects associated (or not) to a quality gate.<br/>Only authorized projects for current user will be returned.
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * Associate a project to a quality gate.<br>The 'projectId' or 'projectKey' must be provided.<br>Project id as a numeric value is deprecated since 6.1. Please use the id similar to 'AU-TpxcA-iU5OvuD2FLz'.<br>Requires the 'Administer Quality Gates' permission.
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * Set a quality gate as the default quality gate.<br>Requires the 'Administer Quality Gates' permission.
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * Display the details of a quality gate
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * Unset a quality gate as the default quality gate.<br>Requires the 'Administer Quality Gates' permission.
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * Update a condition attached to a quality gate.<br>Requires the 'Administer Quality Gates' permission.
*
* This is part of the internal API.
* This is a POST request.
*/
package org.sonarqube.ws.client.qualitygates;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Rename a Quality Gate.<br>Requires the 'Administer Quality Gates' permission.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/qualitygates/rename">Further information about this action online (including a response example)</a>
private String name;
/**
- * ID of the quality gate to rename
- *
* This is a mandatory parameter.
* Example value: "1"
*/
}
/**
- * New name of the quality gate
- *
* This is a mandatory parameter.
* Example value: "My Quality Gate"
*/
*/
package org.sonarqube.ws.client.qualitygates;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Search for projects associated (or not) to a quality gate.<br/>Only authorized projects for current user will be returned.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/qualitygates/search">Further information about this action online (including a response example)</a>
private String selected;
/**
- * Quality Gate ID
- *
* This is a mandatory parameter.
* Example value: "1"
*/
}
/**
- * Page number
- *
* Example value: "2"
*/
public SearchRequest setPage(String page) {
}
/**
- * Page size
- *
* Example value: "10"
*/
public SearchRequest setPageSize(String pageSize) {
}
/**
- * To search for projects containing this string. If this parameter is set, "selected" is set to "all".
- *
* Example value: "abc"
*/
public SearchRequest setQuery(String query) {
}
/**
- * Depending on the value, show only selected items (selected=selected), deselected items (selected=deselected), or all items with their selection status (selected=all).
- *
* Possible values:
* <ul>
* <li>"all"</li>
*/
package org.sonarqube.ws.client.qualitygates;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Associate a project to a quality gate.<br>The 'projectId' or 'projectKey' must be provided.<br>Project id as a numeric value is deprecated since 6.1. Please use the id similar to 'AU-TpxcA-iU5OvuD2FLz'.<br>Requires the 'Administer Quality Gates' permission.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/qualitygates/select">Further information about this action online (including a response example)</a>
private String projectKey;
/**
- * Quality gate id
- *
* This is a mandatory parameter.
* Example value: "1"
*/
}
/**
- * Project id. Project id as an numeric value is deprecated since 6.1
- *
* Example value: "AU-Tpxb--iU5OvuD2FLy"
*/
public SelectRequest setProjectId(String projectId) {
}
/**
- * Project key
- *
* Example value: "my_project"
*/
public SelectRequest setProjectKey(String projectKey) {
*/
package org.sonarqube.ws.client.qualitygates;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Set a quality gate as the default quality gate.<br>Requires the 'Administer Quality Gates' permission.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/qualitygates/set_as_default">Further information about this action online (including a response example)</a>
private String id;
/**
- * ID of the quality gate to set as default
- *
* This is a mandatory parameter.
* Example value: "1"
*/
*/
package org.sonarqube.ws.client.qualitygates;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Display the details of a quality gate
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/qualitygates/show">Further information about this action online (including a response example)</a>
private String name;
/**
- * ID of the quality gate. Either id or name must be set
- *
* Example value: "1"
*/
public ShowRequest setId(String id) {
}
/**
- * Name of the quality gate. Either id or name must be set
- *
* Example value: "My Quality Gate"
*/
public ShowRequest setName(String name) {
*/
package org.sonarqube.ws.client.qualitygates;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Unset a quality gate as the default quality gate.<br>Requires the 'Administer Quality Gates' permission.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/qualitygates/unset_default">Further information about this action online (including a response example)</a>
private String id;
/**
- * ID of the quality gate to unset as default
- *
* This is a mandatory parameter.
* Example value: "1"
*/
*/
package org.sonarqube.ws.client.qualitygates;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Update a condition attached to a quality gate.<br>Requires the 'Administer Quality Gates' permission.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/qualitygates/update_condition">Further information about this action online (including a response example)</a>
private String warning;
/**
- * Condition error threshold
- *
* Example value: "10"
*/
public UpdateConditionRequest setError(String error) {
}
/**
- * Condition ID
- *
* This is a mandatory parameter.
* Example value: "10"
*/
}
/**
- * Condition metric
- *
* This is a mandatory parameter.
* Example value: "blocker_violations"
*/
}
/**
- * Condition operator:<br/><ul><li>EQ = equals</li><li>NE = is not</li><li>LT = is lower than</li><li>GT = is greater than</li></ui>
- *
* Example value: "EQ"
* Possible values:
* <ul>
}
/**
- * Condition period. If not set, the absolute value is considered.
- *
* Possible values:
* <ul>
* <li>"1"</li>
}
/**
- * Condition warning threshold
- *
* Example value: "5"
*/
public UpdateConditionRequest setWarning(String warning) {
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
@ParametersAreNonnullByDefault
+@Generated("sonar-ws-generator")
package org.sonarqube.ws.client.qualitygates;
import javax.annotation.ParametersAreNonnullByDefault;
+import javax.annotation.Generated;
*/
package org.sonarqube.ws.client.qualityprofiles;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Activate a rule on a Quality Profile.<br> Requires one of the following permissions:<ul> <li>'Administer Quality Profiles'</li> <li>Edit right on the specified quality profile</li></ul>
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/qualityprofiles/activate_rule">Further information about this action online (including a response example)</a>
public class ActivateRuleRequest {
private String key;
- private String params;
+ private List<String> params;
private String reset;
private String rule;
private String severity;
/**
- * Quality Profile key. Can be obtained through <code>api/qualityprofiles/search</code>
- *
* This is a mandatory parameter.
* Example value: "AU-Tpxb--iU5OvuD2FLy"
*/
}
/**
- * Parameters as semi-colon list of <code>key=value</code>. Ignored if parameter reset is true.
- *
* Example value: "params=key1=v1;key2=v2"
*/
- public ActivateRuleRequest setParams(String params) {
+ public ActivateRuleRequest setParams(List<String> params) {
this.params = params;
return this;
}
- public String getParams() {
+ public List<String> getParams() {
return params;
}
/**
- * Reset severity and parameters of activated rule. Set the values defined on parent profile or from rule default values.
- *
* Possible values:
* <ul>
* <li>"true"</li>
}
/**
- * Rule key
- *
* This is a mandatory parameter.
* Example value: "squid:AvoidCycles"
*/
}
/**
- * Severity. Ignored if parameter reset is true.
- *
* Possible values:
* <ul>
* <li>"INFO"</li>
import javax.annotation.Generated;
/**
- * Bulk-activate rules on one quality profile.<br> Requires one of the following permissions:<ul> <li>'Administer Quality Profiles'</li> <li>Edit right on the specified quality profile</li></ul>
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/qualityprofiles/activate_rules">Further information about this action online (including a response example)</a>
private List<String> types;
/**
- * Filter rules that are activated or deactivated on the selected Quality profile. Ignored if the parameter 'qprofile' is not set.
- *
* Possible values:
* <ul>
* <li>"true"</li>
}
/**
- * Comma-separated list of activation severities, i.e the severity of rules in Quality profiles.
- *
* Example value: "CRITICAL,BLOCKER"
* Possible values:
* <ul>
}
/**
- * Ascending sort
- *
* Possible values:
* <ul>
* <li>"true"</li>
}
/**
- * Filters rules added since date. Format is yyyy-MM-dd
- *
* Example value: "2014-06-22"
*/
public ActivateRulesRequest setAvailableSince(String availableSince) {
}
/**
- * Quality profile key to filter rules that are activated. Meant to compare easily to profile set in 'qprofile'
- *
* This is part of the internal API.
* Example value: "AU-TpxcA-iU5OvuD2FLz"
*/
}
/**
- * Comma-separated list of values of inheritance for a rule within a quality profile. Used only if the parameter 'activation' is set.
- *
* Example value: "INHERITED,OVERRIDES"
* Possible values:
* <ul>
}
/**
- * Filter template rules
- *
* Possible values:
* <ul>
* <li>"true"</li>
}
/**
- * Comma-separated list of languages
- *
* Example value: "java,js"
*/
public ActivateRulesRequest setLanguages(List<String> languages) {
}
/**
- * Organization key
- *
* This is part of the internal API.
* Example value: "my-org"
*/
}
/**
- * UTF-8 search query
- *
* Example value: "xpath"
*/
public ActivateRulesRequest setQ(String q) {
}
/**
- * Quality profile key to filter on. Used only if the parameter 'activation' is set.
- *
* Example value: "AU-Tpxb--iU5OvuD2FLy"
*/
public ActivateRulesRequest setQprofile(String qprofile) {
}
/**
- * Comma-separated list of repositories
- *
* Example value: "checkstyle,findbugs"
*/
public ActivateRulesRequest setRepositories(List<String> repositories) {
}
/**
- * Key of rule to search for
- *
* Example value: "squid:S001"
*/
public ActivateRulesRequest setRuleKey(String ruleKey) {
}
/**
- * Sort field
- *
* Example value: "name"
* Possible values:
* <ul>
}
/**
- * Comma-separated list of default severities. Not the same than severity of rules in Quality profiles.
- *
* Example value: "CRITICAL,BLOCKER"
* Possible values:
* <ul>
}
/**
- * Comma-separated list of status codes
- *
* Example value: "READY"
* Possible values:
* <ul>
}
/**
- * Comma-separated list of tags. Returned rules match any of the tags (OR operator)
- *
* Example value: "security,java8"
*/
public ActivateRulesRequest setTags(List<String> tags) {
}
/**
- * Quality Profile key on which the rule activation is done. To retrieve a quality profile key please see <code>api/qualityprofiles/search</code>
- *
* This is a mandatory parameter.
* Example value: "AU-TpxcA-iU5OvuD2FL0"
*/
}
/**
- * Severity to set on the activated rules
- *
* Possible values:
* <ul>
* <li>"INFO"</li>
}
/**
- * Key of the template rule to filter on. Used to search for the custom rules based on this template.
- *
* Example value: "java:S001"
*/
public ActivateRulesRequest setTemplateKey(String templateKey) {
}
/**
- * Comma-separated list of types. Returned rules match any of the tags (OR operator)
- *
* Example value: "BUG"
* Possible values:
* <ul>
*/
package org.sonarqube.ws.client.qualityprofiles;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Allow a group to edit a Quality Profile.<br>Requires one of the following permissions:<ul> <li>'Administer Quality Profiles'</li> <li>Edit right on the specified quality profile</li></ul>
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/qualityprofiles/add_group">Further information about this action online (including a response example)</a>
private String qualityProfile;
/**
- * Group name
- *
* This is a mandatory parameter.
* Example value: "sonar-administrators"
*/
}
/**
- * Quality profile language
- *
* This is a mandatory parameter.
*/
public AddGroupRequest setLanguage(String language) {
}
/**
- * Organization key. If no organization is provided, the default organization is used.
- *
* This is part of the internal API.
* Example value: "my-org"
*/
}
/**
- * Quality Profile name
- *
* This is a mandatory parameter.
* Example value: "Recommended quality profile"
*/
*/
package org.sonarqube.ws.client.qualityprofiles;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Associate a project with a quality profile.<br> Requires one of the following permissions:<ul> <li>'Administer Quality Profiles'</li> <li>Edit right on the specified quality profile</li> <li>Administer right on the specified project</li></ul>
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/qualityprofiles/add_project">Further information about this action online (including a response example)</a>
private String qualityProfile;
/**
- * Quality profile key
- *
* Example value: "AU-Tpxb--iU5OvuD2FLy"
* @deprecated since 6.6
*/
}
/**
- * Quality profile language. If this parameter is set, 'key' must not be set and 'language' must be set to disambiguate.
- *
*/
public AddProjectRequest setLanguage(String language) {
this.language = language;
}
/**
- * Organization key. If no organization is provided, the default organization is used.
- *
* This is part of the internal API.
* Example value: "my-org"
*/
}
/**
- * Project key
- *
* Example value: "my_project"
*/
public AddProjectRequest setProject(String project) {
}
/**
- * Project ID. Either this parameter or 'project' must be set.
- *
* Example value: "AU-TpxcA-iU5OvuD2FL5"
* @deprecated since 6.5
*/
}
/**
- * Quality profile name. If this parameter is set, 'key' must not be set and 'language' must be set to disambiguate.
- *
* Example value: "Sonar way"
*/
public AddProjectRequest setQualityProfile(String qualityProfile) {
*/
package org.sonarqube.ws.client.qualityprofiles;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Allow a user to edit a Quality Profile.<br>Requires one of the following permissions:<ul> <li>'Administer Quality Profiles'</li> <li>Edit right on the specified quality profile</li></ul>
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/qualityprofiles/add_user">Further information about this action online (including a response example)</a>
private String qualityProfile;
/**
- * Quality profile language
- *
* This is a mandatory parameter.
*/
public AddUserRequest setLanguage(String language) {
}
/**
- * User login
- *
* This is a mandatory parameter.
* Example value: "john.doe"
*/
}
/**
- * Organization key. If no organization is provided, the default organization is used.
- *
* This is part of the internal API.
* Example value: "my-org"
*/
}
/**
- * Quality Profile name
- *
* This is a mandatory parameter.
* Example value: "Recommended quality profile"
*/
*/
package org.sonarqube.ws.client.qualityprofiles;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Backup a quality profile in XML form. The exported profile can be restored through api/qualityprofiles/restore.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/qualityprofiles/backup">Further information about this action online (including a response example)</a>
private String qualityProfile;
/**
- * Quality profile key
- *
* Example value: "AU-Tpxb--iU5OvuD2FLy"
* @deprecated since 6.6
*/
}
/**
- * Quality profile language. If this parameter is set, 'key' must not be set and 'language' must be set to disambiguate.
- *
*/
public BackupRequest setLanguage(String language) {
this.language = language;
}
/**
- * Organization key. If no organization is provided, the default organization is used.
- *
* This is part of the internal API.
* Example value: "my-org"
*/
}
/**
- * Quality profile name. If this parameter is set, 'key' must not be set and 'language' must be set to disambiguate.
- *
* Example value: "Sonar way"
*/
public BackupRequest setQualityProfile(String qualityProfile) {
*/
package org.sonarqube.ws.client.qualityprofiles;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Change a quality profile's parent.<br>Requires one of the following permissions:<ul> <li>'Administer Quality Profiles'</li> <li>Edit right on the specified quality profile</li></ul>
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/qualityprofiles/change_parent">Further information about this action online (including a response example)</a>
private String qualityProfile;
/**
- * Quality profile key
- *
* Example value: "AU-Tpxb--iU5OvuD2FLy"
* @deprecated since 6.6
*/
}
/**
- * Quality profile language. If this parameter is set, 'key' must not be set and 'language' must be set to disambiguate.
- *
*/
public ChangeParentRequest setLanguage(String language) {
this.language = language;
}
/**
- * Organization key. If no organization is provided, the default organization is used.
- *
* This is part of the internal API.
* Example value: "my-org"
*/
}
/**
- * New parent profile key.<br> If no profile is provided, the inheritance link with current parent profile (if any) is broken, which deactivates all rules which come from the parent and are not overridden.
- *
* Example value: "AU-TpxcA-iU5OvuD2FLz"
* @deprecated since 6.6
*/
}
/**
- * Quality profile name. If this parameter is set, 'parentKey' must not be set and 'language' must be set to disambiguate.
- *
* Example value: "Sonar way"
*/
public ChangeParentRequest setParentQualityProfile(String parentQualityProfile) {
}
/**
- * Quality profile name. If this parameter is set, 'key' must not be set and 'language' must be set to disambiguate.
- *
* Example value: "Sonar way"
*/
public ChangeParentRequest setQualityProfile(String qualityProfile) {
*/
package org.sonarqube.ws.client.qualityprofiles;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Get the history of changes on a quality profile: rule activation/deactivation, change in parameters/severity. Events are ordered by date in descending order (most recent first).
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/qualityprofiles/changelog">Further information about this action online (including a response example)</a>
private String to;
/**
- * Quality profile key
- *
* Example value: "AU-Tpxb--iU5OvuD2FLy"
* @deprecated since 6.6
*/
}
/**
- * Quality profile language. If this parameter is set, 'key' must not be set and 'language' must be set to disambiguate.
- *
*/
public ChangelogRequest setLanguage(String language) {
this.language = language;
}
/**
- * Organization key. If no organization is provided, the default organization is used.
- *
* This is part of the internal API.
* Example value: "my-org"
*/
}
/**
- * 1-based page number
- *
* Example value: "42"
*/
public ChangelogRequest setP(String p) {
}
/**
- * Page size. Must be greater than 0 and less than 500
- *
* Example value: "20"
*/
public ChangelogRequest setPs(String ps) {
}
/**
- * Quality profile name. If this parameter is set, 'key' must not be set and 'language' must be set to disambiguate.
- *
* Example value: "Sonar way"
*/
public ChangelogRequest setQualityProfile(String qualityProfile) {
}
/**
- * Start date for the changelog. <br>Either a date (server timezone) or datetime can be provided.
- *
* Example value: "2017-10-19 or 2017-10-19T13:00:00+0200"
*/
public ChangelogRequest setSince(String since) {
}
/**
- * End date for the changelog. <br>Either a date (server timezone) or datetime can be provided.
- *
* Example value: "2017-10-19 or 2017-10-19T13:00:00+0200"
*/
public ChangelogRequest setTo(String to) {
*/
package org.sonarqube.ws.client.qualityprofiles;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Compare two quality profiles.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/qualityprofiles/compare">Further information about this action online (including a response example)</a>
private String rightKey;
/**
- * Profile key.
- *
* This is a mandatory parameter.
* Example value: "AU-Tpxb--iU5OvuD2FLy"
*/
}
/**
- * Another profile key.
- *
* This is a mandatory parameter.
* Example value: "AU-TpxcA-iU5OvuD2FLz"
*/
*/
package org.sonarqube.ws.client.qualityprofiles;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Copy a quality profile.<br> Requires to be logged in and the 'Administer Quality Profiles' permission.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/qualityprofiles/copy">Further information about this action online (including a response example)</a>
private String toName;
/**
- * Quality profile key
- *
* This is a mandatory parameter.
* Example value: "AU-Tpxb--iU5OvuD2FLy"
*/
}
/**
- * Name for the new quality profile.
- *
* This is a mandatory parameter.
* Example value: "My Sonar way"
*/
*/
package org.sonarqube.ws.client.qualityprofiles;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Create a quality profile.<br>Requires to be logged in and the 'Administer Quality Profiles' permission.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/qualityprofiles/create">Further information about this action online (including a response example)</a>
private String organization;
/**
- * Quality profile language
- *
* This is a mandatory parameter.
* Example value: "js"
*/
}
/**
- * Quality profile name
- *
* This is a mandatory parameter.
* Example value: "My Sonar way"
*/
}
/**
- * Organization key. If no organization is provided, the default organization is used.
- *
* This is part of the internal API.
* Example value: "my-org"
*/
*/
package org.sonarqube.ws.client.qualityprofiles;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Deactivate a rule on a quality profile.<br> Requires one of the following permissions:<ul> <li>'Administer Quality Profiles'</li> <li>Edit right on the specified quality profile</li></ul>
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/qualityprofiles/deactivate_rule">Further information about this action online (including a response example)</a>
private String rule;
/**
- * Quality Profile key. Can be obtained through <code>api/qualityprofiles/search</code>
- *
* This is a mandatory parameter.
* Example value: "AU-Tpxb--iU5OvuD2FLy"
*/
}
/**
- * Rule key
- *
* This is a mandatory parameter.
* Example value: "squid:AvoidCycles"
*/
import javax.annotation.Generated;
/**
- * Bulk deactivate rules on Quality profiles.<br>Requires one of the following permissions:<ul> <li>'Administer Quality Profiles'</li> <li>Edit right on the specified quality profile</li></ul>
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/qualityprofiles/deactivate_rules">Further information about this action online (including a response example)</a>
private List<String> types;
/**
- * Filter rules that are activated or deactivated on the selected Quality profile. Ignored if the parameter 'qprofile' is not set.
- *
* Possible values:
* <ul>
* <li>"true"</li>
}
/**
- * Comma-separated list of activation severities, i.e the severity of rules in Quality profiles.
- *
* Example value: "CRITICAL,BLOCKER"
* Possible values:
* <ul>
}
/**
- * Ascending sort
- *
* Possible values:
* <ul>
* <li>"true"</li>
}
/**
- * Filters rules added since date. Format is yyyy-MM-dd
- *
* Example value: "2014-06-22"
*/
public DeactivateRulesRequest setAvailableSince(String availableSince) {
}
/**
- * Quality profile key to filter rules that are activated. Meant to compare easily to profile set in 'qprofile'
- *
* This is part of the internal API.
* Example value: "AU-TpxcA-iU5OvuD2FLz"
*/
}
/**
- * Comma-separated list of values of inheritance for a rule within a quality profile. Used only if the parameter 'activation' is set.
- *
* Example value: "INHERITED,OVERRIDES"
* Possible values:
* <ul>
}
/**
- * Filter template rules
- *
* Possible values:
* <ul>
* <li>"true"</li>
}
/**
- * Comma-separated list of languages
- *
* Example value: "java,js"
*/
public DeactivateRulesRequest setLanguages(List<String> languages) {
}
/**
- * Organization key
- *
* This is part of the internal API.
* Example value: "my-org"
*/
}
/**
- * UTF-8 search query
- *
* Example value: "xpath"
*/
public DeactivateRulesRequest setQ(String q) {
}
/**
- * Quality profile key to filter on. Used only if the parameter 'activation' is set.
- *
* Example value: "AU-Tpxb--iU5OvuD2FLy"
*/
public DeactivateRulesRequest setQprofile(String qprofile) {
}
/**
- * Comma-separated list of repositories
- *
* Example value: "checkstyle,findbugs"
*/
public DeactivateRulesRequest setRepositories(List<String> repositories) {
}
/**
- * Key of rule to search for
- *
* Example value: "squid:S001"
*/
public DeactivateRulesRequest setRuleKey(String ruleKey) {
}
/**
- * Sort field
- *
* Example value: "name"
* Possible values:
* <ul>
}
/**
- * Comma-separated list of default severities. Not the same than severity of rules in Quality profiles.
- *
* Example value: "CRITICAL,BLOCKER"
* Possible values:
* <ul>
}
/**
- * Comma-separated list of status codes
- *
* Example value: "READY"
* Possible values:
* <ul>
}
/**
- * Comma-separated list of tags. Returned rules match any of the tags (OR operator)
- *
* Example value: "security,java8"
*/
public DeactivateRulesRequest setTags(List<String> tags) {
}
/**
- * Quality Profile key on which the rule deactivation is done. To retrieve a profile key please see <code>api/qualityprofiles/search</code>
- *
* This is a mandatory parameter.
* Example value: "AU-TpxcA-iU5OvuD2FL1"
*/
}
/**
- * Key of the template rule to filter on. Used to search for the custom rules based on this template.
- *
* Example value: "java:S001"
*/
public DeactivateRulesRequest setTemplateKey(String templateKey) {
}
/**
- * Comma-separated list of types. Returned rules match any of the tags (OR operator)
- *
* Example value: "BUG"
* Possible values:
* <ul>
*/
package org.sonarqube.ws.client.qualityprofiles;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Delete a quality profile and all its descendants. The default quality profile cannot be deleted.<br> Requires one of the following permissions:<ul> <li>'Administer Quality Profiles'</li> <li>Edit right on the specified quality profile</li></ul>
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/qualityprofiles/delete">Further information about this action online (including a response example)</a>
private String qualityProfile;
/**
- * Quality profile key
- *
* Example value: "AU-Tpxb--iU5OvuD2FLy"
* @deprecated since 6.6
*/
}
/**
- * Quality profile language. If this parameter is set, 'key' must not be set and 'language' must be set to disambiguate.
- *
*/
public DeleteRequest setLanguage(String language) {
this.language = language;
}
/**
- * Organization key. If no organization is provided, the default organization is used.
- *
* This is part of the internal API.
* Example value: "my-org"
*/
}
/**
- * Quality profile name. If this parameter is set, 'key' must not be set and 'language' must be set to disambiguate.
- *
* Example value: "Sonar way"
*/
public DeleteRequest setQualityProfile(String qualityProfile) {
*/
package org.sonarqube.ws.client.qualityprofiles;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Export a quality profile.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/qualityprofiles/export">Further information about this action online (including a response example)</a>
private String qualityProfile;
/**
- * Quality profile key
- *
* Example value: "AU-Tpxb--iU5OvuD2FLy"
* @deprecated since 6.6
*/
}
/**
- * Quality profile language. If this parameter is set, 'key' must not be set.
- *
* Example value: ""
*/
public ExportRequest setLanguage(String language) {
}
/**
- * Organization key. If no organization is provided, the default organization is used.
- *
* This is part of the internal API.
* Example value: "my-org"
*/
}
/**
- * Quality profile name to export. If left empty, the default profile for the language is exported. If this parameter is set, 'key' must not be set.
- *
* Example value: "My Sonar way"
*/
public ExportRequest setQualityProfile(String qualityProfile) {
*/
package org.sonarqube.ws.client.qualityprofiles;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Show a quality profile's ancestors and children.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/qualityprofiles/inheritance">Further information about this action online (including a response example)</a>
private String qualityProfile;
/**
- * Quality profile key
- *
* Example value: "AU-Tpxb--iU5OvuD2FLy"
* @deprecated since 6.6
*/
}
/**
- * Quality profile language. If this parameter is set, 'key' must not be set and 'language' must be set to disambiguate.
- *
*/
public InheritanceRequest setLanguage(String language) {
this.language = language;
}
/**
- * Organization key. If no organization is provided, the default organization is used.
- *
* This is part of the internal API.
* Example value: "my-org"
*/
}
/**
- * Quality profile name. If this parameter is set, 'key' must not be set and 'language' must be set to disambiguate.
- *
* Example value: "Sonar way"
*/
public InheritanceRequest setQualityProfile(String qualityProfile) {
*/
package org.sonarqube.ws.client.qualityprofiles;
+import java.util.List;
import javax.annotation.Generated;
/**
- * List projects with their association status regarding a quality profile
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/qualityprofiles/projects">Further information about this action online (including a response example)</a>
private String selected;
/**
- * Quality profile key
- *
* This is a mandatory parameter.
* Example value: "AU-Tpxb--iU5OvuD2FLy"
*/
}
/**
- * 1-based page number
- *
* Example value: "42"
*/
public ProjectsRequest setP(String p) {
}
/**
- * Page size. Must be greater than 0 and less than 500
- *
* Example value: "20"
*/
public ProjectsRequest setPs(String ps) {
}
/**
- * Limit search to projects that contain the supplied string.
- *
* Example value: "sonar"
*/
public ProjectsRequest setQ(String q) {
}
/**
- * Depending on the value, show only selected items (selected=selected), deselected items (selected=deselected), or all items with their selection status (selected=all).
- *
* Possible values:
* <ul>
* <li>"all"</li>
import org.sonarqube.ws.Qualityprofiles.ShowResponse;
/**
- * Manage quality profiles.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/qualityprofiles">Further information about this web service online</a>
*/
@Generated("sonar-ws-generator")
}
/**
- * Activate a rule on a Quality Profile.<br> Requires one of the following permissions:<ul> <li>'Administer Quality Profiles'</li> <li>Edit right on the specified quality profile</li></ul>
*
* This is part of the internal API.
* This is a POST request.
call(
new PostRequest(path("activate_rule"))
.setParam("key", request.getKey())
- .setParam("params", request.getParams())
+ .setParam("params", request.getParams() == null ? null : request.getParams().stream().collect(Collectors.joining(",")))
.setParam("reset", request.getReset())
.setParam("rule", request.getRule())
.setParam("severity", request.getSeverity())
}
/**
- * Bulk-activate rules on one quality profile.<br> Requires one of the following permissions:<ul> <li>'Administer Quality Profiles'</li> <li>Edit right on the specified quality profile</li></ul>
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * Allow a group to edit a Quality Profile.<br>Requires one of the following permissions:<ul> <li>'Administer Quality Profiles'</li> <li>Edit right on the specified quality profile</li></ul>
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * Associate a project with a quality profile.<br> Requires one of the following permissions:<ul> <li>'Administer Quality Profiles'</li> <li>Edit right on the specified quality profile</li> <li>Administer right on the specified project</li></ul>
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * Allow a user to edit a Quality Profile.<br>Requires one of the following permissions:<ul> <li>'Administer Quality Profiles'</li> <li>Edit right on the specified quality profile</li></ul>
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * Backup a quality profile in XML form. The exported profile can be restored through api/qualityprofiles/restore.
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * Change a quality profile's parent.<br>Requires one of the following permissions:<ul> <li>'Administer Quality Profiles'</li> <li>Edit right on the specified quality profile</li></ul>
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * Get the history of changes on a quality profile: rule activation/deactivation, change in parameters/severity. Events are ordered by date in descending order (most recent first).
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * Compare two quality profiles.
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * Copy a quality profile.<br> Requires to be logged in and the 'Administer Quality Profiles' permission.
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * Create a quality profile.<br>Requires to be logged in and the 'Administer Quality Profiles' permission.
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * Deactivate a rule on a quality profile.<br> Requires one of the following permissions:<ul> <li>'Administer Quality Profiles'</li> <li>Edit right on the specified quality profile</li></ul>
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * Bulk deactivate rules on Quality profiles.<br>Requires one of the following permissions:<ul> <li>'Administer Quality Profiles'</li> <li>Edit right on the specified quality profile</li></ul>
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * Delete a quality profile and all its descendants. The default quality profile cannot be deleted.<br> Requires one of the following permissions:<ul> <li>'Administer Quality Profiles'</li> <li>Edit right on the specified quality profile</li></ul>
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * Export a quality profile.
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * Lists available profile export formats.
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * List supported importers.
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * Show a quality profile's ancestors and children.
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * List projects with their association status regarding a quality profile
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * Remove the ability from a group to edit a Quality Profile.<br>Requires one of the following permissions:<ul> <li>'Administer Quality Profiles'</li> <li>Edit right on the specified quality profile</li></ul>
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * Remove a project's association with a quality profile.<br> Requires one of the following permissions:<ul> <li>'Administer Quality Profiles'</li> <li>Edit right on the specified quality profile</li> <li>Administer right on the specified project</li></ul>
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * Remove the ability from a user to edit a Quality Profile.<br>Requires one of the following permissions:<ul> <li>'Administer Quality Profiles'</li> <li>Edit right on the specified quality profile</li></ul>
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * Rename a quality profile.<br> Requires one of the following permissions:<ul> <li>'Administer Quality Profiles'</li> <li>Edit right on the specified quality profile</li></ul>
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * Restore a quality profile using an XML file. The restored profile name is taken from the backup file, so if a profile with the same name and language already exists, it will be overwritten.<br> Requires to be logged in and the 'Administer Quality Profiles' permission.
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * This web service has no effect since 6.4. It's no more possible to restore built-in quality profiles because they are automatically updated and read only. Returns HTTP code 410.
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * Search quality profiles
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * List the groups that are allowed to edit a Quality Profile.<br>Requires one of the following permissions:<ul> <li>'Administer Quality Profiles'</li> <li>Edit right on the specified quality profile</li></ul>
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * List the users that are allowed to edit a Quality Profile.<br>Requires one of the following permissions:<ul> <li>'Administer Quality Profiles'</li> <li>Edit right on the specified quality profile</li></ul>
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * Select the default profile for a given language.<br> Requires to be logged in and the 'Administer Quality Profiles' permission.
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * Show a quality profile
*
* This is part of the internal API.
* This is a GET request.
*/
package org.sonarqube.ws.client.qualityprofiles;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Remove the ability from a group to edit a Quality Profile.<br>Requires one of the following permissions:<ul> <li>'Administer Quality Profiles'</li> <li>Edit right on the specified quality profile</li></ul>
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/qualityprofiles/remove_group">Further information about this action online (including a response example)</a>
private String qualityProfile;
/**
- * Group name
- *
* This is a mandatory parameter.
* Example value: "sonar-administrators"
*/
}
/**
- * Quality profile language
- *
* This is a mandatory parameter.
*/
public RemoveGroupRequest setLanguage(String language) {
}
/**
- * Organization key. If no organization is provided, the default organization is used.
- *
* This is part of the internal API.
* Example value: "my-org"
*/
}
/**
- * Quality Profile name
- *
* This is a mandatory parameter.
* Example value: "Recommended quality profile"
*/
*/
package org.sonarqube.ws.client.qualityprofiles;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Remove a project's association with a quality profile.<br> Requires one of the following permissions:<ul> <li>'Administer Quality Profiles'</li> <li>Edit right on the specified quality profile</li> <li>Administer right on the specified project</li></ul>
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/qualityprofiles/remove_project">Further information about this action online (including a response example)</a>
private String qualityProfile;
/**
- * Quality profile key
- *
* Example value: "AU-Tpxb--iU5OvuD2FLy"
* @deprecated since 6.6
*/
}
/**
- * Quality profile language. If this parameter is set, 'key' must not be set and 'language' must be set to disambiguate.
- *
*/
public RemoveProjectRequest setLanguage(String language) {
this.language = language;
}
/**
- * Organization key. If no organization is provided, the default organization is used.
- *
* This is part of the internal API.
* Example value: "my-org"
*/
}
/**
- * Project key
- *
* Example value: "my_project"
*/
public RemoveProjectRequest setProject(String project) {
}
/**
- * Project ID. Either this parameter, or 'project' must be set.
- *
* Example value: "AU-TpxcB-iU5OvuD2FL6"
* @deprecated since 6.5
*/
}
/**
- * Quality profile name. If this parameter is set, 'key' must not be set and 'language' must be set to disambiguate.
- *
* Example value: "Sonar way"
*/
public RemoveProjectRequest setQualityProfile(String qualityProfile) {
*/
package org.sonarqube.ws.client.qualityprofiles;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Remove the ability from a user to edit a Quality Profile.<br>Requires one of the following permissions:<ul> <li>'Administer Quality Profiles'</li> <li>Edit right on the specified quality profile</li></ul>
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/qualityprofiles/remove_user">Further information about this action online (including a response example)</a>
private String qualityProfile;
/**
- * Quality profile language
- *
* This is a mandatory parameter.
*/
public RemoveUserRequest setLanguage(String language) {
}
/**
- * User login
- *
* This is a mandatory parameter.
* Example value: "john.doe"
*/
}
/**
- * Organization key. If no organization is provided, the default organization is used.
- *
* This is part of the internal API.
* Example value: "my-org"
*/
}
/**
- * Quality Profile name
- *
* This is a mandatory parameter.
* Example value: "Recommended quality profile"
*/
*/
package org.sonarqube.ws.client.qualityprofiles;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Rename a quality profile.<br> Requires one of the following permissions:<ul> <li>'Administer Quality Profiles'</li> <li>Edit right on the specified quality profile</li></ul>
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/qualityprofiles/rename">Further information about this action online (including a response example)</a>
private String name;
/**
- * Quality profile key
- *
* This is a mandatory parameter.
* Example value: "AU-Tpxb--iU5OvuD2FLy"
*/
}
/**
- * New quality profile name
- *
* This is a mandatory parameter.
* Example value: "My Sonar way"
*/
*/
package org.sonarqube.ws.client.qualityprofiles;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Restore a quality profile using an XML file. The restored profile name is taken from the backup file, so if a profile with the same name and language already exists, it will be overwritten.<br> Requires to be logged in and the 'Administer Quality Profiles' permission.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/qualityprofiles/restore">Further information about this action online (including a response example)</a>
private String organization;
/**
- * A profile backup file in XML format, as generated by api/qualityprofiles/backup or the former api/profiles/backup.
- *
* This is a mandatory parameter.
*/
public RestoreRequest setBackup(String backup) {
}
/**
- * Organization key. If no organization is provided, the default organization is used.
- *
* This is part of the internal API.
* Example value: "my-org"
*/
*/
package org.sonarqube.ws.client.qualityprofiles;
+import java.util.List;
import javax.annotation.Generated;
/**
- * List the groups that are allowed to edit a Quality Profile.<br>Requires one of the following permissions:<ul> <li>'Administer Quality Profiles'</li> <li>Edit right on the specified quality profile</li></ul>
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/qualityprofiles/search_groups">Further information about this action online (including a response example)</a>
private String selected;
/**
- * Quality profile language
- *
* This is a mandatory parameter.
*/
public SearchGroupsRequest setLanguage(String language) {
}
/**
- * Organization key. If no organization is provided, the default organization is used.
- *
* This is part of the internal API.
* Example value: "my-org"
*/
}
/**
- * 1-based page number
- *
* Example value: "42"
*/
public SearchGroupsRequest setP(String p) {
}
/**
- * Page size. Must be greater than 0.
- *
* Example value: "20"
*/
public SearchGroupsRequest setPs(String ps) {
}
/**
- * Limit search to group names that contain the supplied string.
- *
* Example value: "sonar"
*/
public SearchGroupsRequest setQ(String q) {
}
/**
- * Quality Profile name
- *
* This is a mandatory parameter.
* Example value: "Recommended quality profile"
*/
}
/**
- * Depending on the value, show only selected items (selected=selected), deselected items (selected=deselected), or all items with their selection status (selected=all).
- *
* Possible values:
* <ul>
* <li>"all"</li>
*/
package org.sonarqube.ws.client.qualityprofiles;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Search quality profiles
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/qualityprofiles/search">Further information about this action online (including a response example)</a>
private String qualityProfile;
/**
- * If set to true, return only the quality profiles marked as default for each language
- *
* Possible values:
* <ul>
* <li>"true"</li>
}
/**
- * Language key. If provided, only profiles for the given language are returned.
- *
*/
public SearchRequest setLanguage(String language) {
this.language = language;
}
/**
- * Organization key. If no organization is provided, the default organization is used.
- *
* This is part of the internal API.
* Example value: "my-org"
*/
}
/**
- * Project key
- *
* Example value: "my_project"
*/
public SearchRequest setProject(String project) {
}
/**
- * Quality profile name
- *
* Example value: "SonarQube Way"
*/
public SearchRequest setQualityProfile(String qualityProfile) {
*/
package org.sonarqube.ws.client.qualityprofiles;
+import java.util.List;
import javax.annotation.Generated;
/**
- * List the users that are allowed to edit a Quality Profile.<br>Requires one of the following permissions:<ul> <li>'Administer Quality Profiles'</li> <li>Edit right on the specified quality profile</li></ul>
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/qualityprofiles/search_users">Further information about this action online (including a response example)</a>
private String selected;
/**
- * Quality profile language
- *
* This is a mandatory parameter.
*/
public SearchUsersRequest setLanguage(String language) {
}
/**
- * Organization key. If no organization is provided, the default organization is used.
- *
* This is part of the internal API.
* Example value: "my-org"
*/
}
/**
- * 1-based page number
- *
* Example value: "42"
*/
public SearchUsersRequest setP(String p) {
}
/**
- * Page size. Must be greater than 0.
- *
* Example value: "20"
*/
public SearchUsersRequest setPs(String ps) {
}
/**
- * Limit search to names or logins that contain the supplied string.
- *
* Example value: "freddy"
*/
public SearchUsersRequest setQ(String q) {
}
/**
- * Quality Profile name
- *
* This is a mandatory parameter.
* Example value: "Recommended quality profile"
*/
}
/**
- * Depending on the value, show only selected items (selected=selected), deselected items (selected=deselected), or all items with their selection status (selected=all).
- *
* Possible values:
* <ul>
* <li>"all"</li>
*/
package org.sonarqube.ws.client.qualityprofiles;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Select the default profile for a given language.<br> Requires to be logged in and the 'Administer Quality Profiles' permission.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/qualityprofiles/set_default">Further information about this action online (including a response example)</a>
private String qualityProfile;
/**
- * Quality profile key
- *
* Example value: "AU-Tpxb--iU5OvuD2FLy"
* @deprecated since 6.6
*/
}
/**
- * Quality profile language. If this parameter is set, 'key' must not be set and 'language' must be set to disambiguate.
- *
*/
public SetDefaultRequest setLanguage(String language) {
this.language = language;
}
/**
- * Organization key. If no organization is provided, the default organization is used.
- *
* This is part of the internal API.
* Example value: "my-org"
*/
}
/**
- * Quality profile name. If this parameter is set, 'key' must not be set and 'language' must be set to disambiguate.
- *
* Example value: "Sonar way"
*/
public SetDefaultRequest setQualityProfile(String qualityProfile) {
*/
package org.sonarqube.ws.client.qualityprofiles;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Show a quality profile
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/qualityprofiles/show">Further information about this action online (including a response example)</a>
private String key;
/**
- * Add the number of missing rules from the related Sonar way profile in the response
- *
* This is part of the internal API.
* Possible values:
* <ul>
}
/**
- * Quality profile key
- *
* This is a mandatory parameter.
* Example value: "AU-Tpxb--iU5OvuD2FLy"
*/
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
@ParametersAreNonnullByDefault
+@Generated("sonar-ws-generator")
package org.sonarqube.ws.client.qualityprofiles;
import javax.annotation.ParametersAreNonnullByDefault;
+import javax.annotation.Generated;
import org.sonarqube.ws.client.WsConnector;
/**
- * Removed since 6.3, please use api/components and api/measures instead
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/resources">Further information about this web service online</a>
*/
@Generated("sonar-ws-generator")
}
/**
- * The web service is removed and you're invited to use the alternatives: <ul><li>if you need one component without measures: api/components/show</li><li>if you need one component with measures: api/measures/component</li><li>if you need several components without measures: api/components/tree</li><li>if you need several components with measures: api/measures/component_tree</li></ul>
*
* This is part of the internal API.
* This is a GET request.
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
@ParametersAreNonnullByDefault
+@Generated("sonar-ws-generator")
package org.sonarqube.ws.client.resources;
import javax.annotation.ParametersAreNonnullByDefault;
+import javax.annotation.Generated;
*/
package org.sonarqube.ws.client.roots;
+import java.util.stream.Collectors;
import javax.annotation.Generated;
import org.sonarqube.ws.MediaTypes;
import org.sonarqube.ws.client.BaseService;
import org.sonarqube.ws.Roots.SearchResponse;
/**
- * Manage root users
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/roots">Further information about this web service online</a>
*/
@Generated("sonar-ws-generator")
}
/**
- * Search for root users.<br/>Requires to be root.
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * Make the specified user root.<br/>Requires to be root.
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * Make the specified user not root.<br/>Requires to be root.
*
* This is part of the internal API.
* This is a POST request.
*/
package org.sonarqube.ws.client.roots;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Make the specified user root.<br/>Requires to be root.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/roots/set_root">Further information about this action online (including a response example)</a>
private String login;
/**
- * A user login
- *
* This is a mandatory parameter.
* Example value: "admin"
*/
*/
package org.sonarqube.ws.client.roots;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Make the specified user not root.<br/>Requires to be root.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/roots/unset_root">Further information about this action online (including a response example)</a>
private String login;
/**
- * A user login
- *
* This is a mandatory parameter.
* Example value: "admin"
*/
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
@ParametersAreNonnullByDefault
+@Generated("sonar-ws-generator")
package org.sonarqube.ws.client.roots;
import javax.annotation.ParametersAreNonnullByDefault;
+import javax.annotation.Generated;
*/
package org.sonarqube.ws.client.rules;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Get data required for rendering the page 'Coding Rules'.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/rules/app">Further information about this action online (including a response example)</a>
private String organization;
/**
- * Organization key
- *
* This is part of the internal API.
* Example value: "my-org"
*/
*/
package org.sonarqube.ws.client.rules;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Create a custom rule.<br>Requires the 'Administer Quality Profiles' permission
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/rules/create">Further information about this action online (including a response example)</a>
private String manualKey;
private String markdownDescription;
private String name;
- private String params;
+ private List<String> params;
private String preventReactivation;
private String severity;
private String status;
private String type;
/**
- * Key of the custom rule
- *
* This is a mandatory parameter.
* Example value: "Todo_should_not_be_used"
*/
}
/**
- * Manual rules are no more supported. This parameter is ignored
- *
* Example value: "Error_handling"
* @deprecated since 5.5
*/
}
/**
- * Rule description
- *
* This is a mandatory parameter.
* Example value: "Description of my custom rule"
*/
}
/**
- * Rule name
- *
* This is a mandatory parameter.
* Example value: "My custom rule"
*/
}
/**
- * Parameters as semi-colon list of <key>=<value>, for example 'params=key1=v1;key2=v2' (Only for custom rule)
- *
*/
- public CreateRequest setParams(String params) {
+ public CreateRequest setParams(List<String> params) {
this.params = params;
return this;
}
- public String getParams() {
+ public List<String> getParams() {
return params;
}
/**
- * If set to true and if the rule has been deactivated (status 'REMOVED'), a status 409 will be returned
- *
* Possible values:
* <ul>
* <li>"true"</li>
}
/**
- * Rule severity
- *
* Possible values:
* <ul>
* <li>"INFO"</li>
}
/**
- * Rule status
- *
* Possible values:
* <ul>
* <li>"BETA"</li>
}
/**
- * Key of the template rule in order to create a custom rule (mandatory for custom rule)
- *
* Example value: "java:XPath"
*/
public CreateRequest setTemplateKey(String templateKey) {
}
/**
- * Rule type
- *
* Possible values:
* <ul>
* <li>"CODE_SMELL"</li>
*/
package org.sonarqube.ws.client.rules;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Delete custom rule.<br/>Requires the 'Administer Quality Profiles' permission
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/rules/delete">Further information about this action online (including a response example)</a>
private String key;
/**
- * Rule key
- *
* This is a mandatory parameter.
* Example value: "squid:XPath_1402065390816"
*/
*/
package org.sonarqube.ws.client.rules;
+import java.util.List;
import javax.annotation.Generated;
/**
- * List available rule repositories
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/rules/repositories">Further information about this action online (including a response example)</a>
private String q;
/**
- * A language key; if provided, only repositories for the given language will be returned
- *
* Example value: "java"
*/
public RepositoriesRequest setLanguage(String language) {
}
/**
- * A pattern to match repository keys/names against
- *
* Example value: "squid"
*/
public RepositoriesRequest setQ(String q) {
import org.sonarqube.ws.Rules.UpdateResponse;
/**
- * Get and update some details of automatic rules, and manage custom rules.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/rules">Further information about this web service online</a>
*/
@Generated("sonar-ws-generator")
}
/**
- * Get data required for rendering the page 'Coding Rules'.
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * Create a custom rule.<br>Requires the 'Administer Quality Profiles' permission
*
* This is part of the internal API.
* This is a POST request.
.setParam("manual_key", request.getManualKey())
.setParam("markdown_description", request.getMarkdownDescription())
.setParam("name", request.getName())
- .setParam("params", request.getParams())
+ .setParam("params", request.getParams() == null ? null : request.getParams().stream().collect(Collectors.joining(",")))
.setParam("prevent_reactivation", request.getPreventReactivation())
.setParam("severity", request.getSeverity())
.setParam("status", request.getStatus())
}
/**
- * Delete custom rule.<br/>Requires the 'Administer Quality Profiles' permission
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * List rules, excluding the manual rules and the rules with status REMOVED. JSON format is not supported for response.
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * List available rule repositories
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * Search for a collection of relevant rules matching a specified query.<br/>Since 5.5, following fields in the response have been deprecated :<ul><li>"effortToFixDescription" becomes "gapDescription"</li><li>"debtRemFnCoeff" becomes "remFnGapMultiplier"</li><li>"defaultDebtRemFnCoeff" becomes "defaultRemFnGapMultiplier"</li><li>"debtRemFnOffset" becomes "remFnBaseEffort"</li><li>"defaultDebtRemFnOffset" becomes "defaultRemFnBaseEffort"</li><li>"debtOverloaded" becomes "remFnOverloaded"</li></ul>
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * Get detailed information about a rule<br>Since 5.5, following fields in the response have been deprecated :<ul><li>"effortToFixDescription" becomes "gapDescription"</li><li>"debtRemFnCoeff" becomes "remFnGapMultiplier"</li><li>"defaultDebtRemFnCoeff" becomes "defaultRemFnGapMultiplier"</li><li>"debtRemFnOffset" becomes "remFnBaseEffort"</li><li>"defaultDebtRemFnOffset" becomes "defaultRemFnBaseEffort"</li><li>"debtOverloaded" becomes "remFnOverloaded"</li></ul>
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * List rule tags
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * Update an existing rule.<br>Requires the 'Administer Quality Profiles' permission
*
* This is part of the internal API.
* This is a POST request.
.setParam("markdown_note", request.getMarkdownNote())
.setParam("name", request.getName())
.setParam("organization", request.getOrganization())
- .setParam("params", request.getParams())
+ .setParam("params", request.getParams() == null ? null : request.getParams().stream().collect(Collectors.joining(",")))
.setParam("remediation_fn_base_effort", request.getRemediationFnBaseEffort())
.setParam("remediation_fn_type", request.getRemediationFnType())
.setParam("remediation_fy_gap_multiplier", request.getRemediationFyGapMultiplier())
import javax.annotation.Generated;
/**
- * Search for a collection of relevant rules matching a specified query.<br/>Since 5.5, following fields in the response have been deprecated :<ul><li>"effortToFixDescription" becomes "gapDescription"</li><li>"debtRemFnCoeff" becomes "remFnGapMultiplier"</li><li>"defaultDebtRemFnCoeff" becomes "defaultRemFnGapMultiplier"</li><li>"debtRemFnOffset" becomes "remFnBaseEffort"</li><li>"defaultDebtRemFnOffset" becomes "defaultRemFnBaseEffort"</li><li>"debtOverloaded" becomes "remFnOverloaded"</li></ul>
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/rules/search">Further information about this action online (including a response example)</a>
private List<String> types;
/**
- * Filter rules that are activated or deactivated on the selected Quality profile. Ignored if the parameter 'qprofile' is not set.
- *
* Possible values:
* <ul>
* <li>"true"</li>
}
/**
- * Comma-separated list of activation severities, i.e the severity of rules in Quality profiles.
- *
* Example value: "CRITICAL,BLOCKER"
* Possible values:
* <ul>
}
/**
- * Ascending sort
- *
* Possible values:
* <ul>
* <li>"true"</li>
}
/**
- * Filters rules added since date. Format is yyyy-MM-dd
- *
* Example value: "2014-06-22"
*/
public SearchRequest setAvailableSince(String availableSince) {
}
/**
- * Quality profile key to filter rules that are activated. Meant to compare easily to profile set in 'qprofile'
- *
* This is part of the internal API.
* Example value: "AU-TpxcA-iU5OvuD2FLz"
*/
}
/**
- * Comma-separated list of the fields to be returned in response. All the fields are returned by default, except actives.Since 5.5, following fields have been deprecated :<ul><li>"defaultDebtRemFn" becomes "defaultRemFn"</li><li>"debtRemFn" becomes "remFn"</li><li>"effortToFixDescription" becomes "gapDescription"</li><li>"debtOverloaded" becomes "remFnOverloaded"</li></ul>
- *
* Example value: "repo,name"
* Possible values:
* <ul>
}
/**
- * Comma-separated list of the facets to be computed. No facet is computed by default.
- *
* Example value: "languages,repositories"
* Possible values:
* <ul>
}
/**
- * Comma-separated list of values of inheritance for a rule within a quality profile. Used only if the parameter 'activation' is set.
- *
* Example value: "INHERITED,OVERRIDES"
* Possible values:
* <ul>
}
/**
- * Filter template rules
- *
* Possible values:
* <ul>
* <li>"true"</li>
}
/**
- * Comma-separated list of languages
- *
* Example value: "java,js"
*/
public SearchRequest setLanguages(List<String> languages) {
}
/**
- * Organization key
- *
* This is part of the internal API.
* Example value: "my-org"
*/
}
/**
- * 1-based page number
- *
* Example value: "42"
*/
public SearchRequest setP(String p) {
}
/**
- * Page size. Must be greater than 0 and less than 500
- *
* Example value: "20"
*/
public SearchRequest setPs(String ps) {
}
/**
- * UTF-8 search query
- *
* Example value: "xpath"
*/
public SearchRequest setQ(String q) {
}
/**
- * Quality profile key to filter on. Used only if the parameter 'activation' is set.
- *
* Example value: "AU-Tpxb--iU5OvuD2FLy"
*/
public SearchRequest setQprofile(String qprofile) {
}
/**
- * Comma-separated list of repositories
- *
* Example value: "checkstyle,findbugs"
*/
public SearchRequest setRepositories(List<String> repositories) {
}
/**
- * Key of rule to search for
- *
* Example value: "squid:S001"
*/
public SearchRequest setRuleKey(String ruleKey) {
}
/**
- * Sort field
- *
* Example value: "name"
* Possible values:
* <ul>
}
/**
- * Comma-separated list of default severities. Not the same than severity of rules in Quality profiles.
- *
* Example value: "CRITICAL,BLOCKER"
* Possible values:
* <ul>
}
/**
- * Comma-separated list of status codes
- *
* Example value: "READY"
* Possible values:
* <ul>
}
/**
- * Comma-separated list of tags. Returned rules match any of the tags (OR operator)
- *
* Example value: "security,java8"
*/
public SearchRequest setTags(List<String> tags) {
}
/**
- * Key of the template rule to filter on. Used to search for the custom rules based on this template.
- *
* Example value: "java:S001"
*/
public SearchRequest setTemplateKey(String templateKey) {
}
/**
- * Comma-separated list of types. Returned rules match any of the tags (OR operator)
- *
* Example value: "BUG"
* Possible values:
* <ul>
*/
package org.sonarqube.ws.client.rules;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Get detailed information about a rule<br>Since 5.5, following fields in the response have been deprecated :<ul><li>"effortToFixDescription" becomes "gapDescription"</li><li>"debtRemFnCoeff" becomes "remFnGapMultiplier"</li><li>"defaultDebtRemFnCoeff" becomes "defaultRemFnGapMultiplier"</li><li>"debtRemFnOffset" becomes "remFnBaseEffort"</li><li>"defaultDebtRemFnOffset" becomes "defaultRemFnBaseEffort"</li><li>"debtOverloaded" becomes "remFnOverloaded"</li></ul>
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/rules/show">Further information about this action online (including a response example)</a>
private String organization;
/**
- * Show rule's activations for all profiles ("active rules")
- *
* Possible values:
* <ul>
* <li>"true"</li>
}
/**
- * Rule key
- *
* This is a mandatory parameter.
* Example value: "javascript:EmptyBlock"
*/
}
/**
- * Organization key
- *
* This is part of the internal API.
* Example value: "my-org"
*/
*/
package org.sonarqube.ws.client.rules;
+import java.util.List;
import javax.annotation.Generated;
/**
- * List rule tags
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/rules/tags">Further information about this action online (including a response example)</a>
private String q;
/**
- * Organization key
- *
* This is part of the internal API.
* Example value: "my-org"
*/
}
/**
- * Page size. Must be greater than 0 and less than 100
- *
* Example value: "20"
*/
public TagsRequest setPs(String ps) {
}
/**
- * Limit search to tags that contain the supplied string.
- *
* Example value: "misra"
*/
public TagsRequest setQ(String q) {
import javax.annotation.Generated;
/**
- * Update an existing rule.<br>Requires the 'Administer Quality Profiles' permission
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/rules/update">Further information about this action online (including a response example)</a>
private String markdownNote;
private String name;
private String organization;
- private String params;
+ private List<String> params;
private String remediationFnBaseEffort;
private String remediationFnType;
private String remediationFyGapMultiplier;
}
/**
- * Debt characteristics are no more supported. This parameter is ignored.
- *
* @deprecated since 5.5
*/
@Deprecated
}
/**
- * Key of the rule to update
- *
* This is a mandatory parameter.
* Example value: "javascript:NullCheck"
*/
}
/**
- * Rule description (mandatory for custom rule and manual rule)
- *
* Example value: "Description of my custom rule"
*/
public UpdateRequest setMarkdownDescription(String markdownDescription) {
}
/**
- * Optional note in markdown format. Use empty value to remove current note. Note is not changedif the parameter is not set.
- *
* Example value: "my *note*"
*/
public UpdateRequest setMarkdownNote(String markdownNote) {
}
/**
- * Rule name (mandatory for custom rule)
- *
* Example value: "My custom rule"
*/
public UpdateRequest setName(String name) {
}
/**
- * Organization key
- *
* This is part of the internal API.
* Example value: "my-org"
*/
}
/**
- * Parameters as semi-colon list of <key>=<value>, for example 'params=key1=v1;key2=v2' (Only when updating a custom rule)
- *
*/
- public UpdateRequest setParams(String params) {
+ public UpdateRequest setParams(List<String> params) {
this.params = params;
return this;
}
- public String getParams() {
+ public List<String> getParams() {
return params;
}
/**
- * Base effort of the remediation function of the rule
- *
* Example value: "1d"
*/
public UpdateRequest setRemediationFnBaseEffort(String remediationFnBaseEffort) {
}
/**
- * Type of the remediation function of the rule
- *
* Possible values:
* <ul>
* <li>"LINEAR"</li>
}
/**
- * Gap multiplier of the remediation function of the rule
- *
* Example value: "3min"
*/
public UpdateRequest setRemediationFyGapMultiplier(String remediationFyGapMultiplier) {
}
/**
- * Rule severity (Only when updating a custom rule)
- *
* Possible values:
* <ul>
* <li>"INFO"</li>
}
/**
- * Rule status (Only when updating a custom rule)
- *
* Possible values:
* <ul>
* <li>"BETA"</li>
}
/**
- * Optional comma-separated list of tags to set. Use blank value to remove current tags. Tags are not changed if the parameter is not set.
- *
* Example value: "java8,security"
*/
public UpdateRequest setTags(List<String> tags) {
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
@ParametersAreNonnullByDefault
+@Generated("sonar-ws-generator")
package org.sonarqube.ws.client.rules;
import javax.annotation.ParametersAreNonnullByDefault;
+import javax.annotation.Generated;
import org.sonarqube.ws.client.WsConnector;
/**
- * $webService.description.asString
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/server">Further information about this web service online</a>
*/
@Generated("sonar-ws-generator")
}
/**
- * Version of SonarQube in plain text
*
* This is part of the internal API.
* This is a GET request.
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
@ParametersAreNonnullByDefault
+@Generated("sonar-ws-generator")
package org.sonarqube.ws.client.server;
import javax.annotation.ParametersAreNonnullByDefault;
+import javax.annotation.Generated;
*/
package org.sonarqube.ws.client.settings;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Encrypt a setting value.<br>Requires 'Administer System' permission.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/settings/encrypt">Further information about this action online (including a response example)</a>
private String value;
/**
- * Setting value to encrypt
- *
* This is a mandatory parameter.
* Example value: "my value"
*/
*/
package org.sonarqube.ws.client.settings;
+import java.util.List;
import javax.annotation.Generated;
/**
- * List settings definitions.<br>Requires 'Browse' permission when a component is specified<br/>
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/settings/list_definitions">Further information about this action online (including a response example)</a>
private String component;
/**
- * Branch key. Only available on following settings : sonar.leak.period
- *
* This is part of the internal API.
* Example value: "feature/my_branch"
*/
}
/**
- * Component key
- *
* Example value: "my_project"
*/
public ListDefinitionsRequest setComponent(String component) {
import javax.annotation.Generated;
/**
- * Remove a setting value.<br>Requires one of the following permissions: <ul><li>'Administer System'</li><li>'Administer' rights on the specified component</li></ul>
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/settings/reset">Further information about this action online (including a response example)</a>
private List<String> keys;
/**
- * Branch key
- *
* This is part of the internal API.
* Example value: "feature/my_branch"
*/
}
/**
- * Component key
- *
* Example value: "my_project"
*/
public ResetRequest setComponent(String component) {
}
/**
- * Comma-separated list of keys
- *
* This is a mandatory parameter.
* Example value: "sonar.links.scm,sonar.debt.hoursInDay"
*/
import javax.annotation.Generated;
/**
- * Update a setting value.<br>Either 'value' or 'values' must be provided.<br> Requires one of the following permissions: <ul><li>'Administer System'</li><li>'Administer' rights on the specified component</li></ul>
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/settings/set">Further information about this action online (including a response example)</a>
private List<String> values;
/**
- * Branch key. Only available on following settings : sonar.leak.period
- *
* This is part of the internal API.
* Example value: "feature/my_branch"
*/
}
/**
- * Component key
- *
* Example value: "my_project"
*/
public SetRequest setComponent(String component) {
}
/**
- * Setting field values. To set several values, the parameter must be called once for each value.
- *
* Example value: "fieldValues={\"firstField\":\"first value\", \"secondField\":\"second value\", \"thirdField\":\"third value\"}"
*/
public SetRequest setFieldValues(List<String> fieldValues) {
}
/**
- * Setting key
- *
* This is a mandatory parameter.
* Example value: "sonar.links.scm"
*/
}
/**
- * Setting value. To reset a value, please use the reset web service.
- *
* Example value: "git@github.com:SonarSource/sonarqube.git"
*/
public SetRequest setValue(String value) {
}
/**
- * Setting multi value. To set several values, the parameter must be called once for each value.
- *
* Example value: "values=firstValue&values=secondValue&values=thirdValue"
*/
public SetRequest setValues(List<String> values) {
import java.util.stream.Collectors;
import javax.annotation.Generated;
import org.sonarqube.ws.MediaTypes;
+import org.sonarqube.ws.client.BaseService;
+import org.sonarqube.ws.client.GetRequest;
+import org.sonarqube.ws.client.PostRequest;
+import org.sonarqube.ws.client.WsConnector;
import org.sonarqube.ws.Settings.CheckSecretKeyWsResponse;
import org.sonarqube.ws.Settings.EncryptWsResponse;
import org.sonarqube.ws.Settings.GenerateSecretKeyWsResponse;
import org.sonarqube.ws.Settings.ListDefinitionsWsResponse;
import org.sonarqube.ws.Settings.ValuesWsResponse;
-import org.sonarqube.ws.client.BaseService;
-import org.sonarqube.ws.client.GetRequest;
-import org.sonarqube.ws.client.PostRequest;
-import org.sonarqube.ws.client.WsConnector;
/**
- * Manage settings.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/settings">Further information about this web service online</a>
*/
@Generated("sonar-ws-generator")
}
/**
- * Check if a secret key is available.<br>Requires the 'Administer System' permission.
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * Encrypt a setting value.<br>Requires 'Administer System' permission.
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * Generate a secret key.<br>Requires the 'Administer System' permission
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * List settings definitions.<br>Requires 'Browse' permission when a component is specified<br/>
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * Remove a setting value.<br>Requires one of the following permissions: <ul><li>'Administer System'</li><li>'Administer' rights on the specified component</li></ul>
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * Update a setting value.<br>Either 'value' or 'values' must be provided.<br> Requires one of the following permissions: <ul><li>'Administer System'</li><li>'Administer' rights on the specified component</li></ul>
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * List settings values.<br>If no value has been set for a setting, then the default value is returned.<br>Requires 'Browse' permission when a component is specified<br/>
*
* This is part of the internal API.
* This is a GET request.
import javax.annotation.Generated;
/**
- * List settings values.<br>If no value has been set for a setting, then the default value is returned.<br>Requires 'Browse' permission when a component is specified<br/>
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/settings/values">Further information about this action online (including a response example)</a>
private List<String> keys;
/**
- * Branch key
- *
* This is part of the internal API.
* Example value: "feature/my_branch"
*/
}
/**
- * Component key
- *
* Example value: "my_project"
*/
public ValuesRequest setComponent(String component) {
}
/**
- * List of setting keys
- *
* Example value: "sonar.test.inclusions,sonar.dbcleaner.cleanDirectory"
*/
public ValuesRequest setKeys(List<String> keys) {
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
@ParametersAreNonnullByDefault
+@Generated("sonar-ws-generator")
package org.sonarqube.ws.client.settings;
import javax.annotation.ParametersAreNonnullByDefault;
+import javax.annotation.Generated;
*/
package org.sonarqube.ws.client.sources;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Show line line hashes for a given file. Require See Source Code permission on file's project<br/>
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/sources/hash">Further information about this action online (including a response example)</a>
private String key;
/**
- * File key
- *
* This is a mandatory parameter.
* Example value: "my_project:/src/foo/Bar.php"
*/
*/
package org.sonarqube.ws.client.sources;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Get source code as line number / text pairs. Require See Source Code permission on file
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/sources/index">Further information about this action online (including a response example)</a>
private String to;
/**
- * First line
- *
*/
public IndexRequest setFrom(String from) {
this.from = from;
}
/**
- * File key
- *
* This is a mandatory parameter.
* Example value: "my_project:/src/foo/Bar.php"
*/
}
/**
- * Last line (excluded). If not specified, all lines are returned until end of file
- *
*/
public IndexRequest setTo(String to) {
this.to = to;
*/
package org.sonarqube.ws.client.sources;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Show source code with line oriented info. Require See Source Code permission on file's project<br/>Each element of the result array is an object which contains:<ol><li>Line number</li><li>Content of the line</li><li>Author of the line (from SCM information)</li><li>Revision of the line (from SCM information)</li><li>Last commit date of the line (from SCM information)</li><li>Line hits from coverage</li><li>Number of conditions to cover in tests</li><li>Number of conditions covered by tests</li></ol>
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/sources/lines">Further information about this action online (including a response example)</a>
private String uuid;
/**
- * Branch key
- *
* This is part of the internal API.
* Example value: "feature/my_branch"
*/
}
/**
- * First line to return. Starts from 1
- *
* Example value: "10"
*/
public LinesRequest setFrom(String from) {
}
/**
- * File key. Mandatory if param 'uuid' is not set. Available since 5.2
- *
* Example value: "my_project:/src/foo/Bar.php"
*/
public LinesRequest setKey(String key) {
}
/**
- * Optional last line to return (inclusive). It must be greater than or equal to parameter 'from'. If unset, then all the lines greater than or equal to 'from' are returned.
- *
* Example value: "20"
*/
public LinesRequest setTo(String to) {
}
/**
- * File uuid. Mandatory if param 'key' is not set
- *
* Example value: "f333aab4-7e3a-4d70-87e1-f4c491f05e5c"
*/
public LinesRequest setUuid(String uuid) {
*/
package org.sonarqube.ws.client.sources;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Get source code as raw text. Require 'See Source Code' permission on file
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/sources/raw">Further information about this action online (including a response example)</a>
private String key;
/**
- * Branch key
- *
* This is part of the internal API.
* Example value: "feature/my_branch"
*/
}
/**
- * File key
- *
* This is a mandatory parameter.
* Example value: "my_project:src/foo/Bar.php"
*/
*/
package org.sonarqube.ws.client.sources;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Get SCM information of source files. Require See Source Code permission on file's project<br/>Each element of the result array is composed of:<ol><li>Line number</li><li>Author of the commit</li><li>Datetime of the commit (before 5.2 it was only the Date)</li><li>Revision of the commit (added in 5.2)</li></ol>
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/sources/scm">Further information about this action online (including a response example)</a>
private String to;
/**
- * Group lines by SCM commit if value is false, else display commits for each line, even if two consecutive lines relate to the same commit.
- *
* Possible values:
* <ul>
* <li>"true"</li>
}
/**
- * First line to return. Starts at 1
- *
* Example value: "10"
*/
public ScmRequest setFrom(String from) {
}
/**
- * File key
- *
* This is a mandatory parameter.
* Example value: "my_project:/src/foo/Bar.php"
*/
}
/**
- * Last line to return (inclusive)
- *
* Example value: "20"
*/
public ScmRequest setTo(String to) {
*/
package org.sonarqube.ws.client.sources;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Get source code. Require See Source Code permission on file's project<br/>Each element of the result array is composed of:<ol><li>Line number</li><li>Content of the line</li></ol>
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/sources/show">Further information about this action online (including a response example)</a>
private String to;
/**
- * First line to return. Starts at 1
- *
* Example value: "10"
*/
public ShowRequest setFrom(String from) {
}
/**
- * File key
- *
* This is a mandatory parameter.
* Example value: "my_project:/src/foo/Bar.php"
*/
}
/**
- * Last line to return (inclusive)
- *
* Example value: "20"
*/
public ShowRequest setTo(String to) {
*/
package org.sonarqube.ws.client.sources;
+import java.util.stream.Collectors;
import javax.annotation.Generated;
import org.sonarqube.ws.MediaTypes;
import org.sonarqube.ws.client.BaseService;
import org.sonarqube.ws.client.GetRequest;
+import org.sonarqube.ws.client.PostRequest;
import org.sonarqube.ws.client.WsConnector;
/**
- * Get details on source files. See also api/tests.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/sources">Further information about this web service online</a>
*/
@Generated("sonar-ws-generator")
}
/**
- * Show line line hashes for a given file. Require See Source Code permission on file's project<br/>
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * Get source code as line number / text pairs. Require See Source Code permission on file
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * Show source code with line oriented info. Require See Source Code permission on file's project<br/>Each element of the result array is an object which contains:<ol><li>Line number</li><li>Content of the line</li><li>Author of the line (from SCM information)</li><li>Revision of the line (from SCM information)</li><li>Last commit date of the line (from SCM information)</li><li>Line hits from coverage</li><li>Number of conditions to cover in tests</li><li>Number of conditions covered by tests</li></ol>
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * Get source code as raw text. Require 'See Source Code' permission on file
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * Get SCM information of source files. Require See Source Code permission on file's project<br/>Each element of the result array is composed of:<ol><li>Line number</li><li>Author of the commit</li><li>Datetime of the commit (before 5.2 it was only the Date)</li><li>Revision of the commit (added in 5.2)</li></ol>
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * Get source code. Require See Source Code permission on file's project<br/>Each element of the result array is composed of:<ol><li>Line number</li><li>Content of the line</li></ol>
*
* This is part of the internal API.
* This is a GET request.
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
@ParametersAreNonnullByDefault
+@Generated("sonar-ws-generator")
package org.sonarqube.ws.client.sources;
import javax.annotation.ParametersAreNonnullByDefault;
+import javax.annotation.Generated;
*/
package org.sonarqube.ws.client.system;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Temporarily changes level of logs. New level is not persistent and is lost when restarting server. Requires system administration permission.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/system/change_log_level">Further information about this action online (including a response example)</a>
private String level;
/**
- * The new level. Be cautious: DEBUG, and even more TRACE, may have performance impacts.
- *
* This is a mandatory parameter.
* Possible values:
* <ul>
*/
package org.sonarqube.ws.client.system;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Get system logs in plain-text format. Requires system administration permission.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/system/logs">Further information about this action online (including a response example)</a>
private String process;
/**
- * Process to get logs from
- *
* Possible values:
* <ul>
* <li>"app"</li>
*/
package org.sonarqube.ws.client.system;
+import java.util.stream.Collectors;
import javax.annotation.Generated;
import org.sonarqube.ws.MediaTypes;
import org.sonarqube.ws.client.BaseService;
import org.sonarqube.ws.System.StatusResponse;
/**
- * Get system details, and perform some management actions, such as restarting, and initiating a database migration (as part of a system upgrade).
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/system">Further information about this web service online</a>
*/
@Generated("sonar-ws-generator")
}
/**
- * Temporarily changes level of logs. New level is not persistent and is lost when restarting server. Requires system administration permission.
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * Display the database migration status of SonarQube.<br/>State values are:<ul><li>NO_MIGRATION: DB is up to date with current version of SonarQube.</li><li>NOT_SUPPORTED: Migration is not supported on embedded databases.</li><li>MIGRATION_RUNNING: DB migration is under go.</li><li>MIGRATION_SUCCEEDED: DB migration has run and has been successful.</li><li>MIGRATION_FAILED: DB migration has run and failed. SonarQube must be restarted in order to retry a DB migration (optionally after DB has been restored from backup).</li><li>MIGRATION_REQUIRED: DB migration is required.</li></ul>
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * Provide health status of SonarQube.<p>Require 'Administer System' permission or authentication with passcode</p><p> <ul> <li>GREEN: SonarQube is fully operational</li> <li>YELLOW: SonarQube is usable, but it needs attention in order to be fully operational</li> <li>RED: SonarQube is not operational</li> </ul></p>
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * Get detailed information about system configuration.<br/>Requires 'Administer' permissions.<br/>Since 5.5, this web service becomes internal in order to more easily update result.
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * Get system logs in plain-text format. Requires system administration permission.
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * Migrate the database to match the current version of SonarQube.<br/>Sending a POST request to this URL starts the DB migration. It is strongly advised to <strong>make a database backup</strong> before invoking this WS.<br/>State values are:<ul><li>NO_MIGRATION: DB is up to date with current version of SonarQube.</li><li>NOT_SUPPORTED: Migration is not supported on embedded databases.</li><li>MIGRATION_RUNNING: DB migration is under go.</li><li>MIGRATION_SUCCEEDED: DB migration has run and has been successful.</li><li>MIGRATION_FAILED: DB migration has run and failed. SonarQube must be restarted in order to retry a DB migration (optionally after DB has been restored from backup).</li><li>MIGRATION_REQUIRED: DB migration is required.</li></ul>
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * Answers "pong" as plain-text
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * Restart server. Require 'Administer System' permission. Perform a full restart of the Web, Search and Compute Engine Servers processes.
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * Get state information about SonarQube.<p>status: the running status <ul> <li>STARTING: SonarQube Web Server is up and serving some Web Services (eg. api/system/status) but initialization is still ongoing</li> <li>UP: SonarQube instance is up and running</li> <li>DOWN: SonarQube instance is up but not running because migration has failed (refer to WS /api/system/migrate_db for details) or some other reason (check logs).</li> <li>RESTARTING: SonarQube instance is still up but a restart has been requested (refer to WS /api/system/restart for details).</li> <li>DB_MIGRATION_NEEDED: database migration is required. DB migration can be started using WS /api/system/migrate_db.</li> <li>DB_MIGRATION_RUNNING: DB migration is running (refer to WS /api/system/migrate_db for details)</li> </ul></p>
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * Lists available upgrades for the SonarQube instance (if any) and for each one, lists incompatible plugins and plugins requiring upgrade.<br/>Plugin information is retrieved from Update Center. Date and time at which Update Center was last refreshed is provided in the response.
*
* This is part of the internal API.
* This is a GET request.
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
@ParametersAreNonnullByDefault
+@Generated("sonar-ws-generator")
package org.sonarqube.ws.client.system;
import javax.annotation.ParametersAreNonnullByDefault;
+import javax.annotation.Generated;
*/
package org.sonarqube.ws.client.tests;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Get the list of source files covered by a test. Require Browse permission on test file's project
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/tests/covered_files">Further information about this action online (including a response example)</a>
private String testId;
/**
- * 1-based page number
- *
* Example value: "42"
*/
public CoveredFilesRequest setP(String p) {
}
/**
- * Page size. Must be greater than 0.
- *
* Example value: "20"
*/
public CoveredFilesRequest setPs(String ps) {
}
/**
- * Test ID
- *
* This is a mandatory parameter.
* Example value: "AU-Tpxb--iU5OvuD2FLy"
*/
*/
package org.sonarqube.ws.client.tests;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Get the list of tests either in a test file or that test a given line of source code.<br /> Requires 'Browse' permission on the file's project.<br /> One (and only one) of the following combination of parameters must be provided: <ul><li>testId - get a specific test</li><li>testFileId - get the tests in a test file</li><li>testFileKey - get the tests in a test file</li><li>sourceFileId and sourceFileLineNumber - get the tests that cover a specific line of code</li><li>sourceFileKey and sourceFileLineNumber - get the tests that cover a specific line of code</li></ul>
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/tests/list">Further information about this action online (including a response example)</a>
private String testId;
/**
- * Branch key
- *
* This is part of the internal API.
* Example value: "feature/my_branch"
*/
}
/**
- * 1-based page number
- *
* Example value: "42"
*/
public ListRequest setP(String p) {
}
/**
- * Page size. Must be greater than 0 and less than 500
- *
* Example value: "20"
*/
public ListRequest setPs(String ps) {
}
/**
- * ID of source file. Must be provided with the source file line number.
- *
* Example value: "AU-TpxcA-iU5OvuD2FL0"
*/
public ListRequest setSourceFileId(String sourceFileId) {
}
/**
- * Key of source file. Must be provided with the source file line number.
- *
* Example value: "my_project:/src/foo/Bar.php"
*/
public ListRequest setSourceFileKey(String sourceFileKey) {
}
/**
- * Source file line number. Must be provided with the source file ID or key.
- *
* Example value: "10"
*/
public ListRequest setSourceFileLineNumber(String sourceFileLineNumber) {
}
/**
- * ID of test file
- *
* Example value: "AU-Tpxb--iU5OvuD2FLy"
*/
public ListRequest setTestFileId(String testFileId) {
}
/**
- * Key of test file
- *
* Example value: "MY_PROJECT:src/test/java/foo/BarTest.java"
*/
public ListRequest setTestFileKey(String testFileKey) {
}
/**
- * ID of test
- *
* Example value: "AU-TpxcA-iU5OvuD2FLz"
*/
public ListRequest setTestId(String testId) {
*/
package org.sonarqube.ws.client.tests;
+import java.util.stream.Collectors;
import javax.annotation.Generated;
+import org.sonarqube.ws.MediaTypes;
import org.sonarqube.ws.client.BaseService;
import org.sonarqube.ws.client.GetRequest;
+import org.sonarqube.ws.client.PostRequest;
import org.sonarqube.ws.client.WsConnector;
import org.sonarqube.ws.Tests.CoveredFilesResponse;
import org.sonarqube.ws.Tests.ListResponse;
/**
- * Get details on test files. See also api/sources. Deprecated since 5.6.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/tests">Further information about this web service online</a>
*/
@Generated("sonar-ws-generator")
}
/**
- * Get the list of source files covered by a test. Require Browse permission on test file's project
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * Get the list of tests either in a test file or that test a given line of source code.<br /> Requires 'Browse' permission on the file's project.<br /> One (and only one) of the following combination of parameters must be provided: <ul><li>testId - get a specific test</li><li>testFileId - get the tests in a test file</li><li>testFileKey - get the tests in a test file</li><li>sourceFileId and sourceFileLineNumber - get the tests that cover a specific line of code</li><li>sourceFileKey and sourceFileLineNumber - get the tests that cover a specific line of code</li></ul>
*
* This is part of the internal API.
* This is a GET request.
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
@ParametersAreNonnullByDefault
+@Generated("sonar-ws-generator")
package org.sonarqube.ws.client.tests;
import javax.annotation.ParametersAreNonnullByDefault;
+import javax.annotation.Generated;
import org.sonarqube.ws.client.WsConnector;
/**
- * Removed since 6.3, please use api/measures/search_history instead
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/timemachine">Further information about this web service online</a>
*/
@Generated("sonar-ws-generator")
}
/**
- * The web service is removed and you're invited to use api/measures/search_history instead
*
* This is part of the internal API.
* This is a GET request.
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
@ParametersAreNonnullByDefault
+@Generated("sonar-ws-generator")
package org.sonarqube.ws.client.timemachine;
import javax.annotation.ParametersAreNonnullByDefault;
+import javax.annotation.Generated;
*/
package org.sonarqube.ws.client.updatecenter;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Get the list of all the plugins installed on the SonarQube instance
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/updatecenter/installed_plugins">Further information about this action online (including a response example)</a>
private String format;
/**
- * Only json response format is available
- *
* Possible values:
* <ul>
* <li>"json"</li>
*/
package org.sonarqube.ws.client.updatecenter;
+import java.util.stream.Collectors;
import javax.annotation.Generated;
import org.sonarqube.ws.MediaTypes;
import org.sonarqube.ws.client.BaseService;
import org.sonarqube.ws.client.WsConnector;
/**
- * Get list of installed plugins
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/updatecenter">Further information about this web service online</a>
*/
@Generated("sonar-ws-generator")
}
/**
- * Get the list of all the plugins installed on the SonarQube instance
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * Upload a plugin.<br /> Requires 'Administer System' permission.
*
* This is part of the internal API.
* This is a POST request.
*/
package org.sonarqube.ws.client.updatecenter;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Upload a plugin.<br /> Requires 'Administer System' permission.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/updatecenter/upload">Further information about this action online (including a response example)</a>
private String file;
/**
- * The jar file of the plugin to install
- *
* This is a mandatory parameter.
*/
public UploadRequest setFile(String file) {
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
@ParametersAreNonnullByDefault
+@Generated("sonar-ws-generator")
package org.sonarqube.ws.client.updatecenter;
import javax.annotation.ParametersAreNonnullByDefault;
+import javax.annotation.Generated;
*/
package org.sonarqube.ws.client.usergroups;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Add a user to a group.<br />'id' or 'name' must be provided.<br />Requires the following permission: 'Administer System'.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/user_groups/add_user">Further information about this action online (including a response example)</a>
private String organization;
/**
- * Group id
- *
* Example value: "42"
*/
public AddUserRequest setId(String id) {
}
/**
- * User login
- *
* Example value: "g.hopper"
*/
public AddUserRequest setLogin(String login) {
}
/**
- * Group name
- *
* Example value: "sonar-administrators"
*/
public AddUserRequest setName(String name) {
}
/**
- * Key of organization
- *
* This is part of the internal API.
* Example value: "my-org"
*/
*/
package org.sonarqube.ws.client.usergroups;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Create a group.<br>Requires the following permission: 'Administer System'.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/user_groups/create">Further information about this action online (including a response example)</a>
private String organization;
/**
- * Description for the new group. A group description cannot be larger than 200 characters.
- *
* Example value: "Default group for new users"
*/
public CreateRequest setDescription(String description) {
}
/**
- * Name for the new group. A group name cannot be larger than 255 characters and must be unique. The value 'anyone' (whatever the case) is reserved and cannot be used.
- *
* This is a mandatory parameter.
* Example value: "sonar-users"
*/
}
/**
- * Key of organization. If unset then default organization is used.
- *
* This is part of the internal API.
* Example value: "my-org"
*/
*/
package org.sonarqube.ws.client.usergroups;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Delete a group. The default groups cannot be deleted.<br/>'id' or 'name' must be provided.<br />Requires the following permission: 'Administer System'.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/user_groups/delete">Further information about this action online (including a response example)</a>
private String organization;
/**
- * Group id
- *
* Example value: "42"
*/
public DeleteRequest setId(String id) {
}
/**
- * Group name
- *
* Example value: "sonar-administrators"
*/
public DeleteRequest setName(String name) {
}
/**
- * Key of organization
- *
* This is part of the internal API.
* Example value: "my-org"
*/
*/
package org.sonarqube.ws.client.usergroups;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Remove a user from a group.<br />'id' or 'name' must be provided.<br>Requires the following permission: 'Administer System'.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/user_groups/remove_user">Further information about this action online (including a response example)</a>
private String organization;
/**
- * Group id
- *
* Example value: "42"
*/
public RemoveUserRequest setId(String id) {
}
/**
- * User login
- *
* Example value: "g.hopper"
*/
public RemoveUserRequest setLogin(String login) {
}
/**
- * Group name
- *
* Example value: "sonar-administrators"
*/
public RemoveUserRequest setName(String name) {
}
/**
- * Key of organization
- *
* This is part of the internal API.
* Example value: "my-org"
*/
import javax.annotation.Generated;
/**
- * Search for user groups.<br>Requires the following permission: 'Administer System'.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/user_groups/search">Further information about this action online (including a response example)</a>
private String q;
/**
- * Comma-separated list of the fields to be returned in response. All the fields are returned by default.
- *
* Possible values:
* <ul>
* <li>"name"</li>
}
/**
- * Key of organization. If not set then groups are searched in default organization.
- *
* This is part of the internal API.
* Example value: "my-org"
*/
}
/**
- * 1-based page number
- *
* Example value: "42"
*/
public SearchRequest setP(String p) {
}
/**
- * Page size. Must be greater than 0 and less than 500
- *
* Example value: "20"
*/
public SearchRequest setPs(String ps) {
}
/**
- * Limit search to names that contain the supplied string.
- *
* Example value: "sonar-users"
*/
public SearchRequest setQ(String q) {
*/
package org.sonarqube.ws.client.usergroups;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Update a group.<br>Requires the following permission: 'Administer System'.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/user_groups/update">Further information about this action online (including a response example)</a>
private String name;
/**
- * New optional description for the group. A group description cannot be larger than 200 characters. If value is not defined, then description is not changed.
- *
* Example value: "Default group for new users"
*/
public UpdateRequest setDescription(String description) {
}
/**
- * Identifier of the group.
- *
* This is a mandatory parameter.
* Example value: "42"
*/
}
/**
- * New optional name for the group. A group name cannot be larger than 255 characters and must be unique. Value 'anyone' (whatever the case) is reserved and cannot be used. If value is empty or not defined, then name is not changed.
- *
* Example value: "my-group"
*/
public UpdateRequest setName(String name) {
import org.sonarqube.ws.UserGroups.UpdateWsResponse;
/**
- * Manage user groups.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/user_groups">Further information about this web service online</a>
*/
@Generated("sonar-ws-generator")
}
/**
- * Add a user to a group.<br />'id' or 'name' must be provided.<br />Requires the following permission: 'Administer System'.
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * Create a group.<br>Requires the following permission: 'Administer System'.
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * Delete a group. The default groups cannot be deleted.<br/>'id' or 'name' must be provided.<br />Requires the following permission: 'Administer System'.
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * Remove a user from a group.<br />'id' or 'name' must be provided.<br>Requires the following permission: 'Administer System'.
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * Search for user groups.<br>Requires the following permission: 'Administer System'.
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * Update a group.<br>Requires the following permission: 'Administer System'.
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * Search for users with membership information with respect to a group.<br>Requires the following permission: 'Administer System'.
*
* This is part of the internal API.
* This is a GET request.
*/
package org.sonarqube.ws.client.usergroups;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Search for users with membership information with respect to a group.<br>Requires the following permission: 'Administer System'.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/user_groups/users">Further information about this action online (including a response example)</a>
private String selected;
/**
- * Group id
- *
* Example value: "42"
*/
public UsersRequest setId(String id) {
}
/**
- * Group name
- *
* Example value: "sonar-administrators"
*/
public UsersRequest setName(String name) {
}
/**
- * Key of organization
- *
* This is part of the internal API.
* Example value: "my-org"
*/
}
/**
- * 1-based page number
- *
* Example value: "42"
*/
public UsersRequest setP(String p) {
}
/**
- * Page size. Must be greater than 0.
- *
* Example value: "20"
*/
public UsersRequest setPs(String ps) {
}
/**
- * Limit search to names or logins that contain the supplied string.
- *
* Example value: "freddy"
*/
public UsersRequest setQ(String q) {
}
/**
- * Depending on the value, show only selected items (selected=selected), deselected items (selected=deselected), or all items with their selection status (selected=all).
- *
* Possible values:
* <ul>
* <li>"all"</li>
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
@ParametersAreNonnullByDefault
+@Generated("sonar-ws-generator")
package org.sonarqube.ws.client.usergroups;
import javax.annotation.ParametersAreNonnullByDefault;
+import javax.annotation.Generated;
import org.sonarqube.ws.client.WsConnector;
/**
- * Removed since 6.3, please use api/favorites and api/notifications instead
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/user_properties">Further information about this web service online</a>
*/
@Generated("sonar-ws-generator")
}
/**
- * This web service is removed
*
* This is part of the internal API.
* This is a GET request.
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
@ParametersAreNonnullByDefault
+@Generated("sonar-ws-generator")
package org.sonarqube.ws.client.userproperties;
import javax.annotation.ParametersAreNonnullByDefault;
+import javax.annotation.Generated;
*/
package org.sonarqube.ws.client.users;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Update a user's password. Authenticated users can change their own password, provided that the account is not linked to an external authentication system. Administer System permission is required to change another user's password.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/users/change_password">Further information about this action online (including a response example)</a>
private String previousPassword;
/**
- * User login
- *
* This is a mandatory parameter.
* Example value: "myuser"
*/
}
/**
- * New password
- *
* This is a mandatory parameter.
* Example value: "mypassword"
*/
}
/**
- * Previous password. Required when changing one's own password.
- *
* Example value: "oldpassword"
*/
public ChangePasswordRequest setPreviousPassword(String previousPassword) {
*/
package org.sonarqube.ws.client.users;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Create a user.<br/>If a deactivated user account exists with the given login, it will be reactivated.<br/>Requires Administer System permission
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/users/create">Further information about this action online (including a response example)</a>
private String scmAccounts;
/**
- * User email
- *
* Example value: "myname@email.com"
*/
public CreateRequest setEmail(String email) {
}
/**
- * Specify if the user should be authenticated from SonarQube server or from an external authentication system. Password should not be set when local is set to false.
- *
* Possible values:
* <ul>
* <li>"true"</li>
}
/**
- * User login
- *
* This is a mandatory parameter.
* Example value: "myuser"
*/
}
/**
- * User name
- *
* This is a mandatory parameter.
* Example value: "My Name"
*/
}
/**
- * User password. Only mandatory when creating local user, otherwise it should not be set
- *
* Example value: "mypassword"
*/
public CreateRequest setPassword(String password) {
}
/**
- * SCM accounts. To set several values, the parameter must be called once for each value.
- *
* Example value: "scmAccount=firstValue&scmAccount=secondValue&scmAccount=thirdValue"
*/
public CreateRequest setScmAccount(String scmAccount) {
}
/**
- * This parameter is deprecated, please use 'scmAccount' instead
- *
* Example value: "myscmaccount1,myscmaccount2"
* @deprecated since 6.1
*/
*/
package org.sonarqube.ws.client.users;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Deactivate a user. Requires Administer System permission
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/users/deactivate">Further information about this action online (including a response example)</a>
private String login;
/**
- * User login
- *
* This is a mandatory parameter.
* Example value: "myuser"
*/
*/
package org.sonarqube.ws.client.users;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Lists the groups a user belongs to. <br/>Requires Administer System permission.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/users/groups">Further information about this action online (including a response example)</a>
private String selected;
/**
- * A user login
- *
* This is a mandatory parameter.
* Example value: "admin"
*/
}
/**
- * Organization key
- *
* This is part of the internal API.
* Example value: "my-org"
*/
}
/**
- * 1-based page number
- *
* Example value: "42"
*/
public GroupsRequest setP(String p) {
}
/**
- * Page size. Must be greater than 0.
- *
* Example value: "20"
*/
public GroupsRequest setPs(String ps) {
}
/**
- * Limit search to group names that contain the supplied string.
- *
* Example value: "users"
*/
public GroupsRequest setQ(String q) {
}
/**
- * Depending on the value, show only selected items (selected=selected), deselected items (selected=deselected), or all items with their selection status (selected=all).
- *
* Possible values:
* <ul>
* <li>"all"</li>
import javax.annotation.Generated;
/**
- * Get a list of active users. <br/>Administer System permission is required to show the 'groups' field.<br/>When accessed anonymously, only logins and names are returned.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/users/search">Further information about this action online (including a response example)</a>
private String q;
/**
- * Comma-separated list of the fields to be returned in response. All the fields are returned by default.
- *
* Possible values:
* <ul>
* <li>"name"</li>
}
/**
- * 1-based page number
- *
* Example value: "42"
*/
public SearchRequest setP(String p) {
}
/**
- * Page size. Must be greater than 0 and less than 500
- *
* Example value: "20"
*/
public SearchRequest setPs(String ps) {
}
/**
- * Filter on login or name.
- *
*/
public SearchRequest setQ(String q) {
this.q = q;
*/
package org.sonarqube.ws.client.users;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Update a user. If a deactivated user account exists with the given login, it will be reactivated. Requires Administer System permission
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/users/update">Further information about this action online (including a response example)</a>
private String scmAccounts;
/**
- * User email
- *
* Example value: "myname@email.com"
*/
public UpdateRequest setEmail(String email) {
}
/**
- * User login
- *
* This is a mandatory parameter.
* Example value: "myuser"
*/
}
/**
- * User name
- *
* Example value: "My Name"
*/
public UpdateRequest setName(String name) {
}
/**
- * SCM accounts. To set several values, the parameter must be called once for each value.
- *
* Example value: "scmAccount=firstValue&scmAccount=secondValue&scmAccount=thirdValue"
*/
public UpdateRequest setScmAccount(String scmAccount) {
}
/**
- * This parameter is deprecated, please use 'scmAccount' instead
- *
* Example value: "myscmaccount1,myscmaccount2"
* @deprecated since 6.1
*/
import org.sonarqube.ws.Users.SearchWsResponse;
/**
- * Manage users.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/users">Further information about this web service online</a>
*/
@Generated("sonar-ws-generator")
}
/**
- * Update a user's password. Authenticated users can change their own password, provided that the account is not linked to an external authentication system. Administer System permission is required to change another user's password.
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * Create a user.<br/>If a deactivated user account exists with the given login, it will be reactivated.<br/>Requires Administer System permission
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * Get the details of the current authenticated user.
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * Deactivate a user. Requires Administer System permission
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * Lists the groups a user belongs to. <br/>Requires Administer System permission.
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * List the external identity providers
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * Get a list of active users. <br/>Administer System permission is required to show the 'groups' field.<br/>When accessed anonymously, only logins and names are returned.
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * Stores that the user has skipped the onboarding tutorial and does not want to see it after future logins.<br/>Requires authentication.
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * Update a user. If a deactivated user account exists with the given login, it will be reactivated. Requires Administer System permission
*
* This is part of the internal API.
* This is a POST request.
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
@ParametersAreNonnullByDefault
+@Generated("sonar-ws-generator")
package org.sonarqube.ws.client.users;
import javax.annotation.ParametersAreNonnullByDefault;
+import javax.annotation.Generated;
*/
package org.sonarqube.ws.client.usertokens;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Generate a user access token. <br />Please keep your tokens secret. They enable to authenticate and analyze projects.<br />If the login is set, it requires administration permissions. Otherwise, a token is generated for the authenticated user.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/user_tokens/generate">Further information about this action online (including a response example)</a>
private String name;
/**
- * User login. If not set, the token is generated for the authenticated user.
- *
* Example value: "g.hopper"
*/
public GenerateRequest setLogin(String login) {
}
/**
- * Token name
- *
* This is a mandatory parameter.
* Example value: "Project scan on Travis"
*/
*/
package org.sonarqube.ws.client.usertokens;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Revoke a user access token. <br/>If the login is set, it requires administration permissions. Otherwise, a token is generated for the authenticated user.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/user_tokens/revoke">Further information about this action online (including a response example)</a>
private String name;
/**
- * User login
- *
* Example value: "g.hopper"
*/
public RevokeRequest setLogin(String login) {
}
/**
- * Token name
- *
* This is a mandatory parameter.
* Example value: "Project scan on Travis"
*/
*/
package org.sonarqube.ws.client.usertokens;
+import java.util.List;
import javax.annotation.Generated;
/**
- * List the access tokens of a user.<br>The login must exist and active.<br>If the login is set, it requires administration permissions. Otherwise, a token is generated for the authenticated user.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/user_tokens/search">Further information about this action online (including a response example)</a>
private String login;
/**
- * User login
- *
* Example value: "g.hopper"
*/
public SearchRequest setLogin(String login) {
*/
package org.sonarqube.ws.client.usertokens;
+import java.util.stream.Collectors;
import javax.annotation.Generated;
import org.sonarqube.ws.MediaTypes;
import org.sonarqube.ws.client.BaseService;
import org.sonarqube.ws.UserTokens.SearchWsResponse;
/**
- * List, create, and delete a user's access tokens.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/user_tokens">Further information about this web service online</a>
*/
@Generated("sonar-ws-generator")
}
/**
- * Generate a user access token. <br />Please keep your tokens secret. They enable to authenticate and analyze projects.<br />If the login is set, it requires administration permissions. Otherwise, a token is generated for the authenticated user.
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * Revoke a user access token. <br/>If the login is set, it requires administration permissions. Otherwise, a token is generated for the authenticated user.
*
* This is part of the internal API.
* This is a POST request.
}
/**
- * List the access tokens of a user.<br>The login must exist and active.<br>If the login is set, it requires administration permissions. Otherwise, a token is generated for the authenticated user.
*
* This is part of the internal API.
* This is a GET request.
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
@ParametersAreNonnullByDefault
+@Generated("sonar-ws-generator")
package org.sonarqube.ws.client.usertokens;
import javax.annotation.ParametersAreNonnullByDefault;
+import javax.annotation.Generated;
*/
package org.sonarqube.ws.client.webhooks;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Get the recent deliveries for a specified project or Compute Engine task.<br/>Require 'Administer' permission on the related project.<br/>Note that additional information are returned by api/webhooks/delivery.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/webhooks/deliveries">Further information about this action online (including a response example)</a>
private String componentKey;
/**
- * Id of the Compute Engine task
- *
* Example value: "AU-Tpxb--iU5OvuD2FLy"
*/
public DeliveriesRequest setCeTaskId(String ceTaskId) {
}
/**
- * Key of the project
- *
* Example value: "my-project"
*/
public DeliveriesRequest setComponentKey(String componentKey) {
*/
package org.sonarqube.ws.client.webhooks;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Get a webhook delivery by its id.<br/>Require 'Administer System' permission.<br/>Note that additional information are returned by api/webhooks/delivery.
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/webhooks/delivery">Further information about this action online (including a response example)</a>
private String deliveryId;
/**
- * Id of delivery
- *
* This is a mandatory parameter.
* Example value: "AU-TpxcA-iU5OvuD2FL3"
*/
*/
package org.sonarqube.ws.client.webhooks;
+import java.util.stream.Collectors;
import javax.annotation.Generated;
+import org.sonarqube.ws.MediaTypes;
import org.sonarqube.ws.client.BaseService;
import org.sonarqube.ws.client.GetRequest;
+import org.sonarqube.ws.client.PostRequest;
import org.sonarqube.ws.client.WsConnector;
import org.sonarqube.ws.Webhooks.DeliveriesWsResponse;
import org.sonarqube.ws.Webhooks.DeliveryWsResponse;
/**
- * Webhooks allow to notify external services when a project analysis is done
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/webhooks">Further information about this web service online</a>
*/
@Generated("sonar-ws-generator")
}
/**
- * Get the recent deliveries for a specified project or Compute Engine task.<br/>Require 'Administer' permission on the related project.<br/>Note that additional information are returned by api/webhooks/delivery.
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * Get a webhook delivery by its id.<br/>Require 'Administer System' permission.<br/>Note that additional information are returned by api/webhooks/delivery.
*
* This is part of the internal API.
* This is a GET request.
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
@ParametersAreNonnullByDefault
+@Generated("sonar-ws-generator")
package org.sonarqube.ws.client.webhooks;
import javax.annotation.ParametersAreNonnullByDefault;
+import javax.annotation.Generated;
*/
package org.sonarqube.ws.client.webservices;
+import java.util.List;
import javax.annotation.Generated;
/**
- * List web services
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/webservices/list">Further information about this action online (including a response example)</a>
private String includeInternals;
/**
- * Include web services that are implemented for internal use only. Their forward-compatibility is not assured
- *
* Possible values:
* <ul>
* <li>"true"</li>
*/
package org.sonarqube.ws.client.webservices;
+import java.util.List;
import javax.annotation.Generated;
/**
- * Display web service response example
- *
* This is part of the internal API.
* This is a POST request.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/webservices/response_example">Further information about this action online (including a response example)</a>
private String controller;
/**
- * Action of the web service
- *
* This is a mandatory parameter.
* Example value: "search"
*/
}
/**
- * Controller of the web service
- *
* This is a mandatory parameter.
* Example value: "api/issues"
*/
*/
package org.sonarqube.ws.client.webservices;
+import java.util.stream.Collectors;
import javax.annotation.Generated;
import org.sonarqube.ws.MediaTypes;
import org.sonarqube.ws.client.BaseService;
import org.sonarqube.ws.client.GetRequest;
+import org.sonarqube.ws.client.PostRequest;
import org.sonarqube.ws.client.WsConnector;
/**
- * Get information on the web api supported on this instance.
* @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/webservices">Further information about this web service online</a>
*/
@Generated("sonar-ws-generator")
}
/**
- * List web services
*
* This is part of the internal API.
* This is a GET request.
}
/**
- * Display web service response example
*
* This is part of the internal API.
* This is a GET request.
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
@ParametersAreNonnullByDefault
+@Generated("sonar-ws-generator")
package org.sonarqube.ws.client.webservices;
import javax.annotation.ParametersAreNonnullByDefault;
+import javax.annotation.Generated;
projects / sonarqube.git / commitdiff