| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>Schema</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="Schema"; |
| } |
| } |
| 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,"i40":6,"i41":6,"i42":6,"i43":6,"i44":6,"i45":6,"i46":6,"i47":6,"i48":6,"i49":6,"i50":6,"i51":6,"i52":6,"i53":6,"i54":6,"i55":6,"i56":6,"i57":6,"i58":6,"i59":6,"i60":6,"i61":6,"i62":6,"i63":6,"i64":6,"i65":6,"i66":6,"i67":6,"i68":6,"i69":6,"i70":6,"i71":6,"i72":6,"i73":6,"i74":6,"i75":6,"i76":6,"i77":6,"i78":6,"i79":6,"i80":6,"i81":6,"i82":6,"i83":6,"i84":6,"i85":6,"i86":6,"i87":6,"i88":6,"i89":6,"i90":6,"i91":6,"i92":6,"i93":6,"i94":6,"i95":6,"i96":6,"i97":6,"i98":6,"i99":6,"i100":6,"i101":6,"i102":6,"i103":6,"i104":6,"i105":6,"i106":6,"i107":6,"i108":6,"i109":6,"i110":6,"i111":6,"i112":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><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/MediaType.html" title="interface in org.eclipse.microprofile.openapi.models.media"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.SchemaType.html" title="enum in org.eclipse.microprofile.openapi.models.media"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/eclipse/microprofile/openapi/models/media/Schema.html" target="_top">Frames</a></li> |
| <li><a href="Schema.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><a href="#nested.class.summary">Nested</a> | </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.media</div> |
| <h2 title="Interface Schema" class="title">Interface Schema</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/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a>></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">Schema</span> |
| extends <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/Constructible.html" title="interface in org.eclipse.microprofile.openapi.models">Constructible</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/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a>></pre> |
| <div class="block">The Schema Object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. This object is |
| an extended subset of the <a href="https://tools.ietf.org/html/draft-wright-json-schema-00">JSON Schema Specification Wright Draft 00</a>. |
| <p> |
| For more information about the properties, see <a href="http://json-schema.org/">JSON Schema Core</a> and |
| <a href= "https://tools.ietf.org/html/draft-wright-json-schema-validation-00">JSON Schema Validation</a>. Unless stated otherwise, the property |
| definitions follow the JSON Schema. |
| <p> |
| Any time a Schema Object can be used, a Reference Object can be used in its place. This allows referencing an existing definition instead of |
| defining the same Schema again.</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#schemaObject">OpenAPI Specification Schema 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"> </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 </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.SchemaType.html" title="enum in org.eclipse.microprofile.openapi.models.media">Schema.SchemaType</a></span></code> |
| <div class="block">The values allowed for the in 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"> </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/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/media/Schema.html#addAllOf-org.eclipse.microprofile.openapi.models.media.Schema-">addAllOf</a></span>(<a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a> allOf)</code> |
| <div class="block">Adds the given Schema to the list of schemas used by the allOf property.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <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/media/Schema.html#addAnyOf-org.eclipse.microprofile.openapi.models.media.Schema-">addAnyOf</a></span>(<a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a> anyOf)</code> |
| <div class="block">Adds the given Schema to the list of schemas used by the anyOf property.</div> |
| </td> |
| </tr> |
| <tr id="i2" 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/media/Schema.html#addEnumeration-java.lang.Object-">addEnumeration</a></span>(java.lang.Object enumeration)</code> |
| <div class="block">Adds an item of the appropriate type to the enumerated list of values allowed.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <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/media/Schema.html#additionalProperties-java.lang.Boolean-">additionalProperties</a></span>(java.lang.Boolean additionalProperties)</code> |
| <div class="block">Sets the value of "additionalProperties" to either True or False.</div> |
| </td> |
| </tr> |
| <tr id="i4" 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/media/Schema.html#additionalProperties-org.eclipse.microprofile.openapi.models.media.Schema-">additionalProperties</a></span>(<a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a> additionalProperties)</code> |
| <div class="block">Sets the Schema which defines additional properties not defined by "properties" or "patternProperties".</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <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/media/Schema.html#addOneOf-org.eclipse.microprofile.openapi.models.media.Schema-">addOneOf</a></span>(<a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a> oneOf)</code> |
| <div class="block">Adds the given Schema to the list of schemas used by the oneOf property.</div> |
| </td> |
| </tr> |
| <tr id="i6" 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/media/Schema.html#addProperty-java.lang.String-org.eclipse.microprofile.openapi.models.media.Schema-">addProperty</a></span>(java.lang.String key, |
| <a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a> propertySchema)</code> |
| <div class="block">Adds a Schema property of the provided name using the given schema.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <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/media/Schema.html#addRequired-java.lang.String-">addRequired</a></span>(java.lang.String required)</code> |
| <div class="block">Adds the name of an item to the list of fields required in objects defined by this Schema.</div> |
| </td> |
| </tr> |
| <tr id="i8" 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/media/Schema.html#allOf-java.util.List-">allOf</a></span>(java.util.List<<a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a>> allOf)</code> |
| <div class="block">Sets the schemas used by the allOf property of this Schema.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <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/media/Schema.html#anyOf-java.util.List-">anyOf</a></span>(java.util.List<<a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a>> anyOf)</code> |
| <div class="block">Sets the schemas used by the anyOf property of this Schema.</div> |
| </td> |
| </tr> |
| <tr id="i10" 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/media/Schema.html#defaultValue-java.lang.Object-">defaultValue</a></span>(java.lang.Object defaultValue)</code> |
| <div class="block">Set the default value property of this Schema instance to the value given.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <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/media/Schema.html#deprecated-java.lang.Boolean-">deprecated</a></span>(java.lang.Boolean deprecated)</code> |
| <div class="block">Sets the deprecated property of this Schema.</div> |
| </td> |
| </tr> |
| <tr id="i12" 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/media/Schema.html#description-java.lang.String-">description</a></span>(java.lang.String description)</code> |
| <div class="block">Sets the description property of this Schema to the given string.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <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/media/Schema.html#discriminator-org.eclipse.microprofile.openapi.models.media.Discriminator-">discriminator</a></span>(<a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Discriminator.html" title="interface in org.eclipse.microprofile.openapi.models.media">Discriminator</a> discriminator)</code> |
| <div class="block">Sets the discriminator property of this Schema instance to the given object.</div> |
| </td> |
| </tr> |
| <tr id="i14" 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/media/Schema.html#enumeration-java.util.List-">enumeration</a></span>(java.util.List<java.lang.Object> enumeration)</code> </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <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/media/Schema.html#example-java.lang.Object-">example</a></span>(java.lang.Object example)</code> |
| <div class="block">Sets the example property of this Schema instance.</div> |
| </td> |
| </tr> |
| <tr id="i16" 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/media/Schema.html#exclusiveMaximum-java.lang.Boolean-">exclusiveMaximum</a></span>(java.lang.Boolean exclusiveMaximum)</code> |
| <div class="block">Sets the exclusiveMaximum property of this Schema instance to the value given.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <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/media/Schema.html#exclusiveMinimum-java.lang.Boolean-">exclusiveMinimum</a></span>(java.lang.Boolean exclusiveMinimum)</code> |
| <div class="block">Sets the exclusiveMinimum property of this Schema instance to the value given.</div> |
| </td> |
| </tr> |
| <tr id="i18" 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/media/Schema.html#externalDocs-org.eclipse.microprofile.openapi.models.ExternalDocumentation-">externalDocs</a></span>(<a href="../../../../../../org/eclipse/microprofile/openapi/models/ExternalDocumentation.html" title="interface in org.eclipse.microprofile.openapi.models">ExternalDocumentation</a> externalDocs)</code> |
| <div class="block">Sets the externalDocs property of this Schema to the indicated value.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <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/media/Schema.html#format-java.lang.String-">format</a></span>(java.lang.String format)</code> |
| <div class="block">Sets the format property of this Schema instance to the given string.</div> |
| </td> |
| </tr> |
| <tr id="i20" 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/media/Schema.html#getAdditionalProperties--">getAdditionalProperties</a></span>()</code> |
| <div class="block">Returns the value of the "additionalProperties" setting, which indicates whether |
| properties not otherwise defined are allowed.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code>java.util.List<<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/media/Schema.html#getAllOf--">getAllOf</a></span>()</code> |
| <div class="block">Returns the schemas used by the allOf property.</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code>java.util.List<<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/media/Schema.html#getAnyOf--">getAnyOf</a></span>()</code> |
| <div class="block">Returns the schemas used by the anyOf property.</div> |
| </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code>java.lang.Object</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html#getDefaultValue--">getDefaultValue</a></span>()</code> |
| <div class="block">Returns the default value property from this Schema instance.</div> |
| </td> |
| </tr> |
| <tr id="i24" 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/media/Schema.html#getDeprecated--">getDeprecated</a></span>()</code> |
| <div class="block">Returns the deprecated property from this Schema instance.</div> |
| </td> |
| </tr> |
| <tr id="i25" 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/media/Schema.html#getDescription--">getDescription</a></span>()</code> |
| <div class="block">Returns a description of the purpose of this Schema.</div> |
| </td> |
| </tr> |
| <tr id="i26" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Discriminator.html" title="interface in org.eclipse.microprofile.openapi.models.media">Discriminator</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html#getDiscriminator--">getDiscriminator</a></span>()</code> |
| <div class="block">Returns the discriminator property from this Schema instance.</div> |
| </td> |
| </tr> |
| <tr id="i27" class="rowColor"> |
| <td class="colFirst"><code>java.util.List<java.lang.Object></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html#getEnumeration--">getEnumeration</a></span>()</code> |
| <div class="block">Returns the enumerated list of values allowed for objects defined by this Schema.</div> |
| </td> |
| </tr> |
| <tr id="i28" 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/media/Schema.html#getExample--">getExample</a></span>()</code> |
| <div class="block">Returns the example property from this Schema instance.</div> |
| </td> |
| </tr> |
| <tr id="i29" 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/media/Schema.html#getExclusiveMaximum--">getExclusiveMaximum</a></span>()</code> |
| <div class="block">Returns the exclusiveMaximum property from this Schema instance.</div> |
| </td> |
| </tr> |
| <tr id="i30" 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/media/Schema.html#getExclusiveMinimum--">getExclusiveMinimum</a></span>()</code> |
| <div class="block">Returns the exclusiveMinimum property from this Schema instance.</div> |
| </td> |
| </tr> |
| <tr id="i31" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/eclipse/microprofile/openapi/models/ExternalDocumentation.html" title="interface in org.eclipse.microprofile.openapi.models">ExternalDocumentation</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html#getExternalDocs--">getExternalDocs</a></span>()</code> |
| <div class="block">Returns the externalDocs property from this Schema instance.</div> |
| </td> |
| </tr> |
| <tr id="i32" 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/media/Schema.html#getFormat--">getFormat</a></span>()</code> |
| <div class="block">Returns the format property from this Schema instance.</div> |
| </td> |
| </tr> |
| <tr id="i33" class="rowColor"> |
| <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/media/Schema.html#getItems--">getItems</a></span>()</code> |
| <div class="block">Returns the Schema used for all the elements of an array typed Schema.</div> |
| </td> |
| </tr> |
| <tr id="i34" class="altColor"> |
| <td class="colFirst"><code>java.math.BigDecimal</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html#getMaximum--">getMaximum</a></span>()</code> |
| <div class="block">Returns the maximum property from this Schema instance.</div> |
| </td> |
| </tr> |
| <tr id="i35" class="rowColor"> |
| <td class="colFirst"><code>java.lang.Integer</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html#getMaxItems--">getMaxItems</a></span>()</code> |
| <div class="block">Returns the maxItems property from this Schema instance.</div> |
| </td> |
| </tr> |
| <tr id="i36" class="altColor"> |
| <td class="colFirst"><code>java.lang.Integer</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html#getMaxLength--">getMaxLength</a></span>()</code> |
| <div class="block">Returns the maxLength property from this Schema instance.</div> |
| </td> |
| </tr> |
| <tr id="i37" class="rowColor"> |
| <td class="colFirst"><code>java.lang.Integer</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html#getMaxProperties--">getMaxProperties</a></span>()</code> |
| <div class="block">Returns the maxProperties property from this Schema instance.</div> |
| </td> |
| </tr> |
| <tr id="i38" class="altColor"> |
| <td class="colFirst"><code>java.math.BigDecimal</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html#getMinimum--">getMinimum</a></span>()</code> |
| <div class="block">Returns the minimum property from this Schema instance.</div> |
| </td> |
| </tr> |
| <tr id="i39" class="rowColor"> |
| <td class="colFirst"><code>java.lang.Integer</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html#getMinItems--">getMinItems</a></span>()</code> |
| <div class="block">Returns the minItems property from this Schema instance.</div> |
| </td> |
| </tr> |
| <tr id="i40" class="altColor"> |
| <td class="colFirst"><code>java.lang.Integer</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html#getMinLength--">getMinLength</a></span>()</code> |
| <div class="block">Returns the minLength property from this Schema instance.</div> |
| </td> |
| </tr> |
| <tr id="i41" class="rowColor"> |
| <td class="colFirst"><code>java.lang.Integer</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html#getMinProperties--">getMinProperties</a></span>()</code> |
| <div class="block">Returns the minProperties property from this Schema instance.</div> |
| </td> |
| </tr> |
| <tr id="i42" class="altColor"> |
| <td class="colFirst"><code>java.math.BigDecimal</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html#getMultipleOf--">getMultipleOf</a></span>()</code> |
| <div class="block">Returns the multipleOf property from this Schema instance.</div> |
| </td> |
| </tr> |
| <tr id="i43" class="rowColor"> |
| <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/media/Schema.html#getNot--">getNot</a></span>()</code> |
| <div class="block">Returns a Schema which describes properties not allowed in objects defined by the current schema.</div> |
| </td> |
| </tr> |
| <tr id="i44" 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/media/Schema.html#getNullable--">getNullable</a></span>()</code> |
| <div class="block">Returns the nullable property from this Schema instance which indicates whether null is a valid value.</div> |
| </td> |
| </tr> |
| <tr id="i45" class="rowColor"> |
| <td class="colFirst"><code>java.util.List<<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/media/Schema.html#getOneOf--">getOneOf</a></span>()</code> |
| <div class="block">Returns the schemas used by the oneOf property.</div> |
| </td> |
| </tr> |
| <tr id="i46" 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/media/Schema.html#getPattern--">getPattern</a></span>()</code> |
| <div class="block">Returns the pattern property from this Schema instance.</div> |
| </td> |
| </tr> |
| <tr id="i47" class="rowColor"> |
| <td class="colFirst"><code>java.util.Map<java.lang.String,<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/media/Schema.html#getProperties--">getProperties</a></span>()</code> |
| <div class="block">Returns the properties defined in this Schema.</div> |
| </td> |
| </tr> |
| <tr id="i48" 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/media/Schema.html#getReadOnly--">getReadOnly</a></span>()</code> |
| <div class="block">Returns the readOnly property from this Schema instance.</div> |
| </td> |
| </tr> |
| <tr id="i49" class="rowColor"> |
| <td class="colFirst"><code>java.util.List<java.lang.String></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html#getRequired--">getRequired</a></span>()</code> |
| <div class="block">Returns the required property from this Schema instance.</div> |
| </td> |
| </tr> |
| <tr id="i50" 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/media/Schema.html#getTitle--">getTitle</a></span>()</code> |
| <div class="block">Returns the title property from this Schema instance.</div> |
| </td> |
| </tr> |
| <tr id="i51" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.SchemaType.html" title="enum in org.eclipse.microprofile.openapi.models.media">Schema.SchemaType</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html#getType--">getType</a></span>()</code> |
| <div class="block">Returns the type property from this Schema.</div> |
| </td> |
| </tr> |
| <tr id="i52" 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/media/Schema.html#getUniqueItems--">getUniqueItems</a></span>()</code> |
| <div class="block">Returns the uniqueItems property from this Schema instance.</div> |
| </td> |
| </tr> |
| <tr id="i53" 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/media/Schema.html#getWriteOnly--">getWriteOnly</a></span>()</code> |
| <div class="block">Returns the writeOnly property from this Schema instance.</div> |
| </td> |
| </tr> |
| <tr id="i54" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/XML.html" title="interface in org.eclipse.microprofile.openapi.models.media">XML</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html#getXml--">getXml</a></span>()</code> |
| <div class="block">Returns the xml property from this Schema instance.</div> |
| </td> |
| </tr> |
| <tr id="i55" class="rowColor"> |
| <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/media/Schema.html#items-org.eclipse.microprofile.openapi.models.media.Schema-">items</a></span>(<a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a> items)</code> |
| <div class="block">Set the Schema used for all the elements of an array typed Schema.</div> |
| </td> |
| </tr> |
| <tr id="i56" 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/media/Schema.html#maximum-java.math.BigDecimal-">maximum</a></span>(java.math.BigDecimal maximum)</code> |
| <div class="block">Sets the maximum property of this Schema instance to the value given.</div> |
| </td> |
| </tr> |
| <tr id="i57" class="rowColor"> |
| <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/media/Schema.html#maxItems-java.lang.Integer-">maxItems</a></span>(java.lang.Integer maxItems)</code> |
| <div class="block">Sets the maxItems property of this Schema instance to the value given.</div> |
| </td> |
| </tr> |
| <tr id="i58" 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/media/Schema.html#maxLength-java.lang.Integer-">maxLength</a></span>(java.lang.Integer maxLength)</code> |
| <div class="block">Sets the maxLength property of this Schema instance to the value given.</div> |
| </td> |
| </tr> |
| <tr id="i59" class="rowColor"> |
| <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/media/Schema.html#maxProperties-java.lang.Integer-">maxProperties</a></span>(java.lang.Integer maxProperties)</code> |
| <div class="block">Sets the maxProperties property of this Schema instance to the value given.</div> |
| </td> |
| </tr> |
| <tr id="i60" 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/media/Schema.html#minimum-java.math.BigDecimal-">minimum</a></span>(java.math.BigDecimal minimum)</code> |
| <div class="block">Sets the minimum property of this Schema instance to the value given.</div> |
| </td> |
| </tr> |
| <tr id="i61" class="rowColor"> |
| <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/media/Schema.html#minItems-java.lang.Integer-">minItems</a></span>(java.lang.Integer minItems)</code> |
| <div class="block">Sets the minItems property of this Schema instance to the value given.</div> |
| </td> |
| </tr> |
| <tr id="i62" 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/media/Schema.html#minLength-java.lang.Integer-">minLength</a></span>(java.lang.Integer minLength)</code> |
| <div class="block">Sets the minLength property of this Schema instance to the value given.</div> |
| </td> |
| </tr> |
| <tr id="i63" class="rowColor"> |
| <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/media/Schema.html#minProperties-java.lang.Integer-">minProperties</a></span>(java.lang.Integer minProperties)</code> |
| <div class="block">Sets the minProperties property of this Schema instance to the value given.</div> |
| </td> |
| </tr> |
| <tr id="i64" 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/media/Schema.html#multipleOf-java.math.BigDecimal-">multipleOf</a></span>(java.math.BigDecimal multipleOf)</code> |
| <div class="block">Sets the multipleOf property of this Schema instance to the value given.</div> |
| </td> |
| </tr> |
| <tr id="i65" class="rowColor"> |
| <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/media/Schema.html#not-org.eclipse.microprofile.openapi.models.media.Schema-">not</a></span>(<a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a> not)</code> |
| <div class="block">Sets the not property to a Schema which describes properties not allowed in objects defined by the current schema.</div> |
| </td> |
| </tr> |
| <tr id="i66" 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/media/Schema.html#nullable-java.lang.Boolean-">nullable</a></span>(java.lang.Boolean nullable)</code> |
| <div class="block">Sets the nullable property of this Schema instance.</div> |
| </td> |
| </tr> |
| <tr id="i67" class="rowColor"> |
| <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/media/Schema.html#oneOf-java.util.List-">oneOf</a></span>(java.util.List<<a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a>> oneOf)</code> |
| <div class="block">Sets the schemas used by the oneOf property of this Schema.</div> |
| </td> |
| </tr> |
| <tr id="i68" 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/media/Schema.html#pattern-java.lang.String-">pattern</a></span>(java.lang.String pattern)</code> |
| <div class="block">Sets the pattern property of this Schema instance to the string given.</div> |
| </td> |
| </tr> |
| <tr id="i69" class="rowColor"> |
| <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/media/Schema.html#properties-java.util.Map-">properties</a></span>(java.util.Map<java.lang.String,<a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a>> properties)</code> |
| <div class="block">Sets the properties of this Schema instance to the map provided.</div> |
| </td> |
| </tr> |
| <tr id="i70" 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/media/Schema.html#readOnly-java.lang.Boolean-">readOnly</a></span>(java.lang.Boolean readOnly)</code> |
| <div class="block">Sets the readOnly property of this Schema.</div> |
| </td> |
| </tr> |
| <tr id="i71" class="rowColor"> |
| <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/media/Schema.html#required-java.util.List-">required</a></span>(java.util.List<java.lang.String> required)</code> |
| <div class="block">Sets the list of fields required in objects defined by this Schema.</div> |
| </td> |
| </tr> |
| <tr id="i72" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html#setAdditionalProperties-java.lang.Boolean-">setAdditionalProperties</a></span>(java.lang.Boolean additionalProperties)</code> |
| <div class="block">Sets the value of "additionalProperties" to either True or False.</div> |
| </td> |
| </tr> |
| <tr id="i73" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html#setAdditionalProperties-org.eclipse.microprofile.openapi.models.media.Schema-">setAdditionalProperties</a></span>(<a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a> additionalProperties)</code> |
| <div class="block">Sets the Schema which defines additional properties not defined by "properties" or "patternProperties".</div> |
| </td> |
| </tr> |
| <tr id="i74" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html#setAllOf-java.util.List-">setAllOf</a></span>(java.util.List<<a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a>> allOf)</code> |
| <div class="block">Sets the schemas used by the allOf property of this Schema.</div> |
| </td> |
| </tr> |
| <tr id="i75" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html#setAnyOf-java.util.List-">setAnyOf</a></span>(java.util.List<<a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a>> anyOf)</code> |
| <div class="block">Sets the schemas used by the anyOf property of this Schema.</div> |
| </td> |
| </tr> |
| <tr id="i76" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html#setDefaultValue-java.lang.Object-">setDefaultValue</a></span>(java.lang.Object defaultValue)</code> |
| <div class="block">Set the default value property of this Schema instance to the value given.</div> |
| </td> |
| </tr> |
| <tr id="i77" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html#setDeprecated-java.lang.Boolean-">setDeprecated</a></span>(java.lang.Boolean deprecated)</code> |
| <div class="block">Sets the deprecated property of this Schema.</div> |
| </td> |
| </tr> |
| <tr id="i78" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html#setDescription-java.lang.String-">setDescription</a></span>(java.lang.String description)</code> |
| <div class="block">Sets the description property of this Schema to the given string.</div> |
| </td> |
| </tr> |
| <tr id="i79" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html#setDiscriminator-org.eclipse.microprofile.openapi.models.media.Discriminator-">setDiscriminator</a></span>(<a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Discriminator.html" title="interface in org.eclipse.microprofile.openapi.models.media">Discriminator</a> discriminator)</code> |
| <div class="block">Sets the discriminator property of this Schema instance to the given object.</div> |
| </td> |
| </tr> |
| <tr id="i80" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html#setEnumeration-java.util.List-">setEnumeration</a></span>(java.util.List<java.lang.Object> enumeration)</code> |
| <div class="block">Sets the enumerated list of values allowed for objects defined by this Schema.</div> |
| </td> |
| </tr> |
| <tr id="i81" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html#setExample-java.lang.Object-">setExample</a></span>(java.lang.Object example)</code> |
| <div class="block">Sets the example property of this Schema instance.</div> |
| </td> |
| </tr> |
| <tr id="i82" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html#setExclusiveMaximum-java.lang.Boolean-">setExclusiveMaximum</a></span>(java.lang.Boolean exclusiveMaximum)</code> |
| <div class="block">Sets the exclusiveMaximum property of this Schema instance to the value given.</div> |
| </td> |
| </tr> |
| <tr id="i83" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html#setExclusiveMinimum-java.lang.Boolean-">setExclusiveMinimum</a></span>(java.lang.Boolean exclusiveMinimum)</code> |
| <div class="block">Sets the exclusiveMinimum property of this Schema instance to the value given.</div> |
| </td> |
| </tr> |
| <tr id="i84" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html#setExternalDocs-org.eclipse.microprofile.openapi.models.ExternalDocumentation-">setExternalDocs</a></span>(<a href="../../../../../../org/eclipse/microprofile/openapi/models/ExternalDocumentation.html" title="interface in org.eclipse.microprofile.openapi.models">ExternalDocumentation</a> externalDocs)</code> |
| <div class="block">Sets the externalDocs property of this Schema to the indicated value.</div> |
| </td> |
| </tr> |
| <tr id="i85" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html#setFormat-java.lang.String-">setFormat</a></span>(java.lang.String format)</code> |
| <div class="block">Sets the format property of this Schema instance to the given string.</div> |
| </td> |
| </tr> |
| <tr id="i86" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html#setItems-org.eclipse.microprofile.openapi.models.media.Schema-">setItems</a></span>(<a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a> items)</code> |
| <div class="block">Set the Schema used for all the elements of an array typed Schema.</div> |
| </td> |
| </tr> |
| <tr id="i87" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html#setMaximum-java.math.BigDecimal-">setMaximum</a></span>(java.math.BigDecimal maximum)</code> |
| <div class="block">Sets the maximum property of this Schema instance to the value given.</div> |
| </td> |
| </tr> |
| <tr id="i88" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html#setMaxItems-java.lang.Integer-">setMaxItems</a></span>(java.lang.Integer maxItems)</code> |
| <div class="block">Sets the maxItems property of this Schema instance to the value given.</div> |
| </td> |
| </tr> |
| <tr id="i89" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html#setMaxLength-java.lang.Integer-">setMaxLength</a></span>(java.lang.Integer maxLength)</code> |
| <div class="block">Sets the maxLength property of this Schema instance to the value given.</div> |
| </td> |
| </tr> |
| <tr id="i90" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html#setMaxProperties-java.lang.Integer-">setMaxProperties</a></span>(java.lang.Integer maxProperties)</code> |
| <div class="block">Sets the maxProperties property of this Schema instance to the value given.</div> |
| </td> |
| </tr> |
| <tr id="i91" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html#setMinimum-java.math.BigDecimal-">setMinimum</a></span>(java.math.BigDecimal minimum)</code> |
| <div class="block">Sets the minimum property of this Schema instance to the value given.</div> |
| </td> |
| </tr> |
| <tr id="i92" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html#setMinItems-java.lang.Integer-">setMinItems</a></span>(java.lang.Integer minItems)</code> |
| <div class="block">Sets the minItems property of this Schema instance to the value given.</div> |
| </td> |
| </tr> |
| <tr id="i93" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html#setMinLength-java.lang.Integer-">setMinLength</a></span>(java.lang.Integer minLength)</code> |
| <div class="block">Sets the minLength property of this Schema instance to the value given.</div> |
| </td> |
| </tr> |
| <tr id="i94" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html#setMinProperties-java.lang.Integer-">setMinProperties</a></span>(java.lang.Integer minProperties)</code> |
| <div class="block">Sets the minProperties property of this Schema instance to the value given.</div> |
| </td> |
| </tr> |
| <tr id="i95" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html#setMultipleOf-java.math.BigDecimal-">setMultipleOf</a></span>(java.math.BigDecimal multipleOf)</code> |
| <div class="block">Sets the multipleOf property of this Schema instance to the value given.</div> |
| </td> |
| </tr> |
| <tr id="i96" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html#setNot-org.eclipse.microprofile.openapi.models.media.Schema-">setNot</a></span>(<a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a> not)</code> |
| <div class="block">Sets the not property to a Schema which describes properties not allowed in objects defined by the current schema.</div> |
| </td> |
| </tr> |
| <tr id="i97" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html#setNullable-java.lang.Boolean-">setNullable</a></span>(java.lang.Boolean nullable)</code> |
| <div class="block">Sets the nullable property of this Schema instance.</div> |
| </td> |
| </tr> |
| <tr id="i98" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html#setOneOf-java.util.List-">setOneOf</a></span>(java.util.List<<a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a>> oneOf)</code> |
| <div class="block">Sets the schemas used by the oneOf property of this Schema.</div> |
| </td> |
| </tr> |
| <tr id="i99" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html#setPattern-java.lang.String-">setPattern</a></span>(java.lang.String pattern)</code> |
| <div class="block">Sets the pattern property of this Schema instance to the string given.</div> |
| </td> |
| </tr> |
| <tr id="i100" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html#setProperties-java.util.Map-">setProperties</a></span>(java.util.Map<java.lang.String,<a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a>> properties)</code> |
| <div class="block">Sets the properties of this Schema instance to the map provided.</div> |
| </td> |
| </tr> |
| <tr id="i101" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html#setReadOnly-java.lang.Boolean-">setReadOnly</a></span>(java.lang.Boolean readOnly)</code> |
| <div class="block">Sets the readOnly property of this Schema.</div> |
| </td> |
| </tr> |
| <tr id="i102" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html#setRequired-java.util.List-">setRequired</a></span>(java.util.List<java.lang.String> required)</code> |
| <div class="block">Sets the list of fields required in objects defined by this Schema.</div> |
| </td> |
| </tr> |
| <tr id="i103" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html#setTitle-java.lang.String-">setTitle</a></span>(java.lang.String title)</code> |
| <div class="block">Sets the title property of this Schema instance to the given string.</div> |
| </td> |
| </tr> |
| <tr id="i104" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html#setType-org.eclipse.microprofile.openapi.models.media.Schema.SchemaType-">setType</a></span>(<a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.SchemaType.html" title="enum in org.eclipse.microprofile.openapi.models.media">Schema.SchemaType</a> type)</code> |
| <div class="block">Sets the type used by this Schema to the string given.</div> |
| </td> |
| </tr> |
| <tr id="i105" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html#setUniqueItems-java.lang.Boolean-">setUniqueItems</a></span>(java.lang.Boolean uniqueItems)</code> |
| <div class="block">Sets the uniqueItems property of this Schema instance to the value given.</div> |
| </td> |
| </tr> |
| <tr id="i106" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html#setWriteOnly-java.lang.Boolean-">setWriteOnly</a></span>(java.lang.Boolean writeOnly)</code> |
| <div class="block">Sets the writeOnly property of this Schema.</div> |
| </td> |
| </tr> |
| <tr id="i107" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html#setXml-org.eclipse.microprofile.openapi.models.media.XML-">setXml</a></span>(<a href="../../../../../../org/eclipse/microprofile/openapi/models/media/XML.html" title="interface in org.eclipse.microprofile.openapi.models.media">XML</a> xml)</code> |
| <div class="block">Sets the xml property of this Schema instance.</div> |
| </td> |
| </tr> |
| <tr id="i108" 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/media/Schema.html#title-java.lang.String-">title</a></span>(java.lang.String title)</code> |
| <div class="block">Sets the title property of this Schema instance to the given string.</div> |
| </td> |
| </tr> |
| <tr id="i109" class="rowColor"> |
| <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/media/Schema.html#type-org.eclipse.microprofile.openapi.models.media.Schema.SchemaType-">type</a></span>(<a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.SchemaType.html" title="enum in org.eclipse.microprofile.openapi.models.media">Schema.SchemaType</a> type)</code> |
| <div class="block">Sets the type used by this Schema to the string given.</div> |
| </td> |
| </tr> |
| <tr id="i110" 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/media/Schema.html#uniqueItems-java.lang.Boolean-">uniqueItems</a></span>(java.lang.Boolean uniqueItems)</code> |
| <div class="block">Sets the uniqueItems property of this Schema instance to the value given.</div> |
| </td> |
| </tr> |
| <tr id="i111" class="rowColor"> |
| <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/media/Schema.html#writeOnly-java.lang.Boolean-">writeOnly</a></span>(java.lang.Boolean writeOnly)</code> |
| <div class="block">Sets the writeOnly property of this Schema.</div> |
| </td> |
| </tr> |
| <tr id="i112" 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/media/Schema.html#xml-org.eclipse.microprofile.openapi.models.media.XML-">xml</a></span>(<a href="../../../../../../org/eclipse/microprofile/openapi/models/media/XML.html" title="interface in org.eclipse.microprofile.openapi.models.media">XML</a> xml)</code> |
| <div class="block">Sets the xml property of this Schema instance.</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="getDiscriminator--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDiscriminator</h4> |
| <pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Discriminator.html" title="interface in org.eclipse.microprofile.openapi.models.media">Discriminator</a> getDiscriminator()</pre> |
| <div class="block">Returns the discriminator property from this Schema instance.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the discriminator that is used to differentiate between the schemas which may satisfy the payload description</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setDiscriminator-org.eclipse.microprofile.openapi.models.media.Discriminator-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDiscriminator</h4> |
| <pre>void setDiscriminator(<a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Discriminator.html" title="interface in org.eclipse.microprofile.openapi.models.media">Discriminator</a> discriminator)</pre> |
| <div class="block">Sets the discriminator property of this Schema instance to the given object.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>discriminator</code> - the object that is used to differentiate between the schemas which may satisfy the payload description</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="discriminator-org.eclipse.microprofile.openapi.models.media.Discriminator-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>discriminator</h4> |
| <pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a> discriminator(<a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Discriminator.html" title="interface in org.eclipse.microprofile.openapi.models.media">Discriminator</a> discriminator)</pre> |
| <div class="block">Sets the discriminator property of this Schema instance to the given object.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>discriminator</code> - the object that is used to differentiate between the schemas which may satisfy the payload description</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current Schema instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getTitle--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTitle</h4> |
| <pre>java.lang.String getTitle()</pre> |
| <div class="block">Returns the title property from this Schema instance.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the title assigned to this Schema</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setTitle-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setTitle</h4> |
| <pre>void setTitle(java.lang.String title)</pre> |
| <div class="block">Sets the title property of this Schema instance to the given string.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>title</code> - a title to assign to this Schema</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="title-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>title</h4> |
| <pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a> title(java.lang.String title)</pre> |
| <div class="block">Sets the title property of this Schema instance to the given string.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>title</code> - a title to assign to this Schema</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current Schema instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDefaultValue--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDefaultValue</h4> |
| <pre>java.lang.Object getDefaultValue()</pre> |
| <div class="block">Returns the default value property from this Schema instance.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the default value object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setDefaultValue-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDefaultValue</h4> |
| <pre>void setDefaultValue(java.lang.Object defaultValue)</pre> |
| <div class="block">Set the default value property of this Schema instance to the value given.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>defaultValue</code> - a value to use as the default</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="defaultValue-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>defaultValue</h4> |
| <pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a> defaultValue(java.lang.Object defaultValue)</pre> |
| <div class="block">Set the default value property of this Schema instance to the value given.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>defaultValue</code> - a value to use as the default</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current Schema instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getEnumeration--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEnumeration</h4> |
| <pre>java.util.List<java.lang.Object> getEnumeration()</pre> |
| <div class="block">Returns the enumerated list of values allowed for objects defined by this Schema.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the list of values allowed for objects defined by this Schema</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setEnumeration-java.util.List-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setEnumeration</h4> |
| <pre>void setEnumeration(java.util.List<java.lang.Object> enumeration)</pre> |
| <div class="block">Sets the enumerated list of values allowed for objects defined by this Schema.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>enumeration</code> - a list of values allowed</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="enumeration-java.util.List-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>enumeration</h4> |
| <pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a> enumeration(java.util.List<java.lang.Object> enumeration)</pre> |
| </li> |
| </ul> |
| <a name="addEnumeration-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addEnumeration</h4> |
| <pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a> addEnumeration(java.lang.Object enumeration)</pre> |
| <div class="block">Adds an item of the appropriate type to the enumerated list of values allowed.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>enumeration</code> - an object to add to the enumerated values</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>current Schema instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMultipleOf--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMultipleOf</h4> |
| <pre>java.math.BigDecimal getMultipleOf()</pre> |
| <div class="block">Returns the multipleOf property from this Schema instance. |
| <p> |
| minimum: 0</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the positive number that restricts the value of the object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setMultipleOf-java.math.BigDecimal-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMultipleOf</h4> |
| <pre>void setMultipleOf(java.math.BigDecimal multipleOf)</pre> |
| <div class="block">Sets the multipleOf property of this Schema instance to the value given.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>multipleOf</code> - a positive number that restricts the value of objects described by this Schema</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="multipleOf-java.math.BigDecimal-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>multipleOf</h4> |
| <pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a> multipleOf(java.math.BigDecimal multipleOf)</pre> |
| <div class="block">Sets the multipleOf property of this Schema instance to the value given.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>multipleOf</code> - a positive number that restricts the value of objects described by this Schema</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current Schema instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMaximum--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMaximum</h4> |
| <pre>java.math.BigDecimal getMaximum()</pre> |
| <div class="block">Returns the maximum property from this Schema instance.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the maximum value of a numeric object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setMaximum-java.math.BigDecimal-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMaximum</h4> |
| <pre>void setMaximum(java.math.BigDecimal maximum)</pre> |
| <div class="block">Sets the maximum property of this Schema instance to the value given.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>maximum</code> - specifies the maximum numeric value of objects defined by this Schema</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="maximum-java.math.BigDecimal-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>maximum</h4> |
| <pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a> maximum(java.math.BigDecimal maximum)</pre> |
| <div class="block">Sets the maximum property of this Schema instance to the value given.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>maximum</code> - specifies the maximum numeric value of objects defined by this Schema</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current Schema instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getExclusiveMaximum--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getExclusiveMaximum</h4> |
| <pre>java.lang.Boolean getExclusiveMaximum()</pre> |
| <div class="block">Returns the exclusiveMaximum property from this Schema instance.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>whether the numeric value of objects must be less than the maximum property</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setExclusiveMaximum-java.lang.Boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setExclusiveMaximum</h4> |
| <pre>void setExclusiveMaximum(java.lang.Boolean exclusiveMaximum)</pre> |
| <div class="block">Sets the exclusiveMaximum property of this Schema instance to the value given.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>exclusiveMaximum</code> - when true the numeric value of objects defined by this Schema must be less than indicated by the maximum property</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="exclusiveMaximum-java.lang.Boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>exclusiveMaximum</h4> |
| <pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a> exclusiveMaximum(java.lang.Boolean exclusiveMaximum)</pre> |
| <div class="block">Sets the exclusiveMaximum property of this Schema instance to the value given.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>exclusiveMaximum</code> - when true the numeric value of objects defined by this Schema must be less than indicated by the maximum property</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current Schema instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMinimum--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMinimum</h4> |
| <pre>java.math.BigDecimal getMinimum()</pre> |
| <div class="block">Returns the minimum property from this Schema instance.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the minimum value of a numeric object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setMinimum-java.math.BigDecimal-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMinimum</h4> |
| <pre>void setMinimum(java.math.BigDecimal minimum)</pre> |
| <div class="block">Sets the minimum property of this Schema instance to the value given.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>minimum</code> - specifies the minimum numeric value of objects defined by this Schema</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="minimum-java.math.BigDecimal-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>minimum</h4> |
| <pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a> minimum(java.math.BigDecimal minimum)</pre> |
| <div class="block">Sets the minimum property of this Schema instance to the value given.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>minimum</code> - specifies the minimum numeric value of objects defined by this Schema</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current Schema instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getExclusiveMinimum--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getExclusiveMinimum</h4> |
| <pre>java.lang.Boolean getExclusiveMinimum()</pre> |
| <div class="block">Returns the exclusiveMinimum property from this Schema instance.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>whether the numeric value of objects must be greater than the minimum property</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setExclusiveMinimum-java.lang.Boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setExclusiveMinimum</h4> |
| <pre>void setExclusiveMinimum(java.lang.Boolean exclusiveMinimum)</pre> |
| <div class="block">Sets the exclusiveMinimum property of this Schema instance to the value given.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>exclusiveMinimum</code> - when true the numeric value of objects defined by this Schema must be greater than indicated by the minimum property</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="exclusiveMinimum-java.lang.Boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>exclusiveMinimum</h4> |
| <pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a> exclusiveMinimum(java.lang.Boolean exclusiveMinimum)</pre> |
| <div class="block">Sets the exclusiveMinimum property of this Schema instance to the value given.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>exclusiveMinimum</code> - when true the numeric value of objects defined by this Schema must be greater than indicated by the minimum property</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current Schema instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMaxLength--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMaxLength</h4> |
| <pre>java.lang.Integer getMaxLength()</pre> |
| <div class="block">Returns the maxLength property from this Schema instance. |
| <p> |
| minimum: 0</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the maximum length of objects e.g. strings</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setMaxLength-java.lang.Integer-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMaxLength</h4> |
| <pre>void setMaxLength(java.lang.Integer maxLength)</pre> |
| <div class="block">Sets the maxLength property of this Schema instance to the value given.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>maxLength</code> - the maximum length of objects defined by this Schema</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="maxLength-java.lang.Integer-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>maxLength</h4> |
| <pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a> maxLength(java.lang.Integer maxLength)</pre> |
| <div class="block">Sets the maxLength property of this Schema instance to the value given.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>maxLength</code> - the maximum length of objects defined by this Schema</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current Schema instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMinLength--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMinLength</h4> |
| <pre>java.lang.Integer getMinLength()</pre> |
| <div class="block">Returns the minLength property from this Schema instance. |
| <p> |
| minimum: 0</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the minimum length of objects e.g. strings</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setMinLength-java.lang.Integer-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMinLength</h4> |
| <pre>void setMinLength(java.lang.Integer minLength)</pre> |
| <div class="block">Sets the minLength property of this Schema instance to the value given.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>minLength</code> - the minimum length of objects defined by this Schema</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="minLength-java.lang.Integer-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>minLength</h4> |
| <pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a> minLength(java.lang.Integer minLength)</pre> |
| <div class="block">Sets the minLength property of this Schema instance to the value given.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>minLength</code> - the minimum length of objects defined by this Schema</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current Schema instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getPattern--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPattern</h4> |
| <pre>java.lang.String getPattern()</pre> |
| <div class="block">Returns the pattern property from this Schema instance.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the regular expression which restricts the value of an object e.g. a string</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setPattern-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPattern</h4> |
| <pre>void setPattern(java.lang.String pattern)</pre> |
| <div class="block">Sets the pattern property of this Schema instance to the string given.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>pattern</code> - the regular expression which restricts objects defined by this Schema</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="pattern-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>pattern</h4> |
| <pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a> pattern(java.lang.String pattern)</pre> |
| <div class="block">Sets the pattern property of this Schema instance to the string given.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>pattern</code> - the regular expression which restricts objects defined by this Schema</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current Schema instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMaxItems--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMaxItems</h4> |
| <pre>java.lang.Integer getMaxItems()</pre> |
| <div class="block">Returns the maxItems property from this Schema instance. |
| <p> |
| minimum: 0</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the maximum number of elements in the object e.g. array elements</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setMaxItems-java.lang.Integer-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMaxItems</h4> |
| <pre>void setMaxItems(java.lang.Integer maxItems)</pre> |
| <div class="block">Sets the maxItems property of this Schema instance to the value given.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>maxItems</code> - the maximum number of elements in objects defined by this Schema e.g. array elements</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="maxItems-java.lang.Integer-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>maxItems</h4> |
| <pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a> maxItems(java.lang.Integer maxItems)</pre> |
| <div class="block">Sets the maxItems property of this Schema instance to the value given.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>maxItems</code> - the maximum number of elements in objects defined by this Schema e.g. array elements</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current Schema instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMinItems--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMinItems</h4> |
| <pre>java.lang.Integer getMinItems()</pre> |
| <div class="block">Returns the minItems property from this Schema instance. |
| <p> |
| minimum: 0</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the minimum number of elements in the object e.g. array elements</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setMinItems-java.lang.Integer-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMinItems</h4> |
| <pre>void setMinItems(java.lang.Integer minItems)</pre> |
| <div class="block">Sets the minItems property of this Schema instance to the value given.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>minItems</code> - the minimum number of elements in objects defined by this Schema e.g. array elements</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="minItems-java.lang.Integer-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>minItems</h4> |
| <pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a> minItems(java.lang.Integer minItems)</pre> |
| <div class="block">Sets the minItems property of this Schema instance to the value given.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>minItems</code> - the minimum number of elements in objects defined by this Schema e.g. array elements</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current Schema instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getUniqueItems--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getUniqueItems</h4> |
| <pre>java.lang.Boolean getUniqueItems()</pre> |
| <div class="block">Returns the uniqueItems property from this Schema instance.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>whether to ensure items are unique</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setUniqueItems-java.lang.Boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setUniqueItems</h4> |
| <pre>void setUniqueItems(java.lang.Boolean uniqueItems)</pre> |
| <div class="block">Sets the uniqueItems property of this Schema instance to the value given.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>uniqueItems</code> - ensure the items (e.g. array elements) are unique in objects defined by this Schema</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="uniqueItems-java.lang.Boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>uniqueItems</h4> |
| <pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a> uniqueItems(java.lang.Boolean uniqueItems)</pre> |
| <div class="block">Sets the uniqueItems property of this Schema instance to the value given.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>uniqueItems</code> - ensure the items (e.g. array elements) are unique in objects defined by this Schema</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current Schema instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMaxProperties--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMaxProperties</h4> |
| <pre>java.lang.Integer getMaxProperties()</pre> |
| <div class="block">Returns the maxProperties property from this Schema instance. |
| <p> |
| minimum: 0</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the maximum number of properties allowed in the object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setMaxProperties-java.lang.Integer-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMaxProperties</h4> |
| <pre>void setMaxProperties(java.lang.Integer maxProperties)</pre> |
| <div class="block">Sets the maxProperties property of this Schema instance to the value given.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>maxProperties</code> - limit the number of properties in objects defined by this Schema</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="maxProperties-java.lang.Integer-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>maxProperties</h4> |
| <pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a> maxProperties(java.lang.Integer maxProperties)</pre> |
| <div class="block">Sets the maxProperties property of this Schema instance to the value given.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>maxProperties</code> - limit the number of properties in objects defined by this Schema</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current Schema instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMinProperties--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMinProperties</h4> |
| <pre>java.lang.Integer getMinProperties()</pre> |
| <div class="block">Returns the minProperties property from this Schema instance. |
| <p> |
| minimum: 0</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the minimum number of properties allowed in the object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setMinProperties-java.lang.Integer-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMinProperties</h4> |
| <pre>void setMinProperties(java.lang.Integer minProperties)</pre> |
| <div class="block">Sets the minProperties property of this Schema instance to the value given.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>minProperties</code> - limit the number of properties in objects defined by this Schema</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="minProperties-java.lang.Integer-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>minProperties</h4> |
| <pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a> minProperties(java.lang.Integer minProperties)</pre> |
| <div class="block">Sets the minProperties property of this Schema instance to the value given.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>minProperties</code> - limit the number of properties in objects defined by this Schema</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current Schema instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getRequired--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRequired</h4> |
| <pre>java.util.List<java.lang.String> getRequired()</pre> |
| <div class="block">Returns the required property from this Schema instance.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the list of fields required in objects defined by this Schema</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setRequired-java.util.List-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setRequired</h4> |
| <pre>void setRequired(java.util.List<java.lang.String> required)</pre> |
| <div class="block">Sets the list of fields required in objects defined by this Schema.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>required</code> - the list of fields required in objects defined by this Schema</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="required-java.util.List-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>required</h4> |
| <pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a> required(java.util.List<java.lang.String> required)</pre> |
| <div class="block">Sets the list of fields required in objects defined by this Schema.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>required</code> - the list of fields required in objects defined by this Schema</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current Schema instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addRequired-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addRequired</h4> |
| <pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a> addRequired(java.lang.String required)</pre> |
| <div class="block">Adds the name of an item to the list of fields required in objects defined by this Schema.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>required</code> - the name of an item required in objects defined by this Schema instance</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current Schema instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getType--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getType</h4> |
| <pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.SchemaType.html" title="enum in org.eclipse.microprofile.openapi.models.media">Schema.SchemaType</a> getType()</pre> |
| <div class="block">Returns the type property from this Schema.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the type used in this Schema. Default value <b>must</b> be <code>null</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setType-org.eclipse.microprofile.openapi.models.media.Schema.SchemaType-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setType</h4> |
| <pre>void setType(<a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.SchemaType.html" title="enum in org.eclipse.microprofile.openapi.models.media">Schema.SchemaType</a> type)</pre> |
| <div class="block">Sets the type used by this Schema to the string given.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>type</code> - the type used by this Schema or <code>null</code> for |
| reference schemas</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="type-org.eclipse.microprofile.openapi.models.media.Schema.SchemaType-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>type</h4> |
| <pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a> type(<a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.SchemaType.html" title="enum in org.eclipse.microprofile.openapi.models.media">Schema.SchemaType</a> type)</pre> |
| <div class="block">Sets the type used by this Schema to the string given.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>type</code> - the type used by this Schema or <code>null</code> for |
| reference schemas</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current Schema instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getNot--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getNot</h4> |
| <pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a> getNot()</pre> |
| <div class="block">Returns a Schema which describes properties not allowed in objects defined by the current schema.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the not property's schema</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setNot-org.eclipse.microprofile.openapi.models.media.Schema-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setNot</h4> |
| <pre>void setNot(<a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a> not)</pre> |
| <div class="block">Sets the not property to a Schema which describes properties not allowed in objects defined by the current schema.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>not</code> - the Schema which describes properties not allowed</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="not-org.eclipse.microprofile.openapi.models.media.Schema-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>not</h4> |
| <pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a> not(<a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a> not)</pre> |
| <div class="block">Sets the not property to a Schema which describes properties not allowed in objects defined by the current schema.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>not</code> - the Schema which describes properties not allowed</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current Schema instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getProperties--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getProperties</h4> |
| <pre>java.util.Map<java.lang.String,<a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a>> getProperties()</pre> |
| <div class="block">Returns the properties defined in this Schema.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a map which associates property names with the schemas that describe their contents</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setProperties-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setProperties</h4> |
| <pre>void setProperties(java.util.Map<java.lang.String,<a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a>> properties)</pre> |
| <div class="block">Sets the properties of this Schema instance to the map provided.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>properties</code> - a map which associates property names with the schemas that describe their contents</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="properties-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>properties</h4> |
| <pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a> properties(java.util.Map<java.lang.String,<a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a>> properties)</pre> |
| <div class="block">Sets the properties of this Schema instance to the map provided.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>properties</code> - a map which associates property names with the schemas that describe their contents</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current Schema instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addProperty-java.lang.String-org.eclipse.microprofile.openapi.models.media.Schema-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addProperty</h4> |
| <pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a> addProperty(java.lang.String key, |
| <a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a> propertySchema)</pre> |
| <div class="block">Adds a Schema property of the provided name using the given schema.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - the name of a new Schema property</dd> |
| <dd><code>propertySchema</code> - the Schema which describes the properties of the named property</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current Schema instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getAdditionalProperties--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAdditionalProperties</h4> |
| <pre>java.lang.Object getAdditionalProperties()</pre> |
| <div class="block">Returns the value of the "additionalProperties" setting, which indicates whether |
| properties not otherwise defined are allowed. This setting MUST either be a <code>Boolean</code> |
| or <a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media"><code>Schema</code></a>. |
| |
| <ul> |
| <li>If "additionalProperties" is true, then any additional properties are allowed.</li> |
| |
| <li>If "additionalProperties" is false, then only properties covered by the "properties" |
| and "patternProperties" are allowed.</li> |
| |
| <li>If "additionalProperties" is a Schema, then additional properties are allowed but |
| should conform to the Schema.</li> |
| </ul></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this Schema's additionalProperties property</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setAdditionalProperties-org.eclipse.microprofile.openapi.models.media.Schema-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setAdditionalProperties</h4> |
| <pre>void setAdditionalProperties(<a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a> additionalProperties)</pre> |
| <div class="block">Sets the Schema which defines additional properties not defined by "properties" or "patternProperties". |
| See the javadoc for <a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html#getAdditionalProperties--"><code>getAdditionalProperties()</code></a> for more details on this setting. Note |
| that this version of the setter is mutually exclusive with the Boolean variants.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>additionalProperties</code> - a Schema which defines additional properties</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setAdditionalProperties-java.lang.Boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setAdditionalProperties</h4> |
| <pre>void setAdditionalProperties(java.lang.Boolean additionalProperties)</pre> |
| <div class="block">Sets the value of "additionalProperties" to either True or False. See the javadoc for |
| <a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html#getAdditionalProperties--"><code>getAdditionalProperties()</code></a> for more details on this setting. Note that |
| this version of the setter is mutually exclusive with the <a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media"><code>Schema</code></a> variants.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>additionalProperties</code> - a Schema which defines additional properties</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="additionalProperties-org.eclipse.microprofile.openapi.models.media.Schema-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>additionalProperties</h4> |
| <pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a> additionalProperties(<a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a> additionalProperties)</pre> |
| <div class="block">Sets the Schema which defines additional properties not defined by "properties" or "patternProperties". |
| See the javadoc for <a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html#getAdditionalProperties--"><code>getAdditionalProperties()</code></a> for more details on this setting. Note |
| that this version of the setter is mutually exclusive with the Boolean variants.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>additionalProperties</code> - a Schema which defines additional properties</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current Schema instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="additionalProperties-java.lang.Boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>additionalProperties</h4> |
| <pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a> additionalProperties(java.lang.Boolean additionalProperties)</pre> |
| <div class="block">Sets the value of "additionalProperties" to either True or False. See the javadoc for |
| <a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html#getAdditionalProperties--"><code>getAdditionalProperties()</code></a> for more details on this setting. Note that |
| this version of the setter is mutually exclusive with the <a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media"><code>Schema</code></a> variants.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>additionalProperties</code> - a Schema which defines additional properties</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current Schema instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDescription--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDescription</h4> |
| <pre>java.lang.String getDescription()</pre> |
| <div class="block">Returns a description of the purpose of this Schema.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a string containing a description</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 property of this Schema to the given string.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>description</code> - a string containing a description of the purpose of this Schema</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/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a> description(java.lang.String description)</pre> |
| <div class="block">Sets the description property of this Schema to the given string.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>description</code> - a string containing a description of the purpose of this Schema</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current Schema instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getFormat--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFormat</h4> |
| <pre>java.lang.String getFormat()</pre> |
| <div class="block">Returns the format property from this Schema instance. This property clarifies the data type specified in the type property.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a string describing the format of the data in this Schema</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setFormat-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setFormat</h4> |
| <pre>void setFormat(java.lang.String format)</pre> |
| <div class="block">Sets the format property of this Schema instance to the given string. The value may be one of the formats described in the OAS or a user |
| defined format.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>format</code> - the string specifying the data format</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="format-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>format</h4> |
| <pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a> format(java.lang.String format)</pre> |
| <div class="block">Sets the format property of this Schema instance to the given string. The value may be one of the formats described in the OAS or a user |
| defined format.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>format</code> - the string specifying the data format</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current Schema instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getNullable--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getNullable</h4> |
| <pre>java.lang.Boolean getNullable()</pre> |
| <div class="block">Returns the nullable property from this Schema instance which indicates whether null is a valid value.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the nullable property</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setNullable-java.lang.Boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setNullable</h4> |
| <pre>void setNullable(java.lang.Boolean nullable)</pre> |
| <div class="block">Sets the nullable property of this Schema instance. Specify true if this Schema will allow null values.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>nullable</code> - a boolean value indicating this Schema allows a null value.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="nullable-java.lang.Boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>nullable</h4> |
| <pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a> nullable(java.lang.Boolean nullable)</pre> |
| <div class="block">Sets the nullable property of this Schema instance. Specify true if this Schema will allow null values.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>nullable</code> - a boolean value indicating this Schema allows a null value.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current Schema instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getReadOnly--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getReadOnly</h4> |
| <pre>java.lang.Boolean getReadOnly()</pre> |
| <div class="block">Returns the readOnly property from this Schema instance.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>indication that the Schema is only valid in a response message</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setReadOnly-java.lang.Boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setReadOnly</h4> |
| <pre>void setReadOnly(java.lang.Boolean readOnly)</pre> |
| <div class="block">Sets the readOnly property of this Schema. Only valid when the Schema is the property in an object.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>readOnly</code> - true indicates the Schema should not be sent as part of a request message</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="readOnly-java.lang.Boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>readOnly</h4> |
| <pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a> readOnly(java.lang.Boolean readOnly)</pre> |
| <div class="block">Sets the readOnly property of this Schema. Only valid when the Schema is the property in an object.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>readOnly</code> - true indicates the Schema should not be sent as part of a request message</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current Schema instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getWriteOnly--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getWriteOnly</h4> |
| <pre>java.lang.Boolean getWriteOnly()</pre> |
| <div class="block">Returns the writeOnly property from this Schema instance.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>indication that the Schema is only valid in a request message</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setWriteOnly-java.lang.Boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setWriteOnly</h4> |
| <pre>void setWriteOnly(java.lang.Boolean writeOnly)</pre> |
| <div class="block">Sets the writeOnly property of this Schema. Only valid when the Schema is the property in an object.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>writeOnly</code> - true indicates the Schema should not be sent as part of a response message</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="writeOnly-java.lang.Boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>writeOnly</h4> |
| <pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a> writeOnly(java.lang.Boolean writeOnly)</pre> |
| <div class="block">Sets the writeOnly property of this Schema. Only valid when the Schema is the property in an object.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>writeOnly</code> - true indicates the Schema should not be sent as part of a response message</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current Schema instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getExample--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getExample</h4> |
| <pre>java.lang.Object getExample()</pre> |
| <div class="block">Returns the example property from this Schema instance.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an object which is an example of an instance of this Schema</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setExample-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setExample</h4> |
| <pre>void setExample(java.lang.Object example)</pre> |
| <div class="block">Sets the example property of this Schema instance. To represent examples that cannot be naturally represented in JSON or YAML, a string value |
| can be used to contain the example with escaping where necessary.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>example</code> - an object which is an instance of this Schema</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/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a> example(java.lang.Object example)</pre> |
| <div class="block">Sets the example property of this Schema instance. To represent examples that cannot be naturally represented in JSON or YAML, a string value |
| can be used to contain the example with escaping where necessary.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>example</code> - an object which is an instance of this Schema</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current Schema instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getExternalDocs--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getExternalDocs</h4> |
| <pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/ExternalDocumentation.html" title="interface in org.eclipse.microprofile.openapi.models">ExternalDocumentation</a> getExternalDocs()</pre> |
| <div class="block">Returns the externalDocs property from this Schema instance.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>additional external documentation for this Schema</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setExternalDocs-org.eclipse.microprofile.openapi.models.ExternalDocumentation-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setExternalDocs</h4> |
| <pre>void setExternalDocs(<a href="../../../../../../org/eclipse/microprofile/openapi/models/ExternalDocumentation.html" title="interface in org.eclipse.microprofile.openapi.models">ExternalDocumentation</a> externalDocs)</pre> |
| <div class="block">Sets the externalDocs property of this Schema to the indicated value.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>externalDocs</code> - an additional external documentation object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="externalDocs-org.eclipse.microprofile.openapi.models.ExternalDocumentation-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>externalDocs</h4> |
| <pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a> externalDocs(<a href="../../../../../../org/eclipse/microprofile/openapi/models/ExternalDocumentation.html" title="interface in org.eclipse.microprofile.openapi.models">ExternalDocumentation</a> externalDocs)</pre> |
| <div class="block">Sets the externalDocs property of this Schema to the indicated value.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>externalDocs</code> - an additional external documentation object</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current Schema instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDeprecated--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDeprecated</h4> |
| <pre>java.lang.Boolean getDeprecated()</pre> |
| <div class="block">Returns the deprecated property from this Schema instance.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>indication that the Schema is deprecated and should be transitioned out of usage</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setDeprecated-java.lang.Boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDeprecated</h4> |
| <pre>void setDeprecated(java.lang.Boolean deprecated)</pre> |
| <div class="block">Sets the deprecated property of this Schema. This specifies that the Schema is deprecated and should be transitioned out of usage</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>deprecated</code> - true to indicate this Schema 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/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a> deprecated(java.lang.Boolean deprecated)</pre> |
| <div class="block">Sets the deprecated property of this Schema. This specifies that the Schema is deprecated and should be transitioned out of usage</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>deprecated</code> - true to indicate this Schema is deprecated</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current Schema instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getXml--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getXml</h4> |
| <pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/XML.html" title="interface in org.eclipse.microprofile.openapi.models.media">XML</a> getXml()</pre> |
| <div class="block">Returns the xml property from this Schema instance.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a metadata object that allows for more fine-tuned XML model definitions</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setXml-org.eclipse.microprofile.openapi.models.media.XML-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setXml</h4> |
| <pre>void setXml(<a href="../../../../../../org/eclipse/microprofile/openapi/models/media/XML.html" title="interface in org.eclipse.microprofile.openapi.models.media">XML</a> xml)</pre> |
| <div class="block">Sets the xml property of this Schema instance. It may only be set on properties schemas and adds additional metadata to describe the XML |
| representation of this property.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>xml</code> - a metadata object to describe the XML representation of this property</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="xml-org.eclipse.microprofile.openapi.models.media.XML-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>xml</h4> |
| <pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a> xml(<a href="../../../../../../org/eclipse/microprofile/openapi/models/media/XML.html" title="interface in org.eclipse.microprofile.openapi.models.media">XML</a> xml)</pre> |
| <div class="block">Sets the xml property of this Schema instance. It may only be set on properties schemas and adds additional metadata to describe the XML |
| representation of this property.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>xml</code> - a metadata object to describe the XML representation of this property</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current Schema instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getItems--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getItems</h4> |
| <pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a> getItems()</pre> |
| <div class="block">Returns the Schema used for all the elements of an array typed Schema.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the Schema used for all the elements</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setItems-org.eclipse.microprofile.openapi.models.media.Schema-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setItems</h4> |
| <pre>void setItems(<a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a> items)</pre> |
| <div class="block">Set the Schema used for all the elements of an array typed Schema.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>items</code> - the Schema used by this array</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="items-org.eclipse.microprofile.openapi.models.media.Schema-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>items</h4> |
| <pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a> items(<a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a> items)</pre> |
| <div class="block">Set the Schema used for all the elements of an array typed Schema.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>items</code> - the Schema used by this array</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current Schema instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getAllOf--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAllOf</h4> |
| <pre>java.util.List<<a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a>> getAllOf()</pre> |
| <div class="block">Returns the schemas used by the allOf property.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the list of schemas used by the allOf property</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setAllOf-java.util.List-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setAllOf</h4> |
| <pre>void setAllOf(java.util.List<<a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a>> allOf)</pre> |
| <div class="block">Sets the schemas used by the allOf property of this Schema.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>allOf</code> - the list of schemas used by the allOf property</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="allOf-java.util.List-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>allOf</h4> |
| <pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a> allOf(java.util.List<<a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a>> allOf)</pre> |
| <div class="block">Sets the schemas used by the allOf property of this Schema.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>allOf</code> - the list of schemas used by the allOf property</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current Schema instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addAllOf-org.eclipse.microprofile.openapi.models.media.Schema-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addAllOf</h4> |
| <pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a> addAllOf(<a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a> allOf)</pre> |
| <div class="block">Adds the given Schema to the list of schemas used by the allOf property.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>allOf</code> - a Schema to use with the allOf property</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current Schema instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getAnyOf--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAnyOf</h4> |
| <pre>java.util.List<<a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a>> getAnyOf()</pre> |
| <div class="block">Returns the schemas used by the anyOf property.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the list of schemas used by the anyOf property</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setAnyOf-java.util.List-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setAnyOf</h4> |
| <pre>void setAnyOf(java.util.List<<a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a>> anyOf)</pre> |
| <div class="block">Sets the schemas used by the anyOf property of this Schema.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>anyOf</code> - the list of schemas used by the anyOf property</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="anyOf-java.util.List-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>anyOf</h4> |
| <pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a> anyOf(java.util.List<<a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a>> anyOf)</pre> |
| <div class="block">Sets the schemas used by the anyOf property of this Schema.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>anyOf</code> - the list of schemas used by the anyOf property</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current Schema instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addAnyOf-org.eclipse.microprofile.openapi.models.media.Schema-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addAnyOf</h4> |
| <pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a> addAnyOf(<a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a> anyOf)</pre> |
| <div class="block">Adds the given Schema to the list of schemas used by the anyOf property.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>anyOf</code> - a Schema to use with the anyOf property</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current Schema instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getOneOf--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOneOf</h4> |
| <pre>java.util.List<<a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a>> getOneOf()</pre> |
| <div class="block">Returns the schemas used by the oneOf property.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the list of schemas used by the oneOf property</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setOneOf-java.util.List-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setOneOf</h4> |
| <pre>void setOneOf(java.util.List<<a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a>> oneOf)</pre> |
| <div class="block">Sets the schemas used by the oneOf property of this Schema.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>oneOf</code> - the list of schemas used by the oneOf property</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="oneOf-java.util.List-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>oneOf</h4> |
| <pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a> oneOf(java.util.List<<a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a>> oneOf)</pre> |
| <div class="block">Sets the schemas used by the oneOf property of this Schema.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>oneOf</code> - the list of schemas used by the oneOf property</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current Schema instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addOneOf-org.eclipse.microprofile.openapi.models.media.Schema-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>addOneOf</h4> |
| <pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a> addOneOf(<a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.html" title="interface in org.eclipse.microprofile.openapi.models.media">Schema</a> oneOf)</pre> |
| <div class="block">Adds the given Schema to the list of schemas used by the oneOf property.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>oneOf</code> - a Schema to use with the oneOf property</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current Schema 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><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/MediaType.html" title="interface in org.eclipse.microprofile.openapi.models.media"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.SchemaType.html" title="enum in org.eclipse.microprofile.openapi.models.media"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/eclipse/microprofile/openapi/models/media/Schema.html" target="_top">Frames</a></li> |
| <li><a href="Schema.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><a href="#nested.class.summary">Nested</a> | </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> |