public static class WebService.NewAction extends Object
Modifier and Type | Method and Description |
---|---|
WebService.NewAction |
addFieldsParam(Collection<?> possibleValues)
Creates the parameter
WebService.Param.FIELDS , which is
used to restrict the number of fields returned in JSON response. |
WebService.NewAction |
addPageParam() |
WebService.NewAction |
addPageSize(int defaultPageSize,
int maxPageSize) |
WebService.NewAction |
addPagingParams(int defaultPageSize)
Add predefined parameters related to pagination of results.
|
WebService.NewAction |
addPagingParams(int defaultPageSize,
int maxPageSize)
Add predefined parameters related to pagination of results with a maximum page size.
|
WebService.NewAction |
addSearchQuery(String exampleValue,
String... pluralFields)
Creates the parameter
WebService.Param.TEXT_QUERY , which is
used to search for a subset of fields containing the supplied string. |
WebService.NewAction |
addSelectionModeParam()
Add 'selected=(selected|deselected|all)' for select-list oriented WS.
|
<V> WebService.NewAction |
addSortParams(Collection<V> possibleValues,
V defaultValue,
boolean defaultAscending)
Add predefined parameters related to sorting of results.
|
WebService.NewParam |
createFieldsParam(Collection<?> possibleValues) |
WebService.NewParam |
createParam(String paramKey) |
WebService.NewAction |
createParam(String paramKey,
String description)
Deprecated.
since 4.4. Use
createParam(String paramKey) instead. |
<V> WebService.NewParam |
createSortParams(Collection<V> possibleValues,
V defaultValue,
boolean defaultAscending)
Add predefined parameters related to sorting of results.
|
WebService.NewAction |
setChangelog(Change... changes)
List of changes made to the contract or valuable insight.
|
WebService.NewAction |
setDeprecatedKey(String s) |
WebService.NewAction |
setDeprecatedSince(String deprecatedSince) |
WebService.NewAction |
setDescription(String description)
Used in Orchestrator
|
WebService.NewAction |
setDescription(String description,
Object... descriptionArgument) |
WebService.NewAction |
setHandler(RequestHandler h) |
WebService.NewAction |
setInternal(boolean b)
Internal actions are not displayed by default in the web api documentation.
|
WebService.NewAction |
setPost(boolean b) |
WebService.NewAction |
setResponseExample(URL url)
Link to the document containing an example of response.
|
WebService.NewAction |
setSince(String s) |
public WebService.NewAction setDeprecatedKey(@Nullable String s)
public WebService.NewAction setDescription(@Nullable String description)
public WebService.NewAction setDescription(@Nullable String description, Object... descriptionArgument)
public WebService.NewAction setSince(@Nullable String s)
public WebService.NewAction setDeprecatedSince(@Nullable String deprecatedSince)
public WebService.NewAction setPost(boolean b)
public WebService.NewAction setInternal(boolean b)
public WebService.NewAction setHandler(RequestHandler h)
public WebService.NewAction setResponseExample(@Nullable URL url)
newAction.setResponseExample(getClass().getResource("/org/sonar/my-ws-response-example.json"));
public WebService.NewAction setChangelog(Change... changes)
public WebService.NewParam createParam(String paramKey)
@Deprecated public WebService.NewAction createParam(String paramKey, @Nullable String description)
createParam(String paramKey)
instead.public WebService.NewAction addPagingParams(int defaultPageSize)
public WebService.NewAction addPagingParams(int defaultPageSize, int maxPageSize)
public WebService.NewAction addPageParam()
public WebService.NewAction addPageSize(int defaultPageSize, int maxPageSize)
public WebService.NewAction addFieldsParam(Collection<?> possibleValues)
WebService.Param.FIELDS
, which is
used to restrict the number of fields returned in JSON response.public WebService.NewParam createFieldsParam(Collection<?> possibleValues)
public WebService.NewAction addSearchQuery(String exampleValue, String... pluralFields)
WebService.Param.TEXT_QUERY
, which is
used to search for a subset of fields containing the supplied string.
The fields must be in the plural form (ex: "names", "keys").
public <V> WebService.NewAction addSortParams(Collection<V> possibleValues, @Nullable V defaultValue, boolean defaultAscending)
public <V> WebService.NewParam createSortParams(Collection<V> possibleValues, @Nullable V defaultValue, boolean defaultAscending)
public WebService.NewAction addSelectionModeParam()
Copyright © 2009–2017 SonarSource. All rights reserved.