public static class WebService.NewParam
extends java.lang.Object
Modifier and Type | Method and Description |
---|---|
WebService.NewParam |
setBooleanPossibleValues()
Shortcut for
setPossibleValues("true", "false", "yes", "no") |
WebService.NewParam |
setDefaultValue(java.lang.Object o) |
WebService.NewParam |
setDeprecatedKey(java.lang.String s)
Deprecated.
since 6.4
|
WebService.NewParam |
setDeprecatedKey(java.lang.String key,
java.lang.String deprecatedSince) |
WebService.NewParam |
setDeprecatedSince(java.lang.String deprecatedSince) |
WebService.NewParam |
setDescription(java.lang.String description) |
WebService.NewParam |
setDescription(java.lang.String description,
java.lang.Object... descriptionArgument) |
WebService.NewParam |
setExampleValue(java.lang.Object s) |
WebService.NewParam |
setInternal(boolean b)
Internal parameters are not displayed by default in the web api documentation.
|
WebService.NewParam |
setMaximumLength(java.lang.Integer maximumLength) |
WebService.NewParam |
setMaximumValue(java.lang.Integer maximumValue) |
WebService.NewParam |
setMaxValuesAllowed(java.lang.Integer maxValuesAllowed) |
WebService.NewParam |
setMinimumLength(java.lang.Integer minimumLength) |
<T> WebService.NewParam |
setPossibleValues(java.util.Collection<T> values)
Exhaustive list of possible values when it makes sense, for example
list of severities.
|
<T> WebService.NewParam |
setPossibleValues(T... values)
Exhaustive list of possible values when it makes sense, for example
list of severities.
|
WebService.NewParam |
setRequired(boolean b)
Is the parameter required or optional ? Default value is false (optional).
|
WebService.NewParam |
setSince(java.lang.String since) |
java.lang.String |
toString() |
public WebService.NewParam setSince(@Nullable java.lang.String since)
WebService.Param.since()
public WebService.NewParam setDeprecatedSince(@Nullable java.lang.String deprecatedSince)
@Deprecated public WebService.NewParam setDeprecatedKey(@Nullable java.lang.String s)
setDeprecatedKey(String, String)
public WebService.NewParam setDeprecatedKey(@Nullable java.lang.String key, @Nullable java.lang.String deprecatedSince)
deprecatedSince
- Version when the old key was replaced/deprecated. Ex: 5.6WebService.Param.deprecatedKey()
public WebService.NewParam setDescription(@Nullable java.lang.String description)
public WebService.NewParam setDescription(@Nullable java.lang.String description, java.lang.Object... descriptionArgument)
WebService.Param.description()
public WebService.NewParam setRequired(boolean b)
WebService.Param.isRequired()
public WebService.NewParam setInternal(boolean b)
WebService.Param.isInternal()
public WebService.NewParam setExampleValue(@Nullable java.lang.Object s)
WebService.Param.exampleValue()
public <T> WebService.NewParam setPossibleValues(@Nullable T... values)
WebService.Param.possibleValues()
public WebService.NewParam setBooleanPossibleValues()
setPossibleValues("true", "false", "yes", "no")
public <T> WebService.NewParam setPossibleValues(@Nullable java.util.Collection<T> values)
WebService.Param.possibleValues()
public WebService.NewParam setDefaultValue(@Nullable java.lang.Object o)
WebService.Param.defaultValue()
public WebService.NewParam setMaxValuesAllowed(@Nullable java.lang.Integer maxValuesAllowed)
WebService.Param.maxValuesAllowed()
public WebService.NewParam setMaximumLength(@Nullable java.lang.Integer maximumLength)
WebService.Param.maximumLength()
public WebService.NewParam setMinimumLength(@Nullable java.lang.Integer minimumLength)
WebService.Param.minimumLength()
public WebService.NewParam setMaximumValue(@Nullable java.lang.Integer maximumValue)
WebService.Param.maximumValue()
public java.lang.String toString()
toString
in class java.lang.Object