blob: 50c6025c8a264a4deefcc0f5df3912c877c84a36 [file] [log] [blame]
<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="#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>
<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="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.
&quot;endCursor&quot;: { # 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 &lt;= start_cursor. Specifying a start_cursor before the first message and an end_cursor after the last message will retrieve all messages.
&quot;offset&quot;: &quot;A String&quot;, # The offset of a message within a topic partition. Must be greater than or equal 0.
},
&quot;partition&quot;: &quot;A String&quot;, # Required. The partition for which we should compute message stats.
&quot;startCursor&quot;: { # A cursor that describes the position of a message within a topic partition. # The inclusive start of the range.
&quot;offset&quot;: &quot;A String&quot;, # 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.
&quot;messageBytes&quot;: &quot;A String&quot;, # The number of quota bytes accounted to these messages.
&quot;messageCount&quot;: &quot;A String&quot;, # The count of messages.
&quot;minimumEventTime&quot;: &quot;A String&quot;, # 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.
&quot;minimumPublishTime&quot;: &quot;A String&quot;, # 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>
</body></html>