Skip to content

Commit dd67e9b

Browse files
feat(pubsublite): update the api
#### pubsublite:v1 The following keys were added: - resources.topicStats.resources.projects.resources.locations.resources.topics.methods.computeTimeCursor (Total Keys: 12) - schemas.ComputeTimeCursorRequest (Total Keys: 5) - schemas.ComputeTimeCursorResponse (Total Keys: 3) - schemas.TimeTarget (Total Keys: 6)
1 parent 2b256b5 commit dd67e9b

File tree

2 files changed

+108
-1
lines changed

2 files changed

+108
-1
lines changed

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

+35
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,9 @@ <h2>Instance Methods</h2>
8383
<p class="toc_element">
8484
<code><a href="#computeMessageStats">computeMessageStats(topic, body=None, x__xgafv=None)</a></code></p>
8585
<p class="firstline">Compute statistics about a range of messages in a given topic and partition.</p>
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>
8689
<h3>Method Details</h3>
8790
<div class="method">
8891
<code class="details" id="close">close()</code>
@@ -152,4 +155,36 @@ <h3>Method Details</h3>
152155
}</pre>
153156
</div>
154157

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+
&quot;partition&quot;: &quot;A String&quot;, # Required. The partition for which we should compute the cursor.
169+
&quot;target&quot;: { # 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+
&quot;eventTime&quot;: &quot;A String&quot;, # 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+
&quot;publishTime&quot;: &quot;A String&quot;, # 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 &gt;= `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+
&quot;cursor&quot;: { # 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+
&quot;offset&quot;: &quot;A String&quot;, # The offset of a message within a topic partition. Must be greater than or equal 0.
186+
},
187+
}</pre>
188+
</div>
189+
155190
</body></html>

googleapiclient/discovery_cache/documents/pubsublite.v1.json

+73-1
Original file line numberDiff line numberDiff line change
@@ -652,6 +652,34 @@
652652
"scopes": [
653653
"https://www.googleapis.com/auth/cloud-platform"
654654
]
655+
},
656+
"computeTimeCursor": {
657+
"description": "Compute the corresponding cursor for a publish or event time in a topic partition.",
658+
"flatPath": "v1/topicStats/projects/{projectsId}/locations/{locationsId}/topics/{topicsId}:computeTimeCursor",
659+
"httpMethod": "POST",
660+
"id": "pubsublite.topicStats.projects.locations.topics.computeTimeCursor",
661+
"parameterOrder": [
662+
"topic"
663+
],
664+
"parameters": {
665+
"topic": {
666+
"description": "Required. The topic for which we should compute the cursor.",
667+
"location": "path",
668+
"pattern": "^projects/[^/]+/locations/[^/]+/topics/[^/]+$",
669+
"required": true,
670+
"type": "string"
671+
}
672+
},
673+
"path": "v1/topicStats/{+topic}:computeTimeCursor",
674+
"request": {
675+
"$ref": "ComputeTimeCursorRequest"
676+
},
677+
"response": {
678+
"$ref": "ComputeTimeCursorResponse"
679+
},
680+
"scopes": [
681+
"https://www.googleapis.com/auth/cloud-platform"
682+
]
655683
}
656684
}
657685
}
@@ -662,7 +690,7 @@
662690
}
663691
}
664692
},
665-
"revision": "20210504",
693+
"revision": "20210513",
666694
"rootUrl": "https://pubsublite.googleapis.com/",
667695
"schemas": {
668696
"Capacity": {
@@ -774,6 +802,33 @@
774802
},
775803
"type": "object"
776804
},
805+
"ComputeTimeCursorRequest": {
806+
"description": "Compute the corresponding cursor for a publish or event time in a topic partition.",
807+
"id": "ComputeTimeCursorRequest",
808+
"properties": {
809+
"partition": {
810+
"description": "Required. The partition for which we should compute the cursor.",
811+
"format": "int64",
812+
"type": "string"
813+
},
814+
"target": {
815+
"$ref": "TimeTarget",
816+
"description": "Required. The target publish or event time. Specifying a future time will return an unset cursor."
817+
}
818+
},
819+
"type": "object"
820+
},
821+
"ComputeTimeCursorResponse": {
822+
"description": "Response containing the cursor corresponding to a publish or event time in a topic partition.",
823+
"id": "ComputeTimeCursorResponse",
824+
"properties": {
825+
"cursor": {
826+
"$ref": "Cursor",
827+
"description": "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)."
828+
}
829+
},
830+
"type": "object"
831+
},
777832
"Cursor": {
778833
"description": "A cursor that describes the position of a message within a topic partition.",
779834
"id": "Cursor",
@@ -958,6 +1013,23 @@
9581013
},
9591014
"type": "object"
9601015
},
1016+
"TimeTarget": {
1017+
"description": "A target publish or event time. Can be used for seeking to or retrieving the corresponding cursor.",
1018+
"id": "TimeTarget",
1019+
"properties": {
1020+
"eventTime": {
1021+
"description": "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.",
1022+
"format": "google-datetime",
1023+
"type": "string"
1024+
},
1025+
"publishTime": {
1026+
"description": "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`.",
1027+
"format": "google-datetime",
1028+
"type": "string"
1029+
}
1030+
},
1031+
"type": "object"
1032+
},
9611033
"Topic": {
9621034
"description": "Metadata about a topic resource.",
9631035
"id": "Topic",

0 commit comments

Comments
 (0)