java/all/latest/apidocs/com/google/appengine/v1/TrafficSplitOrBuilder.html - third_party/googleapis - Git at Google

 <!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_181-google-v7) on Fri Oct 04 15:32:50 PDT 2019 -->
 <title>TrafficSplitOrBuilder (java API)</title>
 <meta name="date" content="2019-10-04">
 <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="TrafficSplitOrBuilder (java API)";
         }
     }
     catch(err) {
     }
 //-->
 var methods = {"i0":6,"i1":38,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6};
 var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],32:["t6","Deprecated 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="../../../../com/google/appengine/v1/TrafficSplit.ShardBy.html" title="enum in com.google.appengine.v1"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
 <li><a href="../../../../com/google/appengine/v1/UpdateServiceMethod.html" title="class in com.google.appengine.v1"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
 </ul>
 <ul class="navList">
 <li><a href="../../../../index.html?com/google/appengine/v1/TrafficSplitOrBuilder.html" target="_top">Frames</a></li>
 <li><a href="TrafficSplitOrBuilder.html" target="_top">No&nbsp;Frames</a></li>
 </ul>
 <ul class="navList" id="allclasses_navbar_top">
 <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
 </ul>
 <div>
 <script type="text/javascript"><!--
   allClassesLink = document.getElementById("allclasses_navbar_top");
   if(window==top) {
     allClassesLink.style.display = "block";
   }
   else {
     allClassesLink.style.display = "none";
   }
   //-->
 </script>
 </div>
 <div>
 <ul class="subNavList">
 <li>Summary:&nbsp;</li>
 <li>Nested&nbsp;|&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li>Constr&nbsp;|&nbsp;</li>
 <li><a href="#method.summary">Method</a></li>
 </ul>
 <ul class="subNavList">
 <li>Detail:&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li>Constr&nbsp;|&nbsp;</li>
 <li><a href="#method.detail">Method</a></li>
 </ul>
 </div>
 <a name="skip.navbar.top">
 <!--   -->
 </a></div>
 <!-- ========= END OF TOP NAVBAR ========= -->
 <!-- ======== START OF CLASS DATA ======== -->
 <div class="header">
 <div class="subTitle">com.google.appengine.v1</div>
 <h2 title="Interface TrafficSplitOrBuilder" class="title">Interface TrafficSplitOrBuilder</h2>
 </div>
 <div class="contentContainer">
 <div class="description">
 <ul class="blockList">
 <li class="blockList">
 <dl>
 <dt>All Superinterfaces:</dt>
 <dd><a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageLiteOrBuilder.html?is-external=true" title="class or interface in com.google.protobuf">MessageLiteOrBuilder</a>, <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true" title="class or interface in com.google.protobuf">MessageOrBuilder</a></dd>
 </dl>
 <dl>
 <dt>All Known Implementing Classes:</dt>
 <dd><a href="../../../../com/google/appengine/v1/TrafficSplit.html" title="class in com.google.appengine.v1">TrafficSplit</a>, <a href="../../../../com/google/appengine/v1/TrafficSplit.Builder.html" title="class in com.google.appengine.v1">TrafficSplit.Builder</a></dd>
 </dl>
 <hr>
 <br>
 <pre>public interface <span class="typeNameLabel">TrafficSplitOrBuilder</span>
 extends <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true" title="class or interface in com.google.protobuf">MessageOrBuilder</a></pre>
 </li>
 </ul>
 </div>
 <div class="summary">
 <ul class="blockList">
 <li class="blockList">
 <!-- ========== METHOD SUMMARY =========== -->
 <ul class="blockList">
 <li class="blockList"><a name="method.summary">
 <!--   -->
 </a>
 <h3>Method Summary</h3>
 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
 <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
 <tr>
 <th class="colFirst" scope="col">Modifier and Type</th>
 <th class="colLast" scope="col">Method and Description</th>
 </tr>
 <tr id="i0" class="altColor">
 <td class="colFirst"><code>boolean</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/google/appengine/v1/TrafficSplitOrBuilder.html#containsAllocations-java.lang.String-">containsAllocations</a></span>(java.lang.String&nbsp;key)</code>
 <div class="block">
  Mapping from version IDs within the service to fractional
  (0.000, 1] allocations of traffic for that version.</div>
 </td>
 </tr>
 <tr id="i1" class="rowColor">
 <td class="colFirst"><code>java.util.Map&lt;java.lang.String,java.lang.Double&gt;</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/google/appengine/v1/TrafficSplitOrBuilder.html#getAllocations--">getAllocations</a></span>()</code>
 <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
 </td>
 </tr>
 <tr id="i2" class="altColor">
 <td class="colFirst"><code>int</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/google/appengine/v1/TrafficSplitOrBuilder.html#getAllocationsCount--">getAllocationsCount</a></span>()</code>
 <div class="block">
  Mapping from version IDs within the service to fractional
  (0.000, 1] allocations of traffic for that version.</div>
 </td>
 </tr>
 <tr id="i3" class="rowColor">
 <td class="colFirst"><code>java.util.Map&lt;java.lang.String,java.lang.Double&gt;</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/google/appengine/v1/TrafficSplitOrBuilder.html#getAllocationsMap--">getAllocationsMap</a></span>()</code>
 <div class="block">
  Mapping from version IDs within the service to fractional
  (0.000, 1] allocations of traffic for that version.</div>
 </td>
 </tr>
 <tr id="i4" class="altColor">
 <td class="colFirst"><code>double</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/google/appengine/v1/TrafficSplitOrBuilder.html#getAllocationsOrDefault-java.lang.String-double-">getAllocationsOrDefault</a></span>(java.lang.String&nbsp;key,
                        double&nbsp;defaultValue)</code>
 <div class="block">
  Mapping from version IDs within the service to fractional
  (0.000, 1] allocations of traffic for that version.</div>
 </td>
 </tr>
 <tr id="i5" class="rowColor">
 <td class="colFirst"><code>double</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/google/appengine/v1/TrafficSplitOrBuilder.html#getAllocationsOrThrow-java.lang.String-">getAllocationsOrThrow</a></span>(java.lang.String&nbsp;key)</code>
 <div class="block">
  Mapping from version IDs within the service to fractional
  (0.000, 1] allocations of traffic for that version.</div>
 </td>
 </tr>
 <tr id="i6" class="altColor">
 <td class="colFirst"><code><a href="../../../../com/google/appengine/v1/TrafficSplit.ShardBy.html" title="enum in com.google.appengine.v1">TrafficSplit.ShardBy</a></code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/google/appengine/v1/TrafficSplitOrBuilder.html#getShardBy--">getShardBy</a></span>()</code>
 <div class="block">
  Mechanism used to determine which version a request is sent to.</div>
 </td>
 </tr>
 <tr id="i7" class="rowColor">
 <td class="colFirst"><code>int</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/google/appengine/v1/TrafficSplitOrBuilder.html#getShardByValue--">getShardByValue</a></span>()</code>
 <div class="block">
  Mechanism used to determine which version a request is sent to.</div>
 </td>
 </tr>
 </table>
 <ul class="blockList">
 <li class="blockList"><a name="methods.inherited.from.class.com.google.protobuf.MessageOrBuilder">
 <!--   -->
 </a>
 <h3>Methods inherited from interface&nbsp;com.google.protobuf.<a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true" title="class or interface in com.google.protobuf">MessageOrBuilder</a></h3>
 <code><a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true#findInitializationErrors--" title="class or interface in com.google.protobuf">findInitializationErrors</a>, <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true#getAllFields--" title="class or interface in com.google.protobuf">getAllFields</a>, <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true#getDefaultInstanceForType--" title="class or interface in com.google.protobuf">getDefaultInstanceForType</a>, <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true#getDescriptorForType--" title="class or interface in com.google.protobuf">getDescriptorForType</a>, <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true#getField-com.google.protobuf.Descriptors.FieldDescriptor-" title="class or interface in com.google.protobuf">getField</a>, <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true#getInitializationErrorString--" title="class or interface in com.google.protobuf">getInitializationErrorString</a>, <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true#getOneofFieldDescriptor-com.google.protobuf.Descriptors.OneofDescriptor-" title="class or interface in com.google.protobuf">getOneofFieldDescriptor</a>, <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true#getRepeatedField-com.google.protobuf.Descriptors.FieldDescriptor-int-" title="class or interface in com.google.protobuf">getRepeatedField</a>, <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true#getRepeatedFieldCount-com.google.protobuf.Descriptors.FieldDescriptor-" title="class or interface in com.google.protobuf">getRepeatedFieldCount</a>, <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true#getUnknownFields--" title="class or interface in com.google.protobuf">getUnknownFields</a>, <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true#hasField-com.google.protobuf.Descriptors.FieldDescriptor-" title="class or interface in com.google.protobuf">hasField</a>, <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true#hasOneof-com.google.protobuf.Descriptors.OneofDescriptor-" title="class or interface in com.google.protobuf">hasOneof</a></code></li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="methods.inherited.from.class.com.google.protobuf.MessageLiteOrBuilder">
 <!--   -->
 </a>
 <h3>Methods inherited from interface&nbsp;com.google.protobuf.<a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageLiteOrBuilder.html?is-external=true" title="class or interface in com.google.protobuf">MessageLiteOrBuilder</a></h3>
 <code><a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageLiteOrBuilder.html?is-external=true#isInitialized--" title="class or interface in com.google.protobuf">isInitialized</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="getShardByValue--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getShardByValue</h4>
 <pre>int&nbsp;getShardByValue()</pre>
 <div class="block"><pre>
  Mechanism used to determine which version a request is sent to.
  The traffic selection algorithm will
  be stable for either type until allocations are changed.
  </pre>

  <code>.google.appengine.v1.TrafficSplit.ShardBy shard_by = 1;</code></div>
 </li>
 </ul>
 <a name="getShardBy--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getShardBy</h4>
 <pre><a href="../../../../com/google/appengine/v1/TrafficSplit.ShardBy.html" title="enum in com.google.appengine.v1">TrafficSplit.ShardBy</a>&nbsp;getShardBy()</pre>
 <div class="block"><pre>
  Mechanism used to determine which version a request is sent to.
  The traffic selection algorithm will
  be stable for either type until allocations are changed.
  </pre>

  <code>.google.appengine.v1.TrafficSplit.ShardBy shard_by = 1;</code></div>
 </li>
 </ul>
 <a name="getAllocationsCount--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getAllocationsCount</h4>
 <pre>int&nbsp;getAllocationsCount()</pre>
 <div class="block"><pre>
  Mapping from version IDs within the service to fractional
  (0.000, 1] allocations of traffic for that version. Each version can
  be specified only once, but some versions in the service may not
  have any traffic allocation. Services that have traffic allocated
  cannot be deleted until either the service is deleted or
  their traffic allocation is removed. Allocations must sum to 1.
  Up to two decimal place precision is supported for IP-based splits and
  up to three decimal places is supported for cookie-based splits.
  </pre>

  <code>map&lt;string, double&gt; allocations = 2;</code></div>
 </li>
 </ul>
 <a name="containsAllocations-java.lang.String-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>containsAllocations</h4>
 <pre>boolean&nbsp;containsAllocations(java.lang.String&nbsp;key)</pre>
 <div class="block"><pre>
  Mapping from version IDs within the service to fractional
  (0.000, 1] allocations of traffic for that version. Each version can
  be specified only once, but some versions in the service may not
  have any traffic allocation. Services that have traffic allocated
  cannot be deleted until either the service is deleted or
  their traffic allocation is removed. Allocations must sum to 1.
  Up to two decimal place precision is supported for IP-based splits and
  up to three decimal places is supported for cookie-based splits.
  </pre>

  <code>map&lt;string, double&gt; allocations = 2;</code></div>
 </li>
 </ul>
 <a name="getAllocations--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getAllocations</h4>
 <pre>@Deprecated
 java.util.Map&lt;java.lang.String,java.lang.Double&gt;&nbsp;getAllocations()</pre>
 <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
 <div class="block">Use <a href="../../../../com/google/appengine/v1/TrafficSplitOrBuilder.html#getAllocationsMap--"><code>getAllocationsMap()</code></a> instead.</div>
 </li>
 </ul>
 <a name="getAllocationsMap--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getAllocationsMap</h4>
 <pre>java.util.Map&lt;java.lang.String,java.lang.Double&gt;&nbsp;getAllocationsMap()</pre>
 <div class="block"><pre>
  Mapping from version IDs within the service to fractional
  (0.000, 1] allocations of traffic for that version. Each version can
  be specified only once, but some versions in the service may not
  have any traffic allocation. Services that have traffic allocated
  cannot be deleted until either the service is deleted or
  their traffic allocation is removed. Allocations must sum to 1.
  Up to two decimal place precision is supported for IP-based splits and
  up to three decimal places is supported for cookie-based splits.
  </pre>

  <code>map&lt;string, double&gt; allocations = 2;</code></div>
 </li>
 </ul>
 <a name="getAllocationsOrDefault-java.lang.String-double-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getAllocationsOrDefault</h4>
 <pre>double&nbsp;getAllocationsOrDefault(java.lang.String&nbsp;key,
                                double&nbsp;defaultValue)</pre>
 <div class="block"><pre>
  Mapping from version IDs within the service to fractional
  (0.000, 1] allocations of traffic for that version. Each version can
  be specified only once, but some versions in the service may not
  have any traffic allocation. Services that have traffic allocated
  cannot be deleted until either the service is deleted or
  their traffic allocation is removed. Allocations must sum to 1.
  Up to two decimal place precision is supported for IP-based splits and
  up to three decimal places is supported for cookie-based splits.
  </pre>

  <code>map&lt;string, double&gt; allocations = 2;</code></div>
 </li>
 </ul>
 <a name="getAllocationsOrThrow-java.lang.String-">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>getAllocationsOrThrow</h4>
 <pre>double&nbsp;getAllocationsOrThrow(java.lang.String&nbsp;key)</pre>
 <div class="block"><pre>
  Mapping from version IDs within the service to fractional
  (0.000, 1] allocations of traffic for that version. Each version can
  be specified only once, but some versions in the service may not
  have any traffic allocation. Services that have traffic allocated
  cannot be deleted until either the service is deleted or
  their traffic allocation is removed. Allocations must sum to 1.
  Up to two decimal place precision is supported for IP-based splits and
  up to three decimal places is supported for cookie-based splits.
  </pre>

  <code>map&lt;string, double&gt; allocations = 2;</code></div>
 </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="../../../../com/google/appengine/v1/TrafficSplit.ShardBy.html" title="enum in com.google.appengine.v1"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
 <li><a href="../../../../com/google/appengine/v1/UpdateServiceMethod.html" title="class in com.google.appengine.v1"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
 </ul>
 <ul class="navList">
 <li><a href="../../../../index.html?com/google/appengine/v1/TrafficSplitOrBuilder.html" target="_top">Frames</a></li>
 <li><a href="TrafficSplitOrBuilder.html" target="_top">No&nbsp;Frames</a></li>
 </ul>
 <ul class="navList" id="allclasses_navbar_bottom">
 <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
 </ul>
 <div>
 <script type="text/javascript"><!--
   allClassesLink = document.getElementById("allclasses_navbar_bottom");
   if(window==top) {
     allClassesLink.style.display = "block";
   }
   else {
     allClassesLink.style.display = "none";
   }
   //-->
 </script>
 </div>
 <div>
 <ul class="subNavList">
 <li>Summary:&nbsp;</li>
 <li>Nested&nbsp;|&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li>Constr&nbsp;|&nbsp;</li>
 <li><a href="#method.summary">Method</a></li>
 </ul>
 <ul class="subNavList">
 <li>Detail:&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li>Constr&nbsp;|&nbsp;</li>
 <li><a href="#method.detail">Method</a></li>
 </ul>
 </div>
 <a name="skip.navbar.bottom">
 <!--   -->
 </a></div>
 <!-- ======== END OF BOTTOM NAVBAR ======= -->
 </body>
 </html>