OLD | NEW |
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 Loading... |
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": { |
| 32 "description": "Selector specifying which fields to include in a par
tial response.", |
| 33 "location": "query", |
| 34 "type": "string" |
| 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 }, |
31 "access_token": { | 75 "access_token": { |
32 "description": "OAuth access token.", | 76 "description": "OAuth access token.", |
33 "location": "query", | 77 "location": "query", |
34 "type": "string" | 78 "type": "string" |
35 }, | 79 }, |
36 "key": { | 80 "key": { |
37 "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.", | 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.", |
38 "location": "query", | 82 "location": "query", |
39 "type": "string" | 83 "type": "string" |
40 }, | 84 }, |
(...skipping 21 matching lines...) Expand all Loading... |
62 "upload_protocol": { | 106 "upload_protocol": { |
63 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", | 107 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", |
64 "location": "query", | 108 "location": "query", |
65 "type": "string" | 109 "type": "string" |
66 }, | 110 }, |
67 "prettyPrint": { | 111 "prettyPrint": { |
68 "default": "true", | 112 "default": "true", |
69 "description": "Returns response with indentations and line breaks."
, | 113 "description": "Returns response with indentations and line breaks."
, |
70 "location": "query", | 114 "location": "query", |
71 "type": "boolean" | 115 "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 "subscriptions": { |
123 "methods": { | 123 "methods": { |
124 "delete": { | 124 "create": { |
125 "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.", | 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": "DELETE", | 126 "httpMethod": "PUT", |
127 "id": "pubsub.projects.subscriptions.delete", | 127 "id": "pubsub.projects.subscriptions.create", |
128 "parameterOrder": [ | 128 "parameterOrder": [ |
129 "subscription" | 129 "name" |
130 ], | 130 ], |
131 "parameters": { | 131 "parameters": { |
132 "subscription": { | 132 "name": { |
133 "description": "The subscription to delete.\
nFormat is `projects/{project}/subscriptions/{sub}`.", | 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", | 134 "location": "path", |
135 "pattern": "^projects/[^/]+/subscriptions/[^
/]+$", | 135 "pattern": "^projects/[^/]+/subscriptions/[^
/]+$", |
136 "required": true, | 136 "required": true, |
137 "type": "string" | 137 "type": "string" |
138 } | 138 } |
139 }, | 139 }, |
140 "path": "v1/{+subscription}", | 140 "path": "v1/{+name}", |
| 141 "request": { |
| 142 "$ref": "Subscription" |
| 143 }, |
141 "response": { | 144 "response": { |
142 "$ref": "Empty" | 145 "$ref": "Subscription" |
143 }, | 146 }, |
144 "scopes": [ | 147 "scopes": [ |
145 "https://www.googleapis.com/auth/cloud-platform"
, | 148 "https://www.googleapis.com/auth/cloud-platform"
, |
146 "https://www.googleapis.com/auth/pubsub" | |
147 ] | |
148 }, | |
149 "pull": { | |
150 "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.", | |
151 "httpMethod": "POST", | |
152 "id": "pubsub.projects.subscriptions.pull", | |
153 "parameterOrder": [ | |
154 "subscription" | |
155 ], | |
156 "parameters": { | |
157 "subscription": { | |
158 "description": "The subscription from which
messages should be pulled.\nFormat is `projects/{project}/subscriptions/{sub}`."
, | |
159 "location": "path", | |
160 "pattern": "^projects/[^/]+/subscriptions/[^
/]+$", | |
161 "required": true, | |
162 "type": "string" | |
163 } | |
164 }, | |
165 "path": "v1/{+subscription}:pull", | |
166 "request": { | |
167 "$ref": "PullRequest" | |
168 }, | |
169 "response": { | |
170 "$ref": "PullResponse" | |
171 }, | |
172 "scopes": [ | |
173 "https://www.googleapis.com/auth/cloud-platform"
, | |
174 "https://www.googleapis.com/auth/pubsub" | |
175 ] | |
176 }, | |
177 "list": { | |
178 "description": "Lists matching subscriptions.", | |
179 "httpMethod": "GET", | |
180 "id": "pubsub.projects.subscriptions.list", | |
181 "parameterOrder": [ | |
182 "project" | |
183 ], | |
184 "parameters": { | |
185 "pageToken": { | |
186 "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.", | |
187 "location": "query", | |
188 "type": "string" | |
189 }, | |
190 "pageSize": { | |
191 "description": "Maximum number of subscripti
ons to return.", | |
192 "format": "int32", | |
193 "location": "query", | |
194 "type": "integer" | |
195 }, | |
196 "project": { | |
197 "description": "The name of the cloud projec
t that subscriptions belong to.\nFormat is `projects/{project}`.", | |
198 "location": "path", | |
199 "pattern": "^projects/[^/]+$", | |
200 "required": true, | |
201 "type": "string" | |
202 } | |
203 }, | |
204 "path": "v1/{+project}/subscriptions", | |
205 "response": { | |
206 "$ref": "ListSubscriptionsResponse" | |
207 }, | |
208 "scopes": [ | |
209 "https://www.googleapis.com/auth/cloud-platform"
, | |
210 "https://www.googleapis.com/auth/pubsub" | 149 "https://www.googleapis.com/auth/pubsub" |
211 ] | 150 ] |
212 }, | 151 }, |
213 "setIamPolicy": { | 152 "setIamPolicy": { |
214 "description": "Sets the access control policy on th
e specified resource. Replaces any\nexisting policy.", | 153 "description": "Sets the access control policy on th
e specified resource. Replaces any\nexisting policy.", |
215 "httpMethod": "POST", | 154 "httpMethod": "POST", |
216 "id": "pubsub.projects.subscriptions.setIamPolicy", | 155 "id": "pubsub.projects.subscriptions.setIamPolicy", |
217 "parameterOrder": [ | 156 "parameterOrder": [ |
218 "resource" | 157 "resource" |
219 ], | 158 ], |
(...skipping 11 matching lines...) Expand all Loading... |
231 "$ref": "SetIamPolicyRequest" | 170 "$ref": "SetIamPolicyRequest" |
232 }, | 171 }, |
233 "response": { | 172 "response": { |
234 "$ref": "Policy" | 173 "$ref": "Policy" |
235 }, | 174 }, |
236 "scopes": [ | 175 "scopes": [ |
237 "https://www.googleapis.com/auth/cloud-platform"
, | 176 "https://www.googleapis.com/auth/cloud-platform"
, |
238 "https://www.googleapis.com/auth/pubsub" | 177 "https://www.googleapis.com/auth/pubsub" |
239 ] | 178 ] |
240 }, | 179 }, |
241 "create": { | 180 "modifyAckDeadline": { |
242 "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.", | 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.", |
243 "httpMethod": "PUT", | 182 "httpMethod": "POST", |
244 "id": "pubsub.projects.subscriptions.create", | 183 "id": "pubsub.projects.subscriptions.modifyAckDeadli
ne", |
245 "parameterOrder": [ | 184 "parameterOrder": [ |
246 "name" | 185 "subscription" |
247 ], | 186 ], |
248 "parameters": { | 187 "parameters": { |
249 "name": { | 188 "subscription": { |
250 "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\"`.", | 189 "description": "The name of the subscription
.\nFormat is `projects/{project}/subscriptions/{sub}`.", |
251 "location": "path", | 190 "location": "path", |
252 "pattern": "^projects/[^/]+/subscriptions/[^
/]+$", | 191 "pattern": "^projects/[^/]+/subscriptions/[^
/]+$", |
253 "required": true, | 192 "required": true, |
254 "type": "string" | 193 "type": "string" |
255 } | 194 } |
256 }, | 195 }, |
257 "path": "v1/{+name}", | 196 "path": "v1/{+subscription}:modifyAckDeadline", |
258 "request": { | 197 "request": { |
259 "$ref": "Subscription" | 198 "$ref": "ModifyAckDeadlineRequest" |
260 }, | 199 }, |
261 "response": { | 200 "response": { |
262 "$ref": "Subscription" | 201 "$ref": "Empty" |
263 }, | 202 }, |
264 "scopes": [ | 203 "scopes": [ |
265 "https://www.googleapis.com/auth/cloud-platform"
, | 204 "https://www.googleapis.com/auth/cloud-platform"
, |
266 "https://www.googleapis.com/auth/pubsub" | 205 "https://www.googleapis.com/auth/pubsub" |
267 ] | 206 ] |
268 }, | 207 }, |
269 "acknowledge": { | 208 "acknowledge": { |
270 "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.", | 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.", |
271 "httpMethod": "POST", | 210 "httpMethod": "POST", |
272 "id": "pubsub.projects.subscriptions.acknowledge", | 211 "id": "pubsub.projects.subscriptions.acknowledge", |
(...skipping 14 matching lines...) Expand all Loading... |
287 "$ref": "AcknowledgeRequest" | 226 "$ref": "AcknowledgeRequest" |
288 }, | 227 }, |
289 "response": { | 228 "response": { |
290 "$ref": "Empty" | 229 "$ref": "Empty" |
291 }, | 230 }, |
292 "scopes": [ | 231 "scopes": [ |
293 "https://www.googleapis.com/auth/cloud-platform"
, | 232 "https://www.googleapis.com/auth/cloud-platform"
, |
294 "https://www.googleapis.com/auth/pubsub" | 233 "https://www.googleapis.com/auth/pubsub" |
295 ] | 234 ] |
296 }, | 235 }, |
297 "modifyAckDeadline": { | |
298 "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.", | |
299 "httpMethod": "POST", | |
300 "id": "pubsub.projects.subscriptions.modifyAckDeadli
ne", | |
301 "parameterOrder": [ | |
302 "subscription" | |
303 ], | |
304 "parameters": { | |
305 "subscription": { | |
306 "description": "The name of the subscription
.\nFormat is `projects/{project}/subscriptions/{sub}`.", | |
307 "location": "path", | |
308 "pattern": "^projects/[^/]+/subscriptions/[^
/]+$", | |
309 "required": true, | |
310 "type": "string" | |
311 } | |
312 }, | |
313 "path": "v1/{+subscription}:modifyAckDeadline", | |
314 "request": { | |
315 "$ref": "ModifyAckDeadlineRequest" | |
316 }, | |
317 "response": { | |
318 "$ref": "Empty" | |
319 }, | |
320 "scopes": [ | |
321 "https://www.googleapis.com/auth/cloud-platform"
, | |
322 "https://www.googleapis.com/auth/pubsub" | |
323 ] | |
324 }, | |
325 "getIamPolicy": { | 236 "getIamPolicy": { |
326 "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.", | 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.", |
327 "httpMethod": "GET", | 238 "httpMethod": "GET", |
328 "id": "pubsub.projects.subscriptions.getIamPolicy", | 239 "id": "pubsub.projects.subscriptions.getIamPolicy", |
329 "parameterOrder": [ | 240 "parameterOrder": [ |
330 "resource" | 241 "resource" |
331 ], | 242 ], |
332 "parameters": { | 243 "parameters": { |
333 "resource": { | 244 "resource": { |
334 "description": "REQUIRED: The resource for w
hich the policy is being requested.\nSee the operation documentation for the app
ropriate value for this field.", | 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.", |
(...skipping 85 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
420 "request": { | 331 "request": { |
421 "$ref": "ModifyPushConfigRequest" | 332 "$ref": "ModifyPushConfigRequest" |
422 }, | 333 }, |
423 "response": { | 334 "response": { |
424 "$ref": "Empty" | 335 "$ref": "Empty" |
425 }, | 336 }, |
426 "scopes": [ | 337 "scopes": [ |
427 "https://www.googleapis.com/auth/cloud-platform"
, | 338 "https://www.googleapis.com/auth/cloud-platform"
, |
428 "https://www.googleapis.com/auth/pubsub" | 339 "https://www.googleapis.com/auth/pubsub" |
429 ] | 340 ] |
| 341 }, |
| 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": { |
| 396 "description": "Lists matching subscriptions.", |
| 397 "httpMethod": "GET", |
| 398 "id": "pubsub.projects.subscriptions.list", |
| 399 "parameterOrder": [ |
| 400 "project" |
| 401 ], |
| 402 "parameters": { |
| 403 "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.", |
| 405 "location": "query", |
| 406 "type": "string" |
| 407 }, |
| 408 "pageSize": { |
| 409 "description": "Maximum number of subscripti
ons to return.", |
| 410 "format": "int32", |
| 411 "location": "query", |
| 412 "type": "integer" |
| 413 }, |
| 414 "project": { |
| 415 "description": "The name of the cloud projec
t that subscriptions belong to.\nFormat is `projects/{project}`.", |
| 416 "location": "path", |
| 417 "pattern": "^projects/[^/]+$", |
| 418 "required": true, |
| 419 "type": "string" |
| 420 } |
| 421 }, |
| 422 "path": "v1/{+project}/subscriptions", |
| 423 "response": { |
| 424 "$ref": "ListSubscriptionsResponse" |
| 425 }, |
| 426 "scopes": [ |
| 427 "https://www.googleapis.com/auth/cloud-platform"
, |
| 428 "https://www.googleapis.com/auth/pubsub" |
| 429 ] |
430 } | 430 } |
431 } | 431 } |
432 }, | 432 }, |
433 "snapshots": { | 433 "snapshots": { |
434 "methods": { | 434 "methods": { |
435 "getIamPolicy": { | |
436 "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.", | |
437 "httpMethod": "GET", | |
438 "id": "pubsub.projects.snapshots.getIamPolicy", | |
439 "parameterOrder": [ | |
440 "resource" | |
441 ], | |
442 "parameters": { | |
443 "resource": { | |
444 "description": "REQUIRED: The resource for w
hich the policy is being requested.\nSee the operation documentation for the app
ropriate value for this field.", | |
445 "location": "path", | |
446 "pattern": "^projects/[^/]+/snapshots/[^/]+$
", | |
447 "required": true, | |
448 "type": "string" | |
449 } | |
450 }, | |
451 "path": "v1/{+resource}:getIamPolicy", | |
452 "response": { | |
453 "$ref": "Policy" | |
454 }, | |
455 "scopes": [ | |
456 "https://www.googleapis.com/auth/cloud-platform"
, | |
457 "https://www.googleapis.com/auth/pubsub" | |
458 ] | |
459 }, | |
460 "setIamPolicy": { | 435 "setIamPolicy": { |
461 "description": "Sets the access control policy on th
e specified resource. Replaces any\nexisting policy.", | 436 "description": "Sets the access control policy on th
e specified resource. Replaces any\nexisting policy.", |
462 "httpMethod": "POST", | 437 "httpMethod": "POST", |
463 "id": "pubsub.projects.snapshots.setIamPolicy", | 438 "id": "pubsub.projects.snapshots.setIamPolicy", |
464 "parameterOrder": [ | 439 "parameterOrder": [ |
465 "resource" | 440 "resource" |
466 ], | 441 ], |
467 "parameters": { | 442 "parameters": { |
468 "resource": { | 443 "resource": { |
469 "description": "REQUIRED: The resource for w
hich the policy is being specified.\nSee the operation documentation for the app
ropriate value for this field.", | 444 "description": "REQUIRED: The resource for w
hich the policy is being specified.\nSee the operation documentation for the app
ropriate value for this field.", |
(...skipping 35 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
505 "request": { | 480 "request": { |
506 "$ref": "TestIamPermissionsRequest" | 481 "$ref": "TestIamPermissionsRequest" |
507 }, | 482 }, |
508 "response": { | 483 "response": { |
509 "$ref": "TestIamPermissionsResponse" | 484 "$ref": "TestIamPermissionsResponse" |
510 }, | 485 }, |
511 "scopes": [ | 486 "scopes": [ |
512 "https://www.googleapis.com/auth/cloud-platform"
, | 487 "https://www.googleapis.com/auth/cloud-platform"
, |
513 "https://www.googleapis.com/auth/pubsub" | 488 "https://www.googleapis.com/auth/pubsub" |
514 ] | 489 ] |
| 490 }, |
| 491 "getIamPolicy": { |
| 492 "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.", |
| 493 "httpMethod": "GET", |
| 494 "id": "pubsub.projects.snapshots.getIamPolicy", |
| 495 "parameterOrder": [ |
| 496 "resource" |
| 497 ], |
| 498 "parameters": { |
| 499 "resource": { |
| 500 "description": "REQUIRED: The resource for w
hich the policy is being requested.\nSee the operation documentation for the app
ropriate value for this field.", |
| 501 "location": "path", |
| 502 "pattern": "^projects/[^/]+/snapshots/[^/]+$
", |
| 503 "required": true, |
| 504 "type": "string" |
| 505 } |
| 506 }, |
| 507 "path": "v1/{+resource}:getIamPolicy", |
| 508 "response": { |
| 509 "$ref": "Policy" |
| 510 }, |
| 511 "scopes": [ |
| 512 "https://www.googleapis.com/auth/cloud-platform"
, |
| 513 "https://www.googleapis.com/auth/pubsub" |
| 514 ] |
515 } | 515 } |
516 } | 516 } |
517 }, | 517 }, |
518 "topics": { | 518 "topics": { |
519 "methods": { | 519 "methods": { |
520 "delete": { | 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_`.", | 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", | 522 "httpMethod": "DELETE", |
523 "id": "pubsub.projects.topics.delete", | 523 "id": "pubsub.projects.topics.delete", |
524 "parameterOrder": [ | 524 "parameterOrder": [ |
(...skipping 258 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
783 } | 783 } |
784 } | 784 } |
785 } | 785 } |
786 } | 786 } |
787 } | 787 } |
788 } | 788 } |
789 }, | 789 }, |
790 "revision": "20170502", | 790 "revision": "20170502", |
791 "rootUrl": "https://pubsub.googleapis.com/", | 791 "rootUrl": "https://pubsub.googleapis.com/", |
792 "schemas": { | 792 "schemas": { |
793 "TestIamPermissionsRequest": { | 793 "PublishRequest": { |
794 "description": "Request message for `TestIamPermissions` method.", | 794 "description": "Request for the Publish method.", |
795 "id": "TestIamPermissionsRequest", | 795 "id": "PublishRequest", |
796 "properties": { | 796 "properties": { |
797 "permissions": { | 797 "messages": { |
798 "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).", | 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.", |
799 "items": { | 813 "items": { |
800 "type": "string" | 814 "type": "string" |
801 }, | 815 }, |
802 "type": "array" | 816 "type": "array" |
803 } | 817 } |
804 }, | 818 }, |
805 "type": "object" | 819 "type": "object" |
806 }, | 820 }, |
807 "Topic": { | 821 "Subscription": { |
808 "description": "A topic resource.", | 822 "description": "A subscription resource.", |
809 "id": "Topic", | 823 "id": "Subscription", |
810 "properties": { | 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 }, |
811 "name": { | 830 "name": { |
812 "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\"`.", | 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\"`.", |
813 "type": "string" | 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." |
814 } | 841 } |
815 }, | 842 }, |
816 "type": "object" | 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" |
817 }, | 858 }, |
818 "Policy": { | 859 "Policy": { |
819 "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).", | 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).", |
820 "id": "Policy", | 861 "id": "Policy", |
821 "properties": { | 862 "properties": { |
822 "etag": { | 863 "etag": { |
823 "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.", | 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.", |
824 "format": "byte", | 865 "format": "byte", |
825 "type": "string" | 866 "type": "string" |
826 }, | 867 }, |
827 "version": { | 868 "version": { |
828 "description": "Version of the `Policy`. The default version
is 0.", | 869 "description": "Version of the `Policy`. The default version
is 0.", |
829 "format": "int32", | 870 "format": "int32", |
830 "type": "integer" | 871 "type": "integer" |
831 }, | 872 }, |
832 "bindings": { | 873 "bindings": { |
833 "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.", | 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.", |
834 "items": { | 875 "items": { |
835 "$ref": "Binding" | 876 "$ref": "Binding" |
836 }, | 877 }, |
837 "type": "array" | 878 "type": "array" |
838 } | 879 } |
839 }, | 880 }, |
840 "type": "object" | 881 "type": "object" |
841 }, | 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 }, |
842 "ModifyAckDeadlineRequest": { | 894 "ModifyAckDeadlineRequest": { |
843 "description": "Request for the ModifyAckDeadline method.", | 895 "description": "Request for the ModifyAckDeadline method.", |
844 "id": "ModifyAckDeadlineRequest", | 896 "id": "ModifyAckDeadlineRequest", |
845 "properties": { | 897 "properties": { |
846 "ackDeadlineSeconds": { | 898 "ackDeadlineSeconds": { |
847 "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).", | 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).", |
848 "format": "int32", | 900 "format": "int32", |
849 "type": "integer" | 901 "type": "integer" |
850 }, | 902 }, |
851 "ackIds": { | 903 "ackIds": { |
(...skipping 10 matching lines...) Expand all Loading... |
862 "description": "Request message for `SetIamPolicy` method.", | 914 "description": "Request message for `SetIamPolicy` method.", |
863 "id": "SetIamPolicyRequest", | 915 "id": "SetIamPolicyRequest", |
864 "properties": { | 916 "properties": { |
865 "policy": { | 917 "policy": { |
866 "$ref": "Policy", | 918 "$ref": "Policy", |
867 "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." | 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." |
868 } | 920 } |
869 }, | 921 }, |
870 "type": "object" | 922 "type": "object" |
871 }, | 923 }, |
| 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 }, |
872 "PubsubMessage": { | 935 "PubsubMessage": { |
873 "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.", | 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.", |
874 "id": "PubsubMessage", | 937 "id": "PubsubMessage", |
875 "properties": { | 938 "properties": { |
876 "publishTime": { | |
877 "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.", | |
878 "format": "google-datetime", | |
879 "type": "string" | |
880 }, | |
881 "data": { | |
882 "description": "The message payload.", | |
883 "format": "byte", | |
884 "type": "string" | |
885 }, | |
886 "attributes": { | 939 "attributes": { |
887 "additionalProperties": { | 940 "additionalProperties": { |
888 "type": "string" | 941 "type": "string" |
889 }, | 942 }, |
890 "description": "Optional attributes for this message.", | 943 "description": "Optional attributes for this message.", |
891 "type": "object" | 944 "type": "object" |
892 }, | 945 }, |
893 "messageId": { | 946 "messageId": { |
894 "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.", | 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.", |
895 "type": "string" | 948 "type": "string" |
| 949 }, |
| 950 "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.", |
| 952 "format": "google-datetime", |
| 953 "type": "string" |
| 954 }, |
| 955 "data": { |
| 956 "description": "The message payload.", |
| 957 "format": "byte", |
| 958 "type": "string" |
896 } | 959 } |
897 }, | 960 }, |
898 "type": "object" | 961 "type": "object" |
899 }, | |
900 "ModifyPushConfigRequest": { | |
901 "description": "Request for the ModifyPushConfig method.", | |
902 "id": "ModifyPushConfigRequest", | |
903 "properties": { | |
904 "pushConfig": { | |
905 "$ref": "PushConfig", | |
906 "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." | |
907 } | |
908 }, | |
909 "type": "object" | |
910 }, | 962 }, |
911 "Binding": { | 963 "Binding": { |
912 "description": "Associates `members` with a `role`.", | 964 "description": "Associates `members` with a `role`.", |
913 "id": "Binding", | 965 "id": "Binding", |
914 "properties": { | 966 "properties": { |
915 "members": { | 967 "members": { |
916 "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", | 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", |
917 "items": { | 969 "items": { |
918 "type": "string" | 970 "type": "string" |
919 }, | 971 }, |
920 "type": "array" | 972 "type": "array" |
921 }, | 973 }, |
922 "role": { | 974 "role": { |
923 "description": "Role that is assigned to `members`.\nFor exa
mple, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired", | 975 "description": "Role that is assigned to `members`.\nFor exa
mple, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired", |
924 "type": "string" | 976 "type": "string" |
925 } | 977 } |
926 }, | 978 }, |
927 "type": "object" | 979 "type": "object" |
928 }, | 980 }, |
929 "AcknowledgeRequest": { | 981 "ListTopicsResponse": { |
930 "description": "Request for the Acknowledge method.", | 982 "description": "Response for the `ListTopics` method.", |
931 "id": "AcknowledgeRequest", | 983 "id": "ListTopicsResponse", |
932 "properties": { | 984 "properties": { |
933 "ackIds": { | 985 "nextPageToken": { |
934 "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.", | 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`.", |
| 987 "type": "string" |
| 988 }, |
| 989 "topics": { |
| 990 "description": "The resulting topics.", |
935 "items": { | 991 "items": { |
936 "type": "string" | 992 "$ref": "Topic" |
937 }, | 993 }, |
938 "type": "array" | 994 "type": "array" |
939 } | 995 } |
940 }, | 996 }, |
941 "type": "object" | 997 "type": "object" |
942 }, | 998 }, |
943 "Empty": { | 999 "Empty": { |
944 "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 `{}`.", | 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 `{}`.", |
945 "id": "Empty", | 1001 "id": "Empty", |
946 "properties": {}, | 1002 "properties": {}, |
947 "type": "object" | 1003 "type": "object" |
948 }, | 1004 }, |
949 "ListTopicsResponse": { | 1005 "AcknowledgeRequest": { |
950 "description": "Response for the `ListTopics` method.", | 1006 "description": "Request for the Acknowledge method.", |
951 "id": "ListTopicsResponse", | 1007 "id": "AcknowledgeRequest", |
952 "properties": { | 1008 "properties": { |
953 "topics": { | 1009 "ackIds": { |
954 "description": "The resulting topics.", | 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.", |
955 "items": { | 1011 "items": { |
956 "$ref": "Topic" | 1012 "type": "string" |
957 }, | 1013 }, |
958 "type": "array" | 1014 "type": "array" |
959 }, | |
960 "nextPageToken": { | |
961 "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`.", | |
962 "type": "string" | |
963 } | 1015 } |
964 }, | 1016 }, |
965 "type": "object" | 1017 "type": "object" |
966 }, | 1018 }, |
967 "ListTopicSubscriptionsResponse": { | 1019 "ListTopicSubscriptionsResponse": { |
968 "description": "Response for the `ListTopicSubscriptions` method.", | 1020 "description": "Response for the `ListTopicSubscriptions` method.", |
969 "id": "ListTopicSubscriptionsResponse", | 1021 "id": "ListTopicSubscriptionsResponse", |
970 "properties": { | 1022 "properties": { |
971 "nextPageToken": { | 1023 "nextPageToken": { |
972 "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
`ListTopicSubscriptionsRequest` to get more subscriptions.", | 1024 "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
`ListTopicSubscriptionsRequest` to get more subscriptions.", |
(...skipping 67 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1040 }, | 1092 }, |
1041 "type": "array" | 1093 "type": "array" |
1042 } | 1094 } |
1043 }, | 1095 }, |
1044 "type": "object" | 1096 "type": "object" |
1045 }, | 1097 }, |
1046 "PullRequest": { | 1098 "PullRequest": { |
1047 "description": "Request for the `Pull` method.", | 1099 "description": "Request for the `Pull` method.", |
1048 "id": "PullRequest", | 1100 "id": "PullRequest", |
1049 "properties": { | 1101 "properties": { |
1050 "returnImmediately": { | |
1051 "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.", | |
1052 "type": "boolean" | |
1053 }, | |
1054 "maxMessages": { | 1102 "maxMessages": { |
1055 "description": "The maximum number of messages returned for
this request. The Pub/Sub\nsystem may return fewer than the number specified.", | 1103 "description": "The maximum number of messages returned for
this request. The Pub/Sub\nsystem may return fewer than the number specified.", |
1056 "format": "int32", | 1104 "format": "int32", |
1057 "type": "integer" | 1105 "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" |
1058 } | 1110 } |
1059 }, | 1111 }, |
1060 "type": "object" | 1112 "type": "object" |
1061 }, | 1113 }, |
1062 "ListSubscriptionsResponse": { | 1114 "ListSubscriptionsResponse": { |
1063 "description": "Response for the `ListSubscriptions` method.", | 1115 "description": "Response for the `ListSubscriptions` method.", |
1064 "id": "ListSubscriptionsResponse", | 1116 "id": "ListSubscriptionsResponse", |
1065 "properties": { | 1117 "properties": { |
| 1118 "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.", |
| 1120 "type": "string" |
| 1121 }, |
1066 "subscriptions": { | 1122 "subscriptions": { |
1067 "description": "The subscriptions that match the request.", | 1123 "description": "The subscriptions that match the request.", |
1068 "items": { | 1124 "items": { |
1069 "$ref": "Subscription" | 1125 "$ref": "Subscription" |
1070 }, | 1126 }, |
1071 "type": "array" | 1127 "type": "array" |
1072 }, | |
1073 "nextPageToken": { | |
1074 "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.", | |
1075 "type": "string" | |
1076 } | |
1077 }, | |
1078 "type": "object" | |
1079 }, | |
1080 "PublishRequest": { | |
1081 "description": "Request for the Publish method.", | |
1082 "id": "PublishRequest", | |
1083 "properties": { | |
1084 "messages": { | |
1085 "description": "The messages to publish.", | |
1086 "items": { | |
1087 "$ref": "PubsubMessage" | |
1088 }, | |
1089 "type": "array" | |
1090 } | |
1091 }, | |
1092 "type": "object" | |
1093 }, | |
1094 "PublishResponse": { | |
1095 "description": "Response for the `Publish` method.", | |
1096 "id": "PublishResponse", | |
1097 "properties": { | |
1098 "messageIds": { | |
1099 "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.", | |
1100 "items": { | |
1101 "type": "string" | |
1102 }, | |
1103 "type": "array" | |
1104 } | |
1105 }, | |
1106 "type": "object" | |
1107 }, | |
1108 "Subscription": { | |
1109 "description": "A subscription resource.", | |
1110 "id": "Subscription", | |
1111 "properties": { | |
1112 "pushConfig": { | |
1113 "$ref": "PushConfig", | |
1114 "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." | |
1115 }, | |
1116 "ackDeadlineSeconds": { | |
1117 "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.", | |
1118 "format": "int32", | |
1119 "type": "integer" | |
1120 }, | |
1121 "name": { | |
1122 "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\"`.", | |
1123 "type": "string" | |
1124 }, | |
1125 "topic": { | |
1126 "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.
", | |
1127 "type": "string" | |
1128 } | 1128 } |
1129 }, | 1129 }, |
1130 "type": "object" | 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 } |
OLD | NEW |