MicroProfile 7.0 · org.eclipse.microprofile.openapi.models.parameters.RequestBody

Method Summary

Modifier and Type	Method and Description
public default RequestBody	Returns: RequestBody instance with the modified content property content(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.
public default RequestBody	Returns: this RequestBody instance description(String the brief description of the RequestBody description) Sets the description of this RequestBody and return this instance of RequestBody
public Content	Returns: the content of this RequestBody getContent() Returns the content of this instance of RequestBody, where the keys in content are media type names and the values describe it.
public String	Returns: a brief description of the RequestBody getDescription() Returns the description of this instance of RequestBody.
public Boolean	Returns: true iff the RequestBody is required, false otherwise getRequired() Returns whether this instance of RequestBody is required for the operation.
public default RequestBody	Returns: this RequestBody instance required(Boolean 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
public void	setContent(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.
public void	setDescription(String the brief description of the RequestBody description) Sets the description of this instance of RequestBody.
public void	setRequired(Boolean true iff the RequestBody is required, false otherwise required) Sets whether this instance of RequestBody is required or not.

Inherited from org.eclipse.microprofile.openapi.models.Extensible:: addExtension extensions getExtensions removeExtension setExtensions
Inherited from org.eclipse.microprofile.openapi.models.Reference:: getRef ref setRef

Method Detail

content	back to summary
public default RequestBody content(Content 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:Content the content that describes the RequestBody Returns:RequestBody RequestBody instance with the modified content property

content

back to summary

public default RequestBody content(Content 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:Content: the content that describes the RequestBody

Returns:RequestBody

RequestBody instance with the modified content property

description	back to summary
public default RequestBody description(String description) Sets the description of this RequestBody and return this instance of RequestBody Parameters description:String the brief description of the RequestBody Returns:RequestBody this RequestBody instance

description

back to summary

public default RequestBody description(String description)

Sets the description of this RequestBody and return this instance of RequestBody

Parameters

description:String: the brief description of the RequestBody

Returns:RequestBody

this RequestBody instance

getContent	back to summary
public 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:Content the content of this RequestBody

getContent

back to summary

public 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:Content: the content of this RequestBody

getDescription	back to summary
public String getDescription() Returns the description of this instance of RequestBody. Returns:String a brief description of the RequestBody

getDescription

back to summary

public String getDescription()

Returns the description of this instance of RequestBody.

Returns:String: a brief description of the RequestBody

getRequired	back to summary
public Boolean getRequired() Returns whether this instance of RequestBody is required for the operation. Returns:Boolean true iff the RequestBody is required, false otherwise

getRequired

back to summary

public Boolean getRequired()

Returns whether this instance of RequestBody is required for the operation.

Returns:Boolean: true iff the RequestBody is required, false otherwise

required	back to summary
public default RequestBody required(Boolean required) Sets whether this instance of RequestBody is required or not and returns this instance of RequestBody Parameters required:Boolean true iff the RequestBody is required, false otherwise Returns:RequestBody this RequestBody instance

required

back to summary

public default RequestBody required(Boolean required)

Sets whether this instance of RequestBody is required or not and returns this instance of RequestBody

Parameters

required:Boolean: true iff the RequestBody is required, false otherwise

Returns:RequestBody

this RequestBody instance

setContent	back to summary
public void 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. Parameters content:Content the content that describes the RequestBody

setContent

back to summary

public void 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.

Parameters

content:Content: the content that describes the RequestBody

setDescription	back to summary
public void setDescription(String description) Sets the description of this instance of RequestBody. to the parameter. Parameters description:String the brief description of the RequestBody

setDescription

back to summary

public void setDescription(String description)

Sets the description of this instance of RequestBody. to the parameter.

Parameters

description:String: the brief description of the RequestBody

setRequired	back to summary
public void setRequired(Boolean required) Sets whether this instance of RequestBody is required or not. Parameters required:Boolean true iff the RequestBody is required, false otherwise

setRequired

back to summary

public void setRequired(Boolean required)

Sets whether this instance of RequestBody is required or not.

Parameters

required:Boolean: true iff the RequestBody is required, false otherwise

public Interface RequestBody

Method Summary

Method Detail