Google Git
Sign in
apache / tomee-site-pub / 476cf231b77b83a25b4407df84b6a5fd7c0d673a / . / microprofile-2.0 / javadoc / org / eclipse / microprofile / openapi / models / links / Link.html
blob: 76461affffcd8b33c43939eb67cc2d2b48c02727 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<title>Link</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="Link";
}
}
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,"i14":6,"i15":6,"i16":6,"i17":6,"i18":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&nbsp;Class</li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/eclipse/microprofile/openapi/models/links/Link.html" target="_top">Frames</a></li>
<li><a href="Link.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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.links</div>
<h2 title="Interface Link" class="title">Interface Link</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>&lt;<a href="../../../../../../org/eclipse/microprofile/openapi/models/links/Link.html" title="interface in org.eclipse.microprofile.openapi.models.links">Link</a>&gt;</dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">Link</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>&lt;<a href="../../../../../../org/eclipse/microprofile/openapi/models/links/Link.html" title="interface in org.eclipse.microprofile.openapi.models.links">Link</a>&gt;</pre>
<div class="block">Link
<p>
The Link object represents a possible design-time link for a response. The presence of a link does not guarantee the caller's ability to
successfully invoke it, rather it provides a known relationship and traversal mechanism between responses and other operations.
<p>
For computing links, and providing instructions to execute them, a runtime expression is used for accessing values in an operation and using them
as parameters while invoking the linked operation.
<p>
A linked operation MUST be identified using either an operationRef or operationId. In the case of an operationId, it MUST be unique and resolved in
the scope of the OAS document. Because of the potential for name clashes, the operationRef syntax is preferred for specifications with external
references.
<p></div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href= "https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#linkObject"> OpenAPI Specification Link Object</a></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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</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/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/links/Link.html#addParameter-java.lang.String-java.lang.Object-">addParameter</a></span>(java.lang.String&nbsp;name,
java.lang.Object&nbsp;parameter)</code>
<div class="block">Add a new parameter to the parameters property of this instance of Link.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><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/links/Link.html#description-java.lang.String-">description</a></span>(java.lang.String&nbsp;description)</code>
<div class="block">Sets this Link's description property to the given string.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/links/Link.html#getDescription--">getDescription</a></span>()</code>
<div class="block">Returns the description property from a Link instance.</div>
</td>
</tr>
<tr id="i3" 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/links/Link.html#getOperationId--">getOperationId</a></span>()</code>
<div class="block">Returns the operationId property for this instance of Link.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/links/Link.html#getOperationRef--">getOperationRef</a></span>()</code>
<div class="block">Returns the operationRef property from a Link instance.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>java.util.Map&lt;java.lang.String,java.lang.Object&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/links/Link.html#getParameters--">getParameters</a></span>()</code>
<div class="block">Returns the parameters property from this instance of Link.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/links/Link.html#getRequestBody--">getRequestBody</a></span>()</code>
<div class="block">Returns the requestBody property from a Link instance.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/eclipse/microprofile/openapi/models/servers/Server.html" title="interface in org.eclipse.microprofile.openapi.models.servers">Server</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/links/Link.html#getServer--">getServer</a></span>()</code>
<div class="block">Returns the server property from a Link instance.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><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/links/Link.html#operationId-java.lang.String-">operationId</a></span>(java.lang.String&nbsp;operationId)</code>
<div class="block">Sets this Link's operationId property to the given string.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><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/links/Link.html#operationRef-java.lang.String-">operationRef</a></span>(java.lang.String&nbsp;operationRef)</code>
<div class="block">Sets this Link's operationRef property to the given string.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><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/links/Link.html#parameters-java.util.Map-">parameters</a></span>(java.util.Map&lt;java.lang.String,java.lang.Object&gt;&nbsp;parameters)</code>
<div class="block">Sets this Link's parameters property to the given map and returns the modified Link instance.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code><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/links/Link.html#requestBody-java.lang.Object-">requestBody</a></span>(java.lang.Object&nbsp;requestBody)</code>
<div class="block">Sets this Link's requestBody property to the given object.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code><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/links/Link.html#server-org.eclipse.microprofile.openapi.models.servers.Server-">server</a></span>(<a href="../../../../../../org/eclipse/microprofile/openapi/models/servers/Server.html" title="interface in org.eclipse.microprofile.openapi.models.servers">Server</a>&nbsp;server)</code>
<div class="block">Sets this Link's server property to the given object.</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/links/Link.html#setDescription-java.lang.String-">setDescription</a></span>(java.lang.String&nbsp;description)</code>
<div class="block">Sets this Link's description property to the given string.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/links/Link.html#setOperationId-java.lang.String-">setOperationId</a></span>(java.lang.String&nbsp;operationId)</code>
<div class="block">Sets this Link's operationId property to the given string.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/links/Link.html#setOperationRef-java.lang.String-">setOperationRef</a></span>(java.lang.String&nbsp;operationRef)</code>
<div class="block">Sets this Link's operationRef property to the given string.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/links/Link.html#setParameters-java.util.Map-">setParameters</a></span>(java.util.Map&lt;java.lang.String,java.lang.Object&gt;&nbsp;parameters)</code>
<div class="block">Sets this Link's parameters property to the given map.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/links/Link.html#setRequestBody-java.lang.Object-">setRequestBody</a></span>(java.lang.Object&nbsp;requestBody)</code>
<div class="block">Sets this Link's requestBody property to the given object.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/links/Link.html#setServer-org.eclipse.microprofile.openapi.models.servers.Server-">setServer</a></span>(<a href="../../../../../../org/eclipse/microprofile/openapi/models/servers/Server.html" title="interface in org.eclipse.microprofile.openapi.models.servers">Server</a>&nbsp;server)</code>
<div class="block">Sets this Link's server property to the given object.</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&nbsp;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&nbsp;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="getServer--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getServer</h4>
<pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/servers/Server.html" title="interface in org.eclipse.microprofile.openapi.models.servers">Server</a>&nbsp;getServer()</pre>
<div class="block">Returns the server property from a Link instance.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a server object to be used by the target operation</dd>
</dl>
</li>
</ul>
<a name="setServer-org.eclipse.microprofile.openapi.models.servers.Server-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setServer</h4>
<pre>void&nbsp;setServer(<a href="../../../../../../org/eclipse/microprofile/openapi/models/servers/Server.html" title="interface in org.eclipse.microprofile.openapi.models.servers">Server</a>&nbsp;server)</pre>
<div class="block">Sets this Link's server property to the given object.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>server</code> - a server object to be used by the target operation</dd>
</dl>
</li>
</ul>
<a name="server-org.eclipse.microprofile.openapi.models.servers.Server-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>server</h4>
<pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/links/Link.html" title="interface in org.eclipse.microprofile.openapi.models.links">Link</a>&nbsp;server(<a href="../../../../../../org/eclipse/microprofile/openapi/models/servers/Server.html" title="interface in org.eclipse.microprofile.openapi.models.servers">Server</a>&nbsp;server)</pre>
<div class="block">Sets this Link's server property to the given object.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>server</code> - a server object to be used by the target operation</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the current Link instance</dd>
</dl>
</li>
</ul>
<a name="getOperationRef--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOperationRef</h4>
<pre>java.lang.String&nbsp;getOperationRef()</pre>
<div class="block">Returns the operationRef property from a Link instance.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a relative or absolute reference to an OAS operation</dd>
</dl>
</li>
</ul>
<a name="setOperationRef-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setOperationRef</h4>
<pre>void&nbsp;setOperationRef(java.lang.String&nbsp;operationRef)</pre>
<div class="block">Sets this Link's operationRef property to the given string. This field is mutually exclusive of the operationId field.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>operationRef</code> - a relative or absolute reference to an OAS operation</dd>
</dl>
</li>
</ul>
<a name="operationRef-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>operationRef</h4>
<pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/links/Link.html" title="interface in org.eclipse.microprofile.openapi.models.links">Link</a>&nbsp;operationRef(java.lang.String&nbsp;operationRef)</pre>
<div class="block">Sets this Link's operationRef property to the given string. This field is mutually exclusive of the operationId field.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>operationRef</code> - a relative or absolute reference to an OAS operation</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the current Link instance</dd>
</dl>
</li>
</ul>
<a name="getRequestBody--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRequestBody</h4>
<pre>java.lang.Object&nbsp;getRequestBody()</pre>
<div class="block">Returns the requestBody property from a Link instance.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a literal value or runtime expression to use as a request body when calling the target operation</dd>
</dl>
</li>
</ul>
<a name="setRequestBody-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setRequestBody</h4>
<pre>void&nbsp;setRequestBody(java.lang.Object&nbsp;requestBody)</pre>
<div class="block">Sets this Link's requestBody property to the given object.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>requestBody</code> - a literal value or runtime expression to use as a request body when calling the target operation</dd>
</dl>
</li>
</ul>
<a name="requestBody-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>requestBody</h4>
<pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/links/Link.html" title="interface in org.eclipse.microprofile.openapi.models.links">Link</a>&nbsp;requestBody(java.lang.Object&nbsp;requestBody)</pre>
<div class="block">Sets this Link's requestBody property to the given object.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>requestBody</code> - a literal value or runtime expression to use as a request body when calling the target operation</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the current Link instance</dd>
</dl>
</li>
</ul>
<a name="getOperationId--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOperationId</h4>
<pre>java.lang.String&nbsp;getOperationId()</pre>
<div class="block">Returns the operationId property for this instance of Link.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the name of an existing, resolvable OAS operation</dd>
</dl>
</li>
</ul>
<a name="setOperationId-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setOperationId</h4>
<pre>void&nbsp;setOperationId(java.lang.String&nbsp;operationId)</pre>
<div class="block">Sets this Link's operationId property to the given string. This field is mutually exclusive of the operationRef field.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>operationId</code> - the name of an existing, resolvable OAS operation</dd>
</dl>
</li>
</ul>
<a name="operationId-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>operationId</h4>
<pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/links/Link.html" title="interface in org.eclipse.microprofile.openapi.models.links">Link</a>&nbsp;operationId(java.lang.String&nbsp;operationId)</pre>
<div class="block">Sets this Link's operationId property to the given string. This field is mutually exclusive of the operationRef field.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>operationId</code> - the name of an existing, resolvable OAS operation</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the current Link instance</dd>
</dl>
</li>
</ul>
<a name="getParameters--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getParameters</h4>
<pre>java.util.Map&lt;java.lang.String,java.lang.Object&gt;&nbsp;getParameters()</pre>
<div class="block">Returns the parameters property from this instance of Link. The key is the parameter name and the value is a constant or a runtime expression
to be passed to the linked operation.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a map representing parameters to pass to this link's operation</dd>
</dl>
</li>
</ul>
<a name="setParameters-java.util.Map-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setParameters</h4>
<pre>void&nbsp;setParameters(java.util.Map&lt;java.lang.String,java.lang.Object&gt;&nbsp;parameters)</pre>
<div class="block">Sets this Link's parameters property to the given map.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>parameters</code> - a map representing parameters to pass to this link's operation as specified with operationId or identified via operationRef</dd>
</dl>
</li>
</ul>
<a name="parameters-java.util.Map-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>parameters</h4>
<pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/links/Link.html" title="interface in org.eclipse.microprofile.openapi.models.links">Link</a>&nbsp;parameters(java.util.Map&lt;java.lang.String,java.lang.Object&gt;&nbsp;parameters)</pre>
<div class="block">Sets this Link's parameters property to the given map and returns the modified Link instance.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>parameters</code> - a map representing parameters to pass to this link's operation as specified with operationId or identified via operationRef</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>current link instance</dd>
</dl>
</li>
</ul>
<a name="addParameter-java.lang.String-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addParameter</h4>
<pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/links/Link.html" title="interface in org.eclipse.microprofile.openapi.models.links">Link</a>&nbsp;addParameter(java.lang.String&nbsp;name,
java.lang.Object&nbsp;parameter)</pre>
<div class="block">Add a new parameter to the parameters property of this instance of Link.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - The name of the parameter. Can be qualified using the parameter location [{in}.]{name} for operations that use the same parameter
name in different locations (e.g. path.id).</dd>
<dd><code>parameter</code> - a constant or an expression to be evaluated at runtime and passed to the linked operation</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the current Link instance</dd>
</dl>
</li>
</ul>
<a name="getDescription--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDescription</h4>
<pre>java.lang.String&nbsp;getDescription()</pre>
<div class="block">Returns the description property from a Link instance.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a description of the link</dd>
</dl>
</li>
</ul>
<a name="setDescription-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDescription</h4>
<pre>void&nbsp;setDescription(java.lang.String&nbsp;description)</pre>
<div class="block">Sets this Link's description property to the given string.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>description</code> - a description of the link</dd>
</dl>
</li>
</ul>
<a name="description-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>description</h4>
<pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/links/Link.html" title="interface in org.eclipse.microprofile.openapi.models.links">Link</a>&nbsp;description(java.lang.String&nbsp;description)</pre>
<div class="block">Sets this Link's description property to the given string.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>description</code> - a description of the link</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the current Link 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&nbsp;Class</li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/eclipse/microprofile/openapi/models/links/Link.html" target="_top">Frames</a></li>
<li><a href="Link.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>