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
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="pubsublite_v1.html">Pub/Sub Lite API</a> . <a href="pubsublite_v1.topicStats.html">topicStats</a> . <a href="pubsublite_v1.topicStats.projects.html">projects</a> . <a href="pubsublite_v1.topicStats.projects.locations.html">locations</a> . <a href="pubsublite_v1.topicStats.projects.locations.topics.html">topics</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#computeHeadCursor">computeHeadCursor(topic, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Compute the head cursor for the partition. The head cursor's offset is guaranteed to be less than or equal to all messages which have not yet been acknowledged as published, and greater than the offset of any message whose publish has already been acknowledged. It is zero if there have never been messages in the partition.</p>
<p class="toc_element">
<code><a href="#computeMessageStats">computeMessageStats(topic, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Compute statistics about a range of messages in a given topic and partition.</p>
<p class="toc_element">
<code><a href="#computeTimeCursor">computeTimeCursor(topic, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Compute the corresponding cursor for a publish or event time in a topic partition.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="computeHeadCursor">computeHeadCursor(topic, body=None, x__xgafv=None)</code>
<pre>Compute the head cursor for the partition. The head cursor's offset is guaranteed to be less than or equal to all messages which have not yet been acknowledged as published, and greater than the offset of any message whose publish has already been acknowledged. It is zero if there have never been messages in the partition.
Args:
topic: string, Required. The topic for which we should compute the head cursor. (required)
body: object, The request body.
The object takes the form of:
{ # Compute the current head cursor for a partition.
"partition": "A String", # Required. The partition for which we should compute the head cursor.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response containing the head cursor for the requested topic and partition.
"headCursor": { # A cursor that describes the position of a message within a topic partition. # The head cursor.
"offset": "A String", # The offset of a message within a topic partition. Must be greater than or equal 0.
},
}</pre>
</div>
<div class="method">
<code class="details" id="computeMessageStats">computeMessageStats(topic, body=None, x__xgafv=None)</code>
<pre>Compute statistics about a range of messages in a given topic and partition.
Args:
topic: string, Required. The topic for which we should compute message stats. (required)
body: object, The request body.
The object takes the form of:
{ # Compute statistics about a range of messages in a given topic and partition.
"endCursor": { # A cursor that describes the position of a message within a topic partition. # The exclusive end of the range. The range is empty if end_cursor <= start_cursor. Specifying a start_cursor before the first message and an end_cursor after the last message will retrieve all messages.
"offset": "A String", # The offset of a message within a topic partition. Must be greater than or equal 0.
},
"partition": "A String", # Required. The partition for which we should compute message stats.
"startCursor": { # A cursor that describes the position of a message within a topic partition. # The inclusive start of the range.
"offset": "A String", # The offset of a message within a topic partition. Must be greater than or equal 0.
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response containing stats for messages in the requested topic and partition.
"messageBytes": "A String", # The number of quota bytes accounted to these messages.
"messageCount": "A String", # The count of messages.
"minimumEventTime": "A String", # The minimum event timestamp across these messages. For the purposes of this computation, if a message does not have an event time, we use the publish time. The timestamp will be unset if there are no messages.
"minimumPublishTime": "A String", # The minimum publish timestamp across these messages. Note that publish timestamps within a partition are not guaranteed to be non-decreasing. The timestamp will be unset if there are no messages.
}</pre>
</div>
<div class="method">
<code class="details" id="computeTimeCursor">computeTimeCursor(topic, body=None, x__xgafv=None)</code>
<pre>Compute the corresponding cursor for a publish or event time in a topic partition.
Args:
topic: string, Required. The topic for which we should compute the cursor. (required)
body: object, The request body.
The object takes the form of:
{ # Compute the corresponding cursor for a publish or event time in a topic partition.
"partition": "A String", # Required. The partition for which we should compute the cursor.
"target": { # A target publish or event time. Can be used for seeking to or retrieving the corresponding cursor. # Required. The target publish or event time. Specifying a future time will return an unset cursor.
"eventTime": "A String", # Request the cursor of the first message with event time greater than or equal to `event_time`. If messages are missing an event time, the publish time is used as a fallback. As event times are user supplied, subsequent messages may have event times less than `event_time` and should be filtered by the client, if necessary.
"publishTime": "A String", # Request the cursor of the first message with publish time greater than or equal to `publish_time`. All messages thereafter are guaranteed to have publish times >= `publish_time`.
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response containing the cursor corresponding to a publish or event time in a topic partition.
"cursor": { # A cursor that describes the position of a message within a topic partition. # If present, the cursor references the first message with time greater than or equal to the specified target time. If such a message cannot be found, the cursor will be unset (i.e. `cursor` is not present).
"offset": "A String", # The offset of a message within a topic partition. Must be greater than or equal 0.
},
}</pre>
</div>
</body></html>
|
