apidocs/2.1.6/javax/ws/rs/client/Invocation.Builder.html - third_party/jakartaee/rest - Git at Google

 <!DOCTYPE HTML>
 <!-- NewPage -->
 <html lang="en">
 <head>
 <!-- Generated by javadoc (12) on Mon Aug 12 13:20:58 GMT 2019 -->
 <title>Invocation.Builder (jakarta.ws.rs-api 2.1.6 API)</title>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 <meta name="dc.created" content="2019-08-12">
 <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
 <link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style">
 <script type="text/javascript" src="../../../../script.js"></script>
 <script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script>
 <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
 <!--[if IE]>
 <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
 <![endif]-->
 <script type="text/javascript" src="../../../../jquery/jquery-3.3.1.js"></script>
 <script type="text/javascript" src="../../../../jquery/jquery-migrate-3.0.1.js"></script>
 <script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script>
 </head>
 <body>
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
             parent.document.title="Invocation.Builder (jakarta.ws.rs-api 2.1.6 API)";
         }
     }
     catch(err) {
     }
 //-->
 var data = {"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};
 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";
 var pathtoroot = "../../../../";
 var useModuleDirectories = true;
 loadScripts(document, 'script');</script>
 <noscript>
 <div>JavaScript is disabled on your browser.</div>
 </noscript>
 <header role="banner">
 <nav role="navigation">
 <div class="fixedNav">
 <!-- ========= START OF TOP NAVBAR ======= -->
 <div class="topNav"><a id="navbar.top">
 <!--   -->
 </a>
 <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
 <a id="navbar.top.firstrow">
 <!--   -->
 </a>
 <ul class="navList" title="Navigation">
 <li><a href="../../../../index.html">Overview</a></li>
 <li><a href="package-summary.html">Package</a></li>
 <li class="navBarCell1Rev">Class</li>
 <li><a href="class-use/Invocation.Builder.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>
 <div class="subNav">
 <div>
 <ul class="subNavList">
 <li>Summary:&nbsp;</li>
 <li>Nested&nbsp;|&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li>Constr&nbsp;|&nbsp;</li>
 <li><a href="#method.summary">Method</a></li>
 </ul>
 <ul class="subNavList">
 <li>Detail:&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li>Constr&nbsp;|&nbsp;</li>
 <li><a href="#method.detail">Method</a></li>
 </ul>
 </div>
 <ul class="navListSearch">
 <li><label for="search">SEARCH:</label>
 <input type="text" id="search" value="search" disabled="disabled">
 <input type="reset" id="reset" value="reset" disabled="disabled">
 </li>
 </ul>
 </div>
 <a id="skip.navbar.top">
 <!--   -->
 </a>
 <!-- ========= END OF TOP NAVBAR ========= -->
 </div>
 <div class="navPadding">&nbsp;</div>
 <script type="text/javascript"><!--
 $('.navPadding').css('padding-top', $('.fixedNav').css("height"));
 //-->
 </script>
 </nav>
 </header>
 <!-- ======== START OF CLASS DATA ======== -->
 <main role="main">
 <div class="header">
 <div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">javax.ws.rs.client</a></div>
 <h2 title="Interface Invocation.Builder" class="title">Interface Invocation.Builder</h2>
 </div>
 <div class="contentContainer">
 <div class="description">
 <ul class="blockList">
 <li class="blockList">
 <dl>
 <dt>All Superinterfaces:</dt>
 <dd><code><a href="SyncInvoker.html" title="interface in javax.ws.rs.client">SyncInvoker</a></code></dd>
 </dl>
 <dl>
 <dt>Enclosing interface:</dt>
 <dd><a href="Invocation.html" title="interface in javax.ws.rs.client">Invocation</a></dd>
 </dl>
 <hr>
 <pre>public static interface <span class="typeNameLabel">Invocation.Builder</span>
 extends <a href="SyncInvoker.html" title="interface in javax.ws.rs.client">SyncInvoker</a></pre>
 <div class="block">A client request invocation builder.

  The builder, obtained via a call to one of the <code>request(...)</code>
  methods on a <a href="WebTarget.html" title="interface in javax.ws.rs.client"><code>resource target</code></a>, provides methods for
  preparing a client request invocation. Once the request is prepared
  the invocation builder can be either used to build an <a href="Invocation.html" title="interface in javax.ws.rs.client"><code>Invocation</code></a>
  with a generic execution interface:
  <pre>
    Client client = ClientBuilder.newClient();
    WebTarget resourceTarget = client.target("http://examples.jaxrs.com/");

    // Build a HTTP GET request that accepts "text/plain" response type
    // and contains a custom HTTP header entry "Foo: bar".
    Invocation invocation = resourceTarget.request("text/plain")
            .header("Foo", "bar").buildGet();

    // Invoke the request using generic interface
    String response = invocation.invoke(String.class);
  </pre>
  Alternatively, one of the inherited <a href="SyncInvoker.html" title="interface in javax.ws.rs.client"><code>synchronous invocation
  methods</code></a> can be used to invoke the prepared request and return the server
  response in a single step, e.g.:
  <pre>
    Client client = ClientBuilder.newClient();
    WebTarget resourceTarget = client.target("http://examples.jaxrs.com/");

    // Build and invoke the get request in a single step
    String response = resourceTarget.request("text/plain")
            .header("Foo", "bar").get(String.class);
  </pre>
  Once the request is fully prepared for invoking, switching to an
  <a href="AsyncInvoker.html" title="interface in javax.ws.rs.client"><code>asynchronous invocation</code></a> mode is possible by
  calling the <a href="#async()"><code>async()</code></a> method on the builder, e.g.:
  <pre>
    Client client = ClientBuilder.newClient();
    WebTarget resourceTarget = client.target("http://examples.jaxrs.com/");

    // Build and invoke the get request asynchronously in a single step
    Future<String> response = resourceTarget.request("text/plain")
            .header("Foo", "bar").async().get(String.class);
  </pre></div>
 </li>
 </ul>
 </div>
 <div class="summary">
 <ul class="blockList">
 <li class="blockList">
 <!-- ========== METHOD SUMMARY =========== -->
 <section role="region">
 <ul class="blockList">
 <li class="blockList"><a id="method.summary">
 <!--   -->
 </a>
 <h3>Method Summary</h3>
 <div class="memberSummary">
 <div role="tablist" aria-orientation="horizontal"><button role="tab" aria-selected="true" aria-controls="memberSummary_tabpanel" tabindex="0" onkeydown="switchTab(event)" id="t0" class="activeTableTab">All Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t2" class="tableTab" onclick="show(2);">Instance Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t3" class="tableTab" onclick="show(4);">Abstract Methods</button></div>
 <div id="memberSummary_tabpanel" role="tabpanel">
 <table aria-labelledby="t0">
 <tr>
 <th class="colFirst" scope="col">Modifier and Type</th>
 <th class="colSecond" scope="col">Method</th>
 <th class="colLast" scope="col">Description</th>
 </tr>
 <tbody>
 <tr class="altColor" id="i0">
 <td class="colFirst"><code><a href="Invocation.Builder.html" title="interface in javax.ws.rs.client">Invocation.Builder</a></code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#accept(java.lang.String...)">accept</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>...&nbsp;mediaTypes)</code></th>
 <td class="colLast">
 <div class="block">Add the accepted response media types.</div>
 </td>
 </tr>
 <tr class="rowColor" id="i1">
 <td class="colFirst"><code><a href="Invocation.Builder.html" title="interface in javax.ws.rs.client">Invocation.Builder</a></code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#accept(javax.ws.rs.core.MediaType...)">accept</a></span>&#8203;(<a href="../core/MediaType.html" title="class in javax.ws.rs.core">MediaType</a>...&nbsp;mediaTypes)</code></th>
 <td class="colLast">
 <div class="block">Add the accepted response media types.</div>
 </td>
 </tr>
 <tr class="altColor" id="i2">
 <td class="colFirst"><code><a href="Invocation.Builder.html" title="interface in javax.ws.rs.client">Invocation.Builder</a></code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#acceptEncoding(java.lang.String...)">acceptEncoding</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>...&nbsp;encodings)</code></th>
 <td class="colLast">
 <div class="block">Add acceptable encodings.</div>
 </td>
 </tr>
 <tr class="rowColor" id="i3">
 <td class="colFirst"><code><a href="Invocation.Builder.html" title="interface in javax.ws.rs.client">Invocation.Builder</a></code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#acceptLanguage(java.lang.String...)">acceptLanguage</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>...&nbsp;locales)</code></th>
 <td class="colLast">
 <div class="block">Add acceptable languages.</div>
 </td>
 </tr>
 <tr class="altColor" id="i4">
 <td class="colFirst"><code><a href="Invocation.Builder.html" title="interface in javax.ws.rs.client">Invocation.Builder</a></code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#acceptLanguage(java.util.Locale...)">acceptLanguage</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util" class="externalLink">Locale</a>...&nbsp;locales)</code></th>
 <td class="colLast">
 <div class="block">Add acceptable languages.</div>
 </td>
 </tr>
 <tr class="rowColor" id="i5">
 <td class="colFirst"><code><a href="AsyncInvoker.html" title="interface in javax.ws.rs.client">AsyncInvoker</a></code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#async()">async</a></span>()</code></th>
 <td class="colLast">
 <div class="block">Access the asynchronous uniform request invocation interface to
  asynchronously invoke the built request.</div>
 </td>
 </tr>
 <tr class="altColor" id="i6">
 <td class="colFirst"><code><a href="Invocation.html" title="interface in javax.ws.rs.client">Invocation</a></code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#build(java.lang.String)">build</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;method)</code></th>
 <td class="colLast">
 <div class="block">Build a request invocation using an arbitrary request method name.</div>
 </td>
 </tr>
 <tr class="rowColor" id="i7">
 <td class="colFirst"><code><a href="Invocation.html" title="interface in javax.ws.rs.client">Invocation</a></code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#build(java.lang.String,javax.ws.rs.client.Entity)">build</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;method,
      <a href="Entity.html" title="class in javax.ws.rs.client">Entity</a>&lt;?&gt;&nbsp;entity)</code></th>
 <td class="colLast">
 <div class="block">Build a request invocation using an arbitrary request method name and
  request entity.</div>
 </td>
 </tr>
 <tr class="altColor" id="i8">
 <td class="colFirst"><code><a href="Invocation.html" title="interface in javax.ws.rs.client">Invocation</a></code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#buildDelete()">buildDelete</a></span>()</code></th>
 <td class="colLast">
 <div class="block">Build a DELETE request invocation.</div>
 </td>
 </tr>
 <tr class="rowColor" id="i9">
 <td class="colFirst"><code><a href="Invocation.html" title="interface in javax.ws.rs.client">Invocation</a></code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#buildGet()">buildGet</a></span>()</code></th>
 <td class="colLast">
 <div class="block">Build a GET request invocation.</div>
 </td>
 </tr>
 <tr class="altColor" id="i10">
 <td class="colFirst"><code><a href="Invocation.html" title="interface in javax.ws.rs.client">Invocation</a></code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#buildPost(javax.ws.rs.client.Entity)">buildPost</a></span>&#8203;(<a href="Entity.html" title="class in javax.ws.rs.client">Entity</a>&lt;?&gt;&nbsp;entity)</code></th>
 <td class="colLast">
 <div class="block">Build a POST request invocation.</div>
 </td>
 </tr>
 <tr class="rowColor" id="i11">
 <td class="colFirst"><code><a href="Invocation.html" title="interface in javax.ws.rs.client">Invocation</a></code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#buildPut(javax.ws.rs.client.Entity)">buildPut</a></span>&#8203;(<a href="Entity.html" title="class in javax.ws.rs.client">Entity</a>&lt;?&gt;&nbsp;entity)</code></th>
 <td class="colLast">
 <div class="block">Build a PUT request invocation.</div>
 </td>
 </tr>
 <tr class="altColor" id="i12">
 <td class="colFirst"><code><a href="Invocation.Builder.html" title="interface in javax.ws.rs.client">Invocation.Builder</a></code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#cacheControl(javax.ws.rs.core.CacheControl)">cacheControl</a></span>&#8203;(<a href="../core/CacheControl.html" title="class in javax.ws.rs.core">CacheControl</a>&nbsp;cacheControl)</code></th>
 <td class="colLast">
 <div class="block">Set the cache control data of the message.</div>
 </td>
 </tr>
 <tr class="rowColor" id="i13">
 <td class="colFirst"><code><a href="Invocation.Builder.html" title="interface in javax.ws.rs.client">Invocation.Builder</a></code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#cookie(java.lang.String,java.lang.String)">cookie</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;name,
       <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;value)</code></th>
 <td class="colLast">
 <div class="block">Add a cookie to be set.</div>
 </td>
 </tr>
 <tr class="altColor" id="i14">
 <td class="colFirst"><code><a href="Invocation.Builder.html" title="interface in javax.ws.rs.client">Invocation.Builder</a></code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#cookie(javax.ws.rs.core.Cookie)">cookie</a></span>&#8203;(<a href="../core/Cookie.html" title="class in javax.ws.rs.core">Cookie</a>&nbsp;cookie)</code></th>
 <td class="colLast">
 <div class="block">Add a cookie to be set.</div>
 </td>
 </tr>
 <tr class="rowColor" id="i15">
 <td class="colFirst"><code><a href="Invocation.Builder.html" title="interface in javax.ws.rs.client">Invocation.Builder</a></code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#header(java.lang.String,java.lang.Object)">header</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;name,
       <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;value)</code></th>
 <td class="colLast">
 <div class="block">Add an arbitrary header.</div>
 </td>
 </tr>
 <tr class="altColor" id="i16">
 <td class="colFirst"><code><a href="Invocation.Builder.html" title="interface in javax.ws.rs.client">Invocation.Builder</a></code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#headers(javax.ws.rs.core.MultivaluedMap)">headers</a></span>&#8203;(<a href="../core/MultivaluedMap.html" title="interface in javax.ws.rs.core">MultivaluedMap</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,&#8203;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&gt;&nbsp;headers)</code></th>
 <td class="colLast">
 <div class="block">Replaces all existing headers with the newly supplied headers.</div>
 </td>
 </tr>
 <tr class="rowColor" id="i17">
 <td class="colFirst"><code><a href="Invocation.Builder.html" title="interface in javax.ws.rs.client">Invocation.Builder</a></code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#property(java.lang.String,java.lang.Object)">property</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;name,
         <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;value)</code></th>
 <td class="colLast">
 <div class="block">Set a new property in the context of a request represented by this invocation builder.</div>
 </td>
 </tr>
 <tr class="altColor" id="i18">
 <td class="colFirst"><code><a href="CompletionStageRxInvoker.html" title="interface in javax.ws.rs.client">CompletionStageRxInvoker</a></code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#rx()">rx</a></span>()</code></th>
 <td class="colLast">
 <div class="block">Access the default reactive invoker based on <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletionStage.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink"><code>CompletionStage</code></a>.</div>
 </td>
 </tr>
 <tr class="rowColor" id="i19">
 <td class="colFirst"><code>&lt;T extends <a href="RxInvoker.html" title="interface in javax.ws.rs.client">RxInvoker</a>&gt;<br>T</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#rx(java.lang.Class)">rx</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a>&lt;T&gt;&nbsp;clazz)</code></th>
 <td class="colLast">
 <div class="block">Access a reactive invoker based on a <a href="RxInvoker.html" title="interface in javax.ws.rs.client"><code>RxInvoker</code></a> subclass provider.</div>
 </td>
 </tr>
 </tbody>
 </table>
 </div>
 </div>
 <ul class="blockList">
 <li class="blockList"><a id="methods.inherited.from.class.javax.ws.rs.client.SyncInvoker">
 <!--   -->
 </a>
 <h3>Methods inherited from interface&nbsp;javax.ws.rs.client.<a href="SyncInvoker.html" title="interface in javax.ws.rs.client">SyncInvoker</a></h3>
 <code><a href="SyncInvoker.html#delete()">delete</a>, <a href="SyncInvoker.html#delete(java.lang.Class)">delete</a>, <a href="SyncInvoker.html#delete(javax.ws.rs.core.GenericType)">delete</a>, <a href="SyncInvoker.html#get()">get</a>, <a href="SyncInvoker.html#get(java.lang.Class)">get</a>, <a href="SyncInvoker.html#get(javax.ws.rs.core.GenericType)">get</a>, <a href="SyncInvoker.html#head()">head</a>, <a href="SyncInvoker.html#method(java.lang.String)">method</a>, <a href="SyncInvoker.html#method(java.lang.String,java.lang.Class)">method</a>, <a href="SyncInvoker.html#method(java.lang.String,javax.ws.rs.client.Entity)">method</a>, <a href="SyncInvoker.html#method(java.lang.String,javax.ws.rs.client.Entity,java.lang.Class)">method</a>, <a href="SyncInvoker.html#method(java.lang.String,javax.ws.rs.client.Entity,javax.ws.rs.core.GenericType)">method</a>, <a href="SyncInvoker.html#method(java.lang.String,javax.ws.rs.core.GenericType)">method</a>, <a href="SyncInvoker.html#options()">options</a>, <a href="SyncInvoker.html#options(java.lang.Class)">options</a>, <a href="SyncInvoker.html#options(javax.ws.rs.core.GenericType)">options</a>, <a href="SyncInvoker.html#post(javax.ws.rs.client.Entity)">post</a>, <a href="SyncInvoker.html#post(javax.ws.rs.client.Entity,java.lang.Class)">post</a>, <a href="SyncInvoker.html#post(javax.ws.rs.client.Entity,javax.ws.rs.core.GenericType)">post</a>, <a href="SyncInvoker.html#put(javax.ws.rs.client.Entity)">put</a>, <a href="SyncInvoker.html#put(javax.ws.rs.client.Entity,java.lang.Class)">put</a>, <a href="SyncInvoker.html#put(javax.ws.rs.client.Entity,javax.ws.rs.core.GenericType)">put</a>, <a href="SyncInvoker.html#trace()">trace</a>, <a href="SyncInvoker.html#trace(java.lang.Class)">trace</a>, <a href="SyncInvoker.html#trace(javax.ws.rs.core.GenericType)">trace</a></code></li>
 </ul>
 </li>
 </ul>
 </section>
 </li>
 </ul>
 </div>
 <div class="details">
 <ul class="blockList">
 <li class="blockList">
 <!-- ============ METHOD DETAIL ========== -->
 <section role="region">
 <ul class="blockList">
 <li class="blockList"><a id="method.detail">
 <!--   -->
 </a>
 <h3>Method Detail</h3>
 <a id="build(java.lang.String)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>build</h4>
 <pre class="methodSignature"><a href="Invocation.html" title="interface in javax.ws.rs.client">Invocation</a>&nbsp;build&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;method)</pre>
 <div class="block">Build a request invocation using an arbitrary request method name.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>method</code> - request method name.</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>invocation encapsulating the built request.</dd>
 </dl>
 </li>
 </ul>
 <a id="build(java.lang.String,javax.ws.rs.client.Entity)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>build</h4>
 <pre class="methodSignature"><a href="Invocation.html" title="interface in javax.ws.rs.client">Invocation</a>&nbsp;build&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;method,
                  <a href="Entity.html" title="class in javax.ws.rs.client">Entity</a>&lt;?&gt;&nbsp;entity)</pre>
 <div class="block">Build a request invocation using an arbitrary request method name and
  request entity.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>method</code> - request method name.</dd>
 <dd><code>entity</code> - request entity, including it's full <a href="../core/Variant.html" title="class in javax.ws.rs.core"><code>Variant</code></a> information.
                Any variant-related HTTP headers previously set (namely <code>Content-Type</code>,
                <code>Content-Language</code> and <code>Content-Encoding</code>) will be overwritten using
                the entity variant information.</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>invocation encapsulating the built request.</dd>
 </dl>
 </li>
 </ul>
 <a id="buildGet()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>buildGet</h4>
 <pre class="methodSignature"><a href="Invocation.html" title="interface in javax.ws.rs.client">Invocation</a>&nbsp;buildGet()</pre>
 <div class="block">Build a GET request invocation.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>invocation encapsulating the built GET request.</dd>
 </dl>
 </li>
 </ul>
 <a id="buildDelete()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>buildDelete</h4>
 <pre class="methodSignature"><a href="Invocation.html" title="interface in javax.ws.rs.client">Invocation</a>&nbsp;buildDelete()</pre>
 <div class="block">Build a DELETE request invocation.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>invocation encapsulating the built DELETE request.</dd>
 </dl>
 </li>
 </ul>
 <a id="buildPost(javax.ws.rs.client.Entity)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>buildPost</h4>
 <pre class="methodSignature"><a href="Invocation.html" title="interface in javax.ws.rs.client">Invocation</a>&nbsp;buildPost&#8203;(<a href="Entity.html" title="class in javax.ws.rs.client">Entity</a>&lt;?&gt;&nbsp;entity)</pre>
 <div class="block">Build a POST request invocation.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>entity</code> - request entity, including it's full <a href="../core/Variant.html" title="class in javax.ws.rs.core"><code>Variant</code></a> information.
                Any variant-related HTTP headers previously set (namely <code>Content-Type</code>,
                <code>Content-Language</code> and <code>Content-Encoding</code>) will be overwritten using
                the entity variant information.</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>invocation encapsulating the built POST request.</dd>
 </dl>
 </li>
 </ul>
 <a id="buildPut(javax.ws.rs.client.Entity)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>buildPut</h4>
 <pre class="methodSignature"><a href="Invocation.html" title="interface in javax.ws.rs.client">Invocation</a>&nbsp;buildPut&#8203;(<a href="Entity.html" title="class in javax.ws.rs.client">Entity</a>&lt;?&gt;&nbsp;entity)</pre>
 <div class="block">Build a PUT request invocation.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>entity</code> - request entity, including it's full <a href="../core/Variant.html" title="class in javax.ws.rs.core"><code>Variant</code></a> information.
                Any variant-related HTTP headers previously set (namely <code>Content-Type</code>,
                <code>Content-Language</code> and <code>Content-Encoding</code>) will be overwritten using
                the entity variant information.</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>invocation encapsulating the built PUT request.</dd>
 </dl>
 </li>
 </ul>
 <a id="async()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>async</h4>
 <pre class="methodSignature"><a href="AsyncInvoker.html" title="interface in javax.ws.rs.client">AsyncInvoker</a>&nbsp;async()</pre>
 <div class="block">Access the asynchronous uniform request invocation interface to
  asynchronously invoke the built request.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>asynchronous uniform request invocation interface.</dd>
 </dl>
 </li>
 </ul>
 <a id="accept(java.lang.String...)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>accept</h4>
 <pre class="methodSignature"><a href="Invocation.Builder.html" title="interface in javax.ws.rs.client">Invocation.Builder</a>&nbsp;accept&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>...&nbsp;mediaTypes)</pre>
 <div class="block">Add the accepted response media types.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>mediaTypes</code> - accepted response media types.</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the updated builder.</dd>
 </dl>
 </li>
 </ul>
 <a id="accept(javax.ws.rs.core.MediaType...)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>accept</h4>
 <pre class="methodSignature"><a href="Invocation.Builder.html" title="interface in javax.ws.rs.client">Invocation.Builder</a>&nbsp;accept&#8203;(<a href="../core/MediaType.html" title="class in javax.ws.rs.core">MediaType</a>...&nbsp;mediaTypes)</pre>
 <div class="block">Add the accepted response media types.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>mediaTypes</code> - accepted response media types.</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the updated builder.</dd>
 </dl>
 </li>
 </ul>
 <a id="acceptLanguage(java.util.Locale...)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>acceptLanguage</h4>
 <pre class="methodSignature"><a href="Invocation.Builder.html" title="interface in javax.ws.rs.client">Invocation.Builder</a>&nbsp;acceptLanguage&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util" class="externalLink">Locale</a>...&nbsp;locales)</pre>
 <div class="block">Add acceptable languages.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>locales</code> - an array of the acceptable languages.</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the updated builder.</dd>
 </dl>
 </li>
 </ul>
 <a id="acceptLanguage(java.lang.String...)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>acceptLanguage</h4>
 <pre class="methodSignature"><a href="Invocation.Builder.html" title="interface in javax.ws.rs.client">Invocation.Builder</a>&nbsp;acceptLanguage&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>...&nbsp;locales)</pre>
 <div class="block">Add acceptable languages.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>locales</code> - an array of the acceptable languages.</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the updated builder.</dd>
 </dl>
 </li>
 </ul>
 <a id="acceptEncoding(java.lang.String...)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>acceptEncoding</h4>
 <pre class="methodSignature"><a href="Invocation.Builder.html" title="interface in javax.ws.rs.client">Invocation.Builder</a>&nbsp;acceptEncoding&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>...&nbsp;encodings)</pre>
 <div class="block">Add acceptable encodings.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>encodings</code> - an array of the acceptable encodings.</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the updated builder.</dd>
 </dl>
 </li>
 </ul>
 <a id="cookie(javax.ws.rs.core.Cookie)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>cookie</h4>
 <pre class="methodSignature"><a href="Invocation.Builder.html" title="interface in javax.ws.rs.client">Invocation.Builder</a>&nbsp;cookie&#8203;(<a href="../core/Cookie.html" title="class in javax.ws.rs.core">Cookie</a>&nbsp;cookie)</pre>
 <div class="block">Add a cookie to be set.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>cookie</code> - to be set.</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the updated builder.</dd>
 </dl>
 </li>
 </ul>
 <a id="cookie(java.lang.String,java.lang.String)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>cookie</h4>
 <pre class="methodSignature"><a href="Invocation.Builder.html" title="interface in javax.ws.rs.client">Invocation.Builder</a>&nbsp;cookie&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;name,
                           <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;value)</pre>
 <div class="block">Add a cookie to be set.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>name</code> - the name of the cookie.</dd>
 <dd><code>value</code> - the value of the cookie.</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the updated builder.</dd>
 </dl>
 </li>
 </ul>
 <a id="cacheControl(javax.ws.rs.core.CacheControl)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>cacheControl</h4>
 <pre class="methodSignature"><a href="Invocation.Builder.html" title="interface in javax.ws.rs.client">Invocation.Builder</a>&nbsp;cacheControl&#8203;(<a href="../core/CacheControl.html" title="class in javax.ws.rs.core">CacheControl</a>&nbsp;cacheControl)</pre>
 <div class="block">Set the cache control data of the message.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>cacheControl</code> - the cache control directives, if <code>null</code>
                      any existing cache control directives will be removed.</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the updated builder.</dd>
 </dl>
 </li>
 </ul>
 <a id="header(java.lang.String,java.lang.Object)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>header</h4>
 <pre class="methodSignature"><a href="Invocation.Builder.html" title="interface in javax.ws.rs.client">Invocation.Builder</a>&nbsp;header&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;name,
                           <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;value)</pre>
 <div class="block">Add an arbitrary header.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>name</code> - the name of the header</dd>
 <dd><code>value</code> - the value of the header, the header will be serialized
               using a <a href="../ext/RuntimeDelegate.HeaderDelegate.html" title="interface in javax.ws.rs.ext"><code>RuntimeDelegate.HeaderDelegate</code></a> if
               one is available via <a href="../ext/RuntimeDelegate.html#createHeaderDelegate(java.lang.Class)"><code>RuntimeDelegate.createHeaderDelegate(java.lang.Class)</code></a>
               for the class of <code>value</code> or using its <code>toString</code> method
               if a header delegate is not available. If <code>value</code> is <code>null</code>
               then all current headers of the same name will be removed.</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the updated builder.</dd>
 </dl>
 </li>
 </ul>
 <a id="headers(javax.ws.rs.core.MultivaluedMap)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>headers</h4>
 <pre class="methodSignature"><a href="Invocation.Builder.html" title="interface in javax.ws.rs.client">Invocation.Builder</a>&nbsp;headers&#8203;(<a href="../core/MultivaluedMap.html" title="interface in javax.ws.rs.core">MultivaluedMap</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,&#8203;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&gt;&nbsp;headers)</pre>
 <div class="block">Replaces all existing headers with the newly supplied headers.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>headers</code> - new headers to be set, if <code>null</code> all existing
                 headers will be removed.</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the updated builder.</dd>
 </dl>
 </li>
 </ul>
 <a id="property(java.lang.String,java.lang.Object)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>property</h4>
 <pre class="methodSignature"><a href="Invocation.Builder.html" title="interface in javax.ws.rs.client">Invocation.Builder</a>&nbsp;property&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;name,
                             <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;value)</pre>
 <div class="block">Set a new property in the context of a request represented by this invocation builder.
  <p>
  The property is available for a later retrieval via <a href="ClientRequestContext.html#getProperty(java.lang.String)"><code>ClientRequestContext.getProperty(String)</code></a>
  or <a href="../ext/InterceptorContext.html#getProperty(java.lang.String)"><code>InterceptorContext.getProperty(String)</code></a>.
  If a property with a given name is already set in the request context,
  the existing value of the property will be updated.
  Setting a <code>null</code> value into a property effectively removes the property
  from the request property bag.
  </p></div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>name</code> - property name.</dd>
 <dd><code>value</code> - (new) property value. <code>null</code> value removes the property
               with the given name.</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the updated builder.</dd>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="Invocation.html#property(java.lang.String,java.lang.Object)"><code>Invocation.property(String, Object)</code></a></dd>
 </dl>
 </li>
 </ul>
 <a id="rx()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>rx</h4>
 <pre class="methodSignature"><a href="CompletionStageRxInvoker.html" title="interface in javax.ws.rs.client">CompletionStageRxInvoker</a>&nbsp;rx()</pre>
 <div class="block">Access the default reactive invoker based on <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletionStage.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink"><code>CompletionStage</code></a>.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>default reactive invoker instance.</dd>
 <dt><span class="simpleTagLabel">Since:</span></dt>
 <dd>2.1</dd>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="#rx(java.lang.Class)"><code>rx(Class)</code></a></dd>
 </dl>
 </li>
 </ul>
 <a id="rx(java.lang.Class)">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>rx</h4>
 <pre class="methodSignature">&lt;T extends <a href="RxInvoker.html" title="interface in javax.ws.rs.client">RxInvoker</a>&gt;&nbsp;T&nbsp;rx&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a>&lt;T&gt;&nbsp;clazz)</pre>
 <div class="block">Access a reactive invoker based on a <a href="RxInvoker.html" title="interface in javax.ws.rs.client"><code>RxInvoker</code></a> subclass provider. Note
  that corresponding <a href="RxInvokerProvider.html" title="interface in javax.ws.rs.client"><code>RxInvokerProvider</code></a> must be registered in the client runtime.
  <p>
  This method is an extension point for implementations to support other types
  representing asynchronous computations.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>clazz</code> - <a href="RxInvoker.html" title="interface in javax.ws.rs.client"><code>RxInvoker</code></a> subclass.</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>reactive invoker instance.</dd>
 <dt><span class="throwsLabel">Throws:</span></dt>
 <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalStateException</a></code> - when provider for given class is not registered.</dd>
 <dt><span class="simpleTagLabel">Since:</span></dt>
 <dd>2.1</dd>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="../core/Configurable.html#register(java.lang.Class)"><code>Configurable.register(Class)</code></a></dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 </section>
 </li>
 </ul>
 </div>
 </div>
 </main>
 <!-- ========= END OF CLASS DATA ========= -->
 <footer role="contentinfo">
 <nav role="navigation">
 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 <div class="bottomNav"><a id="navbar.bottom">
 <!--   -->
 </a>
 <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
 <a id="navbar.bottom.firstrow">
 <!--   -->
 </a>
 <ul class="navList" title="Navigation">
 <li><a href="../../../../index.html">Overview</a></li>
 <li><a href="package-summary.html">Package</a></li>
 <li class="navBarCell1Rev">Class</li>
 <li><a href="class-use/Invocation.Builder.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>
 <div class="subNav">
 <div>
 <ul class="subNavList">
 <li>Summary:&nbsp;</li>
 <li>Nested&nbsp;|&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li>Constr&nbsp;|&nbsp;</li>
 <li><a href="#method.summary">Method</a></li>
 </ul>
 <ul class="subNavList">
 <li>Detail:&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li>Constr&nbsp;|&nbsp;</li>
 <li><a href="#method.detail">Method</a></li>
 </ul>
 </div>
 </div>
 <a id="skip.navbar.bottom">
 <!--   -->
 </a>
 <!-- ======== END OF BOTTOM NAVBAR ======= -->
 </nav>
 <p class="legalCopy"><small>Copyright (c) 2019 Eclipse Foundation.                             Licensed under <a href="resources/EFSL.html">Eclipse Foundation                             Specification License</a>.</small></p>
 </footer>
 </body>
 </html>