| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, h1, h2, h3, div, span, p, pre, a { |
| 5 | margin: 0; |
| 6 | padding: 0; |
| 7 | border: 0; |
| 8 | font-weight: inherit; |
| 9 | font-style: inherit; |
| 10 | font-size: 100%; |
| 11 | font-family: inherit; |
| 12 | vertical-align: baseline; |
| 13 | } |
| 14 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, h2, h3 { |
| 50 | border-bottom: solid #CCC 1px; |
| 51 | } |
| 52 | |
| 53 | .toc_element { |
| 54 | margin-top: 0.5em; |
| 55 | } |
| 56 | |
| 57 | .firstline { |
| 58 | margin-left: 2 em; |
| 59 | } |
| 60 | |
| 61 | .method { |
| 62 | margin-top: 1em; |
| 63 | border: solid 1px #CCC; |
| 64 | padding: 1em; |
| 65 | background: #EEE; |
| 66 | } |
| 67 | |
| 68 | .details { |
| 69 | font-weight: bold; |
| 70 | font-size: 14px; |
| 71 | } |
| 72 | |
| 73 | </style> |
| 74 | |
| 75 | <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> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="#close">close()</a></code></p> |
| 79 | <p class="firstline">Close httplib2 connections.</p> |
| 80 | <p class="toc_element"> |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 81 | <code><a href="#computeHeadCursor">computeHeadCursor(topic, body=None, x__xgafv=None)</a></code></p> |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 82 | <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> |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 83 | <p class="toc_element"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 84 | <code><a href="#computeMessageStats">computeMessageStats(topic, body=None, x__xgafv=None)</a></code></p> |
| 85 | <p class="firstline">Compute statistics about a range of messages in a given topic and partition.</p> |
| yoshi-code-bot | c2cd326 | 2021-05-16 02:16:04 -0700 | [diff] [blame] | 86 | <p class="toc_element"> |
| 87 | <code><a href="#computeTimeCursor">computeTimeCursor(topic, body=None, x__xgafv=None)</a></code></p> |
| 88 | <p class="firstline">Compute the corresponding cursor for a publish or event time in a topic partition.</p> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 89 | <h3>Method Details</h3> |
| 90 | <div class="method"> |
| 91 | <code class="details" id="close">close()</code> |
| 92 | <pre>Close httplib2 connections.</pre> |
| 93 | </div> |
| 94 | |
| 95 | <div class="method"> |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 96 | <code class="details" id="computeHeadCursor">computeHeadCursor(topic, body=None, x__xgafv=None)</code> |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 97 | <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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 98 | |
| 99 | Args: |
| 100 | topic: string, Required. The topic for which we should compute the head cursor. (required) |
| 101 | body: object, The request body. |
| 102 | The object takes the form of: |
| 103 | |
| 104 | { # Compute the current head cursor for a partition. |
| 105 | "partition": "A String", # Required. The partition for which we should compute the head cursor. |
| 106 | } |
| 107 | |
| 108 | x__xgafv: string, V1 error format. |
| 109 | Allowed values |
| 110 | 1 - v1 error format |
| 111 | 2 - v2 error format |
| 112 | |
| 113 | Returns: |
| 114 | An object of the form: |
| 115 | |
| 116 | { # Response containing the head cursor for the requested topic and partition. |
| 117 | "headCursor": { # A cursor that describes the position of a message within a topic partition. # The head cursor. |
| 118 | "offset": "A String", # The offset of a message within a topic partition. Must be greater than or equal 0. |
| 119 | }, |
| 120 | }</pre> |
| 121 | </div> |
| 122 | |
| 123 | <div class="method"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 124 | <code class="details" id="computeMessageStats">computeMessageStats(topic, body=None, x__xgafv=None)</code> |
| 125 | <pre>Compute statistics about a range of messages in a given topic and partition. |
| 126 | |
| 127 | Args: |
| 128 | topic: string, Required. The topic for which we should compute message stats. (required) |
| 129 | body: object, The request body. |
| 130 | The object takes the form of: |
| 131 | |
| 132 | { # Compute statistics about a range of messages in a given topic and partition. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 133 | "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. |
| 134 | "offset": "A String", # The offset of a message within a topic partition. Must be greater than or equal 0. |
| 135 | }, |
| 136 | "partition": "A String", # Required. The partition for which we should compute message stats. |
| 137 | "startCursor": { # A cursor that describes the position of a message within a topic partition. # The inclusive start of the range. |
| 138 | "offset": "A String", # The offset of a message within a topic partition. Must be greater than or equal 0. |
| 139 | }, |
| 140 | } |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 141 | |
| 142 | x__xgafv: string, V1 error format. |
| 143 | Allowed values |
| 144 | 1 - v1 error format |
| 145 | 2 - v2 error format |
| 146 | |
| 147 | Returns: |
| 148 | An object of the form: |
| 149 | |
| 150 | { # Response containing stats for messages in the requested topic and partition. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 151 | "messageBytes": "A String", # The number of quota bytes accounted to these messages. |
| 152 | "messageCount": "A String", # The count of messages. |
| 153 | "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. |
| 154 | "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. |
| 155 | }</pre> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 156 | </div> |
| 157 | |
| yoshi-code-bot | c2cd326 | 2021-05-16 02:16:04 -0700 | [diff] [blame] | 158 | <div class="method"> |
| 159 | <code class="details" id="computeTimeCursor">computeTimeCursor(topic, body=None, x__xgafv=None)</code> |
| 160 | <pre>Compute the corresponding cursor for a publish or event time in a topic partition. |
| 161 | |
| 162 | Args: |
| 163 | topic: string, Required. The topic for which we should compute the cursor. (required) |
| 164 | body: object, The request body. |
| 165 | The object takes the form of: |
| 166 | |
| 167 | { # Compute the corresponding cursor for a publish or event time in a topic partition. |
| 168 | "partition": "A String", # Required. The partition for which we should compute the cursor. |
| 169 | "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. |
| 170 | "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. |
| 171 | "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`. |
| 172 | }, |
| 173 | } |
| 174 | |
| 175 | x__xgafv: string, V1 error format. |
| 176 | Allowed values |
| 177 | 1 - v1 error format |
| 178 | 2 - v2 error format |
| 179 | |
| 180 | Returns: |
| 181 | An object of the form: |
| 182 | |
| 183 | { # Response containing the cursor corresponding to a publish or event time in a topic partition. |
| 184 | "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). |
| 185 | "offset": "A String", # The offset of a message within a topic partition. Must be greater than or equal 0. |
| 186 | }, |
| 187 | }</pre> |
| 188 | </div> |
| 189 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 190 | </body></html> |