| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (1.8.0_161) on Thu Nov 28 14:41:31 PST 2019 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>NCClientBuilder (NLPCraft Java Client 0.4.0)</title> |
| <meta name="date" content="2019-11-28"> |
| <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="NCClientBuilder (NLPCraft Java Client 0.4.0)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <link href="https://stackpath.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css" rel="stylesheet"> <script src="../../../resources/sh/scripts/XRegExp.js" type="text/javascript"></script> <script src="../../../resources/sh/scripts/shCore.js" type="text/javascript"></script> <script src="../../../resources/sh/scripts/shAutoloader.js" type="text/javascript"></script> <link href="../../../resources/sh/styles/shCoreDataLingvo.css" rel="stylesheet" type="text/css" title="Style"> <link href="../../../resources/sh/styles/shThemeDataLingvo.css" rel="stylesheet" type="text/css" title="Style"> <link href="https://fonts.googleapis.com/css?family=Roboto+Mono" rel="stylesheet"> <script async defer src="https://buttons.github.io/buttons.js"></script> |
| <!-- ========= 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="../../../org/nlpcraft/client/package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/NCClientBuilder.html">Use</a></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 class="aboutLanguage">NLPCraft Java Client 0.4.0</div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../org/nlpcraft/client/NCClient.html" title="interface in org.nlpcraft.client"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../org/nlpcraft/client/NCClientException.html" title="class in org.nlpcraft.client"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?org/nlpcraft/client/NCClientBuilder.html" target="_top">Frames</a></li> |
| <li><a href="NCClientBuilder.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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.nlpcraft.client</div> |
| <h2 title="Class NCClientBuilder" class="title">Class NCClientBuilder</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.nlpcraft.client.NCClientBuilder</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">NCClientBuilder</span> |
| extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre> |
| <div class="block">Builder for the <a href="../../../org/nlpcraft/client/NCClient.html" title="interface in org.nlpcraft.client"><code>NCClient</code></a> instances. |
| <p> |
| <b>Usage</b><br> |
| Client builder usage is straightforward: |
| <pre class="brush: java, highlight=[2,3,4,5]"> |
| // Get client instance. |
| NCClient cli = new NCClientBuilder() |
| .setLogin("admin@admin.com", "admin"), |
| .setBaseUrl("http://localhost:8081/api/v1/") |
| .build(); |
| |
| // Perform any necessary calls... |
| NCResult res = cli.askSync("my.model.id", txt); |
| |
| // Close client & sign out at the end. |
| cli.close(); |
| </pre></div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/nlpcraft/client/NCClientBuilder.html#DFLT_BASEURL">DFLT_BASEURL</a></span></code> |
| <div class="block">Default public REST API URL (endpoint).</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/nlpcraft/client/NCClientBuilder.html#DFLT_CANCEL_ON_EXIT">DFLT_CANCEL_ON_EXIT</a></span></code> |
| <div class="block">Default cancel on exit flag.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/nlpcraft/client/NCClientBuilder.html#DFLT_EMAIL">DFLT_EMAIL</a></span></code> |
| <div class="block">Default user login email.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/nlpcraft/client/NCClientBuilder.html#DFLT_EMBEDDED_PROBE">DFLT_EMBEDDED_PROBE</a></span></code> |
| <div class="block">Default embedded probe mode.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/nlpcraft/client/NCClientBuilder.html#DFLT_PWD">DFLT_PWD</a></span></code> |
| <div class="block">Default user login password.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../org/nlpcraft/client/NCClientBuilder.html#NCClientBuilder--">NCClientBuilder</a></span>()</code> |
| <div class="block">Creates new client builder with all default settings.</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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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/nlpcraft/client/NCClient.html" title="interface in org.nlpcraft.client">NCClient</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/nlpcraft/client/NCClientBuilder.html#build--">build</a></span>()</code> |
| <div class="block">Builds a client instance with configured settings.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../org/nlpcraft/client/NCClientBuilder.html" title="class in org.nlpcraft.client">NCClientBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/nlpcraft/client/NCClientBuilder.html#setBaseUrl-java.lang.String-">setBaseUrl</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> baseUrl)</code> |
| <div class="block">Sets custom base URL of the REST server for this builder.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../org/nlpcraft/client/NCClientBuilder.html" title="class in org.nlpcraft.client">NCClientBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/nlpcraft/client/NCClientBuilder.html#setClientSupplier-java.util.function.Supplier-">setClientSupplier</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/function/Supplier.html?is-external=true" title="class or interface in java.util.function">Supplier</a><org.apache.http.impl.client.CloseableHttpClient> httpCliSup)</code> |
| <div class="block">Sets custom HTTP client for this builder.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../org/nlpcraft/client/NCClientBuilder.html" title="class in org.nlpcraft.client">NCClientBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/nlpcraft/client/NCClientBuilder.html#setEmbeddedProbe-boolean-">setEmbeddedProbe</a></span>(boolean embeddedMode)</code> |
| <div class="block">Sets embedded probe mode flag.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../org/nlpcraft/client/NCClientBuilder.html" title="class in org.nlpcraft.client">NCClientBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/nlpcraft/client/NCClientBuilder.html#setLogin-java.lang.String-java.lang.String-">setLogin</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> email, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> pwd)</code> |
| <div class="block">Sets custom login user account.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../org/nlpcraft/client/NCClientBuilder.html" title="class in org.nlpcraft.client">NCClientBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/nlpcraft/client/NCClientBuilder.html#setRequestConfig-org.apache.http.client.config.RequestConfig-">setRequestConfig</a></span>(org.apache.http.client.config.RequestConfig reqCfg)</code> |
| <div class="block">Sets the custom request config for this builder.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="DFLT_BASEURL"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DFLT_BASEURL</h4> |
| <pre>public static final <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> DFLT_BASEURL</pre> |
| <div class="block">Default public REST API URL (endpoint).</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../constant-values.html#org.nlpcraft.client.NCClientBuilder.DFLT_BASEURL">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="DFLT_EMAIL"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DFLT_EMAIL</h4> |
| <pre>public static final <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> DFLT_EMAIL</pre> |
| <div class="block">Default user login email.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../constant-values.html#org.nlpcraft.client.NCClientBuilder.DFLT_EMAIL">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="DFLT_PWD"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DFLT_PWD</h4> |
| <pre>public static final <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> DFLT_PWD</pre> |
| <div class="block">Default user login password.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../constant-values.html#org.nlpcraft.client.NCClientBuilder.DFLT_PWD">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="DFLT_CANCEL_ON_EXIT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DFLT_CANCEL_ON_EXIT</h4> |
| <pre>public static final boolean DFLT_CANCEL_ON_EXIT</pre> |
| <div class="block">Default cancel on exit flag.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../constant-values.html#org.nlpcraft.client.NCClientBuilder.DFLT_CANCEL_ON_EXIT">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="DFLT_EMBEDDED_PROBE"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>DFLT_EMBEDDED_PROBE</h4> |
| <pre>public static final boolean DFLT_EMBEDDED_PROBE</pre> |
| <div class="block">Default embedded probe mode.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../constant-values.html#org.nlpcraft.client.NCClientBuilder.DFLT_EMBEDDED_PROBE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="NCClientBuilder--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>NCClientBuilder</h4> |
| <pre>public NCClientBuilder()</pre> |
| <div class="block">Creates new client builder with all default settings.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="setRequestConfig-org.apache.http.client.config.RequestConfig-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setRequestConfig</h4> |
| <pre>public <a href="../../../org/nlpcraft/client/NCClientBuilder.html" title="class in org.nlpcraft.client">NCClientBuilder</a> setRequestConfig(org.apache.http.client.config.RequestConfig reqCfg)</pre> |
| <div class="block">Sets the custom request config for this builder.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>reqCfg</code> - Custom request configuration.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Newly created client builder.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setClientSupplier-java.util.function.Supplier-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setClientSupplier</h4> |
| <pre>public <a href="../../../org/nlpcraft/client/NCClientBuilder.html" title="class in org.nlpcraft.client">NCClientBuilder</a> setClientSupplier(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/function/Supplier.html?is-external=true" title="class or interface in java.util.function">Supplier</a><org.apache.http.impl.client.CloseableHttpClient> httpCliSup)</pre> |
| <div class="block">Sets custom HTTP client for this builder.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>httpCliSup</code> - Custom HTTP client to use.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Current client builder.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setBaseUrl-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setBaseUrl</h4> |
| <pre>public <a href="../../../org/nlpcraft/client/NCClientBuilder.html" title="class in org.nlpcraft.client">NCClientBuilder</a> setBaseUrl(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> baseUrl)</pre> |
| <div class="block">Sets custom base URL of the REST server for this builder.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>baseUrl</code> - Base URL of the REST server to use.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Current client builder.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../org/nlpcraft/client/NCClientBuilder.html#DFLT_BASEURL"><code>DFLT_BASEURL</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setLogin-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setLogin</h4> |
| <pre>public <a href="../../../org/nlpcraft/client/NCClientBuilder.html" title="class in org.nlpcraft.client">NCClientBuilder</a> setLogin(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> email, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> pwd)</pre> |
| <div class="block">Sets custom login user account.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>email</code> - User email.</dd> |
| <dd><code>pwd</code> - User password.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Current client builder.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../org/nlpcraft/client/NCClientBuilder.html#DFLT_EMAIL"><code>DFLT_EMAIL</code></a>, |
| <a href="../../../org/nlpcraft/client/NCClientBuilder.html#DFLT_PWD"><code>DFLT_PWD</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setEmbeddedProbe-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setEmbeddedProbe</h4> |
| <pre>public <a href="../../../org/nlpcraft/client/NCClientBuilder.html" title="class in org.nlpcraft.client">NCClientBuilder</a> setEmbeddedProbe(boolean embeddedMode)</pre> |
| <div class="block">Sets embedded probe mode flag. If set to <code>true</code> the implementation |
| will expect that the embedded probe is running in the local JVM and will receive |
| query result via local callbacks. See <code>NCEmbeddedProbe</code> class for more details.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>embeddedMode</code> - Embedded probe mode.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Current client builder.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../org/nlpcraft/client/NCClientBuilder.html#DFLT_EMBEDDED_PROBE"><code>DFLT_EMBEDDED_PROBE</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="build--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>build</h4> |
| <pre>public <a href="../../../org/nlpcraft/client/NCClient.html" title="interface in org.nlpcraft.client">NCClient</a> build() |
| throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a>, |
| <a href="../../../org/nlpcraft/client/NCClientException.html" title="class in org.nlpcraft.client">NCClientException</a></pre> |
| <div class="block">Builds a client instance with configured settings.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Newly created instance of <a href="../../../org/nlpcraft/client/NCClient.html" title="interface in org.nlpcraft.client"><code>NCClient</code></a>.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - Thrown in case of any I/O errors.</dd> |
| <dd><code><a href="../../../org/nlpcraft/client/NCClientException.html" title="class in org.nlpcraft.client">NCClientException</a></code> - Thrown in case of any NLPCraft-specific errors.</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="../../../org/nlpcraft/client/package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/NCClientBuilder.html">Use</a></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 class="aboutLanguage"><span style="vertical-align: super">NLPCraft Java Client 0.4.0</span> <a style="vertical-align: super; margin-right: 10px" href="https://github.com/nlpcrafters/nlpcraft-java-client " target="github"><i class="fa fa-github github-logo"></i></a> <a class="github-button" href="https://github.com/nlpcrafters/nlpcraft-java-client/subscription" data-icon="octicon-eye" aria-label="Watch nlpcrafters/nlpcraft-java-client on GitHub">Watch</a> <a class="github-button" href="https://github.com/nlpcrafters/nlpcraft-java-client" data-icon="octicon-star" aria-label="Star nlpcrafters/nlpcraft-java-client on GitHub">Star</a> <a class="github-button" href="https://github.com/nlpcrafters/nlpcraft-java-client/fork" data-icon="octicon-repo-forked" aria-label="Fork nlpcrafters/nlpcraft-java-client on GitHub">Fork</a> <script type="text/javascript"> SyntaxHighlighter.defaults["auto-links"] = false; SyntaxHighlighter.defaults["tab-size"] = 2; SyntaxHighlighter.autoloader( 'java ../../../resources/sh/scripts/shBrushJava.js', 'js jscript javascript ../../../resources/sh/scripts/shBrushJScript.js', 'text plain ../../../resources/sh/scripts/shBrushPlain.js', 'py python ../../../resources/sh/scripts/shBrushPython.js', 'ruby rails ror rb ../../../resources/sh/scripts/shBrushRuby.js', 'scala ../../../resources/sh/scripts/shBrushScala.js', 'sql ../../../resources/sh/scripts/shBrushSql.js', 'xml xhtml xslt html ../../../resources/sh/scripts/shBrushXml.js' ); SyntaxHighlighter.all(); </script></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../org/nlpcraft/client/NCClient.html" title="interface in org.nlpcraft.client"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../org/nlpcraft/client/NCClientException.html" title="class in org.nlpcraft.client"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?org/nlpcraft/client/NCClientBuilder.html" target="_top">Frames</a></li> |
| <li><a href="NCClientBuilder.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2019 NLPCraft Project. All rights reserved.</small></p> |
| </body> |
| </html> |
