blob: 2f51e1c7210efd1f532710bde24523cc4e3c0f8f [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>ClientProto (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="ClientProto (java API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":9,"i1":9,"i2":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete 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/ChangeType.html" title="enum in com.google.api"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../com/google/api/ConfigChange.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/ClientProto.html" target="_top">Frames</a></li>
<li><a href="ClientProto.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><a href="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&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="Class ClientProto" class="title">Class ClientProto</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>com.google.api.ClientProto</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public final class <span class="typeNameLabel">ClientProto</span>
extends java.lang.Object</pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/ClientProto.html#DEFAULT_HOST_FIELD_NUMBER">DEFAULT_HOST_FIELD_NUMBER</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/GeneratedMessage.GeneratedExtension.html?is-external=true" title="class or interface in com.google.protobuf">GeneratedMessage.GeneratedExtension</a>&lt;<a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/DescriptorProtos.ServiceOptions.html?is-external=true" title="class or interface in com.google.protobuf">DescriptorProtos.ServiceOptions</a>,java.lang.String&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/ClientProto.html#defaultHost">defaultHost</a></span></code>
<div class="block">
The hostname for this service.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/ClientProto.html#METHOD_SIGNATURE_FIELD_NUMBER">METHOD_SIGNATURE_FIELD_NUMBER</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/GeneratedMessage.GeneratedExtension.html?is-external=true" title="class or interface in com.google.protobuf">GeneratedMessage.GeneratedExtension</a>&lt;<a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/DescriptorProtos.MethodOptions.html?is-external=true" title="class or interface in com.google.protobuf">DescriptorProtos.MethodOptions</a>,java.util.List&lt;java.lang.String&gt;&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/ClientProto.html#methodSignature">methodSignature</a></span></code>
<div class="block">
A definition of a client library method signature.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/ClientProto.html#OAUTH_SCOPES_FIELD_NUMBER">OAUTH_SCOPES_FIELD_NUMBER</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/GeneratedMessage.GeneratedExtension.html?is-external=true" title="class or interface in com.google.protobuf">GeneratedMessage.GeneratedExtension</a>&lt;<a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/DescriptorProtos.ServiceOptions.html?is-external=true" title="class or interface in com.google.protobuf">DescriptorProtos.ServiceOptions</a>,java.lang.String&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/ClientProto.html#oauthScopes">oauthScopes</a></span></code>
<div class="block">
OAuth scopes needed for the client.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== 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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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>static <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/Descriptors.FileDescriptor.html?is-external=true" title="class or interface in com.google.protobuf">Descriptors.FileDescriptor</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/ClientProto.html#getDescriptor--">getDescriptor</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/ClientProto.html#registerAllExtensions-com.google.protobuf.ExtensionRegistry-">registerAllExtensions</a></span>(<a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/ExtensionRegistry.html?is-external=true" title="class or interface in com.google.protobuf">ExtensionRegistry</a>&nbsp;registry)</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/ClientProto.html#registerAllExtensions-com.google.protobuf.ExtensionRegistryLite-">registerAllExtensions</a></span>(<a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/ExtensionRegistryLite.html?is-external=true" title="class or interface in com.google.protobuf">ExtensionRegistryLite</a>&nbsp;registry)</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="METHOD_SIGNATURE_FIELD_NUMBER">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>METHOD_SIGNATURE_FIELD_NUMBER</h4>
<pre>public static final&nbsp;int METHOD_SIGNATURE_FIELD_NUMBER</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../constant-values.html#com.google.api.ClientProto.METHOD_SIGNATURE_FIELD_NUMBER">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="methodSignature">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>methodSignature</h4>
<pre>public static final&nbsp;<a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/GeneratedMessage.GeneratedExtension.html?is-external=true" title="class or interface in com.google.protobuf">GeneratedMessage.GeneratedExtension</a>&lt;<a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/DescriptorProtos.MethodOptions.html?is-external=true" title="class or interface in com.google.protobuf">DescriptorProtos.MethodOptions</a>,java.util.List&lt;java.lang.String&gt;&gt; methodSignature</pre>
<div class="block"><pre>
A definition of a client library method signature.
In client libraries, each proto RPC corresponds to one or more methods
which the end user is able to call, and calls the underlying RPC.
Normally, this method receives a single argument (a struct or instance
corresponding to the RPC request object). Defining this field will
add one or more overloads providing flattened or simpler method signatures
in some languages.
The fields on the method signature are provided as a comma-separated
string.
For example, the proto RPC and annotation:
rpc CreateSubscription(CreateSubscriptionRequest)
returns (Subscription) {
option (google.api.method_signature) = "name,topic";
}
Would add the following Java overload (in addition to the method accepting
the request object):
public final Subscription createSubscription(String name, String topic)
The following backwards-compatibility guidelines apply:
* Adding this annotation to an unannotated method is backwards
compatible.
* Adding this annotation to a method which already has existing
method signature annotations is backwards compatible if and only if
the new method signature annotation is last in the sequence.
* Modifying or removing an existing method signature annotation is
a breaking change.
* Re-ordering existing method signature annotations is a breaking
change.
</pre>
<code>extend .google.protobuf.MethodOptions { ... }</code></div>
</li>
</ul>
<a name="DEFAULT_HOST_FIELD_NUMBER">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_HOST_FIELD_NUMBER</h4>
<pre>public static final&nbsp;int DEFAULT_HOST_FIELD_NUMBER</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../constant-values.html#com.google.api.ClientProto.DEFAULT_HOST_FIELD_NUMBER">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="defaultHost">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>defaultHost</h4>
<pre>public static final&nbsp;<a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/GeneratedMessage.GeneratedExtension.html?is-external=true" title="class or interface in com.google.protobuf">GeneratedMessage.GeneratedExtension</a>&lt;<a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/DescriptorProtos.ServiceOptions.html?is-external=true" title="class or interface in com.google.protobuf">DescriptorProtos.ServiceOptions</a>,java.lang.String&gt; defaultHost</pre>
<div class="block"><pre>
The hostname for this service.
This should be specified with no prefix or protocol.
Example:
service Foo {
option (google.api.default_host) = "foo.googleapi.com";
...
}
</pre>
<code>extend .google.protobuf.ServiceOptions { ... }</code></div>
</li>
</ul>
<a name="OAUTH_SCOPES_FIELD_NUMBER">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>OAUTH_SCOPES_FIELD_NUMBER</h4>
<pre>public static final&nbsp;int OAUTH_SCOPES_FIELD_NUMBER</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../constant-values.html#com.google.api.ClientProto.OAUTH_SCOPES_FIELD_NUMBER">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="oauthScopes">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>oauthScopes</h4>
<pre>public static final&nbsp;<a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/GeneratedMessage.GeneratedExtension.html?is-external=true" title="class or interface in com.google.protobuf">GeneratedMessage.GeneratedExtension</a>&lt;<a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/DescriptorProtos.ServiceOptions.html?is-external=true" title="class or interface in com.google.protobuf">DescriptorProtos.ServiceOptions</a>,java.lang.String&gt; oauthScopes</pre>
<div class="block"><pre>
OAuth scopes needed for the client.
Example:
service Foo {
option (google.api.oauth_scopes) = &#92;
"https://www.googleapis.com/auth/cloud-platform";
...
}
If there is more than one scope, use a comma-separated string:
Example:
service Foo {
option (google.api.oauth_scopes) = &#92;
"https://www.googleapis.com/auth/cloud-platform,"
"https://www.googleapis.com/auth/monitoring";
...
}
</pre>
<code>extend .google.protobuf.ServiceOptions { ... }</code></div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="registerAllExtensions-com.google.protobuf.ExtensionRegistryLite-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>registerAllExtensions</h4>
<pre>public static&nbsp;void&nbsp;registerAllExtensions(<a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/ExtensionRegistryLite.html?is-external=true" title="class or interface in com.google.protobuf">ExtensionRegistryLite</a>&nbsp;registry)</pre>
</li>
</ul>
<a name="registerAllExtensions-com.google.protobuf.ExtensionRegistry-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>registerAllExtensions</h4>
<pre>public static&nbsp;void&nbsp;registerAllExtensions(<a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/ExtensionRegistry.html?is-external=true" title="class or interface in com.google.protobuf">ExtensionRegistry</a>&nbsp;registry)</pre>
</li>
</ul>
<a name="getDescriptor--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getDescriptor</h4>
<pre>public static&nbsp;<a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/Descriptors.FileDescriptor.html?is-external=true" title="class or interface in com.google.protobuf">Descriptors.FileDescriptor</a>&nbsp;getDescriptor()</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/ChangeType.html" title="enum in com.google.api"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../com/google/api/ConfigChange.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/ClientProto.html" target="_top">Frames</a></li>
<li><a href="ClientProto.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><a href="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&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>