blob: ae0deb0f5df398b60cf4bc4be824e2866a554d05 [file] [log] [blame]
Dmitry Frenkel3e17f892020-10-06 16:46:05 -07001<html><body>
2<style>
3
4body, 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
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, 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.admin.html">admin</a> . <a href="pubsublite_v1.admin.projects.html">projects</a> . <a href="pubsublite_v1.admin.projects.locations.html">locations</a> . <a href="pubsublite_v1.admin.projects.locations.subscriptions.html">subscriptions</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-bota8b35b92021-03-31 13:33:30 -070081 <code><a href="#create">create(parent, body=None, skipBacklog=None, subscriptionId=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070082<p class="firstline">Creates a new subscription.</p>
83<p class="toc_element">
84 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
85<p class="firstline">Deletes the specified subscription.</p>
86<p class="toc_element">
87 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
88<p class="firstline">Returns the subscription configuration.</p>
89<p class="toc_element">
Yoshi Automation Botc2228be2020-11-24 15:48:03 -080090 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070091<p class="firstline">Returns the list of subscriptions for the given project.</p>
92<p class="toc_element">
93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
94<p class="firstline">Retrieves the next page of results.</p>
95<p class="toc_element">
96 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
97<p class="firstline">Updates properties of the specified subscription.</p>
yoshi-code-bot3e4b5db2021-08-10 00:22:29 -070098<p class="toc_element">
99 <code><a href="#seek">seek(name, body=None, x__xgafv=None)</a></code></p>
100<p class="firstline">Performs an out-of-band seek for a subscription to a specified target, which may be timestamps or named positions within the message backlog. Seek translates these targets to cursors for each partition and orchestrates subscribers to start consuming messages from these seek cursors. If an operation is returned, the seek has been registered and subscribers will eventually receive messages from the seek cursors (i.e. eventual consistency), as long as they are using a minimum supported client library version and not a system that tracks cursors independently of Pub/Sub Lite (e.g. Apache Beam, Dataflow, Spark). The seek operation will fail for unsupported clients. If clients would like to know when subscribers react to the seek (or not), they can poll the operation. The seek operation will succeed and complete once subscribers are ready to receive messages from the seek cursors for all partitions of the topic. This means that the seek operation will not complete until all subscribers come online. If the previous seek operation has not yet completed, it will be aborted and the new invocation of seek will supersede it.</p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700101<h3>Method Details</h3>
102<div class="method">
103 <code class="details" id="close">close()</code>
104 <pre>Close httplib2 connections.</pre>
105</div>
106
107<div class="method">
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700108 <code class="details" id="create">create(parent, body=None, skipBacklog=None, subscriptionId=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700109 <pre>Creates a new subscription.
110
111Args:
112 parent: string, Required. The parent location in which to create the subscription. Structured like `projects/{project_number}/locations/{location}`. (required)
113 body: object, The request body.
114 The object takes the form of:
115
116{ # Metadata about a subscription resource.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800117 &quot;deliveryConfig&quot;: { # The settings for a subscription&#x27;s message delivery. # The settings for this subscription&#x27;s message delivery.
118 &quot;deliveryRequirement&quot;: &quot;A String&quot;, # The DeliveryRequirement for this subscription.
119 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800120 &quot;name&quot;: &quot;A String&quot;, # The name of the subscription. Structured like: projects/{project_number}/locations/{location}/subscriptions/{subscription_id}
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800121 &quot;topic&quot;: &quot;A String&quot;, # The name of the topic this subscription is attached to. Structured like: projects/{project_number}/locations/{location}/topics/{topic_id}
122}
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700123
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700124 skipBacklog: boolean, If true, the newly created subscription will only receive messages published after the subscription was created. Otherwise, the entire message backlog will be received on the subscription. Defaults to false.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700125 subscriptionId: string, Required. The ID to use for the subscription, which will become the final component of the subscription&#x27;s name. This value is structured like: `my-sub-name`.
126 x__xgafv: string, V1 error format.
127 Allowed values
128 1 - v1 error format
129 2 - v2 error format
130
131Returns:
132 An object of the form:
133
134 { # Metadata about a subscription resource.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800135 &quot;deliveryConfig&quot;: { # The settings for a subscription&#x27;s message delivery. # The settings for this subscription&#x27;s message delivery.
136 &quot;deliveryRequirement&quot;: &quot;A String&quot;, # The DeliveryRequirement for this subscription.
137 },
138 &quot;name&quot;: &quot;A String&quot;, # The name of the subscription. Structured like: projects/{project_number}/locations/{location}/subscriptions/{subscription_id}
139 &quot;topic&quot;: &quot;A String&quot;, # The name of the topic this subscription is attached to. Structured like: projects/{project_number}/locations/{location}/topics/{topic_id}
140}</pre>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700141</div>
142
143<div class="method">
144 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
145 <pre>Deletes the specified subscription.
146
147Args:
148 name: string, Required. The name of the subscription to delete. (required)
149 x__xgafv: string, V1 error format.
150 Allowed values
151 1 - v1 error format
152 2 - v2 error format
153
154Returns:
155 An object of the form:
156
157 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800158}</pre>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700159</div>
160
161<div class="method">
162 <code class="details" id="get">get(name, x__xgafv=None)</code>
163 <pre>Returns the subscription configuration.
164
165Args:
166 name: string, Required. The name of the subscription whose configuration to return. (required)
167 x__xgafv: string, V1 error format.
168 Allowed values
169 1 - v1 error format
170 2 - v2 error format
171
172Returns:
173 An object of the form:
174
175 { # Metadata about a subscription resource.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800176 &quot;deliveryConfig&quot;: { # The settings for a subscription&#x27;s message delivery. # The settings for this subscription&#x27;s message delivery.
177 &quot;deliveryRequirement&quot;: &quot;A String&quot;, # The DeliveryRequirement for this subscription.
178 },
179 &quot;name&quot;: &quot;A String&quot;, # The name of the subscription. Structured like: projects/{project_number}/locations/{location}/subscriptions/{subscription_id}
180 &quot;topic&quot;: &quot;A String&quot;, # The name of the topic this subscription is attached to. Structured like: projects/{project_number}/locations/{location}/topics/{topic_id}
181}</pre>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700182</div>
183
184<div class="method">
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800185 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700186 <pre>Returns the list of subscriptions for the given project.
187
188Args:
189 parent: string, Required. The parent whose subscriptions are to be listed. Structured like `projects/{project_number}/locations/{location}`. (required)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700190 pageSize: integer, The maximum number of subscriptions to return. The service may return fewer than this value. If unset or zero, all subscriptions for the parent will be returned.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800191 pageToken: string, A page token, received from a previous `ListSubscriptions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSubscriptions` must match the call that provided the page token.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700192 x__xgafv: string, V1 error format.
193 Allowed values
194 1 - v1 error format
195 2 - v2 error format
196
197Returns:
198 An object of the form:
199
200 { # Response for ListSubscriptions.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800201 &quot;nextPageToken&quot;: &quot;A String&quot;, # A token that can be sent as `page_token` to retrieve the next page of results. If this field is omitted, there are no more results.
202 &quot;subscriptions&quot;: [ # The list of subscriptions in the requested parent. The order of the subscriptions is unspecified.
203 { # Metadata about a subscription resource.
204 &quot;deliveryConfig&quot;: { # The settings for a subscription&#x27;s message delivery. # The settings for this subscription&#x27;s message delivery.
205 &quot;deliveryRequirement&quot;: &quot;A String&quot;, # The DeliveryRequirement for this subscription.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800206 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800207 &quot;name&quot;: &quot;A String&quot;, # The name of the subscription. Structured like: projects/{project_number}/locations/{location}/subscriptions/{subscription_id}
208 &quot;topic&quot;: &quot;A String&quot;, # The name of the topic this subscription is attached to. Structured like: projects/{project_number}/locations/{location}/topics/{topic_id}
209 },
210 ],
211}</pre>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700212</div>
213
214<div class="method">
215 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
216 <pre>Retrieves the next page of results.
217
218Args:
219 previous_request: The request for the previous page. (required)
220 previous_response: The response from the request for the previous page. (required)
221
222Returns:
223 A request object that you can call &#x27;execute()&#x27; on to request the next
224 page. Returns None if there are no more items in the collection.
225 </pre>
226</div>
227
228<div class="method">
229 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
230 <pre>Updates properties of the specified subscription.
231
232Args:
233 name: string, The name of the subscription. Structured like: projects/{project_number}/locations/{location}/subscriptions/{subscription_id} (required)
234 body: object, The request body.
235 The object takes the form of:
236
237{ # Metadata about a subscription resource.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800238 &quot;deliveryConfig&quot;: { # The settings for a subscription&#x27;s message delivery. # The settings for this subscription&#x27;s message delivery.
239 &quot;deliveryRequirement&quot;: &quot;A String&quot;, # The DeliveryRequirement for this subscription.
240 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800241 &quot;name&quot;: &quot;A String&quot;, # The name of the subscription. Structured like: projects/{project_number}/locations/{location}/subscriptions/{subscription_id}
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800242 &quot;topic&quot;: &quot;A String&quot;, # The name of the topic this subscription is attached to. Structured like: projects/{project_number}/locations/{location}/topics/{topic_id}
243}
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700244
245 updateMask: string, Required. A mask specifying the subscription fields to change.
246 x__xgafv: string, V1 error format.
247 Allowed values
248 1 - v1 error format
249 2 - v2 error format
250
251Returns:
252 An object of the form:
253
254 { # Metadata about a subscription resource.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800255 &quot;deliveryConfig&quot;: { # The settings for a subscription&#x27;s message delivery. # The settings for this subscription&#x27;s message delivery.
256 &quot;deliveryRequirement&quot;: &quot;A String&quot;, # The DeliveryRequirement for this subscription.
257 },
258 &quot;name&quot;: &quot;A String&quot;, # The name of the subscription. Structured like: projects/{project_number}/locations/{location}/subscriptions/{subscription_id}
259 &quot;topic&quot;: &quot;A String&quot;, # The name of the topic this subscription is attached to. Structured like: projects/{project_number}/locations/{location}/topics/{topic_id}
260}</pre>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700261</div>
262
yoshi-code-bot3e4b5db2021-08-10 00:22:29 -0700263<div class="method">
264 <code class="details" id="seek">seek(name, body=None, x__xgafv=None)</code>
265 <pre>Performs an out-of-band seek for a subscription to a specified target, which may be timestamps or named positions within the message backlog. Seek translates these targets to cursors for each partition and orchestrates subscribers to start consuming messages from these seek cursors. If an operation is returned, the seek has been registered and subscribers will eventually receive messages from the seek cursors (i.e. eventual consistency), as long as they are using a minimum supported client library version and not a system that tracks cursors independently of Pub/Sub Lite (e.g. Apache Beam, Dataflow, Spark). The seek operation will fail for unsupported clients. If clients would like to know when subscribers react to the seek (or not), they can poll the operation. The seek operation will succeed and complete once subscribers are ready to receive messages from the seek cursors for all partitions of the topic. This means that the seek operation will not complete until all subscribers come online. If the previous seek operation has not yet completed, it will be aborted and the new invocation of seek will supersede it.
266
267Args:
268 name: string, Required. The name of the subscription to seek. (required)
269 body: object, The request body.
270 The object takes the form of:
271
272{ # Request for SeekSubscription.
273 &quot;namedTarget&quot;: &quot;A String&quot;, # Seek to a named position with respect to the message backlog.
274 &quot;timeTarget&quot;: { # A target publish or event time. Can be used for seeking to or retrieving the corresponding cursor. # Seek to the first message whose publish or event time is greater than or equal to the specified query time. If no such message can be located, will seek to the end of the message backlog.
275 &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.
276 &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`.
277 },
278}
279
280 x__xgafv: string, V1 error format.
281 Allowed values
282 1 - v1 error format
283 2 - v2 error format
284
285Returns:
286 An object of the form:
287
288 { # This resource represents a long-running operation that is the result of a network API call.
289 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
290 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
291 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
292 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
293 {
294 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
295 },
296 ],
297 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
298 },
299 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
300 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
301 },
302 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
303 &quot;response&quot;: { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
304 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
305 },
306}</pre>
307</div>
308
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700309</body></html>