public static class WebService.NewAction
extends java.lang.Object
Modifier and Type | Method and Description |
---|---|
WebService.NewAction |
addFieldsParam(java.util.Collection<?> possibleValues)
Creates the parameter
WebService.Param.FIELDS , which is
used to restrict the number of fields returned in JSON response. |
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 |
addPagingParamsSince(int defaultPageSize,
int maxPageSize,
java.lang.String version)
Add predefined parameters related to pagination of results with a maximum page size.
|
WebService.NewAction |
addSearchQuery(java.lang.String exampleValue,
java.lang.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(java.util.Collection<V> possibleValues,
V defaultValue,
boolean defaultAscending)
Add predefined parameters related to sorting of results.
|
WebService.NewParam |
createFieldsParam(java.util.Collection<?> possibleValues) |
WebService.NewParam |
createPageParam() |
WebService.NewParam |
createPageSize(int defaultPageSize,
int maxPageSize) |
WebService.NewParam |
createParam(java.lang.String paramKey) |
WebService.NewParam |
createSearchQuery(java.lang.String exampleValue,
java.lang.String... pluralFields)
Creates the parameter
WebService.Param.TEXT_QUERY , which is
used to search for a subset of fields containing the supplied string. |
<V> WebService.NewParam |
createSortParams(java.util.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(java.lang.String s) |
WebService.NewAction |
setDeprecatedSince(java.lang.String deprecatedSince) |
WebService.NewAction |
setDescription(java.lang.String description)
Used in Orchestrator
|
WebService.NewAction |
setDescription(java.lang.String description,
java.lang.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(java.net.URL url)
Link to the document containing an example of response.
|
WebService.NewAction |
setSince(java.lang.String s) |
public WebService.NewAction setDeprecatedKey(@Nullable java.lang.String s)
public WebService.NewAction setDescription(@Nullable java.lang.String description)
public WebService.NewAction setDescription(@Nullable java.lang.String description, java.lang.Object... descriptionArgument)
public WebService.NewAction setSince(@Nullable java.lang.String s)
public WebService.NewAction setDeprecatedSince(@Nullable java.lang.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 java.net.URL url)
newAction.setResponseExample(getClass().getResource("/org/sonar/my-ws-response-example.json"));
public WebService.NewAction setChangelog(Change... changes)
public WebService.NewParam createParam(java.lang.String paramKey)
public WebService.NewAction addPagingParams(int defaultPageSize)
public WebService.NewAction addPagingParams(int defaultPageSize, int maxPageSize)
public WebService.NewParam createPageParam()
public WebService.NewParam createPageSize(int defaultPageSize, int maxPageSize)
public WebService.NewAction addPagingParamsSince(int defaultPageSize, int maxPageSize, java.lang.String version)
public WebService.NewAction addFieldsParam(java.util.Collection<?> possibleValues)
WebService.Param.FIELDS
, which is
used to restrict the number of fields returned in JSON response.public WebService.NewParam createFieldsParam(java.util.Collection<?> possibleValues)
public WebService.NewAction addSearchQuery(java.lang.String exampleValue, java.lang.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 WebService.NewParam createSearchQuery(java.lang.String exampleValue, java.lang.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(java.util.Collection<V> possibleValues, @Nullable V defaultValue, boolean defaultAscending)
public <V> WebService.NewParam createSortParams(java.util.Collection<V> possibleValues, @Nullable V defaultValue, boolean defaultAscending)
public WebService.NewAction addSelectionModeParam()