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

Issues Search
    My Issues | Starred     Open | Closed | All

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

Issue 3006323002: Api-Roll 54: 2017-09-11 (Closed)
Patch Set: use 2.0.0-dev.infinity sdk constraint in pubspecs Created 3 years, 3 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/prediction__v1.6.json ('k') | discovery/googleapis/qpxExpress__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": {
6 "description": "View and manage your data across Google Clou d Platform services"
7 },
5 "https://www.googleapis.com/auth/pubsub": { 8 "https://www.googleapis.com/auth/pubsub": {
6 "description": "View and manage Pub/Sub topics and subscript ions" 9 "description": "View and manage Pub/Sub topics and subscript ions"
7 },
8 "https://www.googleapis.com/auth/cloud-platform": {
9 "description": "View and manage your data across Google Clou d Platform services"
10 } 10 }
11 } 11 }
12 } 12 }
13 }, 13 },
14 "basePath": "", 14 "basePath": "",
15 "baseUrl": "https://pubsub.googleapis.com/", 15 "baseUrl": "https://pubsub.googleapis.com/",
16 "batchPath": "batch", 16 "batchPath": "batch",
17 "canonicalName": "Pubsub", 17 "canonicalName": "Pubsub",
18 "description": "Provides reliable, many-to-many, asynchronous messaging betw een applications.\n", 18 "description": "Provides reliable, many-to-many, asynchronous messaging betw een applications.\n",
19 "discoveryVersion": "v1", 19 "discoveryVersion": "v1",
(...skipping 12 matching lines...) Expand all
32 "description": "Upload protocol for media (e.g. \"raw\", \"multipart \").", 32 "description": "Upload protocol for media (e.g. \"raw\", \"multipart \").",
33 "location": "query", 33 "location": "query",
34 "type": "string" 34 "type": "string"
35 }, 35 },
36 "prettyPrint": { 36 "prettyPrint": {
37 "default": "true", 37 "default": "true",
38 "description": "Returns response with indentations and line breaks." , 38 "description": "Returns response with indentations and line breaks." ,
39 "location": "query", 39 "location": "query",
40 "type": "boolean" 40 "type": "boolean"
41 }, 41 },
42 "fields": {
43 "description": "Selector specifying which fields to include in a par tial response.",
44 "location": "query",
45 "type": "string"
46 },
42 "uploadType": { 47 "uploadType": {
43 "description": "Legacy upload protocol for media (e.g. \"media\", \" multipart\").", 48 "description": "Legacy upload protocol for media (e.g. \"media\", \" multipart\").",
44 "location": "query", 49 "location": "query",
45 "type": "string" 50 "type": "string"
46 }, 51 },
47 "fields": {
48 "description": "Selector specifying which fields to include in a par tial response.",
49 "location": "query",
50 "type": "string"
51 },
52 "callback": { 52 "callback": {
53 "description": "JSONP", 53 "description": "JSONP",
54 "location": "query", 54 "location": "query",
55 "type": "string" 55 "type": "string"
56 }, 56 },
57 "$.xgafv": { 57 "$.xgafv": {
58 "description": "V1 error format.", 58 "description": "V1 error format.",
59 "enum": [ 59 "enum": [
60 "1", 60 "1",
61 "2" 61 "2"
(...skipping 14 matching lines...) Expand all
76 "proto" 76 "proto"
77 ], 77 ],
78 "enumDescriptions": [ 78 "enumDescriptions": [
79 "Responses with Content-Type of application/json", 79 "Responses with Content-Type of application/json",
80 "Media download with context-dependent Content-Type", 80 "Media download with context-dependent Content-Type",
81 "Responses with Content-Type of application/x-protobuf" 81 "Responses with Content-Type of application/x-protobuf"
82 ], 82 ],
83 "location": "query", 83 "location": "query",
84 "type": "string" 84 "type": "string"
85 }, 85 },
86 "key": {
87 "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.",
88 "location": "query",
89 "type": "string"
90 },
86 "access_token": { 91 "access_token": {
87 "description": "OAuth access token.", 92 "description": "OAuth access token.",
88 "location": "query", 93 "location": "query",
89 "type": "string" 94 "type": "string"
90 }, 95 },
91 "key": {
92 "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.",
93 "location": "query",
94 "type": "string"
95 },
96 "quotaUser": { 96 "quotaUser": {
97 "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.", 97 "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.",
98 "location": "query", 98 "location": "query",
99 "type": "string" 99 "type": "string"
100 }, 100 },
101 "pp": { 101 "pp": {
102 "default": "true", 102 "default": "true",
103 "description": "Pretty-print response.", 103 "description": "Pretty-print response.",
104 "location": "query", 104 "location": "query",
105 "type": "boolean" 105 "type": "boolean"
106 }, 106 },
107 "oauth_token": { 107 "oauth_token": {
108 "description": "OAuth 2.0 token for the current user.", 108 "description": "OAuth 2.0 token for the current user.",
109 "location": "query", 109 "location": "query",
110 "type": "string" 110 "type": "string"
111 }, 111 },
112 "bearer_token": { 112 "bearer_token": {
113 "description": "OAuth bearer token.", 113 "description": "OAuth bearer token.",
114 "location": "query", 114 "location": "query",
115 "type": "string" 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 "topics": { 122 "snapshots": {
123 "methods": { 123 "methods": {
124 "setIamPolicy": {
125 "description": "Sets the access control policy on th e specified resource. Replaces any\nexisting policy.",
126 "httpMethod": "POST",
127 "id": "pubsub.projects.snapshots.setIamPolicy",
128 "parameterOrder": [
129 "resource"
130 ],
131 "parameters": {
132 "resource": {
133 "description": "REQUIRED: The resource for w hich the policy is being specified.\nSee the operation documentation for the app ropriate value for this field.",
134 "location": "path",
135 "pattern": "^projects/[^/]+/snapshots/[^/]+$ ",
136 "required": true,
137 "type": "string"
138 }
139 },
140 "path": "v1/{+resource}:setIamPolicy",
141 "request": {
142 "$ref": "SetIamPolicyRequest"
143 },
144 "response": {
145 "$ref": "Policy"
146 },
147 "scopes": [
148 "https://www.googleapis.com/auth/cloud-platform" ,
149 "https://www.googleapis.com/auth/pubsub"
150 ]
151 },
124 "testIamPermissions": { 152 "testIamPermissions": {
125 "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. ", 153 "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. ",
126 "httpMethod": "POST", 154 "httpMethod": "POST",
127 "id": "pubsub.projects.topics.testIamPermissions", 155 "id": "pubsub.projects.snapshots.testIamPermissions" ,
128 "parameterOrder": [ 156 "parameterOrder": [
129 "resource" 157 "resource"
130 ], 158 ],
131 "parameters": { 159 "parameters": {
132 "resource": { 160 "resource": {
133 "description": "REQUIRED: The resource for w hich the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.", 161 "description": "REQUIRED: The resource for w hich the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
134 "location": "path", 162 "location": "path",
135 "pattern": "^projects/[^/]+/topics/[^/]+$", 163 "pattern": "^projects/[^/]+/snapshots/[^/]+$ ",
136 "required": true, 164 "required": true,
137 "type": "string" 165 "type": "string"
138 } 166 }
139 }, 167 },
140 "path": "v1/{+resource}:testIamPermissions", 168 "path": "v1/{+resource}:testIamPermissions",
141 "request": { 169 "request": {
142 "$ref": "TestIamPermissionsRequest" 170 "$ref": "TestIamPermissionsRequest"
143 }, 171 },
144 "response": { 172 "response": {
145 "$ref": "TestIamPermissionsResponse" 173 "$ref": "TestIamPermissionsResponse"
146 }, 174 },
147 "scopes": [ 175 "scopes": [
148 "https://www.googleapis.com/auth/cloud-platform" , 176 "https://www.googleapis.com/auth/cloud-platform" ,
149 "https://www.googleapis.com/auth/pubsub" 177 "https://www.googleapis.com/auth/pubsub"
150 ] 178 ]
151 }, 179 },
152 "delete": { 180 "getIamPolicy": {
153 "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_`.", 181 "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.",
154 "httpMethod": "DELETE", 182 "httpMethod": "GET",
155 "id": "pubsub.projects.topics.delete", 183 "id": "pubsub.projects.snapshots.getIamPolicy",
156 "parameterOrder": [ 184 "parameterOrder": [
157 "topic" 185 "resource"
158 ], 186 ],
159 "parameters": { 187 "parameters": {
160 "topic": { 188 "resource": {
161 "description": "Name of the topic to delete. \nFormat is `projects/{project}/topics/{topic}`.", 189 "description": "REQUIRED: The resource for w hich the policy is being requested.\nSee the operation documentation for the app ropriate value for this field.",
162 "location": "path", 190 "location": "path",
163 "pattern": "^projects/[^/]+/topics/[^/]+$", 191 "pattern": "^projects/[^/]+/snapshots/[^/]+$ ",
164 "required": true, 192 "required": true,
165 "type": "string" 193 "type": "string"
166 } 194 }
167 }, 195 },
168 "path": "v1/{+topic}", 196 "path": "v1/{+resource}:getIamPolicy",
169 "response": { 197 "response": {
170 "$ref": "Empty" 198 "$ref": "Policy"
171 }, 199 },
172 "scopes": [ 200 "scopes": [
173 "https://www.googleapis.com/auth/cloud-platform" , 201 "https://www.googleapis.com/auth/cloud-platform" ,
174 "https://www.googleapis.com/auth/pubsub" 202 "https://www.googleapis.com/auth/pubsub"
175 ] 203 ]
176 }, 204 }
205 }
206 },
207 "subscriptions": {
208 "methods": {
177 "list": { 209 "list": {
178 "description": "Lists matching topics.", 210 "description": "Lists matching subscriptions.",
179 "httpMethod": "GET", 211 "httpMethod": "GET",
180 "id": "pubsub.projects.topics.list", 212 "id": "pubsub.projects.subscriptions.list",
181 "parameterOrder": [ 213 "parameterOrder": [
182 "project" 214 "project"
183 ], 215 ],
184 "parameters": { 216 "parameters": {
185 "pageToken": {
186 "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.",
187 "location": "query",
188 "type": "string"
189 },
190 "pageSize": { 217 "pageSize": {
191 "description": "Maximum number of topics to return.", 218 "description": "Maximum number of subscripti ons to return.",
192 "format": "int32", 219 "format": "int32",
193 "location": "query", 220 "location": "query",
194 "type": "integer" 221 "type": "integer"
195 }, 222 },
196 "project": { 223 "project": {
197 "description": "The name of the cloud projec t that topics belong to.\nFormat is `projects/{project}`.", 224 "description": "The name of the cloud projec t that subscriptions belong to.\nFormat is `projects/{project}`.",
198 "location": "path", 225 "location": "path",
199 "pattern": "^projects/[^/]+$", 226 "pattern": "^projects/[^/]+$",
200 "required": true, 227 "required": true,
201 "type": "string" 228 "type": "string"
229 },
230 "pageToken": {
231 "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.",
232 "location": "query",
233 "type": "string"
202 } 234 }
203 }, 235 },
204 "path": "v1/{+project}/topics", 236 "path": "v1/{+project}/subscriptions",
205 "response": { 237 "response": {
206 "$ref": "ListTopicsResponse" 238 "$ref": "ListSubscriptionsResponse"
207 }, 239 },
208 "scopes": [ 240 "scopes": [
209 "https://www.googleapis.com/auth/cloud-platform" , 241 "https://www.googleapis.com/auth/cloud-platform" ,
210 "https://www.googleapis.com/auth/pubsub" 242 "https://www.googleapis.com/auth/pubsub"
211 ] 243 ]
212 }, 244 },
213 "create": { 245 "create": {
214 "description": "Creates the given topic with the giv en name.", 246 "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.",
215 "httpMethod": "PUT", 247 "httpMethod": "PUT",
216 "id": "pubsub.projects.topics.create", 248 "id": "pubsub.projects.subscriptions.create",
217 "parameterOrder": [ 249 "parameterOrder": [
218 "name" 250 "name"
219 ], 251 ],
220 "parameters": { 252 "parameters": {
221 "name": { 253 "name": {
222 "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\"`.", 254 "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\"`.",
223 "location": "path", 255 "location": "path",
224 "pattern": "^projects/[^/]+/topics/[^/]+$", 256 "pattern": "^projects/[^/]+/subscriptions/[^ /]+$",
225 "required": true, 257 "required": true,
226 "type": "string" 258 "type": "string"
227 } 259 }
228 }, 260 },
229 "path": "v1/{+name}", 261 "path": "v1/{+name}",
230 "request": { 262 "request": {
231 "$ref": "Topic" 263 "$ref": "Subscription"
232 }, 264 },
233 "response": { 265 "response": {
234 "$ref": "Topic" 266 "$ref": "Subscription"
235 }, 267 },
236 "scopes": [ 268 "scopes": [
237 "https://www.googleapis.com/auth/cloud-platform" , 269 "https://www.googleapis.com/auth/cloud-platform" ,
238 "https://www.googleapis.com/auth/pubsub" 270 "https://www.googleapis.com/auth/pubsub"
239 ] 271 ]
240 }, 272 },
241 "setIamPolicy": { 273 "setIamPolicy": {
242 "description": "Sets the access control policy on th e specified resource. Replaces any\nexisting policy.", 274 "description": "Sets the access control policy on th e specified resource. Replaces any\nexisting policy.",
243 "httpMethod": "POST", 275 "httpMethod": "POST",
244 "id": "pubsub.projects.topics.setIamPolicy", 276 "id": "pubsub.projects.subscriptions.setIamPolicy",
245 "parameterOrder": [ 277 "parameterOrder": [
246 "resource" 278 "resource"
247 ], 279 ],
248 "parameters": { 280 "parameters": {
249 "resource": { 281 "resource": {
250 "description": "REQUIRED: The resource for w hich the policy is being specified.\nSee the operation documentation for the app ropriate value for this field.", 282 "description": "REQUIRED: The resource for w hich the policy is being specified.\nSee the operation documentation for the app ropriate value for this field.",
251 "location": "path", 283 "location": "path",
252 "pattern": "^projects/[^/]+/topics/[^/]+$", 284 "pattern": "^projects/[^/]+/subscriptions/[^ /]+$",
253 "required": true, 285 "required": true,
254 "type": "string" 286 "type": "string"
255 } 287 }
256 }, 288 },
257 "path": "v1/{+resource}:setIamPolicy", 289 "path": "v1/{+resource}:setIamPolicy",
258 "request": { 290 "request": {
259 "$ref": "SetIamPolicyRequest" 291 "$ref": "SetIamPolicyRequest"
260 }, 292 },
261 "response": { 293 "response": {
262 "$ref": "Policy" 294 "$ref": "Policy"
263 }, 295 },
264 "scopes": [ 296 "scopes": [
265 "https://www.googleapis.com/auth/cloud-platform" , 297 "https://www.googleapis.com/auth/cloud-platform" ,
266 "https://www.googleapis.com/auth/pubsub" 298 "https://www.googleapis.com/auth/pubsub"
267 ] 299 ]
268 }, 300 },
301 "acknowledge": {
302 "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.",
303 "httpMethod": "POST",
304 "id": "pubsub.projects.subscriptions.acknowledge",
305 "parameterOrder": [
306 "subscription"
307 ],
308 "parameters": {
309 "subscription": {
310 "description": "The subscription whose messa ge is being acknowledged.\nFormat is `projects/{project}/subscriptions/{sub}`.",
311 "location": "path",
312 "pattern": "^projects/[^/]+/subscriptions/[^ /]+$",
313 "required": true,
314 "type": "string"
315 }
316 },
317 "path": "v1/{+subscription}:acknowledge",
318 "request": {
319 "$ref": "AcknowledgeRequest"
320 },
321 "response": {
322 "$ref": "Empty"
323 },
324 "scopes": [
325 "https://www.googleapis.com/auth/cloud-platform" ,
326 "https://www.googleapis.com/auth/pubsub"
327 ]
328 },
269 "getIamPolicy": { 329 "getIamPolicy": {
270 "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.", 330 "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.",
271 "httpMethod": "GET", 331 "httpMethod": "GET",
272 "id": "pubsub.projects.topics.getIamPolicy", 332 "id": "pubsub.projects.subscriptions.getIamPolicy",
273 "parameterOrder": [ 333 "parameterOrder": [
274 "resource" 334 "resource"
275 ], 335 ],
276 "parameters": { 336 "parameters": {
277 "resource": { 337 "resource": {
278 "description": "REQUIRED: The resource for w hich the policy is being requested.\nSee the operation documentation for the app ropriate value for this field.", 338 "description": "REQUIRED: The resource for w hich the policy is being requested.\nSee the operation documentation for the app ropriate value for this field.",
279 "location": "path", 339 "location": "path",
280 "pattern": "^projects/[^/]+/topics/[^/]+$", 340 "pattern": "^projects/[^/]+/subscriptions/[^ /]+$",
281 "required": true, 341 "required": true,
282 "type": "string" 342 "type": "string"
283 } 343 }
284 }, 344 },
285 "path": "v1/{+resource}:getIamPolicy", 345 "path": "v1/{+resource}:getIamPolicy",
286 "response": { 346 "response": {
287 "$ref": "Policy" 347 "$ref": "Policy"
288 }, 348 },
289 "scopes": [ 349 "scopes": [
290 "https://www.googleapis.com/auth/cloud-platform" , 350 "https://www.googleapis.com/auth/cloud-platform" ,
291 "https://www.googleapis.com/auth/pubsub" 351 "https://www.googleapis.com/auth/pubsub"
292 ] 352 ]
293 }, 353 },
294 "get": { 354 "modifyAckDeadline": {
295 "description": "Gets the configuration of a topic.", 355 "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.",
296 "httpMethod": "GET", 356 "httpMethod": "POST",
297 "id": "pubsub.projects.topics.get", 357 "id": "pubsub.projects.subscriptions.modifyAckDeadli ne",
298 "parameterOrder": [ 358 "parameterOrder": [
299 "topic" 359 "subscription"
300 ], 360 ],
301 "parameters": { 361 "parameters": {
302 "topic": { 362 "subscription": {
303 "description": "The name of the topic to get .\nFormat is `projects/{project}/topics/{topic}`.", 363 "description": "The name of the subscription .\nFormat is `projects/{project}/subscriptions/{sub}`.",
304 "location": "path", 364 "location": "path",
305 "pattern": "^projects/[^/]+/topics/[^/]+$", 365 "pattern": "^projects/[^/]+/subscriptions/[^ /]+$",
306 "required": true, 366 "required": true,
307 "type": "string" 367 "type": "string"
308 } 368 }
309 }, 369 },
310 "path": "v1/{+topic}", 370 "path": "v1/{+subscription}:modifyAckDeadline",
371 "request": {
372 "$ref": "ModifyAckDeadlineRequest"
373 },
311 "response": { 374 "response": {
312 "$ref": "Topic" 375 "$ref": "Empty"
313 }, 376 },
314 "scopes": [ 377 "scopes": [
315 "https://www.googleapis.com/auth/cloud-platform" , 378 "https://www.googleapis.com/auth/cloud-platform" ,
316 "https://www.googleapis.com/auth/pubsub" 379 "https://www.googleapis.com/auth/pubsub"
317 ] 380 ]
318 }, 381 },
319 "publish": { 382 "get": {
320 "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.", 383 "description": "Gets the configuration details of a subscription.",
321 "httpMethod": "POST", 384 "httpMethod": "GET",
322 "id": "pubsub.projects.topics.publish", 385 "id": "pubsub.projects.subscriptions.get",
323 "parameterOrder": [ 386 "parameterOrder": [
324 "topic" 387 "subscription"
325 ], 388 ],
326 "parameters": { 389 "parameters": {
327 "topic": { 390 "subscription": {
328 "description": "The messages in the request will be published on this topic.\nFormat is `projects/{project}/topics/{topic}`. ", 391 "description": "The name of the subscription to get.\nFormat is `projects/{project}/subscriptions/{sub}`.",
329 "location": "path", 392 "location": "path",
330 "pattern": "^projects/[^/]+/topics/[^/]+$", 393 "pattern": "^projects/[^/]+/subscriptions/[^ /]+$",
331 "required": true, 394 "required": true,
332 "type": "string" 395 "type": "string"
333 } 396 }
334 }, 397 },
335 "path": "v1/{+topic}:publish", 398 "path": "v1/{+subscription}",
336 "request": {
337 "$ref": "PublishRequest"
338 },
339 "response": { 399 "response": {
340 "$ref": "PublishResponse" 400 "$ref": "Subscription"
341 }, 401 },
342 "scopes": [ 402 "scopes": [
343 "https://www.googleapis.com/auth/cloud-platform" , 403 "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 "pageSize": {
360 "description": "Maximum number of su bscription names to return.",
361 "format": "int32",
362 "location": "query",
363 "type": "integer"
364 },
365 "topic": {
366 "description": "The name of the topi c that subscriptions are attached to.\nFormat is `projects/{project}/topics/{top ic}`.",
367 "location": "path",
368 "pattern": "^projects/[^/]+/topics/[ ^/]+$",
369 "required": true,
370 "type": "string"
371 },
372 "pageToken": {
373 "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.",
374 "location": "query",
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 }
388 }
389 }
390 },
391 "snapshots": {
392 "methods": {
393 "setIamPolicy": {
394 "description": "Sets the access control policy on th e specified resource. Replaces any\nexisting policy.",
395 "httpMethod": "POST",
396 "id": "pubsub.projects.snapshots.setIamPolicy",
397 "parameterOrder": [
398 "resource"
399 ],
400 "parameters": {
401 "resource": {
402 "description": "REQUIRED: The resource for w hich the policy is being specified.\nSee the operation documentation for the app ropriate value for this field.",
403 "location": "path",
404 "pattern": "^projects/[^/]+/snapshots/[^/]+$ ",
405 "required": true,
406 "type": "string"
407 }
408 },
409 "path": "v1/{+resource}:setIamPolicy",
410 "request": {
411 "$ref": "SetIamPolicyRequest"
412 },
413 "response": {
414 "$ref": "Policy"
415 },
416 "scopes": [
417 "https://www.googleapis.com/auth/cloud-platform" ,
418 "https://www.googleapis.com/auth/pubsub" 404 "https://www.googleapis.com/auth/pubsub"
419 ] 405 ]
420 }, 406 },
421 "testIamPermissions": { 407 "testIamPermissions": {
422 "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. ", 408 "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. ",
423 "httpMethod": "POST", 409 "httpMethod": "POST",
424 "id": "pubsub.projects.snapshots.testIamPermissions" , 410 "id": "pubsub.projects.subscriptions.testIamPermissi ons",
425 "parameterOrder": [ 411 "parameterOrder": [
426 "resource" 412 "resource"
427 ], 413 ],
428 "parameters": { 414 "parameters": {
429 "resource": { 415 "resource": {
430 "description": "REQUIRED: The resource for w hich the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.", 416 "description": "REQUIRED: The resource for w hich the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
431 "location": "path", 417 "location": "path",
432 "pattern": "^projects/[^/]+/snapshots/[^/]+$ ",
433 "required": true,
434 "type": "string"
435 }
436 },
437 "path": "v1/{+resource}:testIamPermissions",
438 "request": {
439 "$ref": "TestIamPermissionsRequest"
440 },
441 "response": {
442 "$ref": "TestIamPermissionsResponse"
443 },
444 "scopes": [
445 "https://www.googleapis.com/auth/cloud-platform" ,
446 "https://www.googleapis.com/auth/pubsub"
447 ]
448 },
449 "getIamPolicy": {
450 "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.",
451 "httpMethod": "GET",
452 "id": "pubsub.projects.snapshots.getIamPolicy",
453 "parameterOrder": [
454 "resource"
455 ],
456 "parameters": {
457 "resource": {
458 "description": "REQUIRED: The resource for w hich the policy is being requested.\nSee the operation documentation for the app ropriate value for this field.",
459 "location": "path",
460 "pattern": "^projects/[^/]+/snapshots/[^/]+$ ",
461 "required": true,
462 "type": "string"
463 }
464 },
465 "path": "v1/{+resource}:getIamPolicy",
466 "response": {
467 "$ref": "Policy"
468 },
469 "scopes": [
470 "https://www.googleapis.com/auth/cloud-platform" ,
471 "https://www.googleapis.com/auth/pubsub"
472 ]
473 }
474 }
475 },
476 "subscriptions": {
477 "methods": {
478 "testIamPermissions": {
479 "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. ",
480 "httpMethod": "POST",
481 "id": "pubsub.projects.subscriptions.testIamPermissi ons",
482 "parameterOrder": [
483 "resource"
484 ],
485 "parameters": {
486 "resource": {
487 "description": "REQUIRED: The resource for w hich the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
488 "location": "path",
489 "pattern": "^projects/[^/]+/subscriptions/[^ /]+$", 418 "pattern": "^projects/[^/]+/subscriptions/[^ /]+$",
490 "required": true, 419 "required": true,
491 "type": "string" 420 "type": "string"
492 } 421 }
493 }, 422 },
494 "path": "v1/{+resource}:testIamPermissions", 423 "path": "v1/{+resource}:testIamPermissions",
495 "request": { 424 "request": {
496 "$ref": "TestIamPermissionsRequest" 425 "$ref": "TestIamPermissionsRequest"
497 }, 426 },
498 "response": { 427 "response": {
(...skipping 77 matching lines...) Expand 10 before | Expand all | Expand 10 after
576 "request": { 505 "request": {
577 "$ref": "PullRequest" 506 "$ref": "PullRequest"
578 }, 507 },
579 "response": { 508 "response": {
580 "$ref": "PullResponse" 509 "$ref": "PullResponse"
581 }, 510 },
582 "scopes": [ 511 "scopes": [
583 "https://www.googleapis.com/auth/cloud-platform" , 512 "https://www.googleapis.com/auth/cloud-platform" ,
584 "https://www.googleapis.com/auth/pubsub" 513 "https://www.googleapis.com/auth/pubsub"
585 ] 514 ]
586 }, 515 }
587 "list": { 516 }
588 "description": "Lists matching subscriptions.", 517 },
518 "topics": {
519 "methods": {
520 "get": {
521 "description": "Gets the configuration of a topic.",
589 "httpMethod": "GET", 522 "httpMethod": "GET",
590 "id": "pubsub.projects.subscriptions.list", 523 "id": "pubsub.projects.topics.get",
591 "parameterOrder": [ 524 "parameterOrder": [
592 "project" 525 "topic"
593 ], 526 ],
594 "parameters": { 527 "parameters": {
595 "pageToken": { 528 "topic": {
596 "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.", 529 "description": "The name of the topic to get .\nFormat is `projects/{project}/topics/{topic}`.",
597 "location": "query",
598 "type": "string"
599 },
600 "pageSize": {
601 "description": "Maximum number of subscripti ons to return.",
602 "format": "int32",
603 "location": "query",
604 "type": "integer"
605 },
606 "project": {
607 "description": "The name of the cloud projec t that subscriptions belong to.\nFormat is `projects/{project}`.",
608 "location": "path", 530 "location": "path",
609 "pattern": "^projects/[^/]+$", 531 "pattern": "^projects/[^/]+/topics/[^/]+$",
610 "required": true, 532 "required": true,
611 "type": "string" 533 "type": "string"
612 } 534 }
613 }, 535 },
614 "path": "v1/{+project}/subscriptions", 536 "path": "v1/{+topic}",
615 "response": { 537 "response": {
616 "$ref": "ListSubscriptionsResponse" 538 "$ref": "Topic"
617 }, 539 },
618 "scopes": [ 540 "scopes": [
619 "https://www.googleapis.com/auth/cloud-platform" , 541 "https://www.googleapis.com/auth/cloud-platform" ,
620 "https://www.googleapis.com/auth/pubsub" 542 "https://www.googleapis.com/auth/pubsub"
621 ] 543 ]
622 }, 544 },
623 "create": { 545 "publish": {
624 "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.", 546 "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.",
625 "httpMethod": "PUT", 547 "httpMethod": "POST",
626 "id": "pubsub.projects.subscriptions.create", 548 "id": "pubsub.projects.topics.publish",
627 "parameterOrder": [ 549 "parameterOrder": [
628 "name" 550 "topic"
629 ], 551 ],
630 "parameters": { 552 "parameters": {
631 "name": { 553 "topic": {
632 "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\"`.", 554 "description": "The messages in the request will be published on this topic.\nFormat is `projects/{project}/topics/{topic}`. ",
633 "location": "path", 555 "location": "path",
634 "pattern": "^projects/[^/]+/subscriptions/[^ /]+$", 556 "pattern": "^projects/[^/]+/topics/[^/]+$",
635 "required": true, 557 "required": true,
636 "type": "string" 558 "type": "string"
637 } 559 }
638 }, 560 },
639 "path": "v1/{+name}", 561 "path": "v1/{+topic}:publish",
640 "request": { 562 "request": {
641 "$ref": "Subscription" 563 "$ref": "PublishRequest"
642 }, 564 },
643 "response": { 565 "response": {
644 "$ref": "Subscription" 566 "$ref": "PublishResponse"
645 }, 567 },
646 "scopes": [ 568 "scopes": [
647 "https://www.googleapis.com/auth/cloud-platform" , 569 "https://www.googleapis.com/auth/cloud-platform" ,
648 "https://www.googleapis.com/auth/pubsub" 570 "https://www.googleapis.com/auth/pubsub"
649 ] 571 ]
650 }, 572 },
651 "setIamPolicy": { 573 "testIamPermissions": {
652 "description": "Sets the access control policy on th e specified resource. Replaces any\nexisting policy.", 574 "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. ",
653 "httpMethod": "POST", 575 "httpMethod": "POST",
654 "id": "pubsub.projects.subscriptions.setIamPolicy", 576 "id": "pubsub.projects.topics.testIamPermissions",
655 "parameterOrder": [ 577 "parameterOrder": [
656 "resource" 578 "resource"
657 ], 579 ],
658 "parameters": { 580 "parameters": {
659 "resource": { 581 "resource": {
660 "description": "REQUIRED: The resource for w hich the policy is being specified.\nSee the operation documentation for the app ropriate value for this field.", 582 "description": "REQUIRED: The resource for w hich the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
661 "location": "path", 583 "location": "path",
662 "pattern": "^projects/[^/]+/subscriptions/[^ /]+$", 584 "pattern": "^projects/[^/]+/topics/[^/]+$",
663 "required": true, 585 "required": true,
664 "type": "string" 586 "type": "string"
665 } 587 }
666 }, 588 },
667 "path": "v1/{+resource}:setIamPolicy", 589 "path": "v1/{+resource}:testIamPermissions",
668 "request": { 590 "request": {
669 "$ref": "SetIamPolicyRequest" 591 "$ref": "TestIamPermissionsRequest"
670 }, 592 },
671 "response": { 593 "response": {
672 "$ref": "Policy" 594 "$ref": "TestIamPermissionsResponse"
673 }, 595 },
674 "scopes": [ 596 "scopes": [
675 "https://www.googleapis.com/auth/cloud-platform" , 597 "https://www.googleapis.com/auth/cloud-platform" ,
676 "https://www.googleapis.com/auth/pubsub" 598 "https://www.googleapis.com/auth/pubsub"
677 ] 599 ]
678 }, 600 },
679 "modifyAckDeadline": { 601 "delete": {
680 "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.", 602 "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_`.",
681 "httpMethod": "POST", 603 "httpMethod": "DELETE",
682 "id": "pubsub.projects.subscriptions.modifyAckDeadli ne", 604 "id": "pubsub.projects.topics.delete",
683 "parameterOrder": [ 605 "parameterOrder": [
684 "subscription" 606 "topic"
685 ], 607 ],
686 "parameters": { 608 "parameters": {
687 "subscription": { 609 "topic": {
688 "description": "The name of the subscription .\nFormat is `projects/{project}/subscriptions/{sub}`.", 610 "description": "Name of the topic to delete. \nFormat is `projects/{project}/topics/{topic}`.",
689 "location": "path", 611 "location": "path",
690 "pattern": "^projects/[^/]+/subscriptions/[^ /]+$", 612 "pattern": "^projects/[^/]+/topics/[^/]+$",
691 "required": true, 613 "required": true,
692 "type": "string" 614 "type": "string"
693 } 615 }
694 }, 616 },
695 "path": "v1/{+subscription}:modifyAckDeadline", 617 "path": "v1/{+topic}",
696 "request": {
697 "$ref": "ModifyAckDeadlineRequest"
698 },
699 "response": { 618 "response": {
700 "$ref": "Empty" 619 "$ref": "Empty"
701 }, 620 },
702 "scopes": [ 621 "scopes": [
703 "https://www.googleapis.com/auth/cloud-platform" , 622 "https://www.googleapis.com/auth/cloud-platform" ,
704 "https://www.googleapis.com/auth/pubsub" 623 "https://www.googleapis.com/auth/pubsub"
705 ] 624 ]
706 }, 625 },
707 "acknowledge": { 626 "list": {
708 "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.", 627 "description": "Lists matching topics.",
709 "httpMethod": "POST", 628 "httpMethod": "GET",
710 "id": "pubsub.projects.subscriptions.acknowledge", 629 "id": "pubsub.projects.topics.list",
711 "parameterOrder": [ 630 "parameterOrder": [
712 "subscription" 631 "project"
713 ], 632 ],
714 "parameters": { 633 "parameters": {
715 "subscription": { 634 "pageToken": {
716 "description": "The subscription whose messa ge is being acknowledged.\nFormat is `projects/{project}/subscriptions/{sub}`.", 635 "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.",
636 "location": "query",
637 "type": "string"
638 },
639 "pageSize": {
640 "description": "Maximum number of topics to return.",
641 "format": "int32",
642 "location": "query",
643 "type": "integer"
644 },
645 "project": {
646 "description": "The name of the cloud projec t that topics belong to.\nFormat is `projects/{project}`.",
717 "location": "path", 647 "location": "path",
718 "pattern": "^projects/[^/]+/subscriptions/[^ /]+$", 648 "pattern": "^projects/[^/]+$",
719 "required": true, 649 "required": true,
720 "type": "string" 650 "type": "string"
721 } 651 }
722 }, 652 },
723 "path": "v1/{+subscription}:acknowledge", 653 "path": "v1/{+project}/topics",
724 "request": {
725 "$ref": "AcknowledgeRequest"
726 },
727 "response": { 654 "response": {
728 "$ref": "Empty" 655 "$ref": "ListTopicsResponse"
729 }, 656 },
730 "scopes": [ 657 "scopes": [
731 "https://www.googleapis.com/auth/cloud-platform" , 658 "https://www.googleapis.com/auth/cloud-platform" ,
732 "https://www.googleapis.com/auth/pubsub" 659 "https://www.googleapis.com/auth/pubsub"
733 ] 660 ]
734 }, 661 },
735 "getIamPolicy": { 662 "create": {
736 "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.", 663 "description": "Creates the given topic with the giv en name.",
737 "httpMethod": "GET", 664 "httpMethod": "PUT",
738 "id": "pubsub.projects.subscriptions.getIamPolicy", 665 "id": "pubsub.projects.topics.create",
666 "parameterOrder": [
667 "name"
668 ],
669 "parameters": {
670 "name": {
671 "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\"`.",
672 "location": "path",
673 "pattern": "^projects/[^/]+/topics/[^/]+$",
674 "required": true,
675 "type": "string"
676 }
677 },
678 "path": "v1/{+name}",
679 "request": {
680 "$ref": "Topic"
681 },
682 "response": {
683 "$ref": "Topic"
684 },
685 "scopes": [
686 "https://www.googleapis.com/auth/cloud-platform" ,
687 "https://www.googleapis.com/auth/pubsub"
688 ]
689 },
690 "setIamPolicy": {
691 "description": "Sets the access control policy on th e specified resource. Replaces any\nexisting policy.",
692 "httpMethod": "POST",
693 "id": "pubsub.projects.topics.setIamPolicy",
739 "parameterOrder": [ 694 "parameterOrder": [
740 "resource" 695 "resource"
741 ], 696 ],
742 "parameters": { 697 "parameters": {
743 "resource": { 698 "resource": {
744 "description": "REQUIRED: The resource for w hich the policy is being requested.\nSee the operation documentation for the app ropriate value for this field.", 699 "description": "REQUIRED: The resource for w hich the policy is being specified.\nSee the operation documentation for the app ropriate value for this field.",
745 "location": "path", 700 "location": "path",
746 "pattern": "^projects/[^/]+/subscriptions/[^ /]+$", 701 "pattern": "^projects/[^/]+/topics/[^/]+$",
747 "required": true, 702 "required": true,
748 "type": "string" 703 "type": "string"
749 } 704 }
750 }, 705 },
751 "path": "v1/{+resource}:getIamPolicy", 706 "path": "v1/{+resource}:setIamPolicy",
707 "request": {
708 "$ref": "SetIamPolicyRequest"
709 },
752 "response": { 710 "response": {
753 "$ref": "Policy" 711 "$ref": "Policy"
754 }, 712 },
755 "scopes": [ 713 "scopes": [
756 "https://www.googleapis.com/auth/cloud-platform" , 714 "https://www.googleapis.com/auth/cloud-platform" ,
757 "https://www.googleapis.com/auth/pubsub" 715 "https://www.googleapis.com/auth/pubsub"
758 ] 716 ]
759 }, 717 },
760 "get": { 718 "getIamPolicy": {
761 "description": "Gets the configuration details of a subscription.", 719 "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.",
762 "httpMethod": "GET", 720 "httpMethod": "GET",
763 "id": "pubsub.projects.subscriptions.get", 721 "id": "pubsub.projects.topics.getIamPolicy",
764 "parameterOrder": [ 722 "parameterOrder": [
765 "subscription" 723 "resource"
766 ], 724 ],
767 "parameters": { 725 "parameters": {
768 "subscription": { 726 "resource": {
769 "description": "The name of the subscription to get.\nFormat is `projects/{project}/subscriptions/{sub}`.", 727 "description": "REQUIRED: The resource for w hich the policy is being requested.\nSee the operation documentation for the app ropriate value for this field.",
770 "location": "path", 728 "location": "path",
771 "pattern": "^projects/[^/]+/subscriptions/[^ /]+$", 729 "pattern": "^projects/[^/]+/topics/[^/]+$",
772 "required": true, 730 "required": true,
773 "type": "string" 731 "type": "string"
774 } 732 }
775 }, 733 },
776 "path": "v1/{+subscription}", 734 "path": "v1/{+resource}:getIamPolicy",
777 "response": { 735 "response": {
778 "$ref": "Subscription" 736 "$ref": "Policy"
779 }, 737 },
780 "scopes": [ 738 "scopes": [
781 "https://www.googleapis.com/auth/cloud-platform" , 739 "https://www.googleapis.com/auth/cloud-platform" ,
782 "https://www.googleapis.com/auth/pubsub" 740 "https://www.googleapis.com/auth/pubsub"
783 ] 741 ]
784 } 742 }
743 },
744 "resources": {
745 "subscriptions": {
746 "methods": {
747 "list": {
748 "description": "Lists the name of the subscr iptions for this topic.",
749 "httpMethod": "GET",
750 "id": "pubsub.projects.topics.subscriptions. list",
751 "parameterOrder": [
752 "topic"
753 ],
754 "parameters": {
755 "pageToken": {
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.",
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 }
783 }
784 }
785 } 785 }
786 } 786 }
787 } 787 }
788 } 788 }
789 }, 789 },
790 "revision": "20170731", 790 "revision": "20170829",
791 "rootUrl": "https://pubsub.googleapis.com/", 791 "rootUrl": "https://pubsub.googleapis.com/",
792 "schemas": { 792 "schemas": {
793 "PullRequest": {
794 "description": "Request for the `Pull` method.",
795 "id": "PullRequest",
796 "properties": {
797 "returnImmediately": {
798 "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.",
799 "type": "boolean"
800 },
801 "maxMessages": {
802 "description": "The maximum number of messages returned for this request. The Pub/Sub\nsystem may return fewer than the number specified.",
803 "format": "int32",
804 "type": "integer"
805 }
806 },
807 "type": "object"
808 },
809 "ListSubscriptionsResponse": {
810 "description": "Response for the `ListSubscriptions` method.",
811 "id": "ListSubscriptionsResponse",
812 "properties": {
813 "nextPageToken": {
814 "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.",
815 "type": "string"
816 },
817 "subscriptions": {
818 "description": "The subscriptions that match the request.",
819 "items": {
820 "$ref": "Subscription"
821 },
822 "type": "array"
823 }
824 },
825 "type": "object"
826 },
827 "PublishRequest": {
828 "description": "Request for the Publish method.",
829 "id": "PublishRequest",
830 "properties": {
831 "messages": {
832 "description": "The messages to publish.",
833 "items": {
834 "$ref": "PubsubMessage"
835 },
836 "type": "array"
837 }
838 },
839 "type": "object"
840 },
841 "PublishResponse": {
842 "description": "Response for the `Publish` method.",
843 "id": "PublishResponse",
844 "properties": {
845 "messageIds": {
846 "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.",
847 "items": {
848 "type": "string"
849 },
850 "type": "array"
851 }
852 },
853 "type": "object"
854 },
855 "Subscription": {
856 "description": "A subscription resource.",
857 "id": "Subscription",
858 "properties": {
859 "ackDeadlineSeconds": {
860 "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.",
861 "format": "int32",
862 "type": "integer"
863 },
864 "name": {
865 "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\"`.",
866 "type": "string"
867 },
868 "topic": {
869 "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. ",
870 "type": "string"
871 },
872 "pushConfig": {
873 "$ref": "PushConfig",
874 "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."
875 }
876 },
877 "type": "object"
878 },
879 "TestIamPermissionsRequest": {
880 "description": "Request message for `TestIamPermissions` method.",
881 "id": "TestIamPermissionsRequest",
882 "properties": {
883 "permissions": {
884 "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).",
885 "items": {
886 "type": "string"
887 },
888 "type": "array"
889 }
890 },
891 "type": "object"
892 },
893 "Topic": {
894 "description": "A topic resource.",
895 "id": "Topic",
896 "properties": {
897 "name": {
898 "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\"`.",
899 "type": "string"
900 }
901 },
902 "type": "object"
903 },
904 "Policy": {
905 "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).",
906 "id": "Policy",
907 "properties": {
908 "bindings": {
909 "description": "Associates a list of `members` to a `role`.\ n`bindings` with no members will result in an error.",
910 "items": {
911 "$ref": "Binding"
912 },
913 "type": "array"
914 },
915 "etag": {
916 "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.",
917 "format": "byte",
918 "type": "string"
919 },
920 "version": {
921 "description": "Version of the `Policy`. The default version is 0.",
922 "format": "int32",
923 "type": "integer"
924 }
925 },
926 "type": "object"
927 },
793 "ModifyAckDeadlineRequest": { 928 "ModifyAckDeadlineRequest": {
794 "description": "Request for the ModifyAckDeadline method.", 929 "description": "Request for the ModifyAckDeadline method.",
795 "id": "ModifyAckDeadlineRequest", 930 "id": "ModifyAckDeadlineRequest",
796 "properties": { 931 "properties": {
797 "ackDeadlineSeconds": { 932 "ackDeadlineSeconds": {
798 "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).", 933 "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).",
799 "format": "int32", 934 "format": "int32",
800 "type": "integer" 935 "type": "integer"
801 }, 936 },
802 "ackIds": { 937 "ackIds": {
(...skipping 183 matching lines...) Expand 10 before | Expand all | Expand 10 after
986 "properties": { 1121 "properties": {
987 "permissions": { 1122 "permissions": {
988 "description": "A subset of `TestPermissionsRequest.permissi ons` that the caller is\nallowed.", 1123 "description": "A subset of `TestPermissionsRequest.permissi ons` that the caller is\nallowed.",
989 "items": { 1124 "items": {
990 "type": "string" 1125 "type": "string"
991 }, 1126 },
992 "type": "array" 1127 "type": "array"
993 } 1128 }
994 }, 1129 },
995 "type": "object" 1130 "type": "object"
996 },
997 "PullRequest": {
998 "description": "Request for the `Pull` method.",
999 "id": "PullRequest",
1000 "properties": {
1001 "maxMessages": {
1002 "description": "The maximum number of messages returned for this request. The Pub/Sub\nsystem may return fewer than the number specified.",
1003 "format": "int32",
1004 "type": "integer"
1005 },
1006 "returnImmediately": {
1007 "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.",
1008 "type": "boolean"
1009 }
1010 },
1011 "type": "object"
1012 },
1013 "ListSubscriptionsResponse": {
1014 "description": "Response for the `ListSubscriptions` method.",
1015 "id": "ListSubscriptionsResponse",
1016 "properties": {
1017 "nextPageToken": {
1018 "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.",
1019 "type": "string"
1020 },
1021 "subscriptions": {
1022 "description": "The subscriptions that match the request.",
1023 "items": {
1024 "$ref": "Subscription"
1025 },
1026 "type": "array"
1027 }
1028 },
1029 "type": "object"
1030 },
1031 "PublishRequest": {
1032 "description": "Request for the Publish method.",
1033 "id": "PublishRequest",
1034 "properties": {
1035 "messages": {
1036 "description": "The messages to publish.",
1037 "items": {
1038 "$ref": "PubsubMessage"
1039 },
1040 "type": "array"
1041 }
1042 },
1043 "type": "object"
1044 },
1045 "PublishResponse": {
1046 "description": "Response for the `Publish` method.",
1047 "id": "PublishResponse",
1048 "properties": {
1049 "messageIds": {
1050 "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.",
1051 "items": {
1052 "type": "string"
1053 },
1054 "type": "array"
1055 }
1056 },
1057 "type": "object"
1058 },
1059 "Subscription": {
1060 "description": "A subscription resource.",
1061 "id": "Subscription",
1062 "properties": {
1063 "topic": {
1064 "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. ",
1065 "type": "string"
1066 },
1067 "pushConfig": {
1068 "$ref": "PushConfig",
1069 "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."
1070 },
1071 "ackDeadlineSeconds": {
1072 "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.",
1073 "format": "int32",
1074 "type": "integer"
1075 },
1076 "name": {
1077 "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\"`.",
1078 "type": "string"
1079 }
1080 },
1081 "type": "object"
1082 },
1083 "TestIamPermissionsRequest": {
1084 "description": "Request message for `TestIamPermissions` method.",
1085 "id": "TestIamPermissionsRequest",
1086 "properties": {
1087 "permissions": {
1088 "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).",
1089 "items": {
1090 "type": "string"
1091 },
1092 "type": "array"
1093 }
1094 },
1095 "type": "object"
1096 },
1097 "Policy": {
1098 "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).",
1099 "id": "Policy",
1100 "properties": {
1101 "bindings": {
1102 "description": "Associates a list of `members` to a `role`.\ n`bindings` with no members will result in an error.",
1103 "items": {
1104 "$ref": "Binding"
1105 },
1106 "type": "array"
1107 },
1108 "etag": {
1109 "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.",
1110 "format": "byte",
1111 "type": "string"
1112 },
1113 "version": {
1114 "description": "Version of the `Policy`. The default version is 0.",
1115 "format": "int32",
1116 "type": "integer"
1117 }
1118 },
1119 "type": "object"
1120 },
1121 "Topic": {
1122 "description": "A topic resource.",
1123 "id": "Topic",
1124 "properties": {
1125 "name": {
1126 "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\"`.",
1127 "type": "string"
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/prediction__v1.6.json ('k') | discovery/googleapis/qpxExpress__v1.json » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698