blob: eb3ea2cab2dee297622cdad5b7af13794ace0ef7 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>LoadBalanceRequestOrBuilder (grpc-all 1.73.0 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.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.7.1.min.js"></script>
<script type="text/javascript" src="../../../../jquery/jquery-ui.min.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="LoadBalanceRequestOrBuilder (grpc-all 1.73.0 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":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/LoadBalanceRequestOrBuilder.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">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<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>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</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 id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= 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">io.grpc.lb.v1</a></div>
<h2 title="Interface LoadBalanceRequestOrBuilder" class="title">Interface LoadBalanceRequestOrBuilder</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><code><a href="https://protobuf.dev/reference/java/api-docs/com/google/protobuf/MessageLiteOrBuilder.html?is-external=true" title="class or interface in com.google.protobuf" class="externalLink">MessageLiteOrBuilder</a></code>, <code><a href="https://protobuf.dev/reference/java/api-docs/com/google/protobuf/MessageOrBuilder.html?is-external=true" title="class or interface in com.google.protobuf" class="externalLink">MessageOrBuilder</a></code></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="LoadBalanceRequest.html" title="class in io.grpc.lb.v1">LoadBalanceRequest</a></code>, <code><a href="LoadBalanceRequest.Builder.html" title="class in io.grpc.lb.v1">LoadBalanceRequest.Builder</a></code></dd>
</dl>
<hr>
<pre>public interface <span class="typeNameLabel">LoadBalanceRequestOrBuilder</span>
extends <a href="https://protobuf.dev/reference/java/api-docs/com/google/protobuf/MessageOrBuilder.html?is-external=true" title="class or interface in com.google.protobuf" class="externalLink">MessageOrBuilder</a></pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="ClientStats.html" title="class in io.grpc.lb.v1">ClientStats</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getClientStats()">getClientStats</a></span>()</code></th>
<td class="colLast">
<div class="block">
The client stats should be periodically reported to the load balancer
based on the duration defined in the InitialLoadBalanceResponse.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="ClientStatsOrBuilder.html" title="interface in io.grpc.lb.v1">ClientStatsOrBuilder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getClientStatsOrBuilder()">getClientStatsOrBuilder</a></span>()</code></th>
<td class="colLast">
<div class="block">
The client stats should be periodically reported to the load balancer
based on the duration defined in the InitialLoadBalanceResponse.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="InitialLoadBalanceRequest.html" title="class in io.grpc.lb.v1">InitialLoadBalanceRequest</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getInitialRequest()">getInitialRequest</a></span>()</code></th>
<td class="colLast">
<div class="block">
This message should be sent on the first request to the load balancer.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="InitialLoadBalanceRequestOrBuilder.html" title="interface in io.grpc.lb.v1">InitialLoadBalanceRequestOrBuilder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getInitialRequestOrBuilder()">getInitialRequestOrBuilder</a></span>()</code></th>
<td class="colLast">
<div class="block">
This message should be sent on the first request to the load balancer.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="LoadBalanceRequest.LoadBalanceRequestTypeCase.html" title="enum in io.grpc.lb.v1">LoadBalanceRequest.LoadBalanceRequestTypeCase</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLoadBalanceRequestTypeCase()">getLoadBalanceRequestTypeCase</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hasClientStats()">hasClientStats</a></span>()</code></th>
<td class="colLast">
<div class="block">
The client stats should be periodically reported to the load balancer
based on the duration defined in the InitialLoadBalanceResponse.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hasInitialRequest()">hasInitialRequest</a></span>()</code></th>
<td class="colLast">
<div class="block">
This message should be sent on the first request to the load balancer.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.com.google.protobuf.MessageLiteOrBuilder">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;com.google.protobuf.<a href="https://protobuf.dev/reference/java/api-docs/com/google/protobuf/MessageLiteOrBuilder.html?is-external=true" title="class or interface in com.google.protobuf" class="externalLink">MessageLiteOrBuilder</a></h3>
<code><a href="https://protobuf.dev/reference/java/api-docs/com/google/protobuf/MessageLiteOrBuilder.html?is-external=true#isInitialized--" title="class or interface in com.google.protobuf" class="externalLink">isInitialized</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.com.google.protobuf.MessageOrBuilder">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;com.google.protobuf.<a href="https://protobuf.dev/reference/java/api-docs/com/google/protobuf/MessageOrBuilder.html?is-external=true" title="class or interface in com.google.protobuf" class="externalLink">MessageOrBuilder</a></h3>
<code><a href="https://protobuf.dev/reference/java/api-docs/com/google/protobuf/MessageOrBuilder.html?is-external=true#findInitializationErrors--" title="class or interface in com.google.protobuf" class="externalLink">findInitializationErrors</a>, <a href="https://protobuf.dev/reference/java/api-docs/com/google/protobuf/MessageOrBuilder.html?is-external=true#getAllFields--" title="class or interface in com.google.protobuf" class="externalLink">getAllFields</a>, <a href="https://protobuf.dev/reference/java/api-docs/com/google/protobuf/MessageOrBuilder.html?is-external=true#getDefaultInstanceForType--" title="class or interface in com.google.protobuf" class="externalLink">getDefaultInstanceForType</a>, <a href="https://protobuf.dev/reference/java/api-docs/com/google/protobuf/MessageOrBuilder.html?is-external=true#getDescriptorForType--" title="class or interface in com.google.protobuf" class="externalLink">getDescriptorForType</a>, <a href="https://protobuf.dev/reference/java/api-docs/com/google/protobuf/MessageOrBuilder.html?is-external=true#getField-com.google.protobuf.Descriptors.FieldDescriptor-" title="class or interface in com.google.protobuf" class="externalLink">getField</a>, <a href="https://protobuf.dev/reference/java/api-docs/com/google/protobuf/MessageOrBuilder.html?is-external=true#getInitializationErrorString--" title="class or interface in com.google.protobuf" class="externalLink">getInitializationErrorString</a>, <a href="https://protobuf.dev/reference/java/api-docs/com/google/protobuf/MessageOrBuilder.html?is-external=true#getOneofFieldDescriptor-com.google.protobuf.Descriptors.OneofDescriptor-" title="class or interface in com.google.protobuf" class="externalLink">getOneofFieldDescriptor</a>, <a href="https://protobuf.dev/reference/java/api-docs/com/google/protobuf/MessageOrBuilder.html?is-external=true#getRepeatedField-com.google.protobuf.Descriptors.FieldDescriptor-int-" title="class or interface in com.google.protobuf" class="externalLink">getRepeatedField</a>, <a href="https://protobuf.dev/reference/java/api-docs/com/google/protobuf/MessageOrBuilder.html?is-external=true#getRepeatedFieldCount-com.google.protobuf.Descriptors.FieldDescriptor-" title="class or interface in com.google.protobuf" class="externalLink">getRepeatedFieldCount</a>, <a href="https://protobuf.dev/reference/java/api-docs/com/google/protobuf/MessageOrBuilder.html?is-external=true#getUnknownFields--" title="class or interface in com.google.protobuf" class="externalLink">getUnknownFields</a>, <a href="https://protobuf.dev/reference/java/api-docs/com/google/protobuf/MessageOrBuilder.html?is-external=true#hasField-com.google.protobuf.Descriptors.FieldDescriptor-" title="class or interface in com.google.protobuf" class="externalLink">hasField</a>, <a href="https://protobuf.dev/reference/java/api-docs/com/google/protobuf/MessageOrBuilder.html?is-external=true#hasOneof-com.google.protobuf.Descriptors.OneofDescriptor-" title="class or interface in com.google.protobuf" class="externalLink">hasOneof</a></code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="hasInitialRequest()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasInitialRequest</h4>
<pre class="methodSignature">boolean&nbsp;hasInitialRequest()</pre>
<div class="block"><pre>
This message should be sent on the first request to the load balancer.
</pre>
<code>.grpc.lb.v1.InitialLoadBalanceRequest initial_request = 1;</code></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Whether the initialRequest field is set.</dd>
</dl>
</li>
</ul>
<a id="getInitialRequest()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInitialRequest</h4>
<pre class="methodSignature"><a href="InitialLoadBalanceRequest.html" title="class in io.grpc.lb.v1">InitialLoadBalanceRequest</a>&nbsp;getInitialRequest()</pre>
<div class="block"><pre>
This message should be sent on the first request to the load balancer.
</pre>
<code>.grpc.lb.v1.InitialLoadBalanceRequest initial_request = 1;</code></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The initialRequest.</dd>
</dl>
</li>
</ul>
<a id="getInitialRequestOrBuilder()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInitialRequestOrBuilder</h4>
<pre class="methodSignature"><a href="InitialLoadBalanceRequestOrBuilder.html" title="interface in io.grpc.lb.v1">InitialLoadBalanceRequestOrBuilder</a>&nbsp;getInitialRequestOrBuilder()</pre>
<div class="block"><pre>
This message should be sent on the first request to the load balancer.
</pre>
<code>.grpc.lb.v1.InitialLoadBalanceRequest initial_request = 1;</code></div>
</li>
</ul>
<a id="hasClientStats()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasClientStats</h4>
<pre class="methodSignature">boolean&nbsp;hasClientStats()</pre>
<div class="block"><pre>
The client stats should be periodically reported to the load balancer
based on the duration defined in the InitialLoadBalanceResponse.
</pre>
<code>.grpc.lb.v1.ClientStats client_stats = 2;</code></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Whether the clientStats field is set.</dd>
</dl>
</li>
</ul>
<a id="getClientStats()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getClientStats</h4>
<pre class="methodSignature"><a href="ClientStats.html" title="class in io.grpc.lb.v1">ClientStats</a>&nbsp;getClientStats()</pre>
<div class="block"><pre>
The client stats should be periodically reported to the load balancer
based on the duration defined in the InitialLoadBalanceResponse.
</pre>
<code>.grpc.lb.v1.ClientStats client_stats = 2;</code></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The clientStats.</dd>
</dl>
</li>
</ul>
<a id="getClientStatsOrBuilder()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getClientStatsOrBuilder</h4>
<pre class="methodSignature"><a href="ClientStatsOrBuilder.html" title="interface in io.grpc.lb.v1">ClientStatsOrBuilder</a>&nbsp;getClientStatsOrBuilder()</pre>
<div class="block"><pre>
The client stats should be periodically reported to the load balancer
based on the duration defined in the InitialLoadBalanceResponse.
</pre>
<code>.grpc.lb.v1.ClientStats client_stats = 2;</code></div>
</li>
</ul>
<a id="getLoadBalanceRequestTypeCase()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getLoadBalanceRequestTypeCase</h4>
<pre class="methodSignature"><a href="LoadBalanceRequest.LoadBalanceRequestTypeCase.html" title="enum in io.grpc.lb.v1">LoadBalanceRequest.LoadBalanceRequestTypeCase</a>&nbsp;getLoadBalanceRequestTypeCase()</pre>
</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/LoadBalanceRequestOrBuilder.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">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses.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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</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 id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
</footer>
</body>
</html>