| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>APIResponse</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../script.js"></script> |
| |
| <link rel="shortcut icon" href="/img/microprofile-favicon.png"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="APIResponse"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li>Prev Class</li> |
| <li><a href="../../../../../../org/eclipse/microprofile/openapi/models/responses/APIResponses.html" title="interface in org.eclipse.microprofile.openapi.models.responses"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/eclipse/microprofile/openapi/models/responses/APIResponse.html" target="_top">Frames</a></li> |
| <li><a href="APIResponse.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.eclipse.microprofile.openapi.models.responses</div> |
| <h2 title="Interface APIResponse" class="title">Interface APIResponse</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><a href="../../../../../../org/eclipse/microprofile/openapi/models/Constructible.html" title="interface in org.eclipse.microprofile.openapi.models">Constructible</a>, <a href="../../../../../../org/eclipse/microprofile/openapi/models/Extensible.html" title="interface in org.eclipse.microprofile.openapi.models">Extensible</a>, <a href="../../../../../../org/eclipse/microprofile/openapi/models/Reference.html" title="interface in org.eclipse.microprofile.openapi.models">Reference</a><<a href="../../../../../../org/eclipse/microprofile/openapi/models/responses/APIResponse.html" title="interface in org.eclipse.microprofile.openapi.models.responses">APIResponse</a>></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">APIResponse</span> |
| extends <a href="../../../../../../org/eclipse/microprofile/openapi/models/Constructible.html" title="interface in org.eclipse.microprofile.openapi.models">Constructible</a>, <a href="../../../../../../org/eclipse/microprofile/openapi/models/Extensible.html" title="interface in org.eclipse.microprofile.openapi.models">Extensible</a>, <a href="../../../../../../org/eclipse/microprofile/openapi/models/Reference.html" title="interface in org.eclipse.microprofile.openapi.models">Reference</a><<a href="../../../../../../org/eclipse/microprofile/openapi/models/responses/APIResponse.html" title="interface in org.eclipse.microprofile.openapi.models.responses">APIResponse</a>></pre> |
| <div class="block">This interface represents a single response from an API Operation, including design-time, static links to operations based on the response.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd>"https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#responseObject"</dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/eclipse/microprofile/openapi/models/responses/APIResponse.html" title="interface in org.eclipse.microprofile.openapi.models.responses">APIResponse</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/responses/APIResponse.html#addHeader-java.lang.String-org.eclipse.microprofile.openapi.models.headers.Header-">addHeader</a></span>(java.lang.String name, |
| <a href="../../../../../../org/eclipse/microprofile/openapi/models/headers/Header.html" title="interface in org.eclipse.microprofile.openapi.models.headers">Header</a> header)</code> |
| <div class="block">Adds the given Header to this ApiResponse instance's map of Headers with the given name and return this instance of ApiResponse.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/eclipse/microprofile/openapi/models/responses/APIResponse.html" title="interface in org.eclipse.microprofile.openapi.models.responses">APIResponse</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/responses/APIResponse.html#addLink-java.lang.String-org.eclipse.microprofile.openapi.models.links.Link-">addLink</a></span>(java.lang.String name, |
| <a href="../../../../../../org/eclipse/microprofile/openapi/models/links/Link.html" title="interface in org.eclipse.microprofile.openapi.models.links">Link</a> link)</code> |
| <div class="block">Adds a link to this instance of ApiResponse using the given name and Link, and returns this ApiResponse instance.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/eclipse/microprofile/openapi/models/responses/APIResponse.html" title="interface in org.eclipse.microprofile.openapi.models.responses">APIResponse</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/responses/APIResponse.html#content-org.eclipse.microprofile.openapi.models.media.Content-">content</a></span>(<a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Content.html" title="interface in org.eclipse.microprofile.openapi.models.media">Content</a> content)</code> |
| <div class="block">Sets the map containing descriptions of potential response payload for this instance of ApiResponse and returns this ApiResponse instance.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/eclipse/microprofile/openapi/models/responses/APIResponse.html" title="interface in org.eclipse.microprofile.openapi.models.responses">APIResponse</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/responses/APIResponse.html#description-java.lang.String-">description</a></span>(java.lang.String description)</code> |
| <div class="block">Sets the description of this instance of ApiResponse and returns this ApiResponse instance.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Content.html" title="interface in org.eclipse.microprofile.openapi.models.media">Content</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/responses/APIResponse.html#getContent--">getContent</a></span>()</code> |
| <div class="block">Returns the map containing descriptions of potential response payload for this instance of ApiResponse.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/responses/APIResponse.html#getDescription--">getDescription</a></span>()</code> |
| <div class="block">Returns a short description of this instance of ApiResponse.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>java.util.Map<java.lang.String,<a href="../../../../../../org/eclipse/microprofile/openapi/models/headers/Header.html" title="interface in org.eclipse.microprofile.openapi.models.headers">Header</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/responses/APIResponse.html#getHeaders--">getHeaders</a></span>()</code> |
| <div class="block">Returns the map of Headers in this instance of ApiResponse.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>java.util.Map<java.lang.String,<a href="../../../../../../org/eclipse/microprofile/openapi/models/links/Link.html" title="interface in org.eclipse.microprofile.openapi.models.links">Link</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/responses/APIResponse.html#getLinks--">getLinks</a></span>()</code> |
| <div class="block">Returns the operations links that can be followed from tis instance of ApiResponse.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/eclipse/microprofile/openapi/models/responses/APIResponse.html" title="interface in org.eclipse.microprofile.openapi.models.responses">APIResponse</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/responses/APIResponse.html#headers-java.util.Map-">headers</a></span>(java.util.Map<java.lang.String,<a href="../../../../../../org/eclipse/microprofile/openapi/models/headers/Header.html" title="interface in org.eclipse.microprofile.openapi.models.headers">Header</a>> headers)</code> |
| <div class="block">Sets the Headers for this instance of ApiResponse with the given map of Headers and returns this instance of ApiResponse.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/eclipse/microprofile/openapi/models/responses/APIResponse.html" title="interface in org.eclipse.microprofile.openapi.models.responses">APIResponse</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/responses/APIResponse.html#links-java.util.Map-">links</a></span>(java.util.Map<java.lang.String,<a href="../../../../../../org/eclipse/microprofile/openapi/models/links/Link.html" title="interface in org.eclipse.microprofile.openapi.models.links">Link</a>> links)</code> |
| <div class="block">Sets the operations links that can be followed from this instance of ApiResponse.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/responses/APIResponse.html#setContent-org.eclipse.microprofile.openapi.models.media.Content-">setContent</a></span>(<a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Content.html" title="interface in org.eclipse.microprofile.openapi.models.media">Content</a> content)</code> |
| <div class="block">Sets the map containing descriptions of potential response payload for this instance of ApiResponse.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/responses/APIResponse.html#setDescription-java.lang.String-">setDescription</a></span>(java.lang.String description)</code> |
| <div class="block">Sets the description of this instance of ApiResponse.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/responses/APIResponse.html#setHeaders-java.util.Map-">setHeaders</a></span>(java.util.Map<java.lang.String,<a href="../../../../../../org/eclipse/microprofile/openapi/models/headers/Header.html" title="interface in org.eclipse.microprofile.openapi.models.headers">Header</a>> headers)</code> |
| <div class="block">Sets the Headers for this instance of ApiResponse with the given map of Headers.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/responses/APIResponse.html#setLinks-java.util.Map-">setLinks</a></span>(java.util.Map<java.lang.String,<a href="../../../../../../org/eclipse/microprofile/openapi/models/links/Link.html" title="interface in org.eclipse.microprofile.openapi.models.links">Link</a>> links)</code> |
| <div class="block">Sets the operations links that can be followed from this instance of ApiResponse.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.eclipse.microprofile.openapi.models.Extensible"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.eclipse.microprofile.openapi.models.<a href="../../../../../../org/eclipse/microprofile/openapi/models/Extensible.html" title="interface in org.eclipse.microprofile.openapi.models">Extensible</a></h3> |
| <code><a href="../../../../../../org/eclipse/microprofile/openapi/models/Extensible.html#addExtension-java.lang.String-java.lang.Object-">addExtension</a>, <a href="../../../../../../org/eclipse/microprofile/openapi/models/Extensible.html#getExtensions--">getExtensions</a>, <a href="../../../../../../org/eclipse/microprofile/openapi/models/Extensible.html#setExtensions-java.util.Map-">setExtensions</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.eclipse.microprofile.openapi.models.Reference"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.eclipse.microprofile.openapi.models.<a href="../../../../../../org/eclipse/microprofile/openapi/models/Reference.html" title="interface in org.eclipse.microprofile.openapi.models">Reference</a></h3> |
| <code><a href="../../../../../../org/eclipse/microprofile/openapi/models/Reference.html#getRef--">getRef</a>, <a href="../../../../../../org/eclipse/microprofile/openapi/models/Reference.html#ref-java.lang.String-">ref</a>, <a href="../../../../../../org/eclipse/microprofile/openapi/models/Reference.html#setRef-java.lang.String-">setRef</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getDescription--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDescription</h4> |
| <pre>java.lang.String getDescription()</pre> |
| <div class="block">Returns a short description of this instance of ApiResponse.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a short description of the response</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setDescription-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDescription</h4> |
| <pre>void setDescription(java.lang.String description)</pre> |
| <div class="block">Sets the description of this instance of ApiResponse.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>description</code> - a short description of the response</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="description-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>description</h4> |
| <pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/responses/APIResponse.html" title="interface in org.eclipse.microprofile.openapi.models.responses">APIResponse</a> description(java.lang.String description)</pre> |
| <div class="block">Sets the description of this instance of ApiResponse and returns this ApiResponse instance.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>description</code> - a short description of the response</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this ApiResponse instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getHeaders--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getHeaders</h4> |
| <pre>java.util.Map<java.lang.String,<a href="../../../../../../org/eclipse/microprofile/openapi/models/headers/Header.html" title="interface in org.eclipse.microprofile.openapi.models.headers">Header</a>> getHeaders()</pre> |
| <div class="block">Returns the map of Headers in this instance of ApiResponse.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the headers of this response</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setHeaders-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setHeaders</h4> |
| <pre>void setHeaders(java.util.Map<java.lang.String,<a href="../../../../../../org/eclipse/microprofile/openapi/models/headers/Header.html" title="interface in org.eclipse.microprofile.openapi.models.headers">Header</a>> headers)</pre> |
| <div class="block">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.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>headers</code> - the headers of the response</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="headers-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>headers</h4> |
| <pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/responses/APIResponse.html" title="interface in org.eclipse.microprofile.openapi.models.responses">APIResponse</a> headers(java.util.Map<java.lang.String,<a href="../../../../../../org/eclipse/microprofile/openapi/models/headers/Header.html" title="interface in org.eclipse.microprofile.openapi.models.headers">Header</a>> headers)</pre> |
| <div class="block">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.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>headers</code> - the headers of the response</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this ApiResponse instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addHeader-java.lang.String-org.eclipse.microprofile.openapi.models.headers.Header-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addHeader</h4> |
| <pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/responses/APIResponse.html" title="interface in org.eclipse.microprofile.openapi.models.responses">APIResponse</a> addHeader(java.lang.String name, |
| <a href="../../../../../../org/eclipse/microprofile/openapi/models/headers/Header.html" title="interface in org.eclipse.microprofile.openapi.models.headers">Header</a> header)</pre> |
| <div class="block">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.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the unique name of the header</dd> |
| <dd><code>header</code> - a header for the response</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this ApiResponse instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getContent--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getContent</h4> |
| <pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Content.html" title="interface in org.eclipse.microprofile.openapi.models.media">Content</a> getContent()</pre> |
| <div class="block">Returns the map containing descriptions of potential response payload for this instance of ApiResponse.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the potential content of the response</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setContent-org.eclipse.microprofile.openapi.models.media.Content-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setContent</h4> |
| <pre>void setContent(<a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Content.html" title="interface in org.eclipse.microprofile.openapi.models.media">Content</a> content)</pre> |
| <div class="block">Sets the map containing descriptions of potential response payload for this instance of ApiResponse.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>content</code> - the potential content of the response</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="content-org.eclipse.microprofile.openapi.models.media.Content-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>content</h4> |
| <pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/responses/APIResponse.html" title="interface in org.eclipse.microprofile.openapi.models.responses">APIResponse</a> content(<a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Content.html" title="interface in org.eclipse.microprofile.openapi.models.media">Content</a> content)</pre> |
| <div class="block">Sets the map containing descriptions of potential response payload for this instance of ApiResponse and returns this ApiResponse instance.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>content</code> - the potential content of the response</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this ApiResponse instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getLinks--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLinks</h4> |
| <pre>java.util.Map<java.lang.String,<a href="../../../../../../org/eclipse/microprofile/openapi/models/links/Link.html" title="interface in org.eclipse.microprofile.openapi.models.links">Link</a>> getLinks()</pre> |
| <div class="block">Returns the operations links that can be followed from tis instance of ApiResponse.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>operation links that can be followed from the response</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setLinks-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setLinks</h4> |
| <pre>void setLinks(java.util.Map<java.lang.String,<a href="../../../../../../org/eclipse/microprofile/openapi/models/links/Link.html" title="interface in org.eclipse.microprofile.openapi.models.links">Link</a>> links)</pre> |
| <div class="block">Sets the operations links that can be followed from this instance of ApiResponse.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>links</code> - the operation links followed from the response</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="links-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>links</h4> |
| <pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/responses/APIResponse.html" title="interface in org.eclipse.microprofile.openapi.models.responses">APIResponse</a> links(java.util.Map<java.lang.String,<a href="../../../../../../org/eclipse/microprofile/openapi/models/links/Link.html" title="interface in org.eclipse.microprofile.openapi.models.links">Link</a>> links)</pre> |
| <div class="block">Sets the operations links that can be followed from this instance of ApiResponse.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>links</code> - the operation links followed from the response</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>current APIResponse instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addLink-java.lang.String-org.eclipse.microprofile.openapi.models.links.Link-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>addLink</h4> |
| <pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/responses/APIResponse.html" title="interface in org.eclipse.microprofile.openapi.models.responses">APIResponse</a> addLink(java.lang.String name, |
| <a href="../../../../../../org/eclipse/microprofile/openapi/models/links/Link.html" title="interface in org.eclipse.microprofile.openapi.models.links">Link</a> link)</pre> |
| <div class="block">Adds a link to this instance of ApiResponse using the given name and Link, and returns this ApiResponse instance.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the short name of the link</dd> |
| <dd><code>link</code> - the operation link that can be followed from the response</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this ApiResponse instance</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li>Prev Class</li> |
| <li><a href="../../../../../../org/eclipse/microprofile/openapi/models/responses/APIResponses.html" title="interface in org.eclipse.microprofile.openapi.models.responses"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/eclipse/microprofile/openapi/models/responses/APIResponse.html" target="_top">Frames</a></li> |
| <li><a href="APIResponse.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
