Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(145)

Issues Search
    My Issues | Starred     Open | Closed | All

Side by Side Diff: discovery/googleapis/pubsub__v1.json

Issue 2973303002: Api-Roll 51: 2017-07-10 (Closed)
Patch Set: Created 3 years, 5 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch
« no previous file with comments | « discovery/googleapis/plus__v1.json ('k') | discovery/googleapis/runtimeconfig__v1.json » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
1 { 1 {
2 "auth": { 2 "auth": {
3 "oauth2": { 3 "oauth2": {
4 "scopes": { 4 "scopes": {
5 "https://www.googleapis.com/auth/cloud-platform": { 5 "https://www.googleapis.com/auth/cloud-platform": {
6 "description": "View and manage your data across Google Clou d Platform services" 6 "description": "View and manage your data across Google Clou d Platform services"
7 }, 7 },
8 "https://www.googleapis.com/auth/pubsub": { 8 "https://www.googleapis.com/auth/pubsub": {
9 "description": "View and manage Pub/Sub topics and subscript ions" 9 "description": "View and manage Pub/Sub topics and subscript ions"
10 } 10 }
(...skipping 10 matching lines...) Expand all
21 "icons": { 21 "icons": {
22 "x16": "http://www.google.com/images/icons/product/search-16.gif", 22 "x16": "http://www.google.com/images/icons/product/search-16.gif",
23 "x32": "http://www.google.com/images/icons/product/search-32.gif" 23 "x32": "http://www.google.com/images/icons/product/search-32.gif"
24 }, 24 },
25 "id": "pubsub:v1", 25 "id": "pubsub:v1",
26 "kind": "discovery#restDescription", 26 "kind": "discovery#restDescription",
27 "name": "pubsub", 27 "name": "pubsub",
28 "ownerDomain": "google.com", 28 "ownerDomain": "google.com",
29 "ownerName": "Google", 29 "ownerName": "Google",
30 "parameters": { 30 "parameters": {
31 "fields": { 31 "key": {
32 "description": "Selector specifying which fields to include in a par tial response.", 32 "description": "API key. Your API key identifies your project and pr ovides you with API access, quota, and reports. Required unless you provide an O Auth 2.0 token.",
33 "location": "query", 33 "location": "query",
34 "type": "string" 34 "type": "string"
35 }, 35 },
36 "uploadType": {
37 "description": "Legacy upload protocol for media (e.g. \"media\", \" multipart\").",
38 "location": "query",
39 "type": "string"
40 },
41 "$.xgafv": {
42 "description": "V1 error format.",
43 "enum": [
44 "1",
45 "2"
46 ],
47 "enumDescriptions": [
48 "v1 error format",
49 "v2 error format"
50 ],
51 "location": "query",
52 "type": "string"
53 },
54 "callback": {
55 "description": "JSONP",
56 "location": "query",
57 "type": "string"
58 },
59 "alt": {
60 "default": "json",
61 "description": "Data format for response.",
62 "enum": [
63 "json",
64 "media",
65 "proto"
66 ],
67 "enumDescriptions": [
68 "Responses with Content-Type of application/json",
69 "Media download with context-dependent Content-Type",
70 "Responses with Content-Type of application/x-protobuf"
71 ],
72 "location": "query",
73 "type": "string"
74 },
75 "access_token": { 36 "access_token": {
76 "description": "OAuth access token.", 37 "description": "OAuth access token.",
77 "location": "query", 38 "location": "query",
78 "type": "string" 39 "type": "string"
79 }, 40 },
80 "key": {
81 "description": "API key. Your API key identifies your project and pr ovides you with API access, quota, and reports. Required unless you provide an O Auth 2.0 token.",
82 "location": "query",
83 "type": "string"
84 },
85 "quotaUser": { 41 "quotaUser": {
86 "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exc eed 40 characters.", 42 "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exc eed 40 characters.",
87 "location": "query", 43 "location": "query",
88 "type": "string" 44 "type": "string"
89 }, 45 },
90 "pp": { 46 "pp": {
91 "default": "true", 47 "default": "true",
92 "description": "Pretty-print response.", 48 "description": "Pretty-print response.",
93 "location": "query", 49 "location": "query",
94 "type": "boolean" 50 "type": "boolean"
(...skipping 11 matching lines...) Expand all
106 "upload_protocol": { 62 "upload_protocol": {
107 "description": "Upload protocol for media (e.g. \"raw\", \"multipart \").", 63 "description": "Upload protocol for media (e.g. \"raw\", \"multipart \").",
108 "location": "query", 64 "location": "query",
109 "type": "string" 65 "type": "string"
110 }, 66 },
111 "prettyPrint": { 67 "prettyPrint": {
112 "default": "true", 68 "default": "true",
113 "description": "Returns response with indentations and line breaks." , 69 "description": "Returns response with indentations and line breaks." ,
114 "location": "query", 70 "location": "query",
115 "type": "boolean" 71 "type": "boolean"
72 },
73 "uploadType": {
74 "description": "Legacy upload protocol for media (e.g. \"media\", \" multipart\").",
75 "location": "query",
76 "type": "string"
77 },
78 "fields": {
79 "description": "Selector specifying which fields to include in a par tial response.",
80 "location": "query",
81 "type": "string"
82 },
83 "callback": {
84 "description": "JSONP",
85 "location": "query",
86 "type": "string"
87 },
88 "$.xgafv": {
89 "description": "V1 error format.",
90 "enum": [
91 "1",
92 "2"
93 ],
94 "enumDescriptions": [
95 "v1 error format",
96 "v2 error format"
97 ],
98 "location": "query",
99 "type": "string"
100 },
101 "alt": {
102 "default": "json",
103 "description": "Data format for response.",
104 "enum": [
105 "json",
106 "media",
107 "proto"
108 ],
109 "enumDescriptions": [
110 "Responses with Content-Type of application/json",
111 "Media download with context-dependent Content-Type",
112 "Responses with Content-Type of application/x-protobuf"
113 ],
114 "location": "query",
115 "type": "string"
116 } 116 }
117 }, 117 },
118 "protocol": "rest", 118 "protocol": "rest",
119 "resources": { 119 "resources": {
120 "projects": { 120 "projects": {
121 "resources": { 121 "resources": {
122 "subscriptions": { 122 "topics": {
123 "methods": { 123 "methods": {
124 "create": {
125 "description": "Creates a subscription to a given to pic.\nIf the subscription already exists, returns `ALREADY_EXISTS`.\nIf the corr esponding topic doesn't exist, returns `NOT_FOUND`.\n\nIf the name is not provid ed in the request, the server will assign a random\nname for this subscription o n the same project as the topic, conforming\nto the\n[resource name format](http s://cloud.google.com/pubsub/docs/overview#names).\nThe generated name is populat ed in the returned Subscription object.\nNote that for REST API requests, you mu st specify a name in the request.",
126 "httpMethod": "PUT",
127 "id": "pubsub.projects.subscriptions.create",
128 "parameterOrder": [
129 "name"
130 ],
131 "parameters": {
132 "name": {
133 "description": "The name of the subscription . It must have the format\n`\"projects/{project}/subscriptions/{subscription}\"` . `{subscription}` must\nstart with a letter, and contain only letters (`[A-Za-z ]`), numbers\n(`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),\nplus (`+`) or percent signs (`%`). It must be between 3 and 255 characte rs\nin length, and it must not start with `\"goog\"`.",
134 "location": "path",
135 "pattern": "^projects/[^/]+/subscriptions/[^ /]+$",
136 "required": true,
137 "type": "string"
138 }
139 },
140 "path": "v1/{+name}",
141 "request": {
142 "$ref": "Subscription"
143 },
144 "response": {
145 "$ref": "Subscription"
146 },
147 "scopes": [
148 "https://www.googleapis.com/auth/cloud-platform" ,
149 "https://www.googleapis.com/auth/pubsub"
150 ]
151 },
152 "setIamPolicy": {
153 "description": "Sets the access control policy on th e specified resource. Replaces any\nexisting policy.",
154 "httpMethod": "POST",
155 "id": "pubsub.projects.subscriptions.setIamPolicy",
156 "parameterOrder": [
157 "resource"
158 ],
159 "parameters": {
160 "resource": {
161 "description": "REQUIRED: The resource for w hich the policy is being specified.\nSee the operation documentation for the app ropriate value for this field.",
162 "location": "path",
163 "pattern": "^projects/[^/]+/subscriptions/[^ /]+$",
164 "required": true,
165 "type": "string"
166 }
167 },
168 "path": "v1/{+resource}:setIamPolicy",
169 "request": {
170 "$ref": "SetIamPolicyRequest"
171 },
172 "response": {
173 "$ref": "Policy"
174 },
175 "scopes": [
176 "https://www.googleapis.com/auth/cloud-platform" ,
177 "https://www.googleapis.com/auth/pubsub"
178 ]
179 },
180 "modifyAckDeadline": {
181 "description": "Modifies the ack deadline for a spec ific message. This method is useful\nto indicate that more time is needed to pro cess a message by the\nsubscriber, or to make the message available for redelive ry if the\nprocessing was interrupted. Note that this does not modify the\nsubsc ription-level `ackDeadlineSeconds` used for subsequent messages.",
182 "httpMethod": "POST",
183 "id": "pubsub.projects.subscriptions.modifyAckDeadli ne",
184 "parameterOrder": [
185 "subscription"
186 ],
187 "parameters": {
188 "subscription": {
189 "description": "The name of the subscription .\nFormat is `projects/{project}/subscriptions/{sub}`.",
190 "location": "path",
191 "pattern": "^projects/[^/]+/subscriptions/[^ /]+$",
192 "required": true,
193 "type": "string"
194 }
195 },
196 "path": "v1/{+subscription}:modifyAckDeadline",
197 "request": {
198 "$ref": "ModifyAckDeadlineRequest"
199 },
200 "response": {
201 "$ref": "Empty"
202 },
203 "scopes": [
204 "https://www.googleapis.com/auth/cloud-platform" ,
205 "https://www.googleapis.com/auth/pubsub"
206 ]
207 },
208 "acknowledge": {
209 "description": "Acknowledges the messages associated with the `ack_ids` in the\n`AcknowledgeRequest`. The Pub/Sub system can remove the relevant messages\nfrom the subscription.\n\nAcknowledging a message whose a ck deadline has expired may succeed,\nbut such a message may be redelivered late r. Acknowledging a message more\nthan once will not result in an error.",
210 "httpMethod": "POST",
211 "id": "pubsub.projects.subscriptions.acknowledge",
212 "parameterOrder": [
213 "subscription"
214 ],
215 "parameters": {
216 "subscription": {
217 "description": "The subscription whose messa ge is being acknowledged.\nFormat is `projects/{project}/subscriptions/{sub}`.",
218 "location": "path",
219 "pattern": "^projects/[^/]+/subscriptions/[^ /]+$",
220 "required": true,
221 "type": "string"
222 }
223 },
224 "path": "v1/{+subscription}:acknowledge",
225 "request": {
226 "$ref": "AcknowledgeRequest"
227 },
228 "response": {
229 "$ref": "Empty"
230 },
231 "scopes": [
232 "https://www.googleapis.com/auth/cloud-platform" ,
233 "https://www.googleapis.com/auth/pubsub"
234 ]
235 },
236 "getIamPolicy": { 124 "getIamPolicy": {
237 "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a p olicy\nset.", 125 "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a p olicy\nset.",
238 "httpMethod": "GET", 126 "httpMethod": "GET",
239 "id": "pubsub.projects.subscriptions.getIamPolicy", 127 "id": "pubsub.projects.topics.getIamPolicy",
240 "parameterOrder": [ 128 "parameterOrder": [
241 "resource" 129 "resource"
242 ], 130 ],
243 "parameters": { 131 "parameters": {
244 "resource": { 132 "resource": {
245 "description": "REQUIRED: The resource for w hich the policy is being requested.\nSee the operation documentation for the app ropriate value for this field.", 133 "description": "REQUIRED: The resource for w hich the policy is being requested.\nSee the operation documentation for the app ropriate value for this field.",
246 "location": "path", 134 "location": "path",
247 "pattern": "^projects/[^/]+/subscriptions/[^ /]+$", 135 "pattern": "^projects/[^/]+/topics/[^/]+$",
248 "required": true, 136 "required": true,
249 "type": "string" 137 "type": "string"
250 } 138 }
251 }, 139 },
252 "path": "v1/{+resource}:getIamPolicy", 140 "path": "v1/{+resource}:getIamPolicy",
253 "response": { 141 "response": {
254 "$ref": "Policy" 142 "$ref": "Policy"
255 }, 143 },
256 "scopes": [ 144 "scopes": [
257 "https://www.googleapis.com/auth/cloud-platform" , 145 "https://www.googleapis.com/auth/cloud-platform" ,
258 "https://www.googleapis.com/auth/pubsub" 146 "https://www.googleapis.com/auth/pubsub"
259 ] 147 ]
260 }, 148 },
261 "get": { 149 "get": {
262 "description": "Gets the configuration details of a subscription.", 150 "description": "Gets the configuration of a topic.",
263 "httpMethod": "GET", 151 "httpMethod": "GET",
264 "id": "pubsub.projects.subscriptions.get", 152 "id": "pubsub.projects.topics.get",
265 "parameterOrder": [ 153 "parameterOrder": [
266 "subscription" 154 "topic"
267 ], 155 ],
268 "parameters": { 156 "parameters": {
269 "subscription": { 157 "topic": {
270 "description": "The name of the subscription to get.\nFormat is `projects/{project}/subscriptions/{sub}`.", 158 "description": "The name of the topic to get .\nFormat is `projects/{project}/topics/{topic}`.",
271 "location": "path", 159 "location": "path",
272 "pattern": "^projects/[^/]+/subscriptions/[^ /]+$", 160 "pattern": "^projects/[^/]+/topics/[^/]+$",
273 "required": true, 161 "required": true,
274 "type": "string" 162 "type": "string"
275 } 163 }
276 }, 164 },
277 "path": "v1/{+subscription}", 165 "path": "v1/{+topic}",
278 "response": { 166 "response": {
279 "$ref": "Subscription" 167 "$ref": "Topic"
168 },
169 "scopes": [
170 "https://www.googleapis.com/auth/cloud-platform" ,
171 "https://www.googleapis.com/auth/pubsub"
172 ]
173 },
174 "publish": {
175 "description": "Adds one or more messages to the top ic. Returns `NOT_FOUND` if the topic\ndoes not exist. The message payload must n ot be empty; it must contain\n either a non-empty data field, or at least one at tribute.",
176 "httpMethod": "POST",
177 "id": "pubsub.projects.topics.publish",
178 "parameterOrder": [
179 "topic"
180 ],
181 "parameters": {
182 "topic": {
183 "description": "The messages in the request will be published on this topic.\nFormat is `projects/{project}/topics/{topic}`. ",
184 "location": "path",
185 "pattern": "^projects/[^/]+/topics/[^/]+$",
186 "required": true,
187 "type": "string"
188 }
189 },
190 "path": "v1/{+topic}:publish",
191 "request": {
192 "$ref": "PublishRequest"
193 },
194 "response": {
195 "$ref": "PublishResponse"
280 }, 196 },
281 "scopes": [ 197 "scopes": [
282 "https://www.googleapis.com/auth/cloud-platform" , 198 "https://www.googleapis.com/auth/cloud-platform" ,
283 "https://www.googleapis.com/auth/pubsub" 199 "https://www.googleapis.com/auth/pubsub"
284 ] 200 ]
285 }, 201 },
286 "testIamPermissions": { 202 "testIamPermissions": {
287 "description": "Returns permissions that a caller ha s on the specified resource.\nIf the resource does not exist, this will return a n empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is d esigned to be used for building permission-aware\nUIs and command-line tools, no t for authorization checking. This operation\nmay \"fail open\" without warning. ", 203 "description": "Returns permissions that a caller ha s on the specified resource.\nIf the resource does not exist, this will return a n empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is d esigned to be used for building permission-aware\nUIs and command-line tools, no t for authorization checking. This operation\nmay \"fail open\" without warning. ",
288 "httpMethod": "POST", 204 "httpMethod": "POST",
289 "id": "pubsub.projects.subscriptions.testIamPermissi ons", 205 "id": "pubsub.projects.topics.testIamPermissions",
290 "parameterOrder": [ 206 "parameterOrder": [
291 "resource" 207 "resource"
292 ], 208 ],
293 "parameters": { 209 "parameters": {
294 "resource": { 210 "resource": {
295 "description": "REQUIRED: The resource for w hich the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.", 211 "description": "REQUIRED: The resource for w hich the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
296 "location": "path", 212 "location": "path",
297 "pattern": "^projects/[^/]+/subscriptions/[^ /]+$", 213 "pattern": "^projects/[^/]+/topics/[^/]+$",
298 "required": true, 214 "required": true,
299 "type": "string" 215 "type": "string"
300 } 216 }
301 }, 217 },
302 "path": "v1/{+resource}:testIamPermissions", 218 "path": "v1/{+resource}:testIamPermissions",
303 "request": { 219 "request": {
304 "$ref": "TestIamPermissionsRequest" 220 "$ref": "TestIamPermissionsRequest"
305 }, 221 },
306 "response": { 222 "response": {
307 "$ref": "TestIamPermissionsResponse" 223 "$ref": "TestIamPermissionsResponse"
308 }, 224 },
309 "scopes": [ 225 "scopes": [
310 "https://www.googleapis.com/auth/cloud-platform" , 226 "https://www.googleapis.com/auth/cloud-platform" ,
311 "https://www.googleapis.com/auth/pubsub" 227 "https://www.googleapis.com/auth/pubsub"
312 ] 228 ]
313 }, 229 },
314 "modifyPushConfig": { 230 "delete": {
315 "description": "Modifies the `PushConfig` for a spec ified subscription.\n\nThis may be used to change a push subscription to a pull one (signified by\nan empty `PushConfig`) or vice versa, or change the endpoint URL and other\nattributes of a push subscription. Messages will accumulate for d elivery\ncontinuously through the call regardless of changes to the `PushConfig` .", 231 "description": "Deletes the topic with the given nam e. Returns `NOT_FOUND` if the topic\ndoes not exist. After a topic is deleted, a new topic may be created with\nthe same name; this is an entirely new topic wit h none of the old\nconfiguration or subscriptions. Existing subscriptions to thi s topic are\nnot deleted, but their `topic` field is set to `_deleted-topic_`.",
316 "httpMethod": "POST", 232 "httpMethod": "DELETE",
317 "id": "pubsub.projects.subscriptions.modifyPushConfi g", 233 "id": "pubsub.projects.topics.delete",
318 "parameterOrder": [ 234 "parameterOrder": [
319 "subscription" 235 "topic"
320 ], 236 ],
321 "parameters": { 237 "parameters": {
322 "subscription": { 238 "topic": {
323 "description": "The name of the subscription .\nFormat is `projects/{project}/subscriptions/{sub}`.", 239 "description": "Name of the topic to delete. \nFormat is `projects/{project}/topics/{topic}`.",
324 "location": "path", 240 "location": "path",
325 "pattern": "^projects/[^/]+/subscriptions/[^ /]+$", 241 "pattern": "^projects/[^/]+/topics/[^/]+$",
326 "required": true, 242 "required": true,
327 "type": "string" 243 "type": "string"
328 } 244 }
329 }, 245 },
330 "path": "v1/{+subscription}:modifyPushConfig", 246 "path": "v1/{+topic}",
331 "request": {
332 "$ref": "ModifyPushConfigRequest"
333 },
334 "response": { 247 "response": {
335 "$ref": "Empty" 248 "$ref": "Empty"
336 }, 249 },
337 "scopes": [ 250 "scopes": [
338 "https://www.googleapis.com/auth/cloud-platform" , 251 "https://www.googleapis.com/auth/cloud-platform" ,
339 "https://www.googleapis.com/auth/pubsub" 252 "https://www.googleapis.com/auth/pubsub"
340 ] 253 ]
341 }, 254 },
342 "pull": {
343 "description": "Pulls messages from the server. Retu rns an empty list if there are no\nmessages available in the backlog. The server may return `UNAVAILABLE` if\nthere are too many concurrent pull requests pendin g for the given\nsubscription.",
344 "httpMethod": "POST",
345 "id": "pubsub.projects.subscriptions.pull",
346 "parameterOrder": [
347 "subscription"
348 ],
349 "parameters": {
350 "subscription": {
351 "description": "The subscription from which messages should be pulled.\nFormat is `projects/{project}/subscriptions/{sub}`." ,
352 "location": "path",
353 "pattern": "^projects/[^/]+/subscriptions/[^ /]+$",
354 "required": true,
355 "type": "string"
356 }
357 },
358 "path": "v1/{+subscription}:pull",
359 "request": {
360 "$ref": "PullRequest"
361 },
362 "response": {
363 "$ref": "PullResponse"
364 },
365 "scopes": [
366 "https://www.googleapis.com/auth/cloud-platform" ,
367 "https://www.googleapis.com/auth/pubsub"
368 ]
369 },
370 "delete": {
371 "description": "Deletes an existing subscription. Al l messages retained in the subscription\nare immediately dropped. Calls to `Pull ` after deletion will return\n`NOT_FOUND`. After a subscription is deleted, a ne w one may be created with\nthe same name, but the new one has no association wit h the old\nsubscription or its topic unless the same topic is specified.",
372 "httpMethod": "DELETE",
373 "id": "pubsub.projects.subscriptions.delete",
374 "parameterOrder": [
375 "subscription"
376 ],
377 "parameters": {
378 "subscription": {
379 "description": "The subscription to delete.\ nFormat is `projects/{project}/subscriptions/{sub}`.",
380 "location": "path",
381 "pattern": "^projects/[^/]+/subscriptions/[^ /]+$",
382 "required": true,
383 "type": "string"
384 }
385 },
386 "path": "v1/{+subscription}",
387 "response": {
388 "$ref": "Empty"
389 },
390 "scopes": [
391 "https://www.googleapis.com/auth/cloud-platform" ,
392 "https://www.googleapis.com/auth/pubsub"
393 ]
394 },
395 "list": { 255 "list": {
396 "description": "Lists matching subscriptions.", 256 "description": "Lists matching topics.",
397 "httpMethod": "GET", 257 "httpMethod": "GET",
398 "id": "pubsub.projects.subscriptions.list", 258 "id": "pubsub.projects.topics.list",
399 "parameterOrder": [ 259 "parameterOrder": [
400 "project" 260 "project"
401 ], 261 ],
402 "parameters": { 262 "parameters": {
403 "pageToken": { 263 "pageToken": {
404 "description": "The value returned by the la st `ListSubscriptionsResponse`; indicates that\nthis is a continuation of a prio r `ListSubscriptions` call, and that the\nsystem should return the next page of data.", 264 "description": "The value returned by the la st `ListTopicsResponse`; indicates that this is\na continuation of a prior `List Topics` call, and that the system should\nreturn the next page of data.",
405 "location": "query", 265 "location": "query",
406 "type": "string" 266 "type": "string"
407 }, 267 },
408 "pageSize": { 268 "pageSize": {
409 "description": "Maximum number of subscripti ons to return.", 269 "description": "Maximum number of topics to return.",
410 "format": "int32", 270 "format": "int32",
411 "location": "query", 271 "location": "query",
412 "type": "integer" 272 "type": "integer"
413 }, 273 },
414 "project": { 274 "project": {
415 "description": "The name of the cloud projec t that subscriptions belong to.\nFormat is `projects/{project}`.", 275 "description": "The name of the cloud projec t that topics belong to.\nFormat is `projects/{project}`.",
416 "location": "path", 276 "location": "path",
417 "pattern": "^projects/[^/]+$", 277 "pattern": "^projects/[^/]+$",
418 "required": true, 278 "required": true,
419 "type": "string" 279 "type": "string"
420 } 280 }
421 }, 281 },
422 "path": "v1/{+project}/subscriptions", 282 "path": "v1/{+project}/topics",
423 "response": { 283 "response": {
424 "$ref": "ListSubscriptionsResponse" 284 "$ref": "ListTopicsResponse"
425 }, 285 },
426 "scopes": [ 286 "scopes": [
427 "https://www.googleapis.com/auth/cloud-platform" , 287 "https://www.googleapis.com/auth/cloud-platform" ,
428 "https://www.googleapis.com/auth/pubsub" 288 "https://www.googleapis.com/auth/pubsub"
429 ] 289 ]
290 },
291 "create": {
292 "description": "Creates the given topic with the giv en name.",
293 "httpMethod": "PUT",
294 "id": "pubsub.projects.topics.create",
295 "parameterOrder": [
296 "name"
297 ],
298 "parameters": {
299 "name": {
300 "description": "The name of the topic. It mu st have the format\n`\"projects/{project}/topics/{topic}\"`. `{topic}` must star t with a letter,\nand contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dash es (`-`),\nunderscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent \nsigns (`%`). It must be between 3 and 255 characters in length, and it\nmust n ot start with `\"goog\"`.",
301 "location": "path",
302 "pattern": "^projects/[^/]+/topics/[^/]+$",
303 "required": true,
304 "type": "string"
305 }
306 },
307 "path": "v1/{+name}",
308 "request": {
309 "$ref": "Topic"
310 },
311 "response": {
312 "$ref": "Topic"
313 },
314 "scopes": [
315 "https://www.googleapis.com/auth/cloud-platform" ,
316 "https://www.googleapis.com/auth/pubsub"
317 ]
318 },
319 "setIamPolicy": {
320 "description": "Sets the access control policy on th e specified resource. Replaces any\nexisting policy.",
321 "httpMethod": "POST",
322 "id": "pubsub.projects.topics.setIamPolicy",
323 "parameterOrder": [
324 "resource"
325 ],
326 "parameters": {
327 "resource": {
328 "description": "REQUIRED: The resource for w hich the policy is being specified.\nSee the operation documentation for the app ropriate value for this field.",
329 "location": "path",
330 "pattern": "^projects/[^/]+/topics/[^/]+$",
331 "required": true,
332 "type": "string"
333 }
334 },
335 "path": "v1/{+resource}:setIamPolicy",
336 "request": {
337 "$ref": "SetIamPolicyRequest"
338 },
339 "response": {
340 "$ref": "Policy"
341 },
342 "scopes": [
343 "https://www.googleapis.com/auth/cloud-platform" ,
344 "https://www.googleapis.com/auth/pubsub"
345 ]
346 }
347 },
348 "resources": {
349 "subscriptions": {
350 "methods": {
351 "list": {
352 "description": "Lists the name of the subscr iptions for this topic.",
353 "httpMethod": "GET",
354 "id": "pubsub.projects.topics.subscriptions. list",
355 "parameterOrder": [
356 "topic"
357 ],
358 "parameters": {
359 "pageToken": {
360 "description": "The value returned b y the last `ListTopicSubscriptionsResponse`; indicates\nthat this is a continuat ion of a prior `ListTopicSubscriptions` call, and\nthat the system should return the next page of data.",
361 "location": "query",
362 "type": "string"
363 },
364 "pageSize": {
365 "description": "Maximum number of su bscription names to return.",
366 "format": "int32",
367 "location": "query",
368 "type": "integer"
369 },
370 "topic": {
371 "description": "The name of the topi c that subscriptions are attached to.\nFormat is `projects/{project}/topics/{top ic}`.",
372 "location": "path",
373 "pattern": "^projects/[^/]+/topics/[ ^/]+$",
374 "required": true,
375 "type": "string"
376 }
377 },
378 "path": "v1/{+topic}/subscriptions",
379 "response": {
380 "$ref": "ListTopicSubscriptionsResponse"
381 },
382 "scopes": [
383 "https://www.googleapis.com/auth/cloud-p latform",
384 "https://www.googleapis.com/auth/pubsub"
385 ]
386 }
387 }
430 } 388 }
431 } 389 }
432 }, 390 },
433 "snapshots": { 391 "snapshots": {
434 "methods": { 392 "methods": {
435 "setIamPolicy": { 393 "setIamPolicy": {
436 "description": "Sets the access control policy on th e specified resource. Replaces any\nexisting policy.", 394 "description": "Sets the access control policy on th e specified resource. Replaces any\nexisting policy.",
437 "httpMethod": "POST", 395 "httpMethod": "POST",
438 "id": "pubsub.projects.snapshots.setIamPolicy", 396 "id": "pubsub.projects.snapshots.setIamPolicy",
439 "parameterOrder": [ 397 "parameterOrder": [
(...skipping 68 matching lines...) Expand 10 before | Expand all | Expand 10 after
508 "response": { 466 "response": {
509 "$ref": "Policy" 467 "$ref": "Policy"
510 }, 468 },
511 "scopes": [ 469 "scopes": [
512 "https://www.googleapis.com/auth/cloud-platform" , 470 "https://www.googleapis.com/auth/cloud-platform" ,
513 "https://www.googleapis.com/auth/pubsub" 471 "https://www.googleapis.com/auth/pubsub"
514 ] 472 ]
515 } 473 }
516 } 474 }
517 }, 475 },
518 "topics": { 476 "subscriptions": {
519 "methods": { 477 "methods": {
520 "delete": {
521 "description": "Deletes the topic with the given nam e. Returns `NOT_FOUND` if the topic\ndoes not exist. After a topic is deleted, a new topic may be created with\nthe same name; this is an entirely new topic wit h none of the old\nconfiguration or subscriptions. Existing subscriptions to thi s topic are\nnot deleted, but their `topic` field is set to `_deleted-topic_`.",
522 "httpMethod": "DELETE",
523 "id": "pubsub.projects.topics.delete",
524 "parameterOrder": [
525 "topic"
526 ],
527 "parameters": {
528 "topic": {
529 "description": "Name of the topic to delete. \nFormat is `projects/{project}/topics/{topic}`.",
530 "location": "path",
531 "pattern": "^projects/[^/]+/topics/[^/]+$",
532 "required": true,
533 "type": "string"
534 }
535 },
536 "path": "v1/{+topic}",
537 "response": {
538 "$ref": "Empty"
539 },
540 "scopes": [
541 "https://www.googleapis.com/auth/cloud-platform" ,
542 "https://www.googleapis.com/auth/pubsub"
543 ]
544 },
545 "list": { 478 "list": {
546 "description": "Lists matching topics.", 479 "description": "Lists matching subscriptions.",
547 "httpMethod": "GET", 480 "httpMethod": "GET",
548 "id": "pubsub.projects.topics.list", 481 "id": "pubsub.projects.subscriptions.list",
549 "parameterOrder": [ 482 "parameterOrder": [
550 "project" 483 "project"
551 ], 484 ],
552 "parameters": { 485 "parameters": {
486 "project": {
487 "description": "The name of the cloud projec t that subscriptions belong to.\nFormat is `projects/{project}`.",
488 "location": "path",
489 "pattern": "^projects/[^/]+$",
490 "required": true,
491 "type": "string"
492 },
553 "pageToken": { 493 "pageToken": {
554 "description": "The value returned by the la st `ListTopicsResponse`; indicates that this is\na continuation of a prior `List Topics` call, and that the system should\nreturn the next page of data.", 494 "description": "The value returned by the la st `ListSubscriptionsResponse`; indicates that\nthis is a continuation of a prio r `ListSubscriptions` call, and that the\nsystem should return the next page of data.",
555 "location": "query", 495 "location": "query",
556 "type": "string" 496 "type": "string"
557 }, 497 },
558 "pageSize": { 498 "pageSize": {
559 "description": "Maximum number of topics to return.", 499 "description": "Maximum number of subscripti ons to return.",
560 "format": "int32", 500 "format": "int32",
561 "location": "query", 501 "location": "query",
562 "type": "integer" 502 "type": "integer"
563 },
564 "project": {
565 "description": "The name of the cloud projec t that topics belong to.\nFormat is `projects/{project}`.",
566 "location": "path",
567 "pattern": "^projects/[^/]+$",
568 "required": true,
569 "type": "string"
570 } 503 }
571 }, 504 },
572 "path": "v1/{+project}/topics", 505 "path": "v1/{+project}/subscriptions",
573 "response": { 506 "response": {
574 "$ref": "ListTopicsResponse" 507 "$ref": "ListSubscriptionsResponse"
575 }, 508 },
576 "scopes": [ 509 "scopes": [
577 "https://www.googleapis.com/auth/cloud-platform" , 510 "https://www.googleapis.com/auth/cloud-platform" ,
578 "https://www.googleapis.com/auth/pubsub" 511 "https://www.googleapis.com/auth/pubsub"
579 ] 512 ]
580 }, 513 },
581 "setIamPolicy": { 514 "setIamPolicy": {
582 "description": "Sets the access control policy on th e specified resource. Replaces any\nexisting policy.", 515 "description": "Sets the access control policy on th e specified resource. Replaces any\nexisting policy.",
583 "httpMethod": "POST", 516 "httpMethod": "POST",
584 "id": "pubsub.projects.topics.setIamPolicy", 517 "id": "pubsub.projects.subscriptions.setIamPolicy",
585 "parameterOrder": [ 518 "parameterOrder": [
586 "resource" 519 "resource"
587 ], 520 ],
588 "parameters": { 521 "parameters": {
589 "resource": { 522 "resource": {
590 "description": "REQUIRED: The resource for w hich the policy is being specified.\nSee the operation documentation for the app ropriate value for this field.", 523 "description": "REQUIRED: The resource for w hich the policy is being specified.\nSee the operation documentation for the app ropriate value for this field.",
591 "location": "path", 524 "location": "path",
592 "pattern": "^projects/[^/]+/topics/[^/]+$", 525 "pattern": "^projects/[^/]+/subscriptions/[^ /]+$",
593 "required": true, 526 "required": true,
594 "type": "string" 527 "type": "string"
595 } 528 }
596 }, 529 },
597 "path": "v1/{+resource}:setIamPolicy", 530 "path": "v1/{+resource}:setIamPolicy",
598 "request": { 531 "request": {
599 "$ref": "SetIamPolicyRequest" 532 "$ref": "SetIamPolicyRequest"
600 }, 533 },
601 "response": { 534 "response": {
602 "$ref": "Policy" 535 "$ref": "Policy"
603 }, 536 },
604 "scopes": [ 537 "scopes": [
605 "https://www.googleapis.com/auth/cloud-platform" , 538 "https://www.googleapis.com/auth/cloud-platform" ,
606 "https://www.googleapis.com/auth/pubsub" 539 "https://www.googleapis.com/auth/pubsub"
607 ] 540 ]
608 }, 541 },
609 "create": { 542 "create": {
610 "description": "Creates the given topic with the giv en name.", 543 "description": "Creates a subscription to a given to pic.\nIf the subscription already exists, returns `ALREADY_EXISTS`.\nIf the corr esponding topic doesn't exist, returns `NOT_FOUND`.\n\nIf the name is not provid ed in the request, the server will assign a random\nname for this subscription o n the same project as the topic, conforming\nto the\n[resource name format](http s://cloud.google.com/pubsub/docs/overview#names).\nThe generated name is populat ed in the returned Subscription object.\nNote that for REST API requests, you mu st specify a name in the request.",
611 "httpMethod": "PUT", 544 "httpMethod": "PUT",
612 "id": "pubsub.projects.topics.create", 545 "id": "pubsub.projects.subscriptions.create",
613 "parameterOrder": [ 546 "parameterOrder": [
614 "name" 547 "name"
615 ], 548 ],
616 "parameters": { 549 "parameters": {
617 "name": { 550 "name": {
618 "description": "The name of the topic. It mu st have the format\n`\"projects/{project}/topics/{topic}\"`. `{topic}` must star t with a letter,\nand contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dash es (`-`),\nunderscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent \nsigns (`%`). It must be between 3 and 255 characters in length, and it\nmust n ot start with `\"goog\"`.", 551 "description": "The name of the subscription . It must have the format\n`\"projects/{project}/subscriptions/{subscription}\"` . `{subscription}` must\nstart with a letter, and contain only letters (`[A-Za-z ]`), numbers\n(`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),\nplus (`+`) or percent signs (`%`). It must be between 3 and 255 characte rs\nin length, and it must not start with `\"goog\"`.",
619 "location": "path", 552 "location": "path",
620 "pattern": "^projects/[^/]+/topics/[^/]+$", 553 "pattern": "^projects/[^/]+/subscriptions/[^ /]+$",
621 "required": true, 554 "required": true,
622 "type": "string" 555 "type": "string"
623 } 556 }
624 }, 557 },
625 "path": "v1/{+name}", 558 "path": "v1/{+name}",
626 "request": { 559 "request": {
627 "$ref": "Topic" 560 "$ref": "Subscription"
628 }, 561 },
629 "response": { 562 "response": {
630 "$ref": "Topic" 563 "$ref": "Subscription"
631 }, 564 },
632 "scopes": [ 565 "scopes": [
633 "https://www.googleapis.com/auth/cloud-platform" , 566 "https://www.googleapis.com/auth/cloud-platform" ,
567 "https://www.googleapis.com/auth/pubsub"
568 ]
569 },
570 "acknowledge": {
571 "description": "Acknowledges the messages associated with the `ack_ids` in the\n`AcknowledgeRequest`. The Pub/Sub system can remove the relevant messages\nfrom the subscription.\n\nAcknowledging a message whose a ck deadline has expired may succeed,\nbut such a message may be redelivered late r. Acknowledging a message more\nthan once will not result in an error.",
572 "httpMethod": "POST",
573 "id": "pubsub.projects.subscriptions.acknowledge",
574 "parameterOrder": [
575 "subscription"
576 ],
577 "parameters": {
578 "subscription": {
579 "description": "The subscription whose messa ge is being acknowledged.\nFormat is `projects/{project}/subscriptions/{sub}`.",
580 "location": "path",
581 "pattern": "^projects/[^/]+/subscriptions/[^ /]+$",
582 "required": true,
583 "type": "string"
584 }
585 },
586 "path": "v1/{+subscription}:acknowledge",
587 "request": {
588 "$ref": "AcknowledgeRequest"
589 },
590 "response": {
591 "$ref": "Empty"
592 },
593 "scopes": [
594 "https://www.googleapis.com/auth/cloud-platform" ,
595 "https://www.googleapis.com/auth/pubsub"
596 ]
597 },
598 "modifyAckDeadline": {
599 "description": "Modifies the ack deadline for a spec ific message. This method is useful\nto indicate that more time is needed to pro cess a message by the\nsubscriber, or to make the message available for redelive ry if the\nprocessing was interrupted. Note that this does not modify the\nsubsc ription-level `ackDeadlineSeconds` used for subsequent messages.",
600 "httpMethod": "POST",
601 "id": "pubsub.projects.subscriptions.modifyAckDeadli ne",
602 "parameterOrder": [
603 "subscription"
604 ],
605 "parameters": {
606 "subscription": {
607 "description": "The name of the subscription .\nFormat is `projects/{project}/subscriptions/{sub}`.",
608 "location": "path",
609 "pattern": "^projects/[^/]+/subscriptions/[^ /]+$",
610 "required": true,
611 "type": "string"
612 }
613 },
614 "path": "v1/{+subscription}:modifyAckDeadline",
615 "request": {
616 "$ref": "ModifyAckDeadlineRequest"
617 },
618 "response": {
619 "$ref": "Empty"
620 },
621 "scopes": [
622 "https://www.googleapis.com/auth/cloud-platform" ,
634 "https://www.googleapis.com/auth/pubsub" 623 "https://www.googleapis.com/auth/pubsub"
635 ] 624 ]
636 }, 625 },
637 "getIamPolicy": { 626 "getIamPolicy": {
638 "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a p olicy\nset.", 627 "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a p olicy\nset.",
639 "httpMethod": "GET", 628 "httpMethod": "GET",
640 "id": "pubsub.projects.topics.getIamPolicy", 629 "id": "pubsub.projects.subscriptions.getIamPolicy",
641 "parameterOrder": [ 630 "parameterOrder": [
642 "resource" 631 "resource"
643 ], 632 ],
644 "parameters": { 633 "parameters": {
645 "resource": { 634 "resource": {
646 "description": "REQUIRED: The resource for w hich the policy is being requested.\nSee the operation documentation for the app ropriate value for this field.", 635 "description": "REQUIRED: The resource for w hich the policy is being requested.\nSee the operation documentation for the app ropriate value for this field.",
647 "location": "path", 636 "location": "path",
648 "pattern": "^projects/[^/]+/topics/[^/]+$", 637 "pattern": "^projects/[^/]+/subscriptions/[^ /]+$",
649 "required": true, 638 "required": true,
650 "type": "string" 639 "type": "string"
651 } 640 }
652 }, 641 },
653 "path": "v1/{+resource}:getIamPolicy", 642 "path": "v1/{+resource}:getIamPolicy",
654 "response": { 643 "response": {
655 "$ref": "Policy" 644 "$ref": "Policy"
656 }, 645 },
657 "scopes": [ 646 "scopes": [
658 "https://www.googleapis.com/auth/cloud-platform" , 647 "https://www.googleapis.com/auth/cloud-platform" ,
659 "https://www.googleapis.com/auth/pubsub" 648 "https://www.googleapis.com/auth/pubsub"
660 ] 649 ]
661 }, 650 },
662 "get": { 651 "get": {
663 "description": "Gets the configuration of a topic.", 652 "description": "Gets the configuration details of a subscription.",
664 "httpMethod": "GET", 653 "httpMethod": "GET",
665 "id": "pubsub.projects.topics.get", 654 "id": "pubsub.projects.subscriptions.get",
666 "parameterOrder": [ 655 "parameterOrder": [
667 "topic" 656 "subscription"
668 ], 657 ],
669 "parameters": { 658 "parameters": {
670 "topic": { 659 "subscription": {
671 "description": "The name of the topic to get .\nFormat is `projects/{project}/topics/{topic}`.", 660 "description": "The name of the subscription to get.\nFormat is `projects/{project}/subscriptions/{sub}`.",
672 "location": "path", 661 "location": "path",
673 "pattern": "^projects/[^/]+/topics/[^/]+$", 662 "pattern": "^projects/[^/]+/subscriptions/[^ /]+$",
674 "required": true, 663 "required": true,
675 "type": "string" 664 "type": "string"
676 } 665 }
677 }, 666 },
678 "path": "v1/{+topic}", 667 "path": "v1/{+subscription}",
679 "response": { 668 "response": {
680 "$ref": "Topic" 669 "$ref": "Subscription"
681 },
682 "scopes": [
683 "https://www.googleapis.com/auth/cloud-platform" ,
684 "https://www.googleapis.com/auth/pubsub"
685 ]
686 },
687 "publish": {
688 "description": "Adds one or more messages to the top ic. Returns `NOT_FOUND` if the topic\ndoes not exist. The message payload must n ot be empty; it must contain\n either a non-empty data field, or at least one at tribute.",
689 "httpMethod": "POST",
690 "id": "pubsub.projects.topics.publish",
691 "parameterOrder": [
692 "topic"
693 ],
694 "parameters": {
695 "topic": {
696 "description": "The messages in the request will be published on this topic.\nFormat is `projects/{project}/topics/{topic}`. ",
697 "location": "path",
698 "pattern": "^projects/[^/]+/topics/[^/]+$",
699 "required": true,
700 "type": "string"
701 }
702 },
703 "path": "v1/{+topic}:publish",
704 "request": {
705 "$ref": "PublishRequest"
706 },
707 "response": {
708 "$ref": "PublishResponse"
709 }, 670 },
710 "scopes": [ 671 "scopes": [
711 "https://www.googleapis.com/auth/cloud-platform" , 672 "https://www.googleapis.com/auth/cloud-platform" ,
712 "https://www.googleapis.com/auth/pubsub" 673 "https://www.googleapis.com/auth/pubsub"
713 ] 674 ]
714 }, 675 },
715 "testIamPermissions": { 676 "testIamPermissions": {
716 "description": "Returns permissions that a caller ha s on the specified resource.\nIf the resource does not exist, this will return a n empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is d esigned to be used for building permission-aware\nUIs and command-line tools, no t for authorization checking. This operation\nmay \"fail open\" without warning. ", 677 "description": "Returns permissions that a caller ha s on the specified resource.\nIf the resource does not exist, this will return a n empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is d esigned to be used for building permission-aware\nUIs and command-line tools, no t for authorization checking. This operation\nmay \"fail open\" without warning. ",
717 "httpMethod": "POST", 678 "httpMethod": "POST",
718 "id": "pubsub.projects.topics.testIamPermissions", 679 "id": "pubsub.projects.subscriptions.testIamPermissi ons",
719 "parameterOrder": [ 680 "parameterOrder": [
720 "resource" 681 "resource"
721 ], 682 ],
722 "parameters": { 683 "parameters": {
723 "resource": { 684 "resource": {
724 "description": "REQUIRED: The resource for w hich the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.", 685 "description": "REQUIRED: The resource for w hich the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
725 "location": "path", 686 "location": "path",
726 "pattern": "^projects/[^/]+/topics/[^/]+$", 687 "pattern": "^projects/[^/]+/subscriptions/[^ /]+$",
727 "required": true, 688 "required": true,
728 "type": "string" 689 "type": "string"
729 } 690 }
730 }, 691 },
731 "path": "v1/{+resource}:testIamPermissions", 692 "path": "v1/{+resource}:testIamPermissions",
732 "request": { 693 "request": {
733 "$ref": "TestIamPermissionsRequest" 694 "$ref": "TestIamPermissionsRequest"
734 }, 695 },
735 "response": { 696 "response": {
736 "$ref": "TestIamPermissionsResponse" 697 "$ref": "TestIamPermissionsResponse"
737 }, 698 },
738 "scopes": [ 699 "scopes": [
739 "https://www.googleapis.com/auth/cloud-platform" , 700 "https://www.googleapis.com/auth/cloud-platform" ,
740 "https://www.googleapis.com/auth/pubsub" 701 "https://www.googleapis.com/auth/pubsub"
741 ] 702 ]
742 } 703 },
743 }, 704 "modifyPushConfig": {
744 "resources": { 705 "description": "Modifies the `PushConfig` for a spec ified subscription.\n\nThis may be used to change a push subscription to a pull one (signified by\nan empty `PushConfig`) or vice versa, or change the endpoint URL and other\nattributes of a push subscription. Messages will accumulate for d elivery\ncontinuously through the call regardless of changes to the `PushConfig` .",
745 "subscriptions": { 706 "httpMethod": "POST",
746 "methods": { 707 "id": "pubsub.projects.subscriptions.modifyPushConfi g",
747 "list": { 708 "parameterOrder": [
748 "description": "Lists the name of the subscr iptions for this topic.", 709 "subscription"
749 "httpMethod": "GET", 710 ],
750 "id": "pubsub.projects.topics.subscriptions. list", 711 "parameters": {
751 "parameterOrder": [ 712 "subscription": {
752 "topic" 713 "description": "The name of the subscription .\nFormat is `projects/{project}/subscriptions/{sub}`.",
753 ], 714 "location": "path",
754 "parameters": { 715 "pattern": "^projects/[^/]+/subscriptions/[^ /]+$",
755 "pageToken": { 716 "required": true,
756 "description": "The value returned b y the last `ListTopicSubscriptionsResponse`; indicates\nthat this is a continuat ion of a prior `ListTopicSubscriptions` call, and\nthat the system should return the next page of data.", 717 "type": "string"
757 "location": "query",
758 "type": "string"
759 },
760 "pageSize": {
761 "description": "Maximum number of su bscription names to return.",
762 "format": "int32",
763 "location": "query",
764 "type": "integer"
765 },
766 "topic": {
767 "description": "The name of the topi c that subscriptions are attached to.\nFormat is `projects/{project}/topics/{top ic}`.",
768 "location": "path",
769 "pattern": "^projects/[^/]+/topics/[ ^/]+$",
770 "required": true,
771 "type": "string"
772 }
773 },
774 "path": "v1/{+topic}/subscriptions",
775 "response": {
776 "$ref": "ListTopicSubscriptionsResponse"
777 },
778 "scopes": [
779 "https://www.googleapis.com/auth/cloud-p latform",
780 "https://www.googleapis.com/auth/pubsub"
781 ]
782 } 718 }
783 } 719 },
720 "path": "v1/{+subscription}:modifyPushConfig",
721 "request": {
722 "$ref": "ModifyPushConfigRequest"
723 },
724 "response": {
725 "$ref": "Empty"
726 },
727 "scopes": [
728 "https://www.googleapis.com/auth/cloud-platform" ,
729 "https://www.googleapis.com/auth/pubsub"
730 ]
731 },
732 "pull": {
733 "description": "Pulls messages from the server. Retu rns an empty list if there are no\nmessages available in the backlog. The server may return `UNAVAILABLE` if\nthere are too many concurrent pull requests pendin g for the given\nsubscription.",
734 "httpMethod": "POST",
735 "id": "pubsub.projects.subscriptions.pull",
736 "parameterOrder": [
737 "subscription"
738 ],
739 "parameters": {
740 "subscription": {
741 "description": "The subscription from which messages should be pulled.\nFormat is `projects/{project}/subscriptions/{sub}`." ,
742 "location": "path",
743 "pattern": "^projects/[^/]+/subscriptions/[^ /]+$",
744 "required": true,
745 "type": "string"
746 }
747 },
748 "path": "v1/{+subscription}:pull",
749 "request": {
750 "$ref": "PullRequest"
751 },
752 "response": {
753 "$ref": "PullResponse"
754 },
755 "scopes": [
756 "https://www.googleapis.com/auth/cloud-platform" ,
757 "https://www.googleapis.com/auth/pubsub"
758 ]
759 },
760 "delete": {
761 "description": "Deletes an existing subscription. Al l messages retained in the subscription\nare immediately dropped. Calls to `Pull ` after deletion will return\n`NOT_FOUND`. After a subscription is deleted, a ne w one may be created with\nthe same name, but the new one has no association wit h the old\nsubscription or its topic unless the same topic is specified.",
762 "httpMethod": "DELETE",
763 "id": "pubsub.projects.subscriptions.delete",
764 "parameterOrder": [
765 "subscription"
766 ],
767 "parameters": {
768 "subscription": {
769 "description": "The subscription to delete.\ nFormat is `projects/{project}/subscriptions/{sub}`.",
770 "location": "path",
771 "pattern": "^projects/[^/]+/subscriptions/[^ /]+$",
772 "required": true,
773 "type": "string"
774 }
775 },
776 "path": "v1/{+subscription}",
777 "response": {
778 "$ref": "Empty"
779 },
780 "scopes": [
781 "https://www.googleapis.com/auth/cloud-platform" ,
782 "https://www.googleapis.com/auth/pubsub"
783 ]
784 } 784 }
785 } 785 }
786 } 786 }
787 } 787 }
788 } 788 }
789 }, 789 },
790 "revision": "20170502", 790 "revision": "20170630",
791 "rootUrl": "https://pubsub.googleapis.com/", 791 "rootUrl": "https://pubsub.googleapis.com/",
792 "schemas": { 792 "schemas": {
793 "PublishRequest": {
794 "description": "Request for the Publish method.",
795 "id": "PublishRequest",
796 "properties": {
797 "messages": {
798 "description": "The messages to publish.",
799 "items": {
800 "$ref": "PubsubMessage"
801 },
802 "type": "array"
803 }
804 },
805 "type": "object"
806 },
807 "PublishResponse": {
808 "description": "Response for the `Publish` method.",
809 "id": "PublishResponse",
810 "properties": {
811 "messageIds": {
812 "description": "The server-assigned ID of each published mes sage, in the same order as\nthe messages in the request. IDs are guaranteed to b e unique within\nthe topic.",
813 "items": {
814 "type": "string"
815 },
816 "type": "array"
817 }
818 },
819 "type": "object"
820 },
821 "Subscription": {
822 "description": "A subscription resource.",
823 "id": "Subscription",
824 "properties": {
825 "ackDeadlineSeconds": {
826 "description": "This value is the maximum time after a subsc riber receives a message\nbefore the subscriber should acknowledge the message. After message\ndelivery but before the ack deadline expires and before the messa ge is\nacknowledged, it is an outstanding message and will not be delivered\naga in during that time (on a best-effort basis).\n\nFor pull subscriptions, this va lue is used as the initial value for the ack\ndeadline. To override this value f or a given message, call\n`ModifyAckDeadline` with the corresponding `ack_id` if using\npull.\nThe minimum custom deadline you can specify is 10 seconds.\nThe m aximum custom deadline you can specify is 600 seconds (10 minutes).\nIf this par ameter is 0, a default value of 10 seconds is used.\n\nFor push delivery, this v alue is also used to set the request timeout for\nthe call to the push endpoint. \n\nIf the subscriber never acknowledges the message, the Pub/Sub\nsystem will e ventually redeliver the message.",
827 "format": "int32",
828 "type": "integer"
829 },
830 "name": {
831 "description": "The name of the subscription. It must have t he format\n`\"projects/{project}/subscriptions/{subscription}\"`. `{subscription }` must\nstart with a letter, and contain only letters (`[A-Za-z]`), numbers\n(` [0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),\nplus (`+ `) or percent signs (`%`). It must be between 3 and 255 characters\nin length, a nd it must not start with `\"goog\"`.",
832 "type": "string"
833 },
834 "topic": {
835 "description": "The name of the topic from which this subscr iption is receiving messages.\nFormat is `projects/{project}/topics/{topic}`.\nT he value of this field will be `_deleted-topic_` if the topic has been\ndeleted. ",
836 "type": "string"
837 },
838 "pushConfig": {
839 "$ref": "PushConfig",
840 "description": "If push delivery is used with this subscript ion, this field is\nused to configure it. An empty `pushConfig` signifies that t he subscriber\nwill pull and ack messages using API methods."
841 }
842 },
843 "type": "object"
844 },
845 "TestIamPermissionsRequest": {
846 "description": "Request message for `TestIamPermissions` method.",
847 "id": "TestIamPermissionsRequest",
848 "properties": {
849 "permissions": {
850 "description": "The set of permissions to check for the `res ource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed . For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/ov erview#permissions).",
851 "items": {
852 "type": "string"
853 },
854 "type": "array"
855 }
856 },
857 "type": "object"
858 },
859 "Policy": {
860 "description": "Defines an Identity and Access Management (IAM) poli cy. It is used to\nspecify access control policies for Cloud Platform resources. \n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n `members` to a `role`, where the members can be user accounts, Google groups,\nG oogle domains, and service accounts. A `role` is a named list of permissions\nde fined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike @example.com\",\n \"group:admins@example.com\",\n \"domain :google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccoun t.com\",\n ]\n },\n {\n \"role\": \"roles/viewer \",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide ](https://cloud.google.com/iam).",
861 "id": "Policy",
862 "properties": {
863 "etag": {
864 "description": "`etag` is used for optimistic concurrency co ntrol as a way to help\nprevent simultaneous updates of a policy from overwritin g each other.\nIt is strongly suggested that systems make use of the `etag` in t he\nread-modify-write cycle to perform policy updates in order to avoid race\nco nditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that t heir change will be applied to the same version of the policy.\n\nIf no `etag` i s provided in the call to `setIamPolicy`, then the existing\npolicy is overwritt en blindly.",
865 "format": "byte",
866 "type": "string"
867 },
868 "version": {
869 "description": "Version of the `Policy`. The default version is 0.",
870 "format": "int32",
871 "type": "integer"
872 },
873 "bindings": {
874 "description": "Associates a list of `members` to a `role`.\ nMultiple `bindings` must not be specified for the same `role`.\n`bindings` with no members will result in an error.",
875 "items": {
876 "$ref": "Binding"
877 },
878 "type": "array"
879 }
880 },
881 "type": "object"
882 },
883 "Topic": {
884 "description": "A topic resource.",
885 "id": "Topic",
886 "properties": {
887 "name": {
888 "description": "The name of the topic. It must have the form at\n`\"projects/{project}/topics/{topic}\"`. `{topic}` must start with a letter, \nand contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`),\nunder scores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent\nsigns (`%`). I t must be between 3 and 255 characters in length, and it\nmust not start with `\ "goog\"`.",
889 "type": "string"
890 }
891 },
892 "type": "object"
893 },
894 "ModifyAckDeadlineRequest": {
895 "description": "Request for the ModifyAckDeadline method.",
896 "id": "ModifyAckDeadlineRequest",
897 "properties": {
898 "ackDeadlineSeconds": {
899 "description": "The new ack deadline with respect to the tim e this request was sent to\nthe Pub/Sub system. For example, if the value is 10, the new\nack deadline will expire 10 seconds after the `ModifyAckDeadline` call \nwas made. Specifying zero may immediately make the message available for\nanot her pull request.\nThe minimum deadline you can specify is 0 seconds.\nThe maxim um deadline you can specify is 600 seconds (10 minutes).",
900 "format": "int32",
901 "type": "integer"
902 },
903 "ackIds": {
904 "description": "List of acknowledgment IDs.",
905 "items": {
906 "type": "string"
907 },
908 "type": "array"
909 }
910 },
911 "type": "object"
912 },
913 "SetIamPolicyRequest": { 793 "SetIamPolicyRequest": {
914 "description": "Request message for `SetIamPolicy` method.", 794 "description": "Request message for `SetIamPolicy` method.",
915 "id": "SetIamPolicyRequest", 795 "id": "SetIamPolicyRequest",
916 "properties": { 796 "properties": {
917 "policy": { 797 "policy": {
918 "$ref": "Policy", 798 "$ref": "Policy",
919 "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An emp ty policy is a\nvalid policy but certain Cloud Platform services (such as Projec ts)\nmight reject them." 799 "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An emp ty policy is a\nvalid policy but certain Cloud Platform services (such as Projec ts)\nmight reject them."
920 } 800 }
921 }, 801 },
922 "type": "object" 802 "type": "object"
923 }, 803 },
924 "ModifyPushConfigRequest": {
925 "description": "Request for the ModifyPushConfig method.",
926 "id": "ModifyPushConfigRequest",
927 "properties": {
928 "pushConfig": {
929 "$ref": "PushConfig",
930 "description": "The push configuration for future deliveries .\n\nAn empty `pushConfig` indicates that the Pub/Sub system should\nstop pushin g messages from the given subscription and allow\nmessages to be pulled and ackn owledged - effectively pausing\nthe subscription if `Pull` is not called."
931 }
932 },
933 "type": "object"
934 },
935 "PubsubMessage": { 804 "PubsubMessage": {
936 "description": "A message data and its attributes. The message paylo ad must not be empty;\nit must contain either a non-empty data field, or at leas t one attribute.", 805 "description": "A message data and its attributes. The message paylo ad must not be empty;\nit must contain either a non-empty data field, or at leas t one attribute.",
937 "id": "PubsubMessage", 806 "id": "PubsubMessage",
938 "properties": { 807 "properties": {
808 "messageId": {
809 "description": "ID of this message, assigned by the server w hen the message is published.\nGuaranteed to be unique within the topic. This va lue may be read by a\nsubscriber that receives a `PubsubMessage` via a `Pull` ca ll or a push\ndelivery. It must not be populated by the publisher in a `Publish` call.",
810 "type": "string"
811 },
939 "attributes": { 812 "attributes": {
940 "additionalProperties": { 813 "additionalProperties": {
941 "type": "string" 814 "type": "string"
942 }, 815 },
943 "description": "Optional attributes for this message.", 816 "description": "Optional attributes for this message.",
944 "type": "object" 817 "type": "object"
945 }, 818 },
946 "messageId": {
947 "description": "ID of this message, assigned by the server w hen the message is published.\nGuaranteed to be unique within the topic. This va lue may be read by a\nsubscriber that receives a `PubsubMessage` via a `Pull` ca ll or a push\ndelivery. It must not be populated by the publisher in a `Publish` call.",
948 "type": "string"
949 },
950 "publishTime": { 819 "publishTime": {
951 "description": "The time at which the message was published, populated by the server when\nit receives the `Publish` call. It must not be po pulated by the\npublisher in a `Publish` call.", 820 "description": "The time at which the message was published, populated by the server when\nit receives the `Publish` call. It must not be po pulated by the\npublisher in a `Publish` call.",
952 "format": "google-datetime", 821 "format": "google-datetime",
953 "type": "string" 822 "type": "string"
954 }, 823 },
955 "data": { 824 "data": {
956 "description": "The message payload.", 825 "description": "The message payload.",
957 "format": "byte", 826 "format": "byte",
958 "type": "string" 827 "type": "string"
959 } 828 }
960 }, 829 },
961 "type": "object" 830 "type": "object"
962 }, 831 },
832 "ModifyPushConfigRequest": {
833 "description": "Request for the ModifyPushConfig method.",
834 "id": "ModifyPushConfigRequest",
835 "properties": {
836 "pushConfig": {
837 "$ref": "PushConfig",
838 "description": "The push configuration for future deliveries .\n\nAn empty `pushConfig` indicates that the Pub/Sub system should\nstop pushin g messages from the given subscription and allow\nmessages to be pulled and ackn owledged - effectively pausing\nthe subscription if `Pull` is not called."
839 }
840 },
841 "type": "object"
842 },
963 "Binding": { 843 "Binding": {
964 "description": "Associates `members` with a `role`.", 844 "description": "Associates `members` with a `role`.",
965 "id": "Binding", 845 "id": "Binding",
966 "properties": { 846 "properties": {
847 "role": {
848 "description": "Role that is assigned to `members`.\nFor exa mple, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
849 "type": "string"
850 },
967 "members": { 851 "members": {
968 "description": "Specifies the identities requesting access f or a Cloud Platform resource.\n`members` can have the following values:\n\n* `al lUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special ident ifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a spec ific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\ n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{e mailid}`: An email address that represents a Google group.\n For example, `adm ins@example.com`.\n\n* `domain:{domain}`: A Google Apps domain name that represe nts all the\n users of that domain. For example, `google.com` or `example.com` .\n\n", 852 "description": "Specifies the identities requesting access f or a Cloud Platform resource.\n`members` can have the following values:\n\n* `al lUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special ident ifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a spec ific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\ n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{e mailid}`: An email address that represents a Google group.\n For example, `adm ins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that repre sents all the\n users of that domain. For example, `google.com` or `example.co m`.\n\n",
969 "items": { 853 "items": {
970 "type": "string" 854 "type": "string"
971 }, 855 },
972 "type": "array" 856 "type": "array"
973 },
974 "role": {
975 "description": "Role that is assigned to `members`.\nFor exa mple, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
976 "type": "string"
977 } 857 }
978 }, 858 },
979 "type": "object" 859 "type": "object"
980 }, 860 },
981 "ListTopicsResponse": { 861 "AcknowledgeRequest": {
982 "description": "Response for the `ListTopics` method.", 862 "description": "Request for the Acknowledge method.",
983 "id": "ListTopicsResponse", 863 "id": "AcknowledgeRequest",
984 "properties": { 864 "properties": {
985 "nextPageToken": { 865 "ackIds": {
986 "description": "If not empty, indicates that there may be mo re topics that match the\nrequest; this value should be passed in a new `ListTop icsRequest`.", 866 "description": "The acknowledgment ID for the messages being acknowledged that was returned\nby the Pub/Sub system in the `Pull` response. M ust not be empty.",
987 "type": "string"
988 },
989 "topics": {
990 "description": "The resulting topics.",
991 "items": { 867 "items": {
992 "$ref": "Topic" 868 "type": "string"
993 }, 869 },
994 "type": "array" 870 "type": "array"
995 } 871 }
996 }, 872 },
997 "type": "object" 873 "type": "object"
998 }, 874 },
999 "Empty": { 875 "Empty": {
1000 "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use i t as the request\nor the response type of an API method. For instance:\n\n se rvice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty );\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.", 876 "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use i t as the request\nor the response type of an API method. For instance:\n\n se rvice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty );\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
1001 "id": "Empty", 877 "id": "Empty",
1002 "properties": {}, 878 "properties": {},
1003 "type": "object" 879 "type": "object"
1004 }, 880 },
1005 "AcknowledgeRequest": { 881 "ListTopicsResponse": {
1006 "description": "Request for the Acknowledge method.", 882 "description": "Response for the `ListTopics` method.",
1007 "id": "AcknowledgeRequest", 883 "id": "ListTopicsResponse",
1008 "properties": { 884 "properties": {
1009 "ackIds": { 885 "nextPageToken": {
1010 "description": "The acknowledgment ID for the messages being acknowledged that was returned\nby the Pub/Sub system in the `Pull` response. M ust not be empty.", 886 "description": "If not empty, indicates that there may be mo re topics that match the\nrequest; this value should be passed in a new `ListTop icsRequest`.",
887 "type": "string"
888 },
889 "topics": {
890 "description": "The resulting topics.",
1011 "items": { 891 "items": {
1012 "type": "string" 892 "$ref": "Topic"
1013 }, 893 },
1014 "type": "array" 894 "type": "array"
1015 } 895 }
1016 }, 896 },
1017 "type": "object" 897 "type": "object"
1018 }, 898 },
1019 "ListTopicSubscriptionsResponse": { 899 "ListTopicSubscriptionsResponse": {
1020 "description": "Response for the `ListTopicSubscriptions` method.", 900 "description": "Response for the `ListTopicSubscriptions` method.",
1021 "id": "ListTopicSubscriptionsResponse", 901 "id": "ListTopicSubscriptionsResponse",
1022 "properties": { 902 "properties": {
(...skipping 37 matching lines...) Expand 10 before | Expand all | Expand 10 after
1060 "description": "This ID can be used to acknowledge the recei ved message.", 940 "description": "This ID can be used to acknowledge the recei ved message.",
1061 "type": "string" 941 "type": "string"
1062 } 942 }
1063 }, 943 },
1064 "type": "object" 944 "type": "object"
1065 }, 945 },
1066 "PushConfig": { 946 "PushConfig": {
1067 "description": "Configuration for a push delivery endpoint.", 947 "description": "Configuration for a push delivery endpoint.",
1068 "id": "PushConfig", 948 "id": "PushConfig",
1069 "properties": { 949 "properties": {
1070 "pushEndpoint": {
1071 "description": "A URL locating the endpoint to which message s should be pushed.\nFor example, a Webhook endpoint might use \"https://example .com/push\".",
1072 "type": "string"
1073 },
1074 "attributes": { 950 "attributes": {
1075 "additionalProperties": { 951 "additionalProperties": {
1076 "type": "string" 952 "type": "string"
1077 }, 953 },
1078 "description": "Endpoint configuration attributes.\n\nEvery endpoint has a set of API supported attributes that can be used to\ncontrol diff erent aspects of the message delivery.\n\nThe currently supported attribute is ` x-goog-version`, which you can\nuse to change the format of the pushed message. This attribute\nindicates the version of the data expected by the endpoint. This \ncontrols the shape of the pushed message (i.e., its fields and metadata).\nThe endpoint version is based on the version of the Pub/Sub API.\n\nIf not present during the `CreateSubscription` call, it will default to\nthe version of the API used to make such call. If not present during a\n`ModifyPushConfig` call, its v alue will not be changed. `GetSubscription`\ncalls will always return a valid ve rsion, even if the subscription was\ncreated without this attribute.\n\nThe poss ible values for this attribute are:\n\n* `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API.\n* `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API.", 954 "description": "Endpoint configuration attributes.\n\nEvery endpoint has a set of API supported attributes that can be used to\ncontrol diff erent aspects of the message delivery.\n\nThe currently supported attribute is ` x-goog-version`, which you can\nuse to change the format of the pushed message. This attribute\nindicates the version of the data expected by the endpoint. This \ncontrols the shape of the pushed message (i.e., its fields and metadata).\nThe endpoint version is based on the version of the Pub/Sub API.\n\nIf not present during the `CreateSubscription` call, it will default to\nthe version of the API used to make such call. If not present during a\n`ModifyPushConfig` call, its v alue will not be changed. `GetSubscription`\ncalls will always return a valid ve rsion, even if the subscription was\ncreated without this attribute.\n\nThe poss ible values for this attribute are:\n\n* `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API.\n* `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API.",
1079 "type": "object" 955 "type": "object"
956 },
957 "pushEndpoint": {
958 "description": "A URL locating the endpoint to which message s should be pushed.\nFor example, a Webhook endpoint might use \"https://example .com/push\".",
959 "type": "string"
1080 } 960 }
1081 }, 961 },
1082 "type": "object" 962 "type": "object"
1083 }, 963 },
1084 "TestIamPermissionsResponse": { 964 "TestIamPermissionsResponse": {
1085 "description": "Response message for `TestIamPermissions` method.", 965 "description": "Response message for `TestIamPermissions` method.",
1086 "id": "TestIamPermissionsResponse", 966 "id": "TestIamPermissionsResponse",
1087 "properties": { 967 "properties": {
1088 "permissions": { 968 "permissions": {
1089 "description": "A subset of `TestPermissionsRequest.permissi ons` that the caller is\nallowed.", 969 "description": "A subset of `TestPermissionsRequest.permissi ons` that the caller is\nallowed.",
1090 "items": { 970 "items": {
1091 "type": "string" 971 "type": "string"
1092 }, 972 },
1093 "type": "array" 973 "type": "array"
1094 } 974 }
1095 }, 975 },
1096 "type": "object" 976 "type": "object"
1097 }, 977 },
1098 "PullRequest": { 978 "PullRequest": {
1099 "description": "Request for the `Pull` method.", 979 "description": "Request for the `Pull` method.",
1100 "id": "PullRequest", 980 "id": "PullRequest",
1101 "properties": { 981 "properties": {
982 "returnImmediately": {
983 "description": "If this field set to true, the system will r espond immediately even if\nit there are no messages available to return in the `Pull` response.\nOtherwise, the system may wait (for a bounded amount of time) until at\nleast one message is available, rather than returning no messages. The \nclient may cancel the request if it does not wish to wait any longer for\nthe response.",
984 "type": "boolean"
985 },
1102 "maxMessages": { 986 "maxMessages": {
1103 "description": "The maximum number of messages returned for this request. The Pub/Sub\nsystem may return fewer than the number specified.", 987 "description": "The maximum number of messages returned for this request. The Pub/Sub\nsystem may return fewer than the number specified.",
1104 "format": "int32", 988 "format": "int32",
1105 "type": "integer" 989 "type": "integer"
1106 },
1107 "returnImmediately": {
1108 "description": "If this field set to true, the system will r espond immediately even if\nit there are no messages available to return in the `Pull` response.\nOtherwise, the system may wait (for a bounded amount of time) until at\nleast one message is available, rather than returning no messages. The \nclient may cancel the request if it does not wish to wait any longer for\nthe response.",
1109 "type": "boolean"
1110 } 990 }
1111 }, 991 },
1112 "type": "object" 992 "type": "object"
1113 }, 993 },
1114 "ListSubscriptionsResponse": { 994 "ListSubscriptionsResponse": {
1115 "description": "Response for the `ListSubscriptions` method.", 995 "description": "Response for the `ListSubscriptions` method.",
1116 "id": "ListSubscriptionsResponse", 996 "id": "ListSubscriptionsResponse",
1117 "properties": { 997 "properties": {
1118 "nextPageToken": { 998 "nextPageToken": {
1119 "description": "If not empty, indicates that there may be mo re subscriptions that match\nthe request; this value should be passed in a new\n `ListSubscriptionsRequest` to get more subscriptions.", 999 "description": "If not empty, indicates that there may be mo re subscriptions that match\nthe request; this value should be passed in a new\n `ListSubscriptionsRequest` to get more subscriptions.",
1120 "type": "string" 1000 "type": "string"
1121 }, 1001 },
1122 "subscriptions": { 1002 "subscriptions": {
1123 "description": "The subscriptions that match the request.", 1003 "description": "The subscriptions that match the request.",
1124 "items": { 1004 "items": {
1125 "$ref": "Subscription" 1005 "$ref": "Subscription"
1126 }, 1006 },
1127 "type": "array" 1007 "type": "array"
1128 } 1008 }
1129 }, 1009 },
1130 "type": "object" 1010 "type": "object"
1011 },
1012 "PublishRequest": {
1013 "description": "Request for the Publish method.",
1014 "id": "PublishRequest",
1015 "properties": {
1016 "messages": {
1017 "description": "The messages to publish.",
1018 "items": {
1019 "$ref": "PubsubMessage"
1020 },
1021 "type": "array"
1022 }
1023 },
1024 "type": "object"
1025 },
1026 "PublishResponse": {
1027 "description": "Response for the `Publish` method.",
1028 "id": "PublishResponse",
1029 "properties": {
1030 "messageIds": {
1031 "description": "The server-assigned ID of each published mes sage, in the same order as\nthe messages in the request. IDs are guaranteed to b e unique within\nthe topic.",
1032 "items": {
1033 "type": "string"
1034 },
1035 "type": "array"
1036 }
1037 },
1038 "type": "object"
1039 },
1040 "Subscription": {
1041 "description": "A subscription resource.",
1042 "id": "Subscription",
1043 "properties": {
1044 "ackDeadlineSeconds": {
1045 "description": "This value is the maximum time after a subsc riber receives a message\nbefore the subscriber should acknowledge the message. After message\ndelivery but before the ack deadline expires and before the messa ge is\nacknowledged, it is an outstanding message and will not be delivered\naga in during that time (on a best-effort basis).\n\nFor pull subscriptions, this va lue is used as the initial value for the ack\ndeadline. To override this value f or a given message, call\n`ModifyAckDeadline` with the corresponding `ack_id` if using\npull.\nThe minimum custom deadline you can specify is 10 seconds.\nThe m aximum custom deadline you can specify is 600 seconds (10 minutes).\nIf this par ameter is 0, a default value of 10 seconds is used.\n\nFor push delivery, this v alue is also used to set the request timeout for\nthe call to the push endpoint. \n\nIf the subscriber never acknowledges the message, the Pub/Sub\nsystem will e ventually redeliver the message.",
1046 "format": "int32",
1047 "type": "integer"
1048 },
1049 "name": {
1050 "description": "The name of the subscription. It must have t he format\n`\"projects/{project}/subscriptions/{subscription}\"`. `{subscription }` must\nstart with a letter, and contain only letters (`[A-Za-z]`), numbers\n(` [0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),\nplus (`+ `) or percent signs (`%`). It must be between 3 and 255 characters\nin length, a nd it must not start with `\"goog\"`.",
1051 "type": "string"
1052 },
1053 "topic": {
1054 "description": "The name of the topic from which this subscr iption is receiving messages.\nFormat is `projects/{project}/topics/{topic}`.\nT he value of this field will be `_deleted-topic_` if the topic has been\ndeleted. ",
1055 "type": "string"
1056 },
1057 "pushConfig": {
1058 "$ref": "PushConfig",
1059 "description": "If push delivery is used with this subscript ion, this field is\nused to configure it. An empty `pushConfig` signifies that t he subscriber\nwill pull and ack messages using API methods."
1060 }
1061 },
1062 "type": "object"
1063 },
1064 "TestIamPermissionsRequest": {
1065 "description": "Request message for `TestIamPermissions` method.",
1066 "id": "TestIamPermissionsRequest",
1067 "properties": {
1068 "permissions": {
1069 "description": "The set of permissions to check for the `res ource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed . For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/ov erview#permissions).",
1070 "items": {
1071 "type": "string"
1072 },
1073 "type": "array"
1074 }
1075 },
1076 "type": "object"
1077 },
1078 "Policy": {
1079 "description": "Defines an Identity and Access Management (IAM) poli cy. It is used to\nspecify access control policies for Cloud Platform resources. \n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n `members` to a `role`, where the members can be user accounts, Google groups,\nG oogle domains, and service accounts. A `role` is a named list of permissions\nde fined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike @example.com\",\n \"group:admins@example.com\",\n \"domain :google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccoun t.com\",\n ]\n },\n {\n \"role\": \"roles/viewer \",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide ](https://cloud.google.com/iam).",
1080 "id": "Policy",
1081 "properties": {
1082 "bindings": {
1083 "description": "Associates a list of `members` to a `role`.\ n`bindings` with no members will result in an error.",
1084 "items": {
1085 "$ref": "Binding"
1086 },
1087 "type": "array"
1088 },
1089 "etag": {
1090 "description": "`etag` is used for optimistic concurrency co ntrol as a way to help\nprevent simultaneous updates of a policy from overwritin g each other.\nIt is strongly suggested that systems make use of the `etag` in t he\nread-modify-write cycle to perform policy updates in order to avoid race\nco nditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that t heir change will be applied to the same version of the policy.\n\nIf no `etag` i s provided in the call to `setIamPolicy`, then the existing\npolicy is overwritt en blindly.",
1091 "format": "byte",
1092 "type": "string"
1093 },
1094 "version": {
1095 "description": "Version of the `Policy`. The default version is 0.",
1096 "format": "int32",
1097 "type": "integer"
1098 }
1099 },
1100 "type": "object"
1101 },
1102 "Topic": {
1103 "description": "A topic resource.",
1104 "id": "Topic",
1105 "properties": {
1106 "name": {
1107 "description": "The name of the topic. It must have the form at\n`\"projects/{project}/topics/{topic}\"`. `{topic}` must start with a letter, \nand contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`),\nunder scores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent\nsigns (`%`). I t must be between 3 and 255 characters in length, and it\nmust not start with `\ "goog\"`.",
1108 "type": "string"
1109 }
1110 },
1111 "type": "object"
1112 },
1113 "ModifyAckDeadlineRequest": {
1114 "description": "Request for the ModifyAckDeadline method.",
1115 "id": "ModifyAckDeadlineRequest",
1116 "properties": {
1117 "ackDeadlineSeconds": {
1118 "description": "The new ack deadline with respect to the tim e this request was sent to\nthe Pub/Sub system. For example, if the value is 10, the new\nack deadline will expire 10 seconds after the `ModifyAckDeadline` call \nwas made. Specifying zero may immediately make the message available for\nanot her pull request.\nThe minimum deadline you can specify is 0 seconds.\nThe maxim um deadline you can specify is 600 seconds (10 minutes).",
1119 "format": "int32",
1120 "type": "integer"
1121 },
1122 "ackIds": {
1123 "description": "List of acknowledgment IDs.",
1124 "items": {
1125 "type": "string"
1126 },
1127 "type": "array"
1128 }
1129 },
1130 "type": "object"
1131 } 1131 }
1132 }, 1132 },
1133 "servicePath": "", 1133 "servicePath": "",
1134 "title": "Google Cloud Pub/Sub API", 1134 "title": "Google Cloud Pub/Sub API",
1135 "version": "v1" 1135 "version": "v1"
1136 } 1136 }
OLDNEW
« no previous file with comments | « discovery/googleapis/plus__v1.json ('k') | discovery/googleapis/runtimeconfig__v1.json » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698