blob: 7a7709a6925a84179a49ebc379973ebb1b3c37ad [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:54 PDT 2019 -->
<title>HttpRuleOrBuilder (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="HttpRuleOrBuilder (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,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6,"i21":6,"i22":6,"i23":6,"i24":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/HttpRule.PatternCase.html" title="enum in com.google.api"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../com/google/api/LabelDescriptor.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/HttpRuleOrBuilder.html" target="_top">Frames</a></li>
<li><a href="HttpRuleOrBuilder.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 HttpRuleOrBuilder" class="title">Interface HttpRuleOrBuilder</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/HttpRule.html" title="class in com.google.api">HttpRule</a>, <a href="../../../com/google/api/HttpRule.Builder.html" title="class in com.google.api">HttpRule.Builder</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">HttpRuleOrBuilder</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><a href="../../../com/google/api/HttpRule.html" title="class in com.google.api">HttpRule</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/HttpRuleOrBuilder.html#getAdditionalBindings-int-">getAdditionalBindings</a></span>(int&nbsp;index)</code>
<div class="block">
Additional HTTP bindings for the selector.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/HttpRuleOrBuilder.html#getAdditionalBindingsCount--">getAdditionalBindingsCount</a></span>()</code>
<div class="block">
Additional HTTP bindings for the selector.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.util.List&lt;<a href="../../../com/google/api/HttpRule.html" title="class in com.google.api">HttpRule</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/HttpRuleOrBuilder.html#getAdditionalBindingsList--">getAdditionalBindingsList</a></span>()</code>
<div class="block">
Additional HTTP bindings for the selector.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../com/google/api/HttpRuleOrBuilder.html" title="interface in com.google.api">HttpRuleOrBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/HttpRuleOrBuilder.html#getAdditionalBindingsOrBuilder-int-">getAdditionalBindingsOrBuilder</a></span>(int&nbsp;index)</code>
<div class="block">
Additional HTTP bindings for the selector.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>java.util.List&lt;? extends <a href="../../../com/google/api/HttpRuleOrBuilder.html" title="interface in com.google.api">HttpRuleOrBuilder</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/HttpRuleOrBuilder.html#getAdditionalBindingsOrBuilderList--">getAdditionalBindingsOrBuilderList</a></span>()</code>
<div class="block">
Additional HTTP bindings for the selector.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/HttpRuleOrBuilder.html#getBody--">getBody</a></span>()</code>
<div class="block">
The name of the request field whose value is mapped to the HTTP request
body, or `*` for mapping all request fields not captured by the path
pattern to the HTTP body, or omitted for not having any HTTP request body.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<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/HttpRuleOrBuilder.html#getBodyBytes--">getBodyBytes</a></span>()</code>
<div class="block">
The name of the request field whose value is mapped to the HTTP request
body, or `*` for mapping all request fields not captured by the path
pattern to the HTTP body, or omitted for not having any HTTP request body.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="../../../com/google/api/CustomHttpPattern.html" title="class in com.google.api">CustomHttpPattern</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/HttpRuleOrBuilder.html#getCustom--">getCustom</a></span>()</code>
<div class="block">
The custom pattern is used for specifying an HTTP method that is not
included in the `pattern` field, such as HEAD, or "*" to leave the
HTTP method unspecified for this rule.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="../../../com/google/api/CustomHttpPatternOrBuilder.html" title="interface in com.google.api">CustomHttpPatternOrBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/HttpRuleOrBuilder.html#getCustomOrBuilder--">getCustomOrBuilder</a></span>()</code>
<div class="block">
The custom pattern is used for specifying an HTTP method that is not
included in the `pattern` field, such as HEAD, or "*" to leave the
HTTP method unspecified for this rule.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/HttpRuleOrBuilder.html#getDelete--">getDelete</a></span>()</code>
<div class="block">
Maps to HTTP DELETE.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<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/HttpRuleOrBuilder.html#getDeleteBytes--">getDeleteBytes</a></span>()</code>
<div class="block">
Maps to HTTP DELETE.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/HttpRuleOrBuilder.html#getGet--">getGet</a></span>()</code>
<div class="block">
Maps to HTTP GET.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<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/HttpRuleOrBuilder.html#getGetBytes--">getGetBytes</a></span>()</code>
<div class="block">
Maps to HTTP GET.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/HttpRuleOrBuilder.html#getPatch--">getPatch</a></span>()</code>
<div class="block">
Maps to HTTP PATCH.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<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/HttpRuleOrBuilder.html#getPatchBytes--">getPatchBytes</a></span>()</code>
<div class="block">
Maps to HTTP PATCH.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code><a href="../../../com/google/api/HttpRule.PatternCase.html" title="enum in com.google.api">HttpRule.PatternCase</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/HttpRuleOrBuilder.html#getPatternCase--">getPatternCase</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/HttpRuleOrBuilder.html#getPost--">getPost</a></span>()</code>
<div class="block">
Maps to HTTP POST.</div>
</td>
</tr>
<tr id="i17" 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/HttpRuleOrBuilder.html#getPostBytes--">getPostBytes</a></span>()</code>
<div class="block">
Maps to HTTP POST.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/HttpRuleOrBuilder.html#getPut--">getPut</a></span>()</code>
<div class="block">
Maps to HTTP PUT.</div>
</td>
</tr>
<tr id="i19" 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/HttpRuleOrBuilder.html#getPutBytes--">getPutBytes</a></span>()</code>
<div class="block">
Maps to HTTP PUT.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/HttpRuleOrBuilder.html#getResponseBody--">getResponseBody</a></span>()</code>
<div class="block">
Optional.</div>
</td>
</tr>
<tr id="i21" 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/HttpRuleOrBuilder.html#getResponseBodyBytes--">getResponseBodyBytes</a></span>()</code>
<div class="block">
Optional.</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/HttpRuleOrBuilder.html#getSelector--">getSelector</a></span>()</code>
<div class="block">
Selects a method to which this rule applies.</div>
</td>
</tr>
<tr id="i23" 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/HttpRuleOrBuilder.html#getSelectorBytes--">getSelectorBytes</a></span>()</code>
<div class="block">
Selects a method to which this rule applies.</div>
</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/HttpRuleOrBuilder.html#hasCustom--">hasCustom</a></span>()</code>
<div class="block">
The custom pattern is used for specifying an HTTP method that is not
included in the `pattern` field, such as HEAD, or "*" to leave the
HTTP method unspecified for this rule.</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 a method 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 a method 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="getGet--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getGet</h4>
<pre>java.lang.String&nbsp;getGet()</pre>
<div class="block"><pre>
Maps to HTTP GET. Used for listing and getting information about
resources.
</pre>
<code>string get = 2;</code></div>
</li>
</ul>
<a name="getGetBytes--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getGetBytes</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;getGetBytes()</pre>
<div class="block"><pre>
Maps to HTTP GET. Used for listing and getting information about
resources.
</pre>
<code>string get = 2;</code></div>
</li>
</ul>
<a name="getPut--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPut</h4>
<pre>java.lang.String&nbsp;getPut()</pre>
<div class="block"><pre>
Maps to HTTP PUT. Used for replacing a resource.
</pre>
<code>string put = 3;</code></div>
</li>
</ul>
<a name="getPutBytes--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPutBytes</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;getPutBytes()</pre>
<div class="block"><pre>
Maps to HTTP PUT. Used for replacing a resource.
</pre>
<code>string put = 3;</code></div>
</li>
</ul>
<a name="getPost--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPost</h4>
<pre>java.lang.String&nbsp;getPost()</pre>
<div class="block"><pre>
Maps to HTTP POST. Used for creating a resource or performing an action.
</pre>
<code>string post = 4;</code></div>
</li>
</ul>
<a name="getPostBytes--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPostBytes</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;getPostBytes()</pre>
<div class="block"><pre>
Maps to HTTP POST. Used for creating a resource or performing an action.
</pre>
<code>string post = 4;</code></div>
</li>
</ul>
<a name="getDelete--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDelete</h4>
<pre>java.lang.String&nbsp;getDelete()</pre>
<div class="block"><pre>
Maps to HTTP DELETE. Used for deleting a resource.
</pre>
<code>string delete = 5;</code></div>
</li>
</ul>
<a name="getDeleteBytes--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDeleteBytes</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;getDeleteBytes()</pre>
<div class="block"><pre>
Maps to HTTP DELETE. Used for deleting a resource.
</pre>
<code>string delete = 5;</code></div>
</li>
</ul>
<a name="getPatch--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPatch</h4>
<pre>java.lang.String&nbsp;getPatch()</pre>
<div class="block"><pre>
Maps to HTTP PATCH. Used for updating a resource.
</pre>
<code>string patch = 6;</code></div>
</li>
</ul>
<a name="getPatchBytes--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPatchBytes</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;getPatchBytes()</pre>
<div class="block"><pre>
Maps to HTTP PATCH. Used for updating a resource.
</pre>
<code>string patch = 6;</code></div>
</li>
</ul>
<a name="hasCustom--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasCustom</h4>
<pre>boolean&nbsp;hasCustom()</pre>
<div class="block"><pre>
The custom pattern is used for specifying an HTTP method that is not
included in the `pattern` field, such as HEAD, or "*" to leave the
HTTP method unspecified for this rule. The wild-card rule is useful
for services that provide content to Web (HTML) clients.
</pre>
<code>.google.api.CustomHttpPattern custom = 8;</code></div>
</li>
</ul>
<a name="getCustom--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCustom</h4>
<pre><a href="../../../com/google/api/CustomHttpPattern.html" title="class in com.google.api">CustomHttpPattern</a>&nbsp;getCustom()</pre>
<div class="block"><pre>
The custom pattern is used for specifying an HTTP method that is not
included in the `pattern` field, such as HEAD, or "*" to leave the
HTTP method unspecified for this rule. The wild-card rule is useful
for services that provide content to Web (HTML) clients.
</pre>
<code>.google.api.CustomHttpPattern custom = 8;</code></div>
</li>
</ul>
<a name="getCustomOrBuilder--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCustomOrBuilder</h4>
<pre><a href="../../../com/google/api/CustomHttpPatternOrBuilder.html" title="interface in com.google.api">CustomHttpPatternOrBuilder</a>&nbsp;getCustomOrBuilder()</pre>
<div class="block"><pre>
The custom pattern is used for specifying an HTTP method that is not
included in the `pattern` field, such as HEAD, or "*" to leave the
HTTP method unspecified for this rule. The wild-card rule is useful
for services that provide content to Web (HTML) clients.
</pre>
<code>.google.api.CustomHttpPattern custom = 8;</code></div>
</li>
</ul>
<a name="getBody--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBody</h4>
<pre>java.lang.String&nbsp;getBody()</pre>
<div class="block"><pre>
The name of the request field whose value is mapped to the HTTP request
body, or `*` for mapping all request fields not captured by the path
pattern to the HTTP body, or omitted for not having any HTTP request body.
NOTE: the referred field must be present at the top-level of the request
message type.
</pre>
<code>string body = 7;</code></div>
</li>
</ul>
<a name="getBodyBytes--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBodyBytes</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;getBodyBytes()</pre>
<div class="block"><pre>
The name of the request field whose value is mapped to the HTTP request
body, or `*` for mapping all request fields not captured by the path
pattern to the HTTP body, or omitted for not having any HTTP request body.
NOTE: the referred field must be present at the top-level of the request
message type.
</pre>
<code>string body = 7;</code></div>
</li>
</ul>
<a name="getResponseBody--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getResponseBody</h4>
<pre>java.lang.String&nbsp;getResponseBody()</pre>
<div class="block"><pre>
Optional. The name of the response field whose value is mapped to the HTTP
response body. When omitted, the entire response message will be used
as the HTTP response body.
NOTE: The referred field must be present at the top-level of the response
message type.
</pre>
<code>string response_body = 12;</code></div>
</li>
</ul>
<a name="getResponseBodyBytes--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getResponseBodyBytes</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;getResponseBodyBytes()</pre>
<div class="block"><pre>
Optional. The name of the response field whose value is mapped to the HTTP
response body. When omitted, the entire response message will be used
as the HTTP response body.
NOTE: The referred field must be present at the top-level of the response
message type.
</pre>
<code>string response_body = 12;</code></div>
</li>
</ul>
<a name="getAdditionalBindingsList--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAdditionalBindingsList</h4>
<pre>java.util.List&lt;<a href="../../../com/google/api/HttpRule.html" title="class in com.google.api">HttpRule</a>&gt;&nbsp;getAdditionalBindingsList()</pre>
<div class="block"><pre>
Additional HTTP bindings for the selector. Nested bindings must
not contain an `additional_bindings` field themselves (that is,
the nesting may only be one level deep).
</pre>
<code>repeated .google.api.HttpRule additional_bindings = 11;</code></div>
</li>
</ul>
<a name="getAdditionalBindings-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAdditionalBindings</h4>
<pre><a href="../../../com/google/api/HttpRule.html" title="class in com.google.api">HttpRule</a>&nbsp;getAdditionalBindings(int&nbsp;index)</pre>
<div class="block"><pre>
Additional HTTP bindings for the selector. Nested bindings must
not contain an `additional_bindings` field themselves (that is,
the nesting may only be one level deep).
</pre>
<code>repeated .google.api.HttpRule additional_bindings = 11;</code></div>
</li>
</ul>
<a name="getAdditionalBindingsCount--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAdditionalBindingsCount</h4>
<pre>int&nbsp;getAdditionalBindingsCount()</pre>
<div class="block"><pre>
Additional HTTP bindings for the selector. Nested bindings must
not contain an `additional_bindings` field themselves (that is,
the nesting may only be one level deep).
</pre>
<code>repeated .google.api.HttpRule additional_bindings = 11;</code></div>
</li>
</ul>
<a name="getAdditionalBindingsOrBuilderList--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAdditionalBindingsOrBuilderList</h4>
<pre>java.util.List&lt;? extends <a href="../../../com/google/api/HttpRuleOrBuilder.html" title="interface in com.google.api">HttpRuleOrBuilder</a>&gt;&nbsp;getAdditionalBindingsOrBuilderList()</pre>
<div class="block"><pre>
Additional HTTP bindings for the selector. Nested bindings must
not contain an `additional_bindings` field themselves (that is,
the nesting may only be one level deep).
</pre>
<code>repeated .google.api.HttpRule additional_bindings = 11;</code></div>
</li>
</ul>
<a name="getAdditionalBindingsOrBuilder-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAdditionalBindingsOrBuilder</h4>
<pre><a href="../../../com/google/api/HttpRuleOrBuilder.html" title="interface in com.google.api">HttpRuleOrBuilder</a>&nbsp;getAdditionalBindingsOrBuilder(int&nbsp;index)</pre>
<div class="block"><pre>
Additional HTTP bindings for the selector. Nested bindings must
not contain an `additional_bindings` field themselves (that is,
the nesting may only be one level deep).
</pre>
<code>repeated .google.api.HttpRule additional_bindings = 11;</code></div>
</li>
</ul>
<a name="getPatternCase--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getPatternCase</h4>
<pre><a href="../../../com/google/api/HttpRule.PatternCase.html" title="enum in com.google.api">HttpRule.PatternCase</a>&nbsp;getPatternCase()</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/HttpRule.PatternCase.html" title="enum in com.google.api"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../com/google/api/LabelDescriptor.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/HttpRuleOrBuilder.html" target="_top">Frames</a></li>
<li><a href="HttpRuleOrBuilder.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>