Google Git
Sign in
fuchsia / third_party / googleapis / upstream/gh-pages / . / java / all / latest / apidocs / com / google / api / AuthenticationRuleOrBuilder.html
blob: eb72b2a6d405d16b63da7abdd33c8b94ecbe36ad [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>AuthenticationRuleOrBuilder (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="AuthenticationRuleOrBuilder (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};
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/AuthenticationRule.Builder.html" title="class in com.google.api"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../com/google/api/AuthProto.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/AuthenticationRuleOrBuilder.html" target="_top">Frames</a></li>
<li><a href="AuthenticationRuleOrBuilder.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 AuthenticationRuleOrBuilder" class="title">Interface AuthenticationRuleOrBuilder</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/AuthenticationRule.html" title="class in com.google.api">AuthenticationRule</a>, <a href="../../../com/google/api/AuthenticationRule.Builder.html" title="class in com.google.api">AuthenticationRule.Builder</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">AuthenticationRuleOrBuilder</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>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/AuthenticationRuleOrBuilder.html#getAllowWithoutCredential--">getAllowWithoutCredential</a></span>()</code>
<div class="block">
If true, the service accepts API keys without any other credential.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../com/google/api/OAuthRequirements.html" title="class in com.google.api">OAuthRequirements</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/AuthenticationRuleOrBuilder.html#getOauth--">getOauth</a></span>()</code>
<div class="block">
The requirements for OAuth credentials.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../com/google/api/OAuthRequirementsOrBuilder.html" title="interface in com.google.api">OAuthRequirementsOrBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/AuthenticationRuleOrBuilder.html#getOauthOrBuilder--">getOauthOrBuilder</a></span>()</code>
<div class="block">
The requirements for OAuth credentials.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../com/google/api/AuthRequirement.html" title="class in com.google.api">AuthRequirement</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/AuthenticationRuleOrBuilder.html#getRequirements-int-">getRequirements</a></span>(int&nbsp;index)</code>
<div class="block">
Requirements for additional authentication providers.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/AuthenticationRuleOrBuilder.html#getRequirementsCount--">getRequirementsCount</a></span>()</code>
<div class="block">
Requirements for additional authentication providers.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>java.util.List&lt;<a href="../../../com/google/api/AuthRequirement.html" title="class in com.google.api">AuthRequirement</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/AuthenticationRuleOrBuilder.html#getRequirementsList--">getRequirementsList</a></span>()</code>
<div class="block">
Requirements for additional authentication providers.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../../com/google/api/AuthRequirementOrBuilder.html" title="interface in com.google.api">AuthRequirementOrBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/AuthenticationRuleOrBuilder.html#getRequirementsOrBuilder-int-">getRequirementsOrBuilder</a></span>(int&nbsp;index)</code>
<div class="block">
Requirements for additional authentication providers.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>java.util.List&lt;? extends <a href="../../../com/google/api/AuthRequirementOrBuilder.html" title="interface in com.google.api">AuthRequirementOrBuilder</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/AuthenticationRuleOrBuilder.html#getRequirementsOrBuilderList--">getRequirementsOrBuilderList</a></span>()</code>
<div class="block">
Requirements for additional authentication providers.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/AuthenticationRuleOrBuilder.html#getSelector--">getSelector</a></span>()</code>
<div class="block">
Selects the methods to which this rule applies.</div>
</td>
</tr>
<tr id="i9" 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/AuthenticationRuleOrBuilder.html#getSelectorBytes--">getSelectorBytes</a></span>()</code>
<div class="block">
Selects the methods to which this rule applies.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/AuthenticationRuleOrBuilder.html#hasOauth--">hasOauth</a></span>()</code>
<div class="block">
The requirements for OAuth credentials.</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="hasOauth--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasOauth</h4>
<pre>boolean&nbsp;hasOauth()</pre>
<div class="block"><pre>
The requirements for OAuth credentials.
</pre>
<code>.google.api.OAuthRequirements oauth = 2;</code></div>
</li>
</ul>
<a name="getOauth--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOauth</h4>
<pre><a href="../../../com/google/api/OAuthRequirements.html" title="class in com.google.api">OAuthRequirements</a>&nbsp;getOauth()</pre>
<div class="block"><pre>
The requirements for OAuth credentials.
</pre>
<code>.google.api.OAuthRequirements oauth = 2;</code></div>
</li>
</ul>
<a name="getOauthOrBuilder--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOauthOrBuilder</h4>
<pre><a href="../../../com/google/api/OAuthRequirementsOrBuilder.html" title="interface in com.google.api">OAuthRequirementsOrBuilder</a>&nbsp;getOauthOrBuilder()</pre>
<div class="block"><pre>
The requirements for OAuth credentials.
</pre>
<code>.google.api.OAuthRequirements oauth = 2;</code></div>
</li>
</ul>
<a name="getAllowWithoutCredential--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAllowWithoutCredential</h4>
<pre>boolean&nbsp;getAllowWithoutCredential()</pre>
<div class="block"><pre>
If true, the service accepts API keys without any other credential.
</pre>
<code>bool allow_without_credential = 5;</code></div>
</li>
</ul>
<a name="getRequirementsList--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRequirementsList</h4>
<pre>java.util.List&lt;<a href="../../../com/google/api/AuthRequirement.html" title="class in com.google.api">AuthRequirement</a>&gt;&nbsp;getRequirementsList()</pre>
<div class="block"><pre>
Requirements for additional authentication providers.
</pre>
<code>repeated .google.api.AuthRequirement requirements = 7;</code></div>
</li>
</ul>
<a name="getRequirements-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRequirements</h4>
<pre><a href="../../../com/google/api/AuthRequirement.html" title="class in com.google.api">AuthRequirement</a>&nbsp;getRequirements(int&nbsp;index)</pre>
<div class="block"><pre>
Requirements for additional authentication providers.
</pre>
<code>repeated .google.api.AuthRequirement requirements = 7;</code></div>
</li>
</ul>
<a name="getRequirementsCount--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRequirementsCount</h4>
<pre>int&nbsp;getRequirementsCount()</pre>
<div class="block"><pre>
Requirements for additional authentication providers.
</pre>
<code>repeated .google.api.AuthRequirement requirements = 7;</code></div>
</li>
</ul>
<a name="getRequirementsOrBuilderList--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRequirementsOrBuilderList</h4>
<pre>java.util.List&lt;? extends <a href="../../../com/google/api/AuthRequirementOrBuilder.html" title="interface in com.google.api">AuthRequirementOrBuilder</a>&gt;&nbsp;getRequirementsOrBuilderList()</pre>
<div class="block"><pre>
Requirements for additional authentication providers.
</pre>
<code>repeated .google.api.AuthRequirement requirements = 7;</code></div>
</li>
</ul>
<a name="getRequirementsOrBuilder-int-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getRequirementsOrBuilder</h4>
<pre><a href="../../../com/google/api/AuthRequirementOrBuilder.html" title="interface in com.google.api">AuthRequirementOrBuilder</a>&nbsp;getRequirementsOrBuilder(int&nbsp;index)</pre>
<div class="block"><pre>
Requirements for additional authentication providers.
</pre>
<code>repeated .google.api.AuthRequirement requirements = 7;</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/api/AuthenticationRule.Builder.html" title="class in com.google.api"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../com/google/api/AuthProto.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/AuthenticationRuleOrBuilder.html" target="_top">Frames</a></li>
<li><a href="AuthenticationRuleOrBuilder.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>