Interface RequestBody
- All Superinterfaces:
Constructible
,Extensible
,Reference<RequestBody>
This interface represents the request body of an operation in which body parameters can be specified.
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionSets the content of this instance of RequestBody, where the keys in content are media type names and the values describe it.description
(String description) Sets the description of this RequestBody and return this instance of RequestBodyReturns the content of this instance of RequestBody, where the keys in content are media type names and the values describe it.Returns the description of this instance of RequestBody.Returns whether this instance of RequestBody is required for the operation.Sets whether this instance of RequestBody is required or not and returns this instance of RequestBodyvoid
setContent
(Content content) Sets the content of this instance of RequestBody, where the keys in content are media type names and the values describe it.void
setDescription
(String description) Sets the description of this instance of RequestBody.void
setRequired
(Boolean required) Sets whether this instance of RequestBody is required or not.Methods inherited from interface org.eclipse.microprofile.openapi.models.Extensible
addExtension, getExtensions, setExtensions
-
Method Details
-
getDescription
String getDescription()Returns the description of this instance of RequestBody.- Returns:
- a brief description of the RequestBody
-
setDescription
Sets the description of this instance of RequestBody. to the parameter.- Parameters:
description
- the brief description of the RequestBody
-
description
Sets the description of this RequestBody and return this instance of RequestBody- Parameters:
description
- the brief description of the RequestBody- Returns:
- this RequestBody instance
-
getContent
Content getContent()Returns the content of this instance of RequestBody, where the keys in content are media type names and the values describe it.- Returns:
- the content of this RequestBody
-
setContent
Sets the content of this instance of RequestBody, where the keys in content are media type names and the values describe it.- Parameters:
content
- the content that describes the RequestBody
-
content
Sets the content of this instance of RequestBody, where the keys in content are media type names and the values describe it.- Parameters:
content
- the content that describes the RequestBody- Returns:
- RequestBody instance with the modified content property
-
getRequired
Boolean getRequired()Returns whether this instance of RequestBody is required for the operation.- Returns:
- true iff the RequestBody is required, false otherwise
-
setRequired
Sets whether this instance of RequestBody is required or not.- Parameters:
required
- true iff the RequestBody is required, false otherwise
-
required
Sets whether this instance of RequestBody is required or not and returns this instance of RequestBody- Parameters:
required
- true iff the RequestBody is required, false otherwise- Returns:
- this RequestBody instance
-