Google Git
Sign in
apache / tomee-site-pub / 476cf231b77b83a25b4407df84b6a5fd7c0d673a / . / microprofile-2.0 / javadoc / org / eclipse / microprofile / openapi / models / parameters / Parameter.html
blob: 8aac98ef66bee03d322abf28ea8c2a8c294cdbcc [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>Parameter</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="Parameter";
}
}
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,"i19":6,"i20":6,"i21":6,"i22":6,"i23":6,"i24":6,"i25":6,"i26":6,"i27":6,"i28":6,"i29":6,"i30":6,"i31":6,"i32":6,"i33":6,"i34":6,"i35":6,"i36":6,"i37":6,"i38":6,"i39":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><a href="../../../../../../org/eclipse/microprofile/openapi/models/parameters/Parameter.In.html" title="enum in org.eclipse.microprofile.openapi.models.parameters"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/eclipse/microprofile/openapi/models/parameters/Parameter.html" target="_top">Frames</a></li>
<li><a href="Parameter.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><a href="#nested.class.summary">Nested</a>&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.parameters</div>
<h2 title="Interface Parameter" class="title">Interface Parameter</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/parameters/Parameter.html" title="interface in org.eclipse.microprofile.openapi.models.parameters">Parameter</a>&gt;</dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">Parameter</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/parameters/Parameter.html" title="interface in org.eclipse.microprofile.openapi.models.parameters">Parameter</a>&gt;</pre>
<div class="block">Parameter
<p>
Describes a single operation parameter.
<p>
A unique parameter is defined by a combination of a name and location. There are four possible parameter locations
specified by the <code>in</code> field:
<ul>
<li>path - Used together with Path Templating, where the parameter value is actually part of the operation's URL. This does not include the host or
base path of the API. For example, in /items/{itemId}, the path parameter is itemId.</li>
<li>query - Parameters that are appended to the URL. For example, in /items?id=###, the query parameter is id.</li>
<li>header - Custom headers that are expected as part of the request. Note that RFC7230 states header names are case insensitive.</li>
<li>cookie - Used to pass a specific cookie value to the API.</li>
</ul>
<p>
The rules for serialization of the parameter are specified in one of two ways. For simpler scenarios, a schema and style can describe the structure
and syntax of the parameter.
<p>
For more complex scenarios, the content property can define the media type and schema of the parameter. A parameter must contain either a schema
property, or a content property, but not both.</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#parameterObject">OpenAPI Specification Parameter
Object</a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Interface and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/parameters/Parameter.In.html" title="enum in org.eclipse.microprofile.openapi.models.parameters">Parameter.In</a></span></code>
<div class="block">The values allowed for the in field.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/parameters/Parameter.Style.html" title="enum in org.eclipse.microprofile.openapi.models.parameters">Parameter.Style</a></span></code>
<div class="block">The values allowed for the style field.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== 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/parameters/Parameter.html" title="interface in org.eclipse.microprofile.openapi.models.parameters">Parameter</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/parameters/Parameter.html#addExample-java.lang.String-org.eclipse.microprofile.openapi.models.examples.Example-">addExample</a></span>(java.lang.String&nbsp;key,
<a href="../../../../../../org/eclipse/microprofile/openapi/models/examples/Example.html" title="interface in org.eclipse.microprofile.openapi.models.examples">Example</a>&nbsp;example)</code>
<div class="block">Adds an example of the media type using the specified key.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/eclipse/microprofile/openapi/models/parameters/Parameter.html" title="interface in org.eclipse.microprofile.openapi.models.parameters">Parameter</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/parameters/Parameter.html#allowEmptyValue-java.lang.Boolean-">allowEmptyValue</a></span>(java.lang.Boolean&nbsp;allowEmptyValue)</code>
<div class="block">Sets the allowEmptyValue property of a Parameter instance to the given value.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/eclipse/microprofile/openapi/models/parameters/Parameter.html" title="interface in org.eclipse.microprofile.openapi.models.parameters">Parameter</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/parameters/Parameter.html#allowReserved-java.lang.Boolean-">allowReserved</a></span>(java.lang.Boolean&nbsp;allowReserved)</code>
<div class="block">Sets the allowReserved property of a Parameter instance to the given value.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/eclipse/microprofile/openapi/models/parameters/Parameter.html" title="interface in org.eclipse.microprofile.openapi.models.parameters">Parameter</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/parameters/Parameter.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>&nbsp;content)</code>
<div class="block">Sets the content property of a Parameter instance to the given object.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/eclipse/microprofile/openapi/models/parameters/Parameter.html" title="interface in org.eclipse.microprofile.openapi.models.parameters">Parameter</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/parameters/Parameter.html#deprecated-java.lang.Boolean-">deprecated</a></span>(java.lang.Boolean&nbsp;deprecated)</code>
<div class="block">Sets the deprecated property of a Parameter instance to the given value.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/eclipse/microprofile/openapi/models/parameters/Parameter.html" title="interface in org.eclipse.microprofile.openapi.models.parameters">Parameter</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/parameters/Parameter.html#description-java.lang.String-">description</a></span>(java.lang.String&nbsp;description)</code>
<div class="block">Sets the description property of a Parameter instance to the given string.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/eclipse/microprofile/openapi/models/parameters/Parameter.html" title="interface in org.eclipse.microprofile.openapi.models.parameters">Parameter</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/parameters/Parameter.html#example-java.lang.Object-">example</a></span>(java.lang.Object&nbsp;example)</code>
<div class="block">Sets the example property of a Parameter instance to the given object.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/eclipse/microprofile/openapi/models/parameters/Parameter.html" title="interface in org.eclipse.microprofile.openapi.models.parameters">Parameter</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/parameters/Parameter.html#examples-java.util.Map-">examples</a></span>(java.util.Map&lt;java.lang.String,<a href="../../../../../../org/eclipse/microprofile/openapi/models/examples/Example.html" title="interface in org.eclipse.microprofile.openapi.models.examples">Example</a>&gt;&nbsp;examples)</code>
<div class="block">Sets the examples property of a Parameter instance to the given value.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/eclipse/microprofile/openapi/models/parameters/Parameter.html" title="interface in org.eclipse.microprofile.openapi.models.parameters">Parameter</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/parameters/Parameter.html#explode-java.lang.Boolean-">explode</a></span>(java.lang.Boolean&nbsp;explode)</code>
<div class="block">Sets the explode property of a Parameter instance to the given value.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>java.lang.Boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/parameters/Parameter.html#getAllowEmptyValue--">getAllowEmptyValue</a></span>()</code>
<div class="block">Returns the allowEmptyValue property from a Parameter instance.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>java.lang.Boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/parameters/Parameter.html#getAllowReserved--">getAllowReserved</a></span>()</code>
<div class="block">Returns the allowReserved property from a Parameter instance.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<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/parameters/Parameter.html#getContent--">getContent</a></span>()</code>
<div class="block">Returns the content property from a Parameter instance.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>java.lang.Boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/parameters/Parameter.html#getDeprecated--">getDeprecated</a></span>()</code>
<div class="block">Returns the deprecated property from a Parameter instance.</div>
</td>
</tr>
<tr id="i13" 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/parameters/Parameter.html#getDescription--">getDescription</a></span>()</code>
<div class="block">Returns the description property from a Parameter instance.</div>
</td>
</tr>
<tr id="i14" 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/parameters/Parameter.html#getExample--">getExample</a></span>()</code>
<div class="block">Returns the example property from a Parameter instance.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>java.util.Map&lt;java.lang.String,<a href="../../../../../../org/eclipse/microprofile/openapi/models/examples/Example.html" title="interface in org.eclipse.microprofile.openapi.models.examples">Example</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/parameters/Parameter.html#getExamples--">getExamples</a></span>()</code>
<div class="block">Returns the examples property from a Parameter instance.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>java.lang.Boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/parameters/Parameter.html#getExplode--">getExplode</a></span>()</code>
<div class="block">Returns the explode property from a Parameter instance.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/eclipse/microprofile/openapi/models/parameters/Parameter.In.html" title="enum in org.eclipse.microprofile.openapi.models.parameters">Parameter.In</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/parameters/Parameter.html#getIn--">getIn</a></span>()</code>
<div class="block">Returns the in property from a Parameter instance.</div>
</td>
</tr>
<tr id="i18" 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/parameters/Parameter.html#getName--">getName</a></span>()</code>
<div class="block">Returns the name property from a Parameter instance.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>java.lang.Boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/parameters/Parameter.html#getRequired--">getRequired</a></span>()</code>
<div class="block">Returns the required property from a Parameter instance.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/parameters/Parameter.html#getSchema--">getSchema</a></span>()</code>
<div class="block">Returns the schema property from a Parameter instance.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/eclipse/microprofile/openapi/models/parameters/Parameter.Style.html" title="enum in org.eclipse.microprofile.openapi.models.parameters">Parameter.Style</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/parameters/Parameter.html#getStyle--">getStyle</a></span>()</code>
<div class="block">Returns the style property from a Parameter instance.</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/eclipse/microprofile/openapi/models/parameters/Parameter.html" title="interface in org.eclipse.microprofile.openapi.models.parameters">Parameter</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/parameters/Parameter.html#in-org.eclipse.microprofile.openapi.models.parameters.Parameter.In-">in</a></span>(<a href="../../../../../../org/eclipse/microprofile/openapi/models/parameters/Parameter.In.html" title="enum in org.eclipse.microprofile.openapi.models.parameters">Parameter.In</a>&nbsp;in)</code>
<div class="block">Sets the in property of a Parameter instance to the given value.</div>
</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/eclipse/microprofile/openapi/models/parameters/Parameter.html" title="interface in org.eclipse.microprofile.openapi.models.parameters">Parameter</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/parameters/Parameter.html#name-java.lang.String-">name</a></span>(java.lang.String&nbsp;name)</code>
<div class="block">Sets the name property of a Parameter instance to the given string.</div>
</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/eclipse/microprofile/openapi/models/parameters/Parameter.html" title="interface in org.eclipse.microprofile.openapi.models.parameters">Parameter</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/parameters/Parameter.html#required-java.lang.Boolean-">required</a></span>(java.lang.Boolean&nbsp;required)</code>
<div class="block">Sets the required property of a Parameter instance to the given value.</div>
</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/eclipse/microprofile/openapi/models/parameters/Parameter.html" title="interface in org.eclipse.microprofile.openapi.models.parameters">Parameter</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/parameters/Parameter.html#schema-org.eclipse.microprofile.openapi.models.media.Schema-">schema</a></span>(<a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a>&nbsp;schema)</code>
<div class="block">Sets the schema property of a Parameter instance to the given value.</div>
</td>
</tr>
<tr id="i26" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/parameters/Parameter.html#setAllowEmptyValue-java.lang.Boolean-">setAllowEmptyValue</a></span>(java.lang.Boolean&nbsp;allowEmptyValue)</code>
<div class="block">Sets the allowEmptyValue property of a Parameter instance to the given value.</div>
</td>
</tr>
<tr id="i27" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/parameters/Parameter.html#setAllowReserved-java.lang.Boolean-">setAllowReserved</a></span>(java.lang.Boolean&nbsp;allowReserved)</code>
<div class="block">Sets the allowReserved property of a Parameter instance to the given value.</div>
</td>
</tr>
<tr id="i28" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/parameters/Parameter.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>&nbsp;content)</code>
<div class="block">Sets the content property of a Parameter instance to the given object.</div>
</td>
</tr>
<tr id="i29" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/parameters/Parameter.html#setDeprecated-java.lang.Boolean-">setDeprecated</a></span>(java.lang.Boolean&nbsp;deprecated)</code>
<div class="block">Sets the deprecated property of a Parameter instance to the given value.</div>
</td>
</tr>
<tr id="i30" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/parameters/Parameter.html#setDescription-java.lang.String-">setDescription</a></span>(java.lang.String&nbsp;description)</code>
<div class="block">Sets the description property of a Parameter instance to the given string.</div>
</td>
</tr>
<tr id="i31" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/parameters/Parameter.html#setExample-java.lang.Object-">setExample</a></span>(java.lang.Object&nbsp;example)</code>
<div class="block">Sets the example property of a Parameter instance to the given object.</div>
</td>
</tr>
<tr id="i32" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/parameters/Parameter.html#setExamples-java.util.Map-">setExamples</a></span>(java.util.Map&lt;java.lang.String,<a href="../../../../../../org/eclipse/microprofile/openapi/models/examples/Example.html" title="interface in org.eclipse.microprofile.openapi.models.examples">Example</a>&gt;&nbsp;examples)</code>
<div class="block">Sets the examples property of a Parameter instance to the given value.</div>
</td>
</tr>
<tr id="i33" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/parameters/Parameter.html#setExplode-java.lang.Boolean-">setExplode</a></span>(java.lang.Boolean&nbsp;explode)</code>
<div class="block">Sets the explode property of a Parameter instance to the given value.</div>
</td>
</tr>
<tr id="i34" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/parameters/Parameter.html#setIn-org.eclipse.microprofile.openapi.models.parameters.Parameter.In-">setIn</a></span>(<a href="../../../../../../org/eclipse/microprofile/openapi/models/parameters/Parameter.In.html" title="enum in org.eclipse.microprofile.openapi.models.parameters">Parameter.In</a>&nbsp;in)</code>
<div class="block">Sets the in property of a Parameter instance to the given value.</div>
</td>
</tr>
<tr id="i35" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/parameters/Parameter.html#setName-java.lang.String-">setName</a></span>(java.lang.String&nbsp;name)</code>
<div class="block">Sets the name property of a Parameter instance to the given string.</div>
</td>
</tr>
<tr id="i36" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/parameters/Parameter.html#setRequired-java.lang.Boolean-">setRequired</a></span>(java.lang.Boolean&nbsp;required)</code>
<div class="block">Sets the required property of a Parameter instance to the given value.</div>
</td>
</tr>
<tr id="i37" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/parameters/Parameter.html#setSchema-org.eclipse.microprofile.openapi.models.media.Schema-">setSchema</a></span>(<a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a>&nbsp;schema)</code>
<div class="block">Sets the schema property of a Parameter instance to the given value.</div>
</td>
</tr>
<tr id="i38" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/parameters/Parameter.html#setStyle-org.eclipse.microprofile.openapi.models.parameters.Parameter.Style-">setStyle</a></span>(<a href="../../../../../../org/eclipse/microprofile/openapi/models/parameters/Parameter.Style.html" title="enum in org.eclipse.microprofile.openapi.models.parameters">Parameter.Style</a>&nbsp;style)</code>
<div class="block">Sets the style property of a Parameter instance to the given value.</div>
</td>
</tr>
<tr id="i39" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/eclipse/microprofile/openapi/models/parameters/Parameter.html" title="interface in org.eclipse.microprofile.openapi.models.parameters">Parameter</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/parameters/Parameter.html#style-org.eclipse.microprofile.openapi.models.parameters.Parameter.Style-">style</a></span>(<a href="../../../../../../org/eclipse/microprofile/openapi/models/parameters/Parameter.Style.html" title="enum in org.eclipse.microprofile.openapi.models.parameters">Parameter.Style</a>&nbsp;style)</code>
<div class="block">Sets the style property of a Parameter instance to the given value.</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="getName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getName</h4>
<pre>java.lang.String&nbsp;getName()</pre>
<div class="block">Returns the name property from a Parameter instance.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the name of the parameter</dd>
</dl>
</li>
</ul>
<a name="setName-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setName</h4>
<pre>void&nbsp;setName(java.lang.String&nbsp;name)</pre>
<div class="block">Sets the name property of a Parameter instance to the given string.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - the name of the parameter</dd>
</dl>
</li>
</ul>
<a name="name-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>name</h4>
<pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/parameters/Parameter.html" title="interface in org.eclipse.microprofile.openapi.models.parameters">Parameter</a>&nbsp;name(java.lang.String&nbsp;name)</pre>
<div class="block">Sets the name property of a Parameter instance to the given string.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - the name of the parameter</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the current Parameter instance</dd>
</dl>
</li>
</ul>
<a name="getIn--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getIn</h4>
<pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/parameters/Parameter.In.html" title="enum in org.eclipse.microprofile.openapi.models.parameters">Parameter.In</a>&nbsp;getIn()</pre>
<div class="block">Returns the in property from a Parameter instance.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the location of the parameter</dd>
</dl>
</li>
</ul>
<a name="setIn-org.eclipse.microprofile.openapi.models.parameters.Parameter.In-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setIn</h4>
<pre>void&nbsp;setIn(<a href="../../../../../../org/eclipse/microprofile/openapi/models/parameters/Parameter.In.html" title="enum in org.eclipse.microprofile.openapi.models.parameters">Parameter.In</a>&nbsp;in)</pre>
<div class="block">Sets the in property of a Parameter instance to the given value.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>in</code> - the value of the in property</dd>
</dl>
</li>
</ul>
<a name="in-org.eclipse.microprofile.openapi.models.parameters.Parameter.In-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>in</h4>
<pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/parameters/Parameter.html" title="interface in org.eclipse.microprofile.openapi.models.parameters">Parameter</a>&nbsp;in(<a href="../../../../../../org/eclipse/microprofile/openapi/models/parameters/Parameter.In.html" title="enum in org.eclipse.microprofile.openapi.models.parameters">Parameter.In</a>&nbsp;in)</pre>
<div class="block">Sets the in property of a Parameter instance to the given value.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>in</code> - the value of the in property</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the current Parameter 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 Parameter instance.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a brief description of the parameter</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 the description property of a Parameter instance to the given string.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>description</code> - a brief description of the parameter</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/parameters/Parameter.html" title="interface in org.eclipse.microprofile.openapi.models.parameters">Parameter</a>&nbsp;description(java.lang.String&nbsp;description)</pre>
<div class="block">Sets the description property of a Parameter instance to the given string.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>description</code> - a brief description of the parameter</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the current Parameter instance</dd>
</dl>
</li>
</ul>
<a name="getRequired--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRequired</h4>
<pre>java.lang.Boolean&nbsp;getRequired()</pre>
<div class="block">Returns the required property from a Parameter instance.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>indicates whether this parameter is mandatory</dd>
</dl>
</li>
</ul>
<a name="setRequired-java.lang.Boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setRequired</h4>
<pre>void&nbsp;setRequired(java.lang.Boolean&nbsp;required)</pre>
<div class="block">Sets the required property of a Parameter instance to the given value.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>required</code> - indicates whether this parameter is mandatory</dd>
</dl>
</li>
</ul>
<a name="required-java.lang.Boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>required</h4>
<pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/parameters/Parameter.html" title="interface in org.eclipse.microprofile.openapi.models.parameters">Parameter</a>&nbsp;required(java.lang.Boolean&nbsp;required)</pre>
<div class="block">Sets the required property of a Parameter instance to the given value.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>required</code> - indicates whether this parameter is mandatory</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the current Parameter instance</dd>
</dl>
</li>
</ul>
<a name="getDeprecated--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDeprecated</h4>
<pre>java.lang.Boolean&nbsp;getDeprecated()</pre>
<div class="block">Returns the deprecated property from a Parameter instance.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>specifies that a parameter is deprecated</dd>
</dl>
</li>
</ul>
<a name="setDeprecated-java.lang.Boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDeprecated</h4>
<pre>void&nbsp;setDeprecated(java.lang.Boolean&nbsp;deprecated)</pre>
<div class="block">Sets the deprecated property of a Parameter instance to the given value.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>deprecated</code> - specifies that a parameter is deprecated</dd>
</dl>
</li>
</ul>
<a name="deprecated-java.lang.Boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>deprecated</h4>
<pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/parameters/Parameter.html" title="interface in org.eclipse.microprofile.openapi.models.parameters">Parameter</a>&nbsp;deprecated(java.lang.Boolean&nbsp;deprecated)</pre>
<div class="block">Sets the deprecated property of a Parameter instance to the given value.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>deprecated</code> - specifies that a parameter is deprecated</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the current Parameter instance</dd>
</dl>
</li>
</ul>
<a name="getAllowEmptyValue--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAllowEmptyValue</h4>
<pre>java.lang.Boolean&nbsp;getAllowEmptyValue()</pre>
<div class="block">Returns the allowEmptyValue property from a Parameter instance.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>specifies the ability to pass empty-valued parameters</dd>
</dl>
</li>
</ul>
<a name="setAllowEmptyValue-java.lang.Boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setAllowEmptyValue</h4>
<pre>void&nbsp;setAllowEmptyValue(java.lang.Boolean&nbsp;allowEmptyValue)</pre>
<div class="block">Sets the allowEmptyValue property of a Parameter instance to the given value.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>allowEmptyValue</code> - specify the ability to pass empty-valued parameters</dd>
</dl>
</li>
</ul>
<a name="allowEmptyValue-java.lang.Boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>allowEmptyValue</h4>
<pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/parameters/Parameter.html" title="interface in org.eclipse.microprofile.openapi.models.parameters">Parameter</a>&nbsp;allowEmptyValue(java.lang.Boolean&nbsp;allowEmptyValue)</pre>
<div class="block">Sets the allowEmptyValue property of a Parameter instance to the given value.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>allowEmptyValue</code> - specify the ability to pass empty-valued parameters</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the current Parameter instance</dd>
</dl>
</li>
</ul>
<a name="getStyle--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStyle</h4>
<pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/parameters/Parameter.Style.html" title="enum in org.eclipse.microprofile.openapi.models.parameters">Parameter.Style</a>&nbsp;getStyle()</pre>
<div class="block">Returns the style property from a Parameter instance.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>describes how the parameter value will be serialized</dd>
</dl>
</li>
</ul>
<a name="setStyle-org.eclipse.microprofile.openapi.models.parameters.Parameter.Style-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setStyle</h4>
<pre>void&nbsp;setStyle(<a href="../../../../../../org/eclipse/microprofile/openapi/models/parameters/Parameter.Style.html" title="enum in org.eclipse.microprofile.openapi.models.parameters">Parameter.Style</a>&nbsp;style)</pre>
<div class="block">Sets the style property of a Parameter instance to the given value.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>style</code> - describes how the parameter value will be serialized</dd>
</dl>
</li>
</ul>
<a name="style-org.eclipse.microprofile.openapi.models.parameters.Parameter.Style-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>style</h4>
<pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/parameters/Parameter.html" title="interface in org.eclipse.microprofile.openapi.models.parameters">Parameter</a>&nbsp;style(<a href="../../../../../../org/eclipse/microprofile/openapi/models/parameters/Parameter.Style.html" title="enum in org.eclipse.microprofile.openapi.models.parameters">Parameter.Style</a>&nbsp;style)</pre>
<div class="block">Sets the style property of a Parameter instance to the given value.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>style</code> - describes how the parameter value will be serialized</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the current Parameter instance</dd>
</dl>
</li>
</ul>
<a name="getExplode--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExplode</h4>
<pre>java.lang.Boolean&nbsp;getExplode()</pre>
<div class="block">Returns the explode property from a Parameter instance.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether parameter values of type "array" or "object" generate separate parameters for each value</dd>
</dl>
</li>
</ul>
<a name="setExplode-java.lang.Boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setExplode</h4>
<pre>void&nbsp;setExplode(java.lang.Boolean&nbsp;explode)</pre>
<div class="block">Sets the explode property of a Parameter instance to the given value.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>explode</code> - whether parameter values of type "array" or "object" generate separate parameters for each value</dd>
</dl>
</li>
</ul>
<a name="explode-java.lang.Boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>explode</h4>
<pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/parameters/Parameter.html" title="interface in org.eclipse.microprofile.openapi.models.parameters">Parameter</a>&nbsp;explode(java.lang.Boolean&nbsp;explode)</pre>
<div class="block">Sets the explode property of a Parameter instance to the given value.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>explode</code> - whether parameter values of type "array" or "object" generate separate parameters for each value</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the current Parameter instance</dd>
</dl>
</li>
</ul>
<a name="getAllowReserved--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAllowReserved</h4>
<pre>java.lang.Boolean&nbsp;getAllowReserved()</pre>
<div class="block">Returns the allowReserved property from a Parameter instance.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>specifies whether the parameter value should allow reserved characters</dd>
</dl>
</li>
</ul>
<a name="setAllowReserved-java.lang.Boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setAllowReserved</h4>
<pre>void&nbsp;setAllowReserved(java.lang.Boolean&nbsp;allowReserved)</pre>
<div class="block">Sets the allowReserved property of a Parameter instance to the given value.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>allowReserved</code> - specifies whether the parameter value should allow reserved characters</dd>
</dl>
</li>
</ul>
<a name="allowReserved-java.lang.Boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>allowReserved</h4>
<pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/parameters/Parameter.html" title="interface in org.eclipse.microprofile.openapi.models.parameters">Parameter</a>&nbsp;allowReserved(java.lang.Boolean&nbsp;allowReserved)</pre>
<div class="block">Sets the allowReserved property of a Parameter instance to the given value.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>allowReserved</code> - specifies whether the parameter value should allow reserved characters</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the current Parameter instance</dd>
</dl>
</li>
</ul>
<a name="getSchema--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSchema</h4>
<pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a>&nbsp;getSchema()</pre>
<div class="block">Returns the schema property from a Parameter instance.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>schema defining the type used for the parameter</dd>
</dl>
</li>
</ul>
<a name="setSchema-org.eclipse.microprofile.openapi.models.media.Schema-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSchema</h4>
<pre>void&nbsp;setSchema(<a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a>&nbsp;schema)</pre>
<div class="block">Sets the schema property of a Parameter instance to the given value.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>schema</code> - schema defining the type used for the parameter</dd>
</dl>
</li>
</ul>
<a name="schema-org.eclipse.microprofile.openapi.models.media.Schema-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>schema</h4>
<pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/parameters/Parameter.html" title="interface in org.eclipse.microprofile.openapi.models.parameters">Parameter</a>&nbsp;schema(<a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a>&nbsp;schema)</pre>
<div class="block">Sets the schema property of a Parameter instance to the given value.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>schema</code> - schema defining the type used for the parameter</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the current Parameter instance</dd>
</dl>
</li>
</ul>
<a name="getExamples--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExamples</h4>
<pre>java.util.Map&lt;java.lang.String,<a href="../../../../../../org/eclipse/microprofile/openapi/models/examples/Example.html" title="interface in org.eclipse.microprofile.openapi.models.examples">Example</a>&gt;&nbsp;getExamples()</pre>
<div class="block">Returns the examples property from a Parameter instance.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>examples of the media type</dd>
</dl>
</li>
</ul>
<a name="setExamples-java.util.Map-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setExamples</h4>
<pre>void&nbsp;setExamples(java.util.Map&lt;java.lang.String,<a href="../../../../../../org/eclipse/microprofile/openapi/models/examples/Example.html" title="interface in org.eclipse.microprofile.openapi.models.examples">Example</a>&gt;&nbsp;examples)</pre>
<div class="block">Sets the examples property of a Parameter instance to the given value. Each example should contain a value in the correct format as specified
in the parameter encoding. The examples object is mutually exclusive of the example object.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>examples</code> - examples of the media type</dd>
</dl>
</li>
</ul>
<a name="examples-java.util.Map-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>examples</h4>
<pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/parameters/Parameter.html" title="interface in org.eclipse.microprofile.openapi.models.parameters">Parameter</a>&nbsp;examples(java.util.Map&lt;java.lang.String,<a href="../../../../../../org/eclipse/microprofile/openapi/models/examples/Example.html" title="interface in org.eclipse.microprofile.openapi.models.examples">Example</a>&gt;&nbsp;examples)</pre>
<div class="block">Sets the examples property of a Parameter instance to the given value. Each example should contain a value in the correct format as specified
in the parameter encoding. The examples object is mutually exclusive of the example object.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>examples</code> - examples of the media type</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the current Parameter instance</dd>
</dl>
</li>
</ul>
<a name="addExample-java.lang.String-org.eclipse.microprofile.openapi.models.examples.Example-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addExample</h4>
<pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/parameters/Parameter.html" title="interface in org.eclipse.microprofile.openapi.models.parameters">Parameter</a>&nbsp;addExample(java.lang.String&nbsp;key,
<a href="../../../../../../org/eclipse/microprofile/openapi/models/examples/Example.html" title="interface in org.eclipse.microprofile.openapi.models.examples">Example</a>&nbsp;example)</pre>
<div class="block">Adds an example of the media type using the specified key. The example should contain a value in the correct format as specified in the
parameter encoding.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - string to represent the example</dd>
<dd><code>example</code> - example of the media type</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the current Parameter instance</dd>
</dl>
</li>
</ul>
<a name="getExample--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExample</h4>
<pre>java.lang.Object&nbsp;getExample()</pre>
<div class="block">Returns the example property from a Parameter instance.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>example of the media type</dd>
</dl>
</li>
</ul>
<a name="setExample-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setExample</h4>
<pre>void&nbsp;setExample(java.lang.Object&nbsp;example)</pre>
<div class="block">Sets the example property of a Parameter instance to the given object. The example should match the specified schema and encoding properties if
present. The examples object is mutually exclusive of the example object.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>example</code> - example of the media type</dd>
</dl>
</li>
</ul>
<a name="example-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>example</h4>
<pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/parameters/Parameter.html" title="interface in org.eclipse.microprofile.openapi.models.parameters">Parameter</a>&nbsp;example(java.lang.Object&nbsp;example)</pre>
<div class="block">Sets the example property of a Parameter instance to the given object. The example should match the specified schema and encoding properties if
present. The examples object is mutually exclusive of the example object.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>example</code> - example of the media type</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the current Parameter 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>&nbsp;getContent()</pre>
<div class="block">Returns the content property from a Parameter instance.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a map containing the media representations for the parameter</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&nbsp;setContent(<a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Content.html" title="interface in org.eclipse.microprofile.openapi.models.media">Content</a>&nbsp;content)</pre>
<div class="block">Sets the content property of a Parameter instance to the given object.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>content</code> - a map containing the media representations for the parameter</dd>
</dl>
</li>
</ul>
<a name="content-org.eclipse.microprofile.openapi.models.media.Content-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>content</h4>
<pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/parameters/Parameter.html" title="interface in org.eclipse.microprofile.openapi.models.parameters">Parameter</a>&nbsp;content(<a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Content.html" title="interface in org.eclipse.microprofile.openapi.models.media">Content</a>&nbsp;content)</pre>
<div class="block">Sets the content property of a Parameter instance to the given object.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>content</code> - a map containing the media representations for the parameter</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the current Parameter 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><a href="../../../../../../org/eclipse/microprofile/openapi/models/parameters/Parameter.In.html" title="enum in org.eclipse.microprofile.openapi.models.parameters"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/eclipse/microprofile/openapi/models/parameters/Parameter.html" target="_top">Frames</a></li>
<li><a href="Parameter.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><a href="#nested.class.summary">Nested</a>&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>