Describes a single operation parameter.
A unique parameter is defined by a combination of a name and location. There are four possible parameter locations
specified by the in field:
The rules for serialization of the parameter are specified in one of two ways. For simpler scenarios, a schema and style can describe the structure and syntax of the parameter.
For more complex scenarios, the content property can define the media type and schema of the parameter. A parameter must contain either a schema property, or a content property, but not both.
| Modifier and Type | Class and Description |
|---|---|
| public static enum | Parameter.
The values allowed for the in field. |
| public static enum | Parameter.
The values allowed for the style field. |
| Modifier and Type | Method and Description |
|---|---|
| public Parameter | Returns: the current Parameter instancestring to represent the example key, Example example of the parameter. null values will be rejected (implementation will throw an exception) or
ignored. example)Adds an example of the parameter using the specified key. |
| public default Parameter | Returns: the current Parameter instancespecify the ability to pass empty-valued parameters allowEmptyValue)Sets the allowEmptyValue property of a Parameter instance to the given value. |
| public default Parameter | Returns: the current Parameter instancespecifies whether the parameter value should allow reserved characters allowReserved)Sets the allowReserved property of a Parameter instance to the given value. |
| public default Parameter | |
| public default Parameter | Returns: the current Parameter instancespecifies that a parameter is deprecated deprecated)Sets the deprecated property of a Parameter instance to the given value. |
| public default Parameter | Returns: the current Parameter instancea brief description of the parameter description)Sets the description property of a Parameter instance to the given string. |
| public default Parameter | |
| public default Parameter | |
| public default Parameter | |
| public Boolean | Returns: specifies the ability to pass empty-valued parametersReturns the allowEmptyValue property from a Parameter instance. |
| public Boolean | Returns: specifies whether the parameter value should allow reserved charactersReturns the allowReserved property from a Parameter instance. |
| public Content | Returns: a map containing the media representations for the parameterReturns the content property from a Parameter instance. |
| public Boolean | Returns: specifies that a parameter is deprecatedReturns the deprecated property from a Parameter instance. |
| public String | Returns: a brief description of the parameterReturns the description property from a Parameter instance. |
| public Object | Returns: example of the parameterReturns the example property from a Parameter instance. |
| public Map | Returns: a copy Map (potentially immutable) of examples of the parameterReturns the examples property from a Parameter instance. |
| public Boolean | Returns: whether parameter values of type "array" or "object" generate separate parameters for each valueReturns the explode property from a Parameter instance. |
| public Parameter. | |
| public String | |
| public Boolean | Returns: indicates whether this parameter is mandatoryReturns the required property from a Parameter instance. |
| public Schema | Returns: schema defining the type used for the parameterReturns the schema property from a Parameter instance. |
| public Parameter. | Returns: describes how the parameter value will be serializedReturns the style property from a Parameter instance. |
| public default Parameter | |
| public default Parameter | |
| public void | removeExample(String
string to represent the example key)Removes an example of the parameter using the specified key. |
| public default Parameter | |
| public default Parameter | |
| public void | setAllowEmptyValue(Boolean
specify the ability to pass empty-valued parameters allowEmptyValue)Sets the allowEmptyValue property of a Parameter instance to the given value. |
| public void | setAllowReserved(Boolean
specifies whether the parameter value should allow reserved characters allowReserved)Sets the allowReserved property of a Parameter instance to the given value. |
| public void | setContent(Content
a map containing the media representations for the parameter content)Sets the content property of a Parameter instance to the given object. |
| public void | setDeprecated(Boolean
specifies that a parameter is deprecated deprecated)Sets the deprecated property of a Parameter instance to the given value. |
| public void | setDescription(String
a brief description of the parameter description)Sets the description property of a Parameter instance to the given string. |
| public void | setExample(Object
example of the parameter example)Sets the example property of a Parameter instance to the given object. |
| public void | setExamples(Map<String, Example>
examples of the parameter examples)Sets the examples property of a Parameter instance to the given value. |
| public void | setExplode(Boolean
whether parameter values of type "array" or "object" generate separate parameters for each value explode)Sets the explode property of a Parameter instance to the given value. |
| public void | |
| public void | |
| public void | setRequired(Boolean
indicates whether this parameter is mandatory required)Sets the required property of a Parameter instance to the given value. |
| public void | |
| public void | |
| public default Parameter |
| addExample | back to summary |
|---|---|
| public Parameter addExample(String key, Example example) Adds an example of the parameter using the specified key. The example should contain a value in the correct format as specified in the parameter encoding. | |
| allowEmptyValue | back to summary |
|---|---|
| public default Parameter allowEmptyValue(Boolean allowEmptyValue) Sets the allowEmptyValue property of a Parameter instance to the given value. | |
| allowReserved | back to summary |
|---|---|
| public default Parameter allowReserved(Boolean allowReserved) Sets the allowReserved property of a Parameter instance to the given value. | |
| content | back to summary |
|---|---|
| public default Parameter content(Content content) Sets the content property of a Parameter instance to the given object. | |
| deprecated | back to summary |
|---|---|
| public default Parameter deprecated(Boolean deprecated) Sets the deprecated property of a Parameter instance to the given value. | |
| description | back to summary |
|---|---|
| public default Parameter description(String description) Sets the description property of a Parameter instance to the given string. | |
| example | back to summary |
|---|---|
| public default Parameter example(Object example) Sets the example property of a Parameter instance to the given object. The example should match the specified schema and encoding properties if present. The examples object is mutually exclusive of the example object. | |
| examples | back to summary |
|---|---|
| public default Parameter examples(Map<String, Example> examples) Sets the examples property of a Parameter instance to the given value. Each example should contain a value in the correct format as specified in the parameter encoding. The examples object is mutually exclusive of the example object. | |
| explode | back to summary |
|---|---|
| public default Parameter explode(Boolean explode) Sets the explode property of a Parameter instance to the given value. | |
| getAllowEmptyValue | back to summary |
|---|---|
| public Boolean getAllowEmptyValue() Returns the allowEmptyValue property from a Parameter instance.
| |
| getAllowReserved | back to summary |
|---|---|
| public Boolean getAllowReserved() Returns the allowReserved property from a Parameter instance.
| |
| getContent | back to summary |
|---|---|
| public Content getContent() Returns the content property from a Parameter instance.
| |
| getDeprecated | back to summary |
|---|---|
| public Boolean getDeprecated() Returns the deprecated property from a Parameter instance.
| |
| getDescription | back to summary |
|---|---|
| public String getDescription() Returns the description property from a Parameter instance.
| |
| getExample | back to summary |
|---|---|
| public Object getExample() Returns the example property from a Parameter instance.
| |
| getExamples | back to summary |
|---|---|
| public Map Returns the examples property from a Parameter instance. | |
| getExplode | back to summary |
|---|---|
| public Boolean getExplode() Returns the explode property from a Parameter instance.
| |
| getIn | back to summary |
|---|---|
| public Parameter. Returns the in property from a Parameter instance. | |
| getName | back to summary |
|---|---|
| public String getName() Returns the name property from a Parameter instance.
| |
| getRequired | back to summary |
|---|---|
| public Boolean getRequired() Returns the required property from a Parameter instance.
| |
| getSchema | back to summary |
|---|---|
| public Schema getSchema() Returns the schema property from a Parameter instance.
| |
| getStyle | back to summary |
|---|---|
| public Parameter. Returns the style property from a Parameter instance. | |
| in | back to summary |
|---|---|
| public default Parameter in(Parameter. Sets the in property of a Parameter instance to the given value. | |
| name | back to summary |
|---|---|
| public default Parameter name(String name) Sets the name property of a Parameter instance to the given string. | |
| removeExample | back to summary |
|---|---|
| public void removeExample(String key) Removes an example of the parameter using the specified key. The example should contain a value in the correct format as specified in the parameter encoding.
| |
| required | back to summary |
|---|---|
| public default Parameter required(Boolean required) Sets the required property of a Parameter instance to the given value. | |
| schema | back to summary |
|---|---|
| public default Parameter schema(Schema schema) Sets the schema property of a Parameter instance to the given value. | |
| setAllowEmptyValue | back to summary |
|---|---|
| public void setAllowEmptyValue(Boolean allowEmptyValue) Sets the allowEmptyValue property of a Parameter instance to the given value.
| |
| setAllowReserved | back to summary |
|---|---|
| public void setAllowReserved(Boolean allowReserved) Sets the allowReserved property of a Parameter instance to the given value.
| |
| setContent | back to summary |
|---|---|
| public void setContent(Content content) Sets the content property of a Parameter instance to the given object.
| |
| setDeprecated | back to summary |
|---|---|
| public void setDeprecated(Boolean deprecated) Sets the deprecated property of a Parameter instance to the given value.
| |
| setDescription | back to summary |
|---|---|
| public void setDescription(String description) Sets the description property of a Parameter instance to the given string.
| |
| setExample | back to summary |
|---|---|
| public void setExample(Object example) Sets the example property of a Parameter instance to the given object. The example should match the specified schema and encoding properties if present. The examples object is mutually exclusive of the example object.
| |
| setExamples | back to summary |
|---|---|
| public void setExamples(Map<String, Example> examples) Sets the examples property of a Parameter instance to the given value. Each example should contain a value in the correct format as specified in the parameter encoding. The examples object is mutually exclusive of the example object. | |
| setExplode | back to summary |
|---|---|
| public void setExplode(Boolean explode) Sets the explode property of a Parameter instance to the given value.
| |
| setIn | back to summary |
|---|---|
| public void setIn(Parameter. Sets the in property of a Parameter instance to the given value. | |
| setName | back to summary |
|---|---|
| public void setName(String name) Sets the name property of a Parameter instance to the given string.
| |
| setRequired | back to summary |
|---|---|
| public void setRequired(Boolean required) Sets the required property of a Parameter instance to the given value.
| |
| setSchema | back to summary |
|---|---|
| public void setSchema(Schema schema) Sets the schema property of a Parameter instance to the given value.
| |
| setStyle | back to summary |
|---|---|
| public void setStyle(Parameter. Sets the style property of a Parameter instance to the given value. | |
| style | back to summary |
|---|---|
| public default Parameter style(Parameter. Sets the style property of a Parameter instance to the given value. | |
| Modifier and Type | Field and Description |
|---|---|
| public static final Parameter. | |
| public static final Parameter. | |
| public static final Parameter. | |
| public static final Parameter. | |
| private final String |
| Modifier and Type | Method and Description |
|---|---|
| public String | toString()
Overrides java. Returns the name of this enum constant, as contained in the declaration. |
| public static Parameter. | |
| public static Parameter. |
| COOKIE | back to summary |
|---|---|
| public static final Parameter. | |
| HEADER | back to summary |
|---|---|
| public static final Parameter. | |
| PATH | back to summary |
|---|---|
| public static final Parameter. | |
| QUERY | back to summary |
|---|---|
| public static final Parameter. | |
| value | back to summary |
|---|---|
| private final String value | |
| In | back to summary |
|---|---|
| private In(String value) | |
| toString | back to summary |
|---|---|
| public String toString() Overrides java. Doc from java. Returns the name of this enum constant, as contained in the declaration. This method may be overridden, though it typically isn't necessary or desirable. An enum class should override this method when a more "programmer-friendly" string form exists. | |
| valueOf | back to summary |
|---|---|
| public static Parameter. | |
| values | back to summary |
|---|---|
| public static Parameter. | |
| Modifier and Type | Field and Description |
|---|---|
| public static final Parameter. | |
| public static final Parameter. | |
| public static final Parameter. | |
| public static final Parameter. | |
| public static final Parameter. | |
| public static final Parameter. | |
| public static final Parameter. | |
| private final String |
| Modifier and Type | Method and Description |
|---|---|
| public String | toString()
Overrides java. Returns the name of this enum constant, as contained in the declaration. |
| public static Parameter. | |
| public static Parameter. |
| DEEPOBJECT | back to summary |
|---|---|
| public static final Parameter. | |
| FORM | back to summary |
|---|---|
| public static final Parameter. | |
| LABEL | back to summary |
|---|---|
| public static final Parameter. | |
| MATRIX | back to summary |
|---|---|
| public static final Parameter. | |
| PIPEDELIMITED | back to summary |
|---|---|
| public static final Parameter. | |
| SIMPLE | back to summary |
|---|---|
| public static final Parameter. | |
| SPACEDELIMITED | back to summary |
|---|---|
| public static final Parameter. | |
| value | back to summary |
|---|---|
| private final String value | |
| Style | back to summary |
|---|---|
| private Style(String value) | |
| toString | back to summary |
|---|---|
| public String toString() Overrides java. Doc from java. Returns the name of this enum constant, as contained in the declaration. This method may be overridden, though it typically isn't necessary or desirable. An enum class should override this method when a more "programmer-friendly" string form exists. | |
| valueOf | back to summary |
|---|---|
| public static Parameter. | |
| values | back to summary |
|---|---|
| public static Parameter. | |