-
Notifications
You must be signed in to change notification settings - Fork 172
Expand file tree
/
Copy pathProtobuf.html
More file actions
330 lines (318 loc) · 18.7 KB
/
Protobuf.html
File metadata and controls
330 lines (318 loc) · 18.7 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="robots" content="index, follow, all" />
<title>Google\Protobuf | Google Protobuf - 4.33.6</title>
<link rel="stylesheet" type="text/css" href="../css/bootstrap.min.css">
<link rel="stylesheet" type="text/css" href="../css/bootstrap-theme.min.css">
<link rel="stylesheet" type="text/css" href="../css/doctum.css">
<link rel="stylesheet" type="text/css" href="../fonts/doctum-font.css">
<script src="../js/jquery-3.5.1.slim.min.js"></script>
<script async defer src="../doctum.js"></script>
<script async defer src="../js/bootstrap.min.js"></script>
<script async defer src="../js/autocomplete.min.js"></script>
<meta name="MobileOptimized" content="width">
<meta name="HandheldFriendly" content="true">
<meta name="viewport" content="width=device-width,initial-scale=1,maximum-scale=1">
</head>
<body id="namespace" data-name="namespace:Google_Protobuf" data-root-path="../" data-search-index-url="../doctum-search.json">
<div id="content">
<div id="left-column">
<div id="control-panel">
<div class="search-bar hidden" id="search-progress-bar-container">
<div class="progress">
<div class="progress-bar" role="progressbar" id="search-progress-bar"
aria-valuenow="0" aria-valuemin="0" aria-valuemax="100" style="width: 0%"></div>
</div>
</div>
<form id="search-form" action="../search.html">
<span class="icon icon-search"></span>
<input name="search"
id="doctum-search-auto-complete"
class="typeahead form-control"
type="search"
placeholder="Search"
spellcheck="false"
autocorrect="off"
autocomplete="off"
autocapitalize="off">
<div class="auto-complete-results" id="auto-complete-results"></div>
</form>
</div>
<div id="api-tree"></div>
</div>
<div id="right-column">
<nav id="site-nav" class="navbar navbar-default" role="navigation">
<div class="container-fluid">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar-elements">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="../index.html">Google Protobuf - 4.33.6</a>
</div>
<div class="collapse navbar-collapse" id="navbar-elements">
<ul class="nav navbar-nav">
<li><a href="../classes.html">Classes</a></li>
<li><a href="../namespaces.html">Namespaces</a></li>
<li><a href="../interfaces.html">Interfaces</a></li>
<li><a href="../traits.html">Traits</a></li>
<li><a href="../doc-index.html">Index</a></li>
<li><a href="../search.html">Search</a></li>
</ul>
</div>
</div>
</nav>
<div class="namespace-breadcrumbs">
<ol class="breadcrumb">
<li><span class="label label-default">Namespace</span></li>
<li><a href="../Google.html">Google</a></li><li class="backslash">\</li><li><a href="../Google/Protobuf.html">Protobuf</a></li><li class="backslash">\</li>
</ol>
</div>
<div id="page-content">
<div class="page-header">
<h1>Google\Protobuf</h1>
</div>
<h2>Namespaces</h2>
<div class="namespace-list">
<a href="../Google/Protobuf/Field.html">Google\Protobuf\Field</a><a href="../Google/Protobuf/Internal.html">Google\Protobuf\Internal</a> </div>
<h2>Classes</h2>
<div class="container-fluid underlined">
<div class="row">
<div class="col-md-6">
<a href="../Google/Protobuf/Any.html"><abbr title="Google\Protobuf\Any">Any</abbr></a> </div>
<div class="col-md-6"><p><code>Any</code> contains an arbitrary serialized protocol buffer message along with a
URL that describes the type of the serialized message.</p></div>
</div>
<div class="row">
<div class="col-md-6">
<a href="../Google/Protobuf/Api.html"><abbr title="Google\Protobuf\Api">Api</abbr></a> </div>
<div class="col-md-6"><p>Api is a light-weight descriptor for an API Interface.</p></div>
</div>
<div class="row">
<div class="col-md-6">
<a href="../Google/Protobuf/BoolValue.html"><abbr title="Google\Protobuf\BoolValue">BoolValue</abbr></a> </div>
<div class="col-md-6"><p>Wrapper message for <code>bool</code>.</p></div>
</div>
<div class="row">
<div class="col-md-6">
<a href="../Google/Protobuf/BytesValue.html"><abbr title="Google\Protobuf\BytesValue">BytesValue</abbr></a> </div>
<div class="col-md-6"><p>Wrapper message for <code>bytes</code>.</p></div>
</div>
<div class="row">
<div class="col-md-6">
<a href="../Google/Protobuf/Descriptor.html"><abbr title="Google\Protobuf\Descriptor">Descriptor</abbr></a> </div>
<div class="col-md-6"></div>
</div>
<div class="row">
<div class="col-md-6">
<a href="../Google/Protobuf/DescriptorPool.html"><abbr title="Google\Protobuf\DescriptorPool">DescriptorPool</abbr></a> </div>
<div class="col-md-6"></div>
</div>
<div class="row">
<div class="col-md-6">
<a href="../Google/Protobuf/DoubleValue.html"><abbr title="Google\Protobuf\DoubleValue">DoubleValue</abbr></a> </div>
<div class="col-md-6"><p>Wrapper message for <code>double</code>.</p></div>
</div>
<div class="row">
<div class="col-md-6">
<a href="../Google/Protobuf/Duration.html"><abbr title="Google\Protobuf\Duration">Duration</abbr></a> </div>
<div class="col-md-6"><p>A Duration represents a signed, fixed-length span of time represented
as a count of seconds and fractions of seconds at nanosecond
resolution. It is independent of any calendar and concepts like "day"
or "month". It is related to Timestamp in that the difference between
two Timestamp values is a Duration and it can be added or subtracted
from a Timestamp. Range is approximately +-10,000 years.</p></div>
</div>
<div class="row">
<div class="col-md-6">
<a href="../Google/Protobuf/Enum.html"><abbr title="Google\Protobuf\Enum">Enum</abbr></a> </div>
<div class="col-md-6"><p>Enum type definition.</p></div>
</div>
<div class="row">
<div class="col-md-6">
<a href="../Google/Protobuf/EnumDescriptor.html"><abbr title="Google\Protobuf\EnumDescriptor">EnumDescriptor</abbr></a> </div>
<div class="col-md-6"></div>
</div>
<div class="row">
<div class="col-md-6">
<a href="../Google/Protobuf/EnumValue.html"><abbr title="Google\Protobuf\EnumValue">EnumValue</abbr></a> </div>
<div class="col-md-6"><p>Enum value definition.</p></div>
</div>
<div class="row">
<div class="col-md-6">
<a href="../Google/Protobuf/EnumValueDescriptor.html"><abbr title="Google\Protobuf\EnumValueDescriptor">EnumValueDescriptor</abbr></a> </div>
<div class="col-md-6"></div>
</div>
<div class="row">
<div class="col-md-6">
<a href="../Google/Protobuf/Field.html"><abbr title="Google\Protobuf\Field">Field</abbr></a> </div>
<div class="col-md-6"><p>A single field of a message type.</p></div>
</div>
<div class="row">
<div class="col-md-6">
<a href="../Google/Protobuf/FieldDescriptor.html"><abbr title="Google\Protobuf\FieldDescriptor">FieldDescriptor</abbr></a> </div>
<div class="col-md-6"></div>
</div>
<div class="row">
<div class="col-md-6">
<a href="../Google/Protobuf/FieldMask.html"><abbr title="Google\Protobuf\FieldMask">FieldMask</abbr></a> </div>
<div class="col-md-6"><p><code>FieldMask</code> represents a set of symbolic field paths, for example:
paths: "f.a"
paths: "f.b.d"
Here <code>f</code> represents a field in some root message, <code>a</code> and <code>b</code>
fields in the message found in <code>f</code>, and <code>d</code> a field found in the
message in <code>f.b</code>.</p></div>
</div>
<div class="row">
<div class="col-md-6">
<a href="../Google/Protobuf/Field_Cardinality.html"><abbr title="Google\Protobuf\Field_Cardinality">Field_Cardinality</abbr></a> <small><span class="label label-danger">deprecated</span></small></div>
<div class="col-md-6"><p>This class is deprecated. Use Google\Protobuf\Field\Cardinality instead.</p></div>
</div>
<div class="row">
<div class="col-md-6">
<a href="../Google/Protobuf/Field_Kind.html"><abbr title="Google\Protobuf\Field_Kind">Field_Kind</abbr></a> <small><span class="label label-danger">deprecated</span></small></div>
<div class="col-md-6"><p>This class is deprecated. Use Google\Protobuf\Field\Kind instead.</p></div>
</div>
<div class="row">
<div class="col-md-6">
<a href="../Google/Protobuf/FloatValue.html"><abbr title="Google\Protobuf\FloatValue">FloatValue</abbr></a> </div>
<div class="col-md-6"><p>Wrapper message for <code>float</code>.</p></div>
</div>
<div class="row">
<div class="col-md-6">
<a href="../Google/Protobuf/GPBEmpty.html"><abbr title="Google\Protobuf\GPBEmpty">GPBEmpty</abbr></a> </div>
<div class="col-md-6"><p>A generic empty message that you can re-use to avoid defining duplicated
empty messages in your APIs. A typical example is to use it as the request
or the response type of an API method. For instance:
service Foo {
rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
}</p></div>
</div>
<div class="row">
<div class="col-md-6">
<a href="../Google/Protobuf/Int32Value.html"><abbr title="Google\Protobuf\Int32Value">Int32Value</abbr></a> </div>
<div class="col-md-6"><p>Wrapper message for <code>int32</code>.</p></div>
</div>
<div class="row">
<div class="col-md-6">
<a href="../Google/Protobuf/Int64Value.html"><abbr title="Google\Protobuf\Int64Value">Int64Value</abbr></a> </div>
<div class="col-md-6"><p>Wrapper message for <code>int64</code>.</p></div>
</div>
<div class="row">
<div class="col-md-6">
<a href="../Google/Protobuf/ListValue.html"><abbr title="Google\Protobuf\ListValue">ListValue</abbr></a> </div>
<div class="col-md-6"><p><code>ListValue</code> is a wrapper around a repeated field of values.</p></div>
</div>
<div class="row">
<div class="col-md-6">
<a href="../Google/Protobuf/Method.html"><abbr title="Google\Protobuf\Method">Method</abbr></a> </div>
<div class="col-md-6"><p>Method represents a method of an API interface.</p></div>
</div>
<div class="row">
<div class="col-md-6">
<a href="../Google/Protobuf/Mixin.html"><abbr title="Google\Protobuf\Mixin">Mixin</abbr></a> </div>
<div class="col-md-6"><p>Declares an API Interface to be included in this interface. The including
interface must redeclare all the methods from the included interface, but
documentation and options are inherited as follows:</p>
<ul>
<li>If after comment and whitespace stripping, the documentation
string of the redeclared method is empty, it will be inherited
from the original method.</li>
</ul></div>
</div>
<div class="row">
<div class="col-md-6">
<a href="../Google/Protobuf/NullValue.html"><abbr title="Google\Protobuf\NullValue">NullValue</abbr></a> </div>
<div class="col-md-6"><p><code>NullValue</code> is a singleton enumeration to represent the null value for the
<code>Value</code> type union.</p></div>
</div>
<div class="row">
<div class="col-md-6">
<a href="../Google/Protobuf/OneofDescriptor.html"><abbr title="Google\Protobuf\OneofDescriptor">OneofDescriptor</abbr></a> </div>
<div class="col-md-6"></div>
</div>
<div class="row">
<div class="col-md-6">
<a href="../Google/Protobuf/Option.html"><abbr title="Google\Protobuf\Option">Option</abbr></a> </div>
<div class="col-md-6"><p>A protocol buffer option, which can be attached to a message, field,
enumeration, etc.</p></div>
</div>
<div class="row">
<div class="col-md-6">
<a href="../Google/Protobuf/PrintOptions.html"><abbr title="Google\Protobuf\PrintOptions">PrintOptions</abbr></a> </div>
<div class="col-md-6"></div>
</div>
<div class="row">
<div class="col-md-6">
<a href="../Google/Protobuf/RepeatedField.html"><abbr title="Google\Protobuf\RepeatedField">RepeatedField</abbr></a> </div>
<div class="col-md-6"><p>RepeatedField is used by generated protocol message classes to manipulate
repeated fields. It can be used like native PHP array.</p></div>
</div>
<div class="row">
<div class="col-md-6">
<a href="../Google/Protobuf/SourceContext.html"><abbr title="Google\Protobuf\SourceContext">SourceContext</abbr></a> </div>
<div class="col-md-6"><p><code>SourceContext</code> represents information about the source of a
protobuf element, like the file in which it is defined.</p></div>
</div>
<div class="row">
<div class="col-md-6">
<a href="../Google/Protobuf/StringValue.html"><abbr title="Google\Protobuf\StringValue">StringValue</abbr></a> </div>
<div class="col-md-6"><p>Wrapper message for <code>string</code>.</p></div>
</div>
<div class="row">
<div class="col-md-6">
<a href="../Google/Protobuf/Struct.html"><abbr title="Google\Protobuf\Struct">Struct</abbr></a> </div>
<div class="col-md-6"><p><code>Struct</code> represents a structured data value, consisting of fields
which map to dynamically typed values. In some languages, <code>Struct</code>
might be supported by a native representation. For example, in
scripting languages like JS a struct is represented as an
object. The details of that representation are described together
with the proto support for the language.</p></div>
</div>
<div class="row">
<div class="col-md-6">
<a href="../Google/Protobuf/Syntax.html"><abbr title="Google\Protobuf\Syntax">Syntax</abbr></a> </div>
<div class="col-md-6"><p>The syntax in which a protocol buffer element is defined.</p></div>
</div>
<div class="row">
<div class="col-md-6">
<a href="../Google/Protobuf/Timestamp.html"><abbr title="Google\Protobuf\Timestamp">Timestamp</abbr></a> </div>
<div class="col-md-6"><p>A Timestamp represents a point in time independent of any time zone or local
calendar, encoded as a count of seconds and fractions of seconds at
nanosecond resolution. The count is relative to an epoch at UTC midnight on
January 1, 1970, in the proleptic Gregorian calendar which extends the
Gregorian calendar backwards to year one.</p></div>
</div>
<div class="row">
<div class="col-md-6">
<a href="../Google/Protobuf/Type.html"><abbr title="Google\Protobuf\Type">Type</abbr></a> </div>
<div class="col-md-6"><p>A protocol buffer message type.</p></div>
</div>
<div class="row">
<div class="col-md-6">
<a href="../Google/Protobuf/UInt32Value.html"><abbr title="Google\Protobuf\UInt32Value">UInt32Value</abbr></a> </div>
<div class="col-md-6"><p>Wrapper message for <code>uint32</code>.</p></div>
</div>
<div class="row">
<div class="col-md-6">
<a href="../Google/Protobuf/UInt64Value.html"><abbr title="Google\Protobuf\UInt64Value">UInt64Value</abbr></a> </div>
<div class="col-md-6"><p>Wrapper message for <code>uint64</code>.</p></div>
</div>
<div class="row">
<div class="col-md-6">
<a href="../Google/Protobuf/Value.html"><abbr title="Google\Protobuf\Value">Value</abbr></a> </div>
<div class="col-md-6"><p><code>Value</code> represents a dynamically typed value which can be either
null, a number, a string, a boolean, a recursive struct value, or a
list of values. A producer of value is expected to set one of these
variants. Absence of any variant indicates an error.</p></div>
</div>
</div>
</div><div id="footer">
Generated by <a href="https://github.com/code-lts/doctum">Doctum, a API Documentation generator and fork of Sami</a>.</div></div>
</div>
</body>
</html>