MicroProfile 7.0 · org.eclipse.microprofile.openapi.models.responses.APIResponse

Method Summary

Modifier and Type	Method and Description
public APIResponse	Returns: this ApiResponse instance addHeader(String the unique name of the header name, Header a header for the response. null values will be rejected (implementation will throw an exception) or ignored. header) Adds the given Header to this ApiResponse instance's map of Headers with the given name and return this instance of ApiResponse.
public APIResponse	Returns: this ApiResponse instance addLink(String the short name of the link name, Link the operation link that can be followed from the response. null values will be rejected (implementation will throw an exception) or ignored. link) Adds a link to this instance of ApiResponse using the given name and Link, and returns this ApiResponse instance.
public default APIResponse	Returns: this ApiResponse instance content(Content the potential content of the response content) Sets the map containing descriptions of potential response payload for this instance of ApiResponse and returns this ApiResponse instance.
public default APIResponse	Returns: this ApiResponse instance description(String a short description of the response description) Sets the description of this instance of ApiResponse and returns this ApiResponse instance.
public Content	Returns: the potential content of the response getContent() Returns the map containing descriptions of potential response payload for this instance of ApiResponse.
public String	Returns: a short description of the response getDescription() Returns a short description of this instance of ApiResponse.
public Map<String, Header>	Returns: a copy Map (potentially immutable) of the headers of this response getHeaders() Returns the map of Headers in this instance of ApiResponse.
public Map<String, Link>	Returns: a copy Map (potentially immutable) of links that can be followed from the response getLinks() Returns the operations links that can be followed from this instance of ApiResponse.
public default APIResponse	Returns: this ApiResponse instance headers(Map<String, Header> the headers of the response headers) Sets the Headers for this instance of ApiResponse with the given map of Headers and returns this instance of ApiResponse.
public default APIResponse	Returns: current APIResponse instance links(Map<String, Link> the operation links followed from the response links) Sets the operations links that can be followed from this instance of ApiResponse.
public void	removeHeader(String the unique name of the header name) Removes the given Header to this ApiResponse instance's map of Headers with the given name and return this instance of ApiResponse.
public void	removeLink(String the short name of the link name) Removes a link to this instance of ApiResponse using the given name and Link.
public void	setContent(Content the potential content of the response content) Sets the map containing descriptions of potential response payload for this instance of ApiResponse.
public void	setDescription(String a short description of the response description) Sets the description of this instance of ApiResponse.
public void	setHeaders(Map<String, Header> the headers of the response headers) Sets the Headers for this instance of ApiResponse with the given map of Headers.
public void	setLinks(Map<String, Link> the operation links followed from the response links) Sets the operations links that can be followed from this instance of ApiResponse.

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

addHeader	back to summary
public APIResponse addHeader(String name, Header header) Adds the given Header to this ApiResponse instance's map of Headers with the given name and return this instance of ApiResponse. If this ApiResponse instance does not have any headers, a new map is created and the given header is added. Parameters name:String the unique name of the header header:Header a header for the response. null values will be rejected (implementation will throw an exception) or ignored. Returns:APIResponse this ApiResponse instance

addHeader

back to summary

public APIResponse addHeader(String name, Header header)

Adds the given Header to this ApiResponse instance's map of Headers with the given name and return this instance of ApiResponse. If this ApiResponse instance does not have any headers, a new map is created and the given header is added.

Parameters

name:String: the unique name of the header
header:Header: a header for the response. null values will be rejected (implementation will throw an exception) or ignored.

Returns:APIResponse

this ApiResponse instance

addLink	back to summary
public APIResponse addLink(String name, Link link) Adds a link to this instance of ApiResponse using the given name and Link, and returns this ApiResponse instance. Parameters name:String the short name of the link link:Link the operation link that can be followed from the response. null values will be rejected (implementation will throw an exception) or ignored. Returns:APIResponse this ApiResponse instance

addLink

back to summary

public APIResponse addLink(String name, Link link)

Adds a link to this instance of ApiResponse using the given name and Link, and returns this ApiResponse instance.

Parameters

name:String: the short name of the link
link:Link: the operation link that can be followed from the response. null values will be rejected (implementation will throw an exception) or ignored.

Returns:APIResponse

this ApiResponse instance

content	back to summary
public default APIResponse content(Content content) Sets the map containing descriptions of potential response payload for this instance of ApiResponse and returns this ApiResponse instance. Parameters content:Content the potential content of the response Returns:APIResponse this ApiResponse instance

content

back to summary

public default APIResponse content(Content content)

Sets the map containing descriptions of potential response payload for this instance of ApiResponse and returns this ApiResponse instance.

Parameters

content:Content: the potential content of the response

Returns:APIResponse

this ApiResponse instance

description	back to summary
public default APIResponse description(String description) Sets the description of this instance of ApiResponse and returns this ApiResponse instance. Parameters description:String a short description of the response Returns:APIResponse this ApiResponse instance

description

back to summary

public default APIResponse description(String description)

Sets the description of this instance of ApiResponse and returns this ApiResponse instance.

Parameters

description:String: a short description of the response

Returns:APIResponse

this ApiResponse instance

getContent	back to summary
public Content getContent() Returns the map containing descriptions of potential response payload for this instance of ApiResponse. Returns:Content the potential content of the response

getContent

back to summary

public Content getContent()

Returns the map containing descriptions of potential response payload for this instance of ApiResponse.

Returns:Content: the potential content of the response

getDescription	back to summary
public String getDescription() Returns a short description of this instance of ApiResponse. Returns:String a short description of the response

getDescription

back to summary

public String getDescription()

Returns a short description of this instance of ApiResponse.

Returns:String: a short description of the response

getHeaders	back to summary
public Map<String, Header> getHeaders() Returns the map of Headers in this instance of ApiResponse. Returns:Map<String, Header> a copy Map (potentially immutable) of the headers of this response

getHeaders

back to summary

public Map<String, Header> getHeaders()

Returns the map of Headers in this instance of ApiResponse.

Returns:Map<String, Header>: a copy Map (potentially immutable) of the headers of this response

getLinks	back to summary
public Map<String, Link> getLinks() Returns the operations links that can be followed from this instance of ApiResponse. Returns:Map<String, Link> a copy Map (potentially immutable) of links that can be followed from the response

getLinks

back to summary

public Map<String, Link> getLinks()

Returns the operations links that can be followed from this instance of ApiResponse.

Returns:Map<String, Link>: a copy Map (potentially immutable) of links that can be followed from the response

headers	back to summary
public default APIResponse headers(Map<String, Header> headers) Sets the Headers for this instance of ApiResponse with the given map of Headers and returns this instance of ApiResponse. The Header names are case insensitive and if a Header is defined with the name 'Content-Type', then it will be ignored. Parameters headers:Map<String, Header> the headers of the response Returns:APIResponse this ApiResponse instance

headers

back to summary

public default APIResponse headers(Map<String, Header> headers)

Sets the Headers for this instance of ApiResponse with the given map of Headers and returns this instance of ApiResponse. The Header names are case insensitive and if a Header is defined with the name 'Content-Type', then it will be ignored.

Parameters

headers:Map<String, Header>: the headers of the response

Returns:APIResponse

this ApiResponse instance

links	back to summary
public default APIResponse links(Map<String, Link> links) Sets the operations links that can be followed from this instance of ApiResponse. Parameters links:Map<String, Link> the operation links followed from the response Returns:APIResponse current APIResponse instance

links

back to summary

public default APIResponse links(Map<String, Link> links)

Sets the operations links that can be followed from this instance of ApiResponse.

Parameters

links:Map<String, Link>: the operation links followed from the response

Returns:APIResponse

current APIResponse instance

removeHeader	back to summary
public void removeHeader(String name) Removes the given Header to this ApiResponse instance's map of Headers with the given name and return this instance of ApiResponse. If this ApiResponse instance does not have any headers, a new map is created and the given header is added. Parameters name:String the unique name of the header

removeHeader

back to summary

public void removeHeader(String name)

Removes the given Header to this ApiResponse instance's map of Headers with the given name and return this instance of ApiResponse. If this ApiResponse instance does not have any headers, a new map is created and the given header is added.

Parameters

name:String: the unique name of the header

removeLink	back to summary
public void removeLink(String name) Removes a link to this instance of ApiResponse using the given name and Link. Parameters name:String the short name of the link

removeLink

back to summary

public void removeLink(String name)

Removes a link to this instance of ApiResponse using the given name and Link.

Parameters

name:String: the short name of the link

setContent	back to summary
public void setContent(Content content) Sets the map containing descriptions of potential response payload for this instance of ApiResponse. Parameters content:Content the potential content of the response

setContent

back to summary

public void setContent(Content content)

Sets the map containing descriptions of potential response payload for this instance of ApiResponse.

Parameters

content:Content: the potential content of the response

setDescription	back to summary
public void setDescription(String description) Sets the description of this instance of ApiResponse. Parameters description:String a short description of the response

setDescription

back to summary

public void setDescription(String description)

Sets the description of this instance of ApiResponse.

Parameters

description:String: a short description of the response

setHeaders	back to summary
public void setHeaders(Map<String, Header> headers) Sets the Headers for this instance of ApiResponse with the given map of Headers. The Header names are case insensitive and if a Header is defined with the name 'Content-Type', then it will be ignored. Parameters headers:Map<String, Header> the headers of the response

setHeaders

back to summary

public void setHeaders(Map<String, Header> headers)

Sets the Headers for this instance of ApiResponse with the given map of Headers. The Header names are case insensitive and if a Header is defined with the name 'Content-Type', then it will be ignored.

Parameters

headers:Map<String, Header>: the headers of the response

setLinks	back to summary
public void setLinks(Map<String, Link> links) Sets the operations links that can be followed from this instance of ApiResponse. Parameters links:Map<String, Link> the operation links followed from the response

setLinks

back to summary

public void setLinks(Map<String, Link> links)

Sets the operations links that can be followed from this instance of ApiResponse.

Parameters

links:Map<String, Link>: the operation links followed from the response

public Interface APIResponse

Method Summary

Method Detail