Skip to content

Commit 77a1a7a

Browse files
chore(pubsublite): update the api
#### pubsublite:v1 The following keys were added: - resources.topicStats.resources.projects.resources.locations.resources.topics.methods.computeHeadCursor (Total Keys: 12) - schemas.ComputeHeadCursorRequest (Total Keys: 4) - schemas.ComputeHeadCursorResponse (Total Keys: 3)
1 parent 8009df8 commit 77a1a7a

File tree

3 files changed

+938
-856
lines changed

3 files changed

+938
-856
lines changed

docs/dyn/pubsublite_v1.admin.projects.locations.topics.html

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ <h3>Method Details</h3>
125125
&quot;publishMibPerSec&quot;: 42, # Publish throughput capacity per partition in MiB/s. Must be &gt;= 4 and &lt;= 16.
126126
&quot;subscribeMibPerSec&quot;: 42, # Subscribe throughput capacity per partition in MiB/s. Must be &gt;= 4 and &lt;= 32.
127127
},
128-
&quot;count&quot;: &quot;A String&quot;, # The number of partitions in the topic. Must be at least 1.
128+
&quot;count&quot;: &quot;A String&quot;, # The number of partitions in the topic. Must be at least 1. Once a topic has been created the number of partitions can be increased but not decreased. Message ordering is not guaranteed across a topic resize. For more information see https://cloud.google.com/pubsub/lite/docs/topics#scaling_capacity
129129
&quot;scale&quot;: 42, # DEPRECATED: Use capacity instead which can express a superset of configurations. Every partition in the topic is allocated throughput equivalent to `scale` times the standard partition throughput (4 MiB/s). This is also reflected in the cost of this topic; a topic with `scale` of 2 and count of 10 is charged for 20 partitions. This value must be in the range [1,4].
130130
},
131131
&quot;retentionConfig&quot;: { # The settings for a topic&#x27;s message retention. # The settings for this topic&#x27;s message retention.
@@ -150,7 +150,7 @@ <h3>Method Details</h3>
150150
&quot;publishMibPerSec&quot;: 42, # Publish throughput capacity per partition in MiB/s. Must be &gt;= 4 and &lt;= 16.
151151
&quot;subscribeMibPerSec&quot;: 42, # Subscribe throughput capacity per partition in MiB/s. Must be &gt;= 4 and &lt;= 32.
152152
},
153-
&quot;count&quot;: &quot;A String&quot;, # The number of partitions in the topic. Must be at least 1.
153+
&quot;count&quot;: &quot;A String&quot;, # The number of partitions in the topic. Must be at least 1. Once a topic has been created the number of partitions can be increased but not decreased. Message ordering is not guaranteed across a topic resize. For more information see https://cloud.google.com/pubsub/lite/docs/topics#scaling_capacity
154154
&quot;scale&quot;: 42, # DEPRECATED: Use capacity instead which can express a superset of configurations. Every partition in the topic is allocated throughput equivalent to `scale` times the standard partition throughput (4 MiB/s). This is also reflected in the cost of this topic; a topic with `scale` of 2 and count of 10 is charged for 20 partitions. This value must be in the range [1,4].
155155
},
156156
&quot;retentionConfig&quot;: { # The settings for a topic&#x27;s message retention. # The settings for this topic&#x27;s message retention.
@@ -199,7 +199,7 @@ <h3>Method Details</h3>
199199
&quot;publishMibPerSec&quot;: 42, # Publish throughput capacity per partition in MiB/s. Must be &gt;= 4 and &lt;= 16.
200200
&quot;subscribeMibPerSec&quot;: 42, # Subscribe throughput capacity per partition in MiB/s. Must be &gt;= 4 and &lt;= 32.
201201
},
202-
&quot;count&quot;: &quot;A String&quot;, # The number of partitions in the topic. Must be at least 1.
202+
&quot;count&quot;: &quot;A String&quot;, # The number of partitions in the topic. Must be at least 1. Once a topic has been created the number of partitions can be increased but not decreased. Message ordering is not guaranteed across a topic resize. For more information see https://cloud.google.com/pubsub/lite/docs/topics#scaling_capacity
203203
&quot;scale&quot;: 42, # DEPRECATED: Use capacity instead which can express a superset of configurations. Every partition in the topic is allocated throughput equivalent to `scale` times the standard partition throughput (4 MiB/s). This is also reflected in the cost of this topic; a topic with `scale` of 2 and count of 10 is charged for 20 partitions. This value must be in the range [1,4].
204204
},
205205
&quot;retentionConfig&quot;: { # The settings for a topic&#x27;s message retention. # The settings for this topic&#x27;s message retention.
@@ -254,7 +254,7 @@ <h3>Method Details</h3>
254254
&quot;publishMibPerSec&quot;: 42, # Publish throughput capacity per partition in MiB/s. Must be &gt;= 4 and &lt;= 16.
255255
&quot;subscribeMibPerSec&quot;: 42, # Subscribe throughput capacity per partition in MiB/s. Must be &gt;= 4 and &lt;= 32.
256256
},
257-
&quot;count&quot;: &quot;A String&quot;, # The number of partitions in the topic. Must be at least 1.
257+
&quot;count&quot;: &quot;A String&quot;, # The number of partitions in the topic. Must be at least 1. Once a topic has been created the number of partitions can be increased but not decreased. Message ordering is not guaranteed across a topic resize. For more information see https://cloud.google.com/pubsub/lite/docs/topics#scaling_capacity
258258
&quot;scale&quot;: 42, # DEPRECATED: Use capacity instead which can express a superset of configurations. Every partition in the topic is allocated throughput equivalent to `scale` times the standard partition throughput (4 MiB/s). This is also reflected in the cost of this topic; a topic with `scale` of 2 and count of 10 is charged for 20 partitions. This value must be in the range [1,4].
259259
},
260260
&quot;retentionConfig&quot;: { # The settings for a topic&#x27;s message retention. # The settings for this topic&#x27;s message retention.
@@ -296,7 +296,7 @@ <h3>Method Details</h3>
296296
&quot;publishMibPerSec&quot;: 42, # Publish throughput capacity per partition in MiB/s. Must be &gt;= 4 and &lt;= 16.
297297
&quot;subscribeMibPerSec&quot;: 42, # Subscribe throughput capacity per partition in MiB/s. Must be &gt;= 4 and &lt;= 32.
298298
},
299-
&quot;count&quot;: &quot;A String&quot;, # The number of partitions in the topic. Must be at least 1.
299+
&quot;count&quot;: &quot;A String&quot;, # The number of partitions in the topic. Must be at least 1. Once a topic has been created the number of partitions can be increased but not decreased. Message ordering is not guaranteed across a topic resize. For more information see https://cloud.google.com/pubsub/lite/docs/topics#scaling_capacity
300300
&quot;scale&quot;: 42, # DEPRECATED: Use capacity instead which can express a superset of configurations. Every partition in the topic is allocated throughput equivalent to `scale` times the standard partition throughput (4 MiB/s). This is also reflected in the cost of this topic; a topic with `scale` of 2 and count of 10 is charged for 20 partitions. This value must be in the range [1,4].
301301
},
302302
&quot;retentionConfig&quot;: { # The settings for a topic&#x27;s message retention. # The settings for this topic&#x27;s message retention.
@@ -321,7 +321,7 @@ <h3>Method Details</h3>
321321
&quot;publishMibPerSec&quot;: 42, # Publish throughput capacity per partition in MiB/s. Must be &gt;= 4 and &lt;= 16.
322322
&quot;subscribeMibPerSec&quot;: 42, # Subscribe throughput capacity per partition in MiB/s. Must be &gt;= 4 and &lt;= 32.
323323
},
324-
&quot;count&quot;: &quot;A String&quot;, # The number of partitions in the topic. Must be at least 1.
324+
&quot;count&quot;: &quot;A String&quot;, # The number of partitions in the topic. Must be at least 1. Once a topic has been created the number of partitions can be increased but not decreased. Message ordering is not guaranteed across a topic resize. For more information see https://cloud.google.com/pubsub/lite/docs/topics#scaling_capacity
325325
&quot;scale&quot;: 42, # DEPRECATED: Use capacity instead which can express a superset of configurations. Every partition in the topic is allocated throughput equivalent to `scale` times the standard partition throughput (4 MiB/s). This is also reflected in the cost of this topic; a topic with `scale` of 2 and count of 10 is charged for 20 partitions. This value must be in the range [1,4].
326326
},
327327
&quot;retentionConfig&quot;: { # The settings for a topic&#x27;s message retention. # The settings for this topic&#x27;s message retention.

docs/dyn/pubsublite_v1.topicStats.projects.locations.topics.html

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,9 @@ <h2>Instance Methods</h2>
7777
<p class="toc_element">
7878
<code><a href="#close">close()</a></code></p>
7979
<p class="firstline">Close httplib2 connections.</p>
80+
<p class="toc_element">
81+
<code><a href="#computeHeadCursor">computeHeadCursor(topic, body=None, x__xgafv=None)</a></code></p>
82+
<p class="firstline">Compute the head cursor for the partition. The head cursor’s offset is guaranteed to be before or equal to all messages which have not yet been acknowledged to be published, and greater than the offset of any message whose publish has already been acknowledged. It is 0 if there have never been messages on the partition.</p>
8083
<p class="toc_element">
8184
<code><a href="#computeMessageStats">computeMessageStats(topic, body=None, x__xgafv=None)</a></code></p>
8285
<p class="firstline">Compute statistics about a range of messages in a given topic and partition.</p>
@@ -86,6 +89,34 @@ <h3>Method Details</h3>
8689
<pre>Close httplib2 connections.</pre>
8790
</div>
8891

92+
<div class="method">
93+
<code class="details" id="computeHeadCursor">computeHeadCursor(topic, body=None, x__xgafv=None)</code>
94+
<pre>Compute the head cursor for the partition. The head cursor’s offset is guaranteed to be before or equal to all messages which have not yet been acknowledged to be published, and greater than the offset of any message whose publish has already been acknowledged. It is 0 if there have never been messages on the partition.
95+
96+
Args:
97+
topic: string, Required. The topic for which we should compute the head cursor. (required)
98+
body: object, The request body.
99+
The object takes the form of:
100+
101+
{ # Compute the current head cursor for a partition.
102+
&quot;partition&quot;: &quot;A String&quot;, # Required. The partition for which we should compute the head cursor.
103+
}
104+
105+
x__xgafv: string, V1 error format.
106+
Allowed values
107+
1 - v1 error format
108+
2 - v2 error format
109+
110+
Returns:
111+
An object of the form:
112+
113+
{ # Response containing the head cursor for the requested topic and partition.
114+
&quot;headCursor&quot;: { # A cursor that describes the position of a message within a topic partition. # The head cursor.
115+
&quot;offset&quot;: &quot;A String&quot;, # The offset of a message within a topic partition. Must be greater than or equal 0.
116+
},
117+
}</pre>
118+
</div>
119+
89120
<div class="method">
90121
<code class="details" id="computeMessageStats">computeMessageStats(topic, body=None, x__xgafv=None)</code>
91122
<pre>Compute statistics about a range of messages in a given topic and partition.

0 commit comments

Comments
 (0)