blob: c3c49b8abb6e72e08b95ee878274c3c01f597c01 [file] [log] [blame]
<!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:53 PDT 2019 -->
<title>BackendRuleOrBuilder (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="BackendRuleOrBuilder (java API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../com/google/api/BackendRule.PathTranslation.html" title="enum in com.google.api"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../com/google/api/Billing.html" title="class in com.google.api"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?com/google/api/BackendRuleOrBuilder.html" target="_top">Frames</a></li>
<li><a href="BackendRuleOrBuilder.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.api</div>
<h2 title="Interface BackendRuleOrBuilder" class="title">Interface BackendRuleOrBuilder</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/api/BackendRule.html" title="class in com.google.api">BackendRule</a>, <a href="../../../com/google/api/BackendRule.Builder.html" title="class in com.google.api">BackendRule.Builder</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">BackendRuleOrBuilder</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></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>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/BackendRuleOrBuilder.html#getAddress--">getAddress</a></span>()</code>
<div class="block">
The address of the API backend.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/ByteString.html?is-external=true" title="class or interface in com.google.protobuf">ByteString</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/BackendRuleOrBuilder.html#getAddressBytes--">getAddressBytes</a></span>()</code>
<div class="block">
The address of the API backend.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../com/google/api/BackendRule.AuthenticationCase.html" title="enum in com.google.api">BackendRule.AuthenticationCase</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/BackendRuleOrBuilder.html#getAuthenticationCase--">getAuthenticationCase</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/BackendRuleOrBuilder.html#getDeadline--">getDeadline</a></span>()</code>
<div class="block">
The number of seconds to wait for a response from a request.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/BackendRuleOrBuilder.html#getJwtAudience--">getJwtAudience</a></span>()</code>
<div class="block">
The JWT audience is used when generating a JWT id token for the backend.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/ByteString.html?is-external=true" title="class or interface in com.google.protobuf">ByteString</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/BackendRuleOrBuilder.html#getJwtAudienceBytes--">getJwtAudienceBytes</a></span>()</code>
<div class="block">
The JWT audience is used when generating a JWT id token for the backend.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/BackendRuleOrBuilder.html#getMinDeadline--">getMinDeadline</a></span>()</code>
<div class="block">
Minimum deadline in seconds needed for this method.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/BackendRuleOrBuilder.html#getOperationDeadline--">getOperationDeadline</a></span>()</code>
<div class="block">
The number of seconds to wait for the completion of a long running
operation.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="../../../com/google/api/BackendRule.PathTranslation.html" title="enum in com.google.api">BackendRule.PathTranslation</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/BackendRuleOrBuilder.html#getPathTranslation--">getPathTranslation</a></span>()</code>
<div class="block"><code>.google.api.BackendRule.PathTranslation path_translation = 6;</code></div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/BackendRuleOrBuilder.html#getPathTranslationValue--">getPathTranslationValue</a></span>()</code>
<div class="block"><code>.google.api.BackendRule.PathTranslation path_translation = 6;</code></div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/BackendRuleOrBuilder.html#getSelector--">getSelector</a></span>()</code>
<div class="block">
Selects the methods to which this rule applies.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code><a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/ByteString.html?is-external=true" title="class or interface in com.google.protobuf">ByteString</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/BackendRuleOrBuilder.html#getSelectorBytes--">getSelectorBytes</a></span>()</code>
<div class="block">
Selects the methods to which this rule applies.</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="getSelector--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSelector</h4>
<pre>java.lang.String&nbsp;getSelector()</pre>
<div class="block"><pre>
Selects the methods to which this rule applies.
Refer to [selector][google.api.DocumentationRule.selector] for syntax details.
</pre>
<code>string selector = 1;</code></div>
</li>
</ul>
<a name="getSelectorBytes--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSelectorBytes</h4>
<pre><a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/ByteString.html?is-external=true" title="class or interface in com.google.protobuf">ByteString</a>&nbsp;getSelectorBytes()</pre>
<div class="block"><pre>
Selects the methods to which this rule applies.
Refer to [selector][google.api.DocumentationRule.selector] for syntax details.
</pre>
<code>string selector = 1;</code></div>
</li>
</ul>
<a name="getAddress--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAddress</h4>
<pre>java.lang.String&nbsp;getAddress()</pre>
<div class="block"><pre>
The address of the API backend.
</pre>
<code>string address = 2;</code></div>
</li>
</ul>
<a name="getAddressBytes--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAddressBytes</h4>
<pre><a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/ByteString.html?is-external=true" title="class or interface in com.google.protobuf">ByteString</a>&nbsp;getAddressBytes()</pre>
<div class="block"><pre>
The address of the API backend.
</pre>
<code>string address = 2;</code></div>
</li>
</ul>
<a name="getDeadline--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDeadline</h4>
<pre>double&nbsp;getDeadline()</pre>
<div class="block"><pre>
The number of seconds to wait for a response from a request. The default
deadline for gRPC is infinite (no deadline) and HTTP requests is 5 seconds.
</pre>
<code>double deadline = 3;</code></div>
</li>
</ul>
<a name="getMinDeadline--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMinDeadline</h4>
<pre>double&nbsp;getMinDeadline()</pre>
<div class="block"><pre>
Minimum deadline in seconds needed for this method. Calls having deadline
value lower than this will be rejected.
</pre>
<code>double min_deadline = 4;</code></div>
</li>
</ul>
<a name="getOperationDeadline--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOperationDeadline</h4>
<pre>double&nbsp;getOperationDeadline()</pre>
<div class="block"><pre>
The number of seconds to wait for the completion of a long running
operation. The default is no deadline.
</pre>
<code>double operation_deadline = 5;</code></div>
</li>
</ul>
<a name="getPathTranslationValue--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPathTranslationValue</h4>
<pre>int&nbsp;getPathTranslationValue()</pre>
<div class="block"><code>.google.api.BackendRule.PathTranslation path_translation = 6;</code></div>
</li>
</ul>
<a name="getPathTranslation--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPathTranslation</h4>
<pre><a href="../../../com/google/api/BackendRule.PathTranslation.html" title="enum in com.google.api">BackendRule.PathTranslation</a>&nbsp;getPathTranslation()</pre>
<div class="block"><code>.google.api.BackendRule.PathTranslation path_translation = 6;</code></div>
</li>
</ul>
<a name="getJwtAudience--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getJwtAudience</h4>
<pre>java.lang.String&nbsp;getJwtAudience()</pre>
<div class="block"><pre>
The JWT audience is used when generating a JWT id token for the backend.
</pre>
<code>string jwt_audience = 7;</code></div>
</li>
</ul>
<a name="getJwtAudienceBytes--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getJwtAudienceBytes</h4>
<pre><a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/ByteString.html?is-external=true" title="class or interface in com.google.protobuf">ByteString</a>&nbsp;getJwtAudienceBytes()</pre>
<div class="block"><pre>
The JWT audience is used when generating a JWT id token for the backend.
</pre>
<code>string jwt_audience = 7;</code></div>
</li>
</ul>
<a name="getAuthenticationCase--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getAuthenticationCase</h4>
<pre><a href="../../../com/google/api/BackendRule.AuthenticationCase.html" title="enum in com.google.api">BackendRule.AuthenticationCase</a>&nbsp;getAuthenticationCase()</pre>
</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/api/BackendRule.PathTranslation.html" title="enum in com.google.api"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../com/google/api/Billing.html" title="class in com.google.api"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?com/google/api/BackendRuleOrBuilder.html" target="_top">Frames</a></li>
<li><a href="BackendRuleOrBuilder.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>