public interface APIResponse extends Constructible, Extensible<APIResponse>, Reference<APIResponse>
Modifier and Type | Method and Description |
---|---|
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.
|
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.
|
default APIResponse |
content(Content content)
Sets the map containing descriptions of potential response payload for this instance of ApiResponse and returns
this ApiResponse instance.
|
default APIResponse |
description(String description)
Sets the description of this instance of ApiResponse and returns this ApiResponse instance.
|
Content |
getContent()
Returns the map containing descriptions of potential response payload for this instance of ApiResponse.
|
String |
getDescription()
Returns a short description of this instance of ApiResponse.
|
Map<String,Header> |
getHeaders()
Returns the map of Headers in this instance of ApiResponse.
|
Map<String,Link> |
getLinks()
Returns the operations links that can be followed from this instance of ApiResponse.
|
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.
|
default APIResponse |
links(Map<String,Link> links)
Sets the operations links that can be followed from this instance of ApiResponse.
|
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.
|
void |
removeLink(String name)
Removes a link to this instance of ApiResponse using the given name and Link.
|
void |
setContent(Content content)
Sets the map containing descriptions of potential response payload for this instance of ApiResponse.
|
void |
setDescription(String description)
Sets the description of this instance of ApiResponse.
|
void |
setHeaders(Map<String,Header> headers)
Sets the Headers for this instance of ApiResponse with the given map of Headers.
|
void |
setLinks(Map<String,Link> links)
Sets the operations links that can be followed from this instance of ApiResponse.
|
addExtension, extensions, getExtensions, removeExtension, setExtensions
String getDescription()
void setDescription(String description)
description
- a short description of the responsedefault APIResponse description(String description)
description
- a short description of the responseMap<String,Header> getHeaders()
void setHeaders(Map<String,Header> headers)
headers
- the headers of the responsedefault APIResponse headers(Map<String,Header> headers)
headers
- the headers of the responseAPIResponse addHeader(String name, Header header)
name
- the unique name of the headerheader
- a header for the response. null values will be rejected (implementation will throw an exception) or
ignored.void removeHeader(String name)
name
- the unique name of the headerContent getContent()
void setContent(Content content)
content
- the potential content of the responsedefault APIResponse content(Content content)
content
- the potential content of the responseMap<String,Link> getLinks()
void setLinks(Map<String,Link> links)
links
- the operation links followed from the responsedefault APIResponse links(Map<String,Link> links)
links
- the operation links followed from the responseAPIResponse addLink(String name, Link link)
name
- the short name of the linklink
- the operation link that can be followed from the response. null values will be rejected
(implementation will throw an exception) or ignored.void removeLink(String name)
name
- the short name of the linkCopyright © 2017 – 2022 Eclipse Foundation. All rights reserved.
Use is subject to license terms.