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:v1beta2", | 25 "id": "pubsub:v1beta2", |
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 "oauth_token": { | |
32 "description": "OAuth 2.0 token for the current user.", | |
33 "location": "query", | |
34 "type": "string" | |
35 }, | |
36 "bearer_token": { | |
37 "description": "OAuth bearer token.", | |
38 "location": "query", | |
39 "type": "string" | |
40 }, | |
41 "upload_protocol": { | 31 "upload_protocol": { |
42 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", | 32 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", |
43 "location": "query", | 33 "location": "query", |
44 "type": "string" | 34 "type": "string" |
45 }, | 35 }, |
46 "prettyPrint": { | 36 "prettyPrint": { |
47 "default": "true", | 37 "default": "true", |
48 "description": "Returns response with indentations and line breaks."
, | 38 "description": "Returns response with indentations and line breaks."
, |
49 "location": "query", | 39 "location": "query", |
50 "type": "boolean" | 40 "type": "boolean" |
(...skipping 35 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
86 "proto" | 76 "proto" |
87 ], | 77 ], |
88 "enumDescriptions": [ | 78 "enumDescriptions": [ |
89 "Responses with Content-Type of application/json", | 79 "Responses with Content-Type of application/json", |
90 "Media download with context-dependent Content-Type", | 80 "Media download with context-dependent Content-Type", |
91 "Responses with Content-Type of application/x-protobuf" | 81 "Responses with Content-Type of application/x-protobuf" |
92 ], | 82 ], |
93 "location": "query", | 83 "location": "query", |
94 "type": "string" | 84 "type": "string" |
95 }, | 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 }, |
96 "access_token": { | 91 "access_token": { |
97 "description": "OAuth access token.", | 92 "description": "OAuth access token.", |
98 "location": "query", | 93 "location": "query", |
99 "type": "string" | 94 "type": "string" |
100 }, | 95 }, |
101 "key": { | |
102 "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.", | |
103 "location": "query", | |
104 "type": "string" | |
105 }, | |
106 "quotaUser": { | 96 "quotaUser": { |
107 "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.", |
108 "location": "query", | 98 "location": "query", |
109 "type": "string" | 99 "type": "string" |
110 }, | 100 }, |
111 "pp": { | 101 "pp": { |
112 "default": "true", | 102 "default": "true", |
113 "description": "Pretty-print response.", | 103 "description": "Pretty-print response.", |
114 "location": "query", | 104 "location": "query", |
115 "type": "boolean" | 105 "type": "boolean" |
| 106 }, |
| 107 "oauth_token": { |
| 108 "description": "OAuth 2.0 token for the current user.", |
| 109 "location": "query", |
| 110 "type": "string" |
| 111 }, |
| 112 "bearer_token": { |
| 113 "description": "OAuth bearer token.", |
| 114 "location": "query", |
| 115 "type": "string" |
116 } | 116 } |
117 }, | 117 }, |
118 "protocol": "rest", | 118 "protocol": "rest", |
119 "resources": { | 119 "resources": { |
120 "projects": { | 120 "projects": { |
121 "resources": { | 121 "resources": { |
122 "subscriptions": { | 122 "topics": { |
123 "methods": { | 123 "methods": { |
| 124 "get": { |
| 125 "description": "Gets the configuration of a topic.", |
| 126 "httpMethod": "GET", |
| 127 "id": "pubsub.projects.topics.get", |
| 128 "parameterOrder": [ |
| 129 "topic" |
| 130 ], |
| 131 "parameters": { |
| 132 "topic": { |
| 133 "description": "The name of the topic to get
.", |
| 134 "location": "path", |
| 135 "pattern": "^projects/[^/]+/topics/[^/]+$", |
| 136 "required": true, |
| 137 "type": "string" |
| 138 } |
| 139 }, |
| 140 "path": "v1beta2/{+topic}", |
| 141 "response": { |
| 142 "$ref": "Topic" |
| 143 }, |
| 144 "scopes": [ |
| 145 "https://www.googleapis.com/auth/cloud-platform"
, |
| 146 "https://www.googleapis.com/auth/pubsub" |
| 147 ] |
| 148 }, |
| 149 "publish": { |
| 150 "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.", |
| 151 "httpMethod": "POST", |
| 152 "id": "pubsub.projects.topics.publish", |
| 153 "parameterOrder": [ |
| 154 "topic" |
| 155 ], |
| 156 "parameters": { |
| 157 "topic": { |
| 158 "description": "The messages in the request
will be published on this topic.", |
| 159 "location": "path", |
| 160 "pattern": "^projects/[^/]+/topics/[^/]+$", |
| 161 "required": true, |
| 162 "type": "string" |
| 163 } |
| 164 }, |
| 165 "path": "v1beta2/{+topic}:publish", |
| 166 "request": { |
| 167 "$ref": "PublishRequest" |
| 168 }, |
| 169 "response": { |
| 170 "$ref": "PublishResponse" |
| 171 }, |
| 172 "scopes": [ |
| 173 "https://www.googleapis.com/auth/cloud-platform"
, |
| 174 "https://www.googleapis.com/auth/pubsub" |
| 175 ] |
| 176 }, |
124 "testIamPermissions": { | 177 "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.
", | 178 "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", | 179 "httpMethod": "POST", |
127 "id": "pubsub.projects.subscriptions.testIamPermissi
ons", | 180 "id": "pubsub.projects.topics.testIamPermissions", |
128 "parameterOrder": [ | 181 "parameterOrder": [ |
129 "resource" | 182 "resource" |
130 ], | 183 ], |
131 "parameters": { | 184 "parameters": { |
132 "resource": { | 185 "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.", | 186 "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", | 187 "location": "path", |
135 "pattern": "^projects/[^/]+/subscriptions/[^
/]+$", | 188 "pattern": "^projects/[^/]+/topics/[^/]+$", |
136 "required": true, | 189 "required": true, |
137 "type": "string" | 190 "type": "string" |
138 } | 191 } |
139 }, | 192 }, |
140 "path": "v1beta2/{+resource}:testIamPermissions", | 193 "path": "v1beta2/{+resource}:testIamPermissions", |
141 "request": { | 194 "request": { |
142 "$ref": "TestIamPermissionsRequest" | 195 "$ref": "TestIamPermissionsRequest" |
143 }, | 196 }, |
144 "response": { | 197 "response": { |
145 "$ref": "TestIamPermissionsResponse" | 198 "$ref": "TestIamPermissionsResponse" |
146 }, | 199 }, |
147 "scopes": [ | 200 "scopes": [ |
148 "https://www.googleapis.com/auth/cloud-platform"
, | 201 "https://www.googleapis.com/auth/cloud-platform"
, |
149 "https://www.googleapis.com/auth/pubsub" | |
150 ] | |
151 }, | |
152 "modifyPushConfig": { | |
153 "description": "Modifies the `PushConfig` for a spec
ified subscription.\n\nThis may be used to change a push subscription to a pull
one (signified by\nan empty `PushConfig`) or vice versa, or change the endpoint
URL and other\nattributes of a push subscription. Messages will accumulate for d
elivery\ncontinuously through the call regardless of changes to the `PushConfig`
.", | |
154 "httpMethod": "POST", | |
155 "id": "pubsub.projects.subscriptions.modifyPushConfi
g", | |
156 "parameterOrder": [ | |
157 "subscription" | |
158 ], | |
159 "parameters": { | |
160 "subscription": { | |
161 "description": "The name of the subscription
.", | |
162 "location": "path", | |
163 "pattern": "^projects/[^/]+/subscriptions/[^
/]+$", | |
164 "required": true, | |
165 "type": "string" | |
166 } | |
167 }, | |
168 "path": "v1beta2/{+subscription}:modifyPushConfig", | |
169 "request": { | |
170 "$ref": "ModifyPushConfigRequest" | |
171 }, | |
172 "response": { | |
173 "$ref": "Empty" | |
174 }, | |
175 "scopes": [ | |
176 "https://www.googleapis.com/auth/cloud-platform"
, | |
177 "https://www.googleapis.com/auth/pubsub" | |
178 ] | |
179 }, | |
180 "pull": { | |
181 "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.", | |
182 "httpMethod": "POST", | |
183 "id": "pubsub.projects.subscriptions.pull", | |
184 "parameterOrder": [ | |
185 "subscription" | |
186 ], | |
187 "parameters": { | |
188 "subscription": { | |
189 "description": "The subscription from which
messages should be pulled.", | |
190 "location": "path", | |
191 "pattern": "^projects/[^/]+/subscriptions/[^
/]+$", | |
192 "required": true, | |
193 "type": "string" | |
194 } | |
195 }, | |
196 "path": "v1beta2/{+subscription}:pull", | |
197 "request": { | |
198 "$ref": "PullRequest" | |
199 }, | |
200 "response": { | |
201 "$ref": "PullResponse" | |
202 }, | |
203 "scopes": [ | |
204 "https://www.googleapis.com/auth/cloud-platform"
, | |
205 "https://www.googleapis.com/auth/pubsub" | 202 "https://www.googleapis.com/auth/pubsub" |
206 ] | 203 ] |
207 }, | 204 }, |
208 "delete": { | 205 "delete": { |
209 "description": "Deletes an existing subscription. Al
l pending messages in the subscription\nare immediately dropped. Calls to `Pull`
after deletion will return\n`NOT_FOUND`. After a subscription is deleted, a new
one may be created with\nthe same name, but the new one has no association with
the old\nsubscription, or its topic unless the same topic is specified.", | 206 "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_`.", |
210 "httpMethod": "DELETE", | 207 "httpMethod": "DELETE", |
211 "id": "pubsub.projects.subscriptions.delete", | 208 "id": "pubsub.projects.topics.delete", |
212 "parameterOrder": [ | 209 "parameterOrder": [ |
213 "subscription" | 210 "topic" |
214 ], | 211 ], |
215 "parameters": { | 212 "parameters": { |
216 "subscription": { | 213 "topic": { |
217 "description": "The subscription to delete."
, | 214 "description": "Name of the topic to delete.
", |
218 "location": "path", | 215 "location": "path", |
219 "pattern": "^projects/[^/]+/subscriptions/[^
/]+$", | 216 "pattern": "^projects/[^/]+/topics/[^/]+$", |
220 "required": true, | 217 "required": true, |
221 "type": "string" | 218 "type": "string" |
222 } | 219 } |
223 }, | 220 }, |
224 "path": "v1beta2/{+subscription}", | 221 "path": "v1beta2/{+topic}", |
225 "response": { | 222 "response": { |
226 "$ref": "Empty" | 223 "$ref": "Empty" |
227 }, | 224 }, |
228 "scopes": [ | 225 "scopes": [ |
229 "https://www.googleapis.com/auth/cloud-platform"
, | 226 "https://www.googleapis.com/auth/cloud-platform"
, |
230 "https://www.googleapis.com/auth/pubsub" | 227 "https://www.googleapis.com/auth/pubsub" |
231 ] | 228 ] |
232 }, | 229 }, |
233 "list": { | 230 "list": { |
234 "description": "Lists matching subscriptions.", | 231 "description": "Lists matching topics.", |
235 "httpMethod": "GET", | 232 "httpMethod": "GET", |
236 "id": "pubsub.projects.subscriptions.list", | 233 "id": "pubsub.projects.topics.list", |
237 "parameterOrder": [ | 234 "parameterOrder": [ |
238 "project" | 235 "project" |
239 ], | 236 ], |
240 "parameters": { | 237 "parameters": { |
241 "pageSize": { | |
242 "description": "Maximum number of subscripti
ons to return.", | |
243 "format": "int32", | |
244 "location": "query", | |
245 "type": "integer" | |
246 }, | |
247 "project": { | 238 "project": { |
248 "description": "The name of the cloud projec
t that subscriptions belong to.", | 239 "description": "The name of the cloud projec
t that topics belong to.", |
249 "location": "path", | 240 "location": "path", |
250 "pattern": "^projects/[^/]+$", | 241 "pattern": "^projects/[^/]+$", |
251 "required": true, | 242 "required": true, |
252 "type": "string" | 243 "type": "string" |
253 }, | 244 }, |
254 "pageToken": { | 245 "pageToken": { |
255 "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.", | 246 "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.", |
256 "location": "query", | 247 "location": "query", |
257 "type": "string" | 248 "type": "string" |
| 249 }, |
| 250 "pageSize": { |
| 251 "description": "Maximum number of topics to
return.", |
| 252 "format": "int32", |
| 253 "location": "query", |
| 254 "type": "integer" |
258 } | 255 } |
259 }, | 256 }, |
260 "path": "v1beta2/{+project}/subscriptions", | 257 "path": "v1beta2/{+project}/topics", |
261 "response": { | 258 "response": { |
262 "$ref": "ListSubscriptionsResponse" | 259 "$ref": "ListTopicsResponse" |
263 }, | 260 }, |
264 "scopes": [ | 261 "scopes": [ |
265 "https://www.googleapis.com/auth/cloud-platform"
, | 262 "https://www.googleapis.com/auth/cloud-platform"
, |
266 "https://www.googleapis.com/auth/pubsub" | 263 "https://www.googleapis.com/auth/pubsub" |
267 ] | 264 ] |
268 }, | 265 }, |
269 "create": { | 266 "create": { |
270 "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. Note that\nfor REST API requests, you must spec
ify a name.", | 267 "description": "Creates the given topic with the giv
en name.", |
271 "httpMethod": "PUT", | 268 "httpMethod": "PUT", |
272 "id": "pubsub.projects.subscriptions.create", | 269 "id": "pubsub.projects.topics.create", |
273 "parameterOrder": [ | 270 "parameterOrder": [ |
274 "name" | 271 "name" |
275 ], | 272 ], |
276 "parameters": { | 273 "parameters": { |
277 "name": { | 274 "name": { |
278 "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\"`.", | 275 "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\"`.", |
279 "location": "path", | 276 "location": "path", |
280 "pattern": "^projects/[^/]+/subscriptions/[^
/]+$", | 277 "pattern": "^projects/[^/]+/topics/[^/]+$", |
281 "required": true, | 278 "required": true, |
282 "type": "string" | 279 "type": "string" |
283 } | 280 } |
284 }, | 281 }, |
285 "path": "v1beta2/{+name}", | 282 "path": "v1beta2/{+name}", |
286 "request": { | 283 "request": { |
287 "$ref": "Subscription" | 284 "$ref": "Topic" |
288 }, | 285 }, |
289 "response": { | 286 "response": { |
290 "$ref": "Subscription" | 287 "$ref": "Topic" |
291 }, | 288 }, |
292 "scopes": [ | 289 "scopes": [ |
293 "https://www.googleapis.com/auth/cloud-platform"
, | 290 "https://www.googleapis.com/auth/cloud-platform"
, |
294 "https://www.googleapis.com/auth/pubsub" | 291 "https://www.googleapis.com/auth/pubsub" |
295 ] | 292 ] |
296 }, | 293 }, |
297 "setIamPolicy": { | 294 "setIamPolicy": { |
298 "description": "Sets the access control policy on th
e specified resource. Replaces any\nexisting policy.", | 295 "description": "Sets the access control policy on th
e specified resource. Replaces any\nexisting policy.", |
299 "httpMethod": "POST", | 296 "httpMethod": "POST", |
300 "id": "pubsub.projects.subscriptions.setIamPolicy", | 297 "id": "pubsub.projects.topics.setIamPolicy", |
301 "parameterOrder": [ | 298 "parameterOrder": [ |
302 "resource" | 299 "resource" |
303 ], | 300 ], |
304 "parameters": { | 301 "parameters": { |
305 "resource": { | 302 "resource": { |
306 "description": "REQUIRED: The resource for w
hich the policy is being specified.\nSee the operation documentation for the app
ropriate value for this field.", | 303 "description": "REQUIRED: The resource for w
hich the policy is being specified.\nSee the operation documentation for the app
ropriate value for this field.", |
307 "location": "path", | 304 "location": "path", |
308 "pattern": "^projects/[^/]+/subscriptions/[^
/]+$", | 305 "pattern": "^projects/[^/]+/topics/[^/]+$", |
309 "required": true, | 306 "required": true, |
310 "type": "string" | 307 "type": "string" |
311 } | 308 } |
312 }, | 309 }, |
313 "path": "v1beta2/{+resource}:setIamPolicy", | 310 "path": "v1beta2/{+resource}:setIamPolicy", |
314 "request": { | 311 "request": { |
315 "$ref": "SetIamPolicyRequest" | 312 "$ref": "SetIamPolicyRequest" |
316 }, | 313 }, |
317 "response": { | 314 "response": { |
318 "$ref": "Policy" | 315 "$ref": "Policy" |
319 }, | 316 }, |
320 "scopes": [ | 317 "scopes": [ |
321 "https://www.googleapis.com/auth/cloud-platform"
, | 318 "https://www.googleapis.com/auth/cloud-platform"
, |
322 "https://www.googleapis.com/auth/pubsub" | 319 "https://www.googleapis.com/auth/pubsub" |
323 ] | 320 ] |
324 }, | 321 }, |
325 "getIamPolicy": { | 322 "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.", | 323 "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", | 324 "httpMethod": "GET", |
328 "id": "pubsub.projects.subscriptions.getIamPolicy", | 325 "id": "pubsub.projects.topics.getIamPolicy", |
329 "parameterOrder": [ | 326 "parameterOrder": [ |
330 "resource" | 327 "resource" |
331 ], | 328 ], |
332 "parameters": { | 329 "parameters": { |
333 "resource": { | 330 "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.", | 331 "description": "REQUIRED: The resource for w
hich the policy is being requested.\nSee the operation documentation for the app
ropriate value for this field.", |
335 "location": "path", | 332 "location": "path", |
336 "pattern": "^projects/[^/]+/subscriptions/[^
/]+$", | 333 "pattern": "^projects/[^/]+/topics/[^/]+$", |
337 "required": true, | 334 "required": true, |
338 "type": "string" | 335 "type": "string" |
339 } | 336 } |
340 }, | 337 }, |
341 "path": "v1beta2/{+resource}:getIamPolicy", | 338 "path": "v1beta2/{+resource}:getIamPolicy", |
342 "response": { | 339 "response": { |
343 "$ref": "Policy" | 340 "$ref": "Policy" |
344 }, | 341 }, |
345 "scopes": [ | 342 "scopes": [ |
346 "https://www.googleapis.com/auth/cloud-platform"
, | 343 "https://www.googleapis.com/auth/cloud-platform"
, |
347 "https://www.googleapis.com/auth/pubsub" | 344 "https://www.googleapis.com/auth/pubsub" |
348 ] | 345 ] |
349 }, | 346 } |
350 "acknowledge": { | 347 }, |
351 "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.", | 348 "resources": { |
352 "httpMethod": "POST", | 349 "subscriptions": { |
353 "id": "pubsub.projects.subscriptions.acknowledge", | 350 "methods": { |
354 "parameterOrder": [ | 351 "list": { |
355 "subscription" | 352 "description": "Lists the name of the subscr
iptions for this topic.", |
356 ], | 353 "httpMethod": "GET", |
357 "parameters": { | 354 "id": "pubsub.projects.topics.subscriptions.
list", |
358 "subscription": { | 355 "parameterOrder": [ |
359 "description": "The subscription whose messa
ge is being acknowledged.", | 356 "topic" |
360 "location": "path", | 357 ], |
361 "pattern": "^projects/[^/]+/subscriptions/[^
/]+$", | 358 "parameters": { |
362 "required": true, | 359 "pageToken": { |
363 "type": "string" | 360 "description": "The value returned b
y the last `ListTopicSubscriptionsResponse`; indicates\nthat this is a continuat
ion of a prior `ListTopicSubscriptions` call, and\nthat the system should return
the next page of data.", |
364 } | 361 "location": "query", |
365 }, | 362 "type": "string" |
366 "path": "v1beta2/{+subscription}:acknowledge", | 363 }, |
367 "request": { | 364 "pageSize": { |
368 "$ref": "AcknowledgeRequest" | 365 "description": "Maximum number of su
bscription names to return.", |
369 }, | 366 "format": "int32", |
370 "response": { | 367 "location": "query", |
371 "$ref": "Empty" | 368 "type": "integer" |
372 }, | 369 }, |
373 "scopes": [ | 370 "topic": { |
374 "https://www.googleapis.com/auth/cloud-platform"
, | 371 "description": "The name of the topi
c that subscriptions are attached to.", |
375 "https://www.googleapis.com/auth/pubsub" | 372 "location": "path", |
376 ] | 373 "pattern": "^projects/[^/]+/topics/[
^/]+$", |
377 }, | 374 "required": true, |
378 "modifyAckDeadline": { | 375 "type": "string" |
379 "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.", | 376 } |
380 "httpMethod": "POST", | 377 }, |
381 "id": "pubsub.projects.subscriptions.modifyAckDeadli
ne", | 378 "path": "v1beta2/{+topic}/subscriptions", |
382 "parameterOrder": [ | 379 "response": { |
383 "subscription" | 380 "$ref": "ListTopicSubscriptionsResponse" |
384 ], | 381 }, |
385 "parameters": { | 382 "scopes": [ |
386 "subscription": { | 383 "https://www.googleapis.com/auth/cloud-p
latform", |
387 "description": "The name of the subscription
.", | 384 "https://www.googleapis.com/auth/pubsub" |
388 "location": "path", | 385 ] |
389 "pattern": "^projects/[^/]+/subscriptions/[^
/]+$", | 386 } |
390 "required": true, | 387 } |
391 "type": "string" | 388 } |
392 } | 389 } |
393 }, | 390 }, |
394 "path": "v1beta2/{+subscription}:modifyAckDeadline", | 391 "subscriptions": { |
395 "request": { | 392 "methods": { |
396 "$ref": "ModifyAckDeadlineRequest" | |
397 }, | |
398 "response": { | |
399 "$ref": "Empty" | |
400 }, | |
401 "scopes": [ | |
402 "https://www.googleapis.com/auth/cloud-platform"
, | |
403 "https://www.googleapis.com/auth/pubsub" | |
404 ] | |
405 }, | |
406 "get": { | 393 "get": { |
407 "description": "Gets the configuration details of a
subscription.", | 394 "description": "Gets the configuration details of a
subscription.", |
408 "httpMethod": "GET", | 395 "httpMethod": "GET", |
409 "id": "pubsub.projects.subscriptions.get", | 396 "id": "pubsub.projects.subscriptions.get", |
410 "parameterOrder": [ | 397 "parameterOrder": [ |
411 "subscription" | 398 "subscription" |
412 ], | 399 ], |
413 "parameters": { | 400 "parameters": { |
414 "subscription": { | 401 "subscription": { |
415 "description": "The name of the subscription
to get.", | 402 "description": "The name of the subscription
to get.", |
416 "location": "path", | 403 "location": "path", |
417 "pattern": "^projects/[^/]+/subscriptions/[^
/]+$", | 404 "pattern": "^projects/[^/]+/subscriptions/[^
/]+$", |
418 "required": true, | 405 "required": true, |
419 "type": "string" | 406 "type": "string" |
420 } | 407 } |
421 }, | 408 }, |
422 "path": "v1beta2/{+subscription}", | 409 "path": "v1beta2/{+subscription}", |
423 "response": { | 410 "response": { |
424 "$ref": "Subscription" | 411 "$ref": "Subscription" |
425 }, | 412 }, |
426 "scopes": [ | 413 "scopes": [ |
427 "https://www.googleapis.com/auth/cloud-platform"
, | 414 "https://www.googleapis.com/auth/cloud-platform"
, |
428 "https://www.googleapis.com/auth/pubsub" | 415 "https://www.googleapis.com/auth/pubsub" |
429 ] | 416 ] |
430 } | 417 }, |
431 } | 418 "testIamPermissions": { |
432 }, | 419 "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.
", |
433 "topics": { | 420 "httpMethod": "POST", |
434 "methods": { | 421 "id": "pubsub.projects.subscriptions.testIamPermissi
ons", |
| 422 "parameterOrder": [ |
| 423 "resource" |
| 424 ], |
| 425 "parameters": { |
| 426 "resource": { |
| 427 "description": "REQUIRED: The resource for w
hich the policy detail is being requested.\nSee the operation documentation for
the appropriate value for this field.", |
| 428 "location": "path", |
| 429 "pattern": "^projects/[^/]+/subscriptions/[^
/]+$", |
| 430 "required": true, |
| 431 "type": "string" |
| 432 } |
| 433 }, |
| 434 "path": "v1beta2/{+resource}:testIamPermissions", |
| 435 "request": { |
| 436 "$ref": "TestIamPermissionsRequest" |
| 437 }, |
| 438 "response": { |
| 439 "$ref": "TestIamPermissionsResponse" |
| 440 }, |
| 441 "scopes": [ |
| 442 "https://www.googleapis.com/auth/cloud-platform"
, |
| 443 "https://www.googleapis.com/auth/pubsub" |
| 444 ] |
| 445 }, |
| 446 "modifyPushConfig": { |
| 447 "description": "Modifies the `PushConfig` for a spec
ified subscription.\n\nThis may be used to change a push subscription to a pull
one (signified by\nan empty `PushConfig`) or vice versa, or change the endpoint
URL and other\nattributes of a push subscription. Messages will accumulate for d
elivery\ncontinuously through the call regardless of changes to the `PushConfig`
.", |
| 448 "httpMethod": "POST", |
| 449 "id": "pubsub.projects.subscriptions.modifyPushConfi
g", |
| 450 "parameterOrder": [ |
| 451 "subscription" |
| 452 ], |
| 453 "parameters": { |
| 454 "subscription": { |
| 455 "description": "The name of the subscription
.", |
| 456 "location": "path", |
| 457 "pattern": "^projects/[^/]+/subscriptions/[^
/]+$", |
| 458 "required": true, |
| 459 "type": "string" |
| 460 } |
| 461 }, |
| 462 "path": "v1beta2/{+subscription}:modifyPushConfig", |
| 463 "request": { |
| 464 "$ref": "ModifyPushConfigRequest" |
| 465 }, |
| 466 "response": { |
| 467 "$ref": "Empty" |
| 468 }, |
| 469 "scopes": [ |
| 470 "https://www.googleapis.com/auth/cloud-platform"
, |
| 471 "https://www.googleapis.com/auth/pubsub" |
| 472 ] |
| 473 }, |
| 474 "delete": { |
| 475 "description": "Deletes an existing subscription. Al
l pending messages in the subscription\nare immediately dropped. Calls to `Pull`
after deletion will return\n`NOT_FOUND`. After a subscription is deleted, a new
one may be created with\nthe same name, but the new one has no association with
the old\nsubscription, or its topic unless the same topic is specified.", |
| 476 "httpMethod": "DELETE", |
| 477 "id": "pubsub.projects.subscriptions.delete", |
| 478 "parameterOrder": [ |
| 479 "subscription" |
| 480 ], |
| 481 "parameters": { |
| 482 "subscription": { |
| 483 "description": "The subscription to delete."
, |
| 484 "location": "path", |
| 485 "pattern": "^projects/[^/]+/subscriptions/[^
/]+$", |
| 486 "required": true, |
| 487 "type": "string" |
| 488 } |
| 489 }, |
| 490 "path": "v1beta2/{+subscription}", |
| 491 "response": { |
| 492 "$ref": "Empty" |
| 493 }, |
| 494 "scopes": [ |
| 495 "https://www.googleapis.com/auth/cloud-platform"
, |
| 496 "https://www.googleapis.com/auth/pubsub" |
| 497 ] |
| 498 }, |
| 499 "pull": { |
| 500 "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.", |
| 501 "httpMethod": "POST", |
| 502 "id": "pubsub.projects.subscriptions.pull", |
| 503 "parameterOrder": [ |
| 504 "subscription" |
| 505 ], |
| 506 "parameters": { |
| 507 "subscription": { |
| 508 "description": "The subscription from which
messages should be pulled.", |
| 509 "location": "path", |
| 510 "pattern": "^projects/[^/]+/subscriptions/[^
/]+$", |
| 511 "required": true, |
| 512 "type": "string" |
| 513 } |
| 514 }, |
| 515 "path": "v1beta2/{+subscription}:pull", |
| 516 "request": { |
| 517 "$ref": "PullRequest" |
| 518 }, |
| 519 "response": { |
| 520 "$ref": "PullResponse" |
| 521 }, |
| 522 "scopes": [ |
| 523 "https://www.googleapis.com/auth/cloud-platform"
, |
| 524 "https://www.googleapis.com/auth/pubsub" |
| 525 ] |
| 526 }, |
435 "list": { | 527 "list": { |
436 "description": "Lists matching topics.", | 528 "description": "Lists matching subscriptions.", |
437 "httpMethod": "GET", | 529 "httpMethod": "GET", |
438 "id": "pubsub.projects.topics.list", | 530 "id": "pubsub.projects.subscriptions.list", |
439 "parameterOrder": [ | 531 "parameterOrder": [ |
440 "project" | 532 "project" |
441 ], | 533 ], |
442 "parameters": { | 534 "parameters": { |
| 535 "pageToken": { |
| 536 "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.", |
| 537 "location": "query", |
| 538 "type": "string" |
| 539 }, |
443 "pageSize": { | 540 "pageSize": { |
444 "description": "Maximum number of topics to
return.", | 541 "description": "Maximum number of subscripti
ons to return.", |
445 "format": "int32", | 542 "format": "int32", |
446 "location": "query", | 543 "location": "query", |
447 "type": "integer" | 544 "type": "integer" |
448 }, | 545 }, |
449 "project": { | 546 "project": { |
450 "description": "The name of the cloud projec
t that topics belong to.", | 547 "description": "The name of the cloud projec
t that subscriptions belong to.", |
451 "location": "path", | 548 "location": "path", |
452 "pattern": "^projects/[^/]+$", | 549 "pattern": "^projects/[^/]+$", |
453 "required": true, | 550 "required": true, |
454 "type": "string" | 551 "type": "string" |
455 }, | 552 } |
456 "pageToken": { | 553 }, |
457 "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.", | 554 "path": "v1beta2/{+project}/subscriptions", |
458 "location": "query", | 555 "response": { |
459 "type": "string" | 556 "$ref": "ListSubscriptionsResponse" |
460 } | |
461 }, | |
462 "path": "v1beta2/{+project}/topics", | |
463 "response": { | |
464 "$ref": "ListTopicsResponse" | |
465 }, | |
466 "scopes": [ | |
467 "https://www.googleapis.com/auth/cloud-platform"
, | |
468 "https://www.googleapis.com/auth/pubsub" | |
469 ] | |
470 }, | |
471 "create": { | |
472 "description": "Creates the given topic with the giv
en name.", | |
473 "httpMethod": "PUT", | |
474 "id": "pubsub.projects.topics.create", | |
475 "parameterOrder": [ | |
476 "name" | |
477 ], | |
478 "parameters": { | |
479 "name": { | |
480 "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\"`.", | |
481 "location": "path", | |
482 "pattern": "^projects/[^/]+/topics/[^/]+$", | |
483 "required": true, | |
484 "type": "string" | |
485 } | |
486 }, | |
487 "path": "v1beta2/{+name}", | |
488 "request": { | |
489 "$ref": "Topic" | |
490 }, | |
491 "response": { | |
492 "$ref": "Topic" | |
493 }, | 557 }, |
494 "scopes": [ | 558 "scopes": [ |
495 "https://www.googleapis.com/auth/cloud-platform"
, | 559 "https://www.googleapis.com/auth/cloud-platform"
, |
496 "https://www.googleapis.com/auth/pubsub" | 560 "https://www.googleapis.com/auth/pubsub" |
497 ] | 561 ] |
498 }, | 562 }, |
499 "setIamPolicy": { | 563 "setIamPolicy": { |
500 "description": "Sets the access control policy on th
e specified resource. Replaces any\nexisting policy.", | 564 "description": "Sets the access control policy on th
e specified resource. Replaces any\nexisting policy.", |
501 "httpMethod": "POST", | 565 "httpMethod": "POST", |
502 "id": "pubsub.projects.topics.setIamPolicy", | 566 "id": "pubsub.projects.subscriptions.setIamPolicy", |
503 "parameterOrder": [ | 567 "parameterOrder": [ |
504 "resource" | 568 "resource" |
505 ], | 569 ], |
506 "parameters": { | 570 "parameters": { |
507 "resource": { | 571 "resource": { |
508 "description": "REQUIRED: The resource for w
hich the policy is being specified.\nSee the operation documentation for the app
ropriate value for this field.", | 572 "description": "REQUIRED: The resource for w
hich the policy is being specified.\nSee the operation documentation for the app
ropriate value for this field.", |
509 "location": "path", | 573 "location": "path", |
510 "pattern": "^projects/[^/]+/topics/[^/]+$", | 574 "pattern": "^projects/[^/]+/subscriptions/[^
/]+$", |
511 "required": true, | 575 "required": true, |
512 "type": "string" | 576 "type": "string" |
513 } | 577 } |
514 }, | 578 }, |
515 "path": "v1beta2/{+resource}:setIamPolicy", | 579 "path": "v1beta2/{+resource}:setIamPolicy", |
516 "request": { | 580 "request": { |
517 "$ref": "SetIamPolicyRequest" | 581 "$ref": "SetIamPolicyRequest" |
518 }, | 582 }, |
519 "response": { | 583 "response": { |
520 "$ref": "Policy" | 584 "$ref": "Policy" |
521 }, | 585 }, |
522 "scopes": [ | |
523 "https://www.googleapis.com/auth/cloud-platform"
, | |
524 "https://www.googleapis.com/auth/pubsub" | |
525 ] | |
526 }, | |
527 "getIamPolicy": { | |
528 "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.", | |
529 "httpMethod": "GET", | |
530 "id": "pubsub.projects.topics.getIamPolicy", | |
531 "parameterOrder": [ | |
532 "resource" | |
533 ], | |
534 "parameters": { | |
535 "resource": { | |
536 "description": "REQUIRED: The resource for w
hich the policy is being requested.\nSee the operation documentation for the app
ropriate value for this field.", | |
537 "location": "path", | |
538 "pattern": "^projects/[^/]+/topics/[^/]+$", | |
539 "required": true, | |
540 "type": "string" | |
541 } | |
542 }, | |
543 "path": "v1beta2/{+resource}:getIamPolicy", | |
544 "response": { | |
545 "$ref": "Policy" | |
546 }, | |
547 "scopes": [ | 586 "scopes": [ |
548 "https://www.googleapis.com/auth/cloud-platform"
, | 587 "https://www.googleapis.com/auth/cloud-platform"
, |
549 "https://www.googleapis.com/auth/pubsub" | 588 "https://www.googleapis.com/auth/pubsub" |
550 ] | 589 ] |
551 }, | 590 }, |
552 "get": { | 591 "create": { |
553 "description": "Gets the configuration of a topic.", | 592 "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. Note that\nfor REST API requests, you must spec
ify a name.", |
554 "httpMethod": "GET", | 593 "httpMethod": "PUT", |
555 "id": "pubsub.projects.topics.get", | 594 "id": "pubsub.projects.subscriptions.create", |
556 "parameterOrder": [ | 595 "parameterOrder": [ |
557 "topic" | 596 "name" |
558 ], | 597 ], |
559 "parameters": { | 598 "parameters": { |
560 "topic": { | 599 "name": { |
561 "description": "The name of the topic to get
.", | 600 "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\"`.", |
562 "location": "path", | 601 "location": "path", |
563 "pattern": "^projects/[^/]+/topics/[^/]+$", | 602 "pattern": "^projects/[^/]+/subscriptions/[^
/]+$", |
564 "required": true, | 603 "required": true, |
565 "type": "string" | 604 "type": "string" |
566 } | 605 } |
567 }, | 606 }, |
568 "path": "v1beta2/{+topic}", | 607 "path": "v1beta2/{+name}", |
| 608 "request": { |
| 609 "$ref": "Subscription" |
| 610 }, |
569 "response": { | 611 "response": { |
570 "$ref": "Topic" | 612 "$ref": "Subscription" |
571 }, | 613 }, |
572 "scopes": [ | 614 "scopes": [ |
573 "https://www.googleapis.com/auth/cloud-platform"
, | 615 "https://www.googleapis.com/auth/cloud-platform"
, |
574 "https://www.googleapis.com/auth/pubsub" | 616 "https://www.googleapis.com/auth/pubsub" |
575 ] | 617 ] |
576 }, | 618 }, |
577 "publish": { | 619 "getIamPolicy": { |
578 "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.", | 620 "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.", |
579 "httpMethod": "POST", | 621 "httpMethod": "GET", |
580 "id": "pubsub.projects.topics.publish", | 622 "id": "pubsub.projects.subscriptions.getIamPolicy", |
581 "parameterOrder": [ | 623 "parameterOrder": [ |
582 "topic" | 624 "resource" |
583 ], | 625 ], |
584 "parameters": { | 626 "parameters": { |
585 "topic": { | 627 "resource": { |
586 "description": "The messages in the request
will be published on this topic.", | 628 "description": "REQUIRED: The resource for w
hich the policy is being requested.\nSee the operation documentation for the app
ropriate value for this field.", |
587 "location": "path", | 629 "location": "path", |
588 "pattern": "^projects/[^/]+/topics/[^/]+$", | 630 "pattern": "^projects/[^/]+/subscriptions/[^
/]+$", |
589 "required": true, | 631 "required": true, |
590 "type": "string" | 632 "type": "string" |
591 } | 633 } |
592 }, | 634 }, |
593 "path": "v1beta2/{+topic}:publish", | 635 "path": "v1beta2/{+resource}:getIamPolicy", |
594 "request": { | |
595 "$ref": "PublishRequest" | |
596 }, | |
597 "response": { | 636 "response": { |
598 "$ref": "PublishResponse" | 637 "$ref": "Policy" |
599 }, | 638 }, |
600 "scopes": [ | 639 "scopes": [ |
601 "https://www.googleapis.com/auth/cloud-platform"
, | 640 "https://www.googleapis.com/auth/cloud-platform"
, |
602 "https://www.googleapis.com/auth/pubsub" | 641 "https://www.googleapis.com/auth/pubsub" |
603 ] | 642 ] |
604 }, | 643 }, |
605 "testIamPermissions": { | 644 "modifyAckDeadline": { |
606 "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.
", | 645 "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.", |
607 "httpMethod": "POST", | 646 "httpMethod": "POST", |
608 "id": "pubsub.projects.topics.testIamPermissions", | 647 "id": "pubsub.projects.subscriptions.modifyAckDeadli
ne", |
609 "parameterOrder": [ | 648 "parameterOrder": [ |
610 "resource" | 649 "subscription" |
611 ], | 650 ], |
612 "parameters": { | 651 "parameters": { |
613 "resource": { | 652 "subscription": { |
614 "description": "REQUIRED: The resource for w
hich the policy detail is being requested.\nSee the operation documentation for
the appropriate value for this field.", | 653 "description": "The name of the subscription
.", |
615 "location": "path", | 654 "location": "path", |
616 "pattern": "^projects/[^/]+/topics/[^/]+$", | 655 "pattern": "^projects/[^/]+/subscriptions/[^
/]+$", |
617 "required": true, | 656 "required": true, |
618 "type": "string" | 657 "type": "string" |
619 } | 658 } |
620 }, | 659 }, |
621 "path": "v1beta2/{+resource}:testIamPermissions", | 660 "path": "v1beta2/{+subscription}:modifyAckDeadline", |
622 "request": { | 661 "request": { |
623 "$ref": "TestIamPermissionsRequest" | 662 "$ref": "ModifyAckDeadlineRequest" |
624 }, | 663 }, |
625 "response": { | 664 "response": { |
626 "$ref": "TestIamPermissionsResponse" | 665 "$ref": "Empty" |
627 }, | 666 }, |
628 "scopes": [ | 667 "scopes": [ |
629 "https://www.googleapis.com/auth/cloud-platform"
, | 668 "https://www.googleapis.com/auth/cloud-platform"
, |
630 "https://www.googleapis.com/auth/pubsub" | 669 "https://www.googleapis.com/auth/pubsub" |
631 ] | 670 ] |
632 }, | 671 }, |
633 "delete": { | 672 "acknowledge": { |
634 "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_`.", | 673 "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.", |
635 "httpMethod": "DELETE", | 674 "httpMethod": "POST", |
636 "id": "pubsub.projects.topics.delete", | 675 "id": "pubsub.projects.subscriptions.acknowledge", |
637 "parameterOrder": [ | 676 "parameterOrder": [ |
638 "topic" | 677 "subscription" |
639 ], | 678 ], |
640 "parameters": { | 679 "parameters": { |
641 "topic": { | 680 "subscription": { |
642 "description": "Name of the topic to delete.
", | 681 "description": "The subscription whose messa
ge is being acknowledged.", |
643 "location": "path", | 682 "location": "path", |
644 "pattern": "^projects/[^/]+/topics/[^/]+$", | 683 "pattern": "^projects/[^/]+/subscriptions/[^
/]+$", |
645 "required": true, | 684 "required": true, |
646 "type": "string" | 685 "type": "string" |
647 } | 686 } |
648 }, | 687 }, |
649 "path": "v1beta2/{+topic}", | 688 "path": "v1beta2/{+subscription}:acknowledge", |
| 689 "request": { |
| 690 "$ref": "AcknowledgeRequest" |
| 691 }, |
650 "response": { | 692 "response": { |
651 "$ref": "Empty" | 693 "$ref": "Empty" |
652 }, | 694 }, |
653 "scopes": [ | 695 "scopes": [ |
654 "https://www.googleapis.com/auth/cloud-platform"
, | 696 "https://www.googleapis.com/auth/cloud-platform"
, |
655 "https://www.googleapis.com/auth/pubsub" | 697 "https://www.googleapis.com/auth/pubsub" |
656 ] | 698 ] |
657 } | 699 } |
658 }, | |
659 "resources": { | |
660 "subscriptions": { | |
661 "methods": { | |
662 "list": { | |
663 "description": "Lists the name of the subscr
iptions for this topic.", | |
664 "httpMethod": "GET", | |
665 "id": "pubsub.projects.topics.subscriptions.
list", | |
666 "parameterOrder": [ | |
667 "topic" | |
668 ], | |
669 "parameters": { | |
670 "pageToken": { | |
671 "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.", | |
672 "location": "query", | |
673 "type": "string" | |
674 }, | |
675 "pageSize": { | |
676 "description": "Maximum number of su
bscription names to return.", | |
677 "format": "int32", | |
678 "location": "query", | |
679 "type": "integer" | |
680 }, | |
681 "topic": { | |
682 "description": "The name of the topi
c that subscriptions are attached to.", | |
683 "location": "path", | |
684 "pattern": "^projects/[^/]+/topics/[
^/]+$", | |
685 "required": true, | |
686 "type": "string" | |
687 } | |
688 }, | |
689 "path": "v1beta2/{+topic}/subscriptions", | |
690 "response": { | |
691 "$ref": "ListTopicSubscriptionsResponse" | |
692 }, | |
693 "scopes": [ | |
694 "https://www.googleapis.com/auth/cloud-p
latform", | |
695 "https://www.googleapis.com/auth/pubsub" | |
696 ] | |
697 } | |
698 } | |
699 } | |
700 } | 700 } |
701 } | 701 } |
702 } | 702 } |
703 } | 703 } |
704 }, | 704 }, |
705 "revision": "20170630", | 705 "revision": "20170731", |
706 "rootUrl": "https://pubsub.googleapis.com/", | 706 "rootUrl": "https://pubsub.googleapis.com/", |
707 "schemas": { | 707 "schemas": { |
| 708 "ModifyAckDeadlineRequest": { |
| 709 "description": "Request for the ModifyAckDeadline method.", |
| 710 "id": "ModifyAckDeadlineRequest", |
| 711 "properties": { |
| 712 "ackId": { |
| 713 "description": "The acknowledgment ID. Either this or ack_id
s must be populated, but not\nboth.", |
| 714 "type": "string" |
| 715 }, |
| 716 "ackDeadlineSeconds": { |
| 717 "description": "The new ack deadline with respect to the tim
e this request was sent to\nthe Pub/Sub system. Must be >= 0. For example, if th
e value is 10, the new\nack deadline will expire 10 seconds after the `ModifyAck
Deadline` call\nwas made. Specifying zero may immediately make the message avail
able for\nanother pull request.", |
| 718 "format": "int32", |
| 719 "type": "integer" |
| 720 }, |
| 721 "ackIds": { |
| 722 "description": "List of acknowledgment IDs.", |
| 723 "items": { |
| 724 "type": "string" |
| 725 }, |
| 726 "type": "array" |
| 727 } |
| 728 }, |
| 729 "type": "object" |
| 730 }, |
| 731 "SetIamPolicyRequest": { |
| 732 "description": "Request message for `SetIamPolicy` method.", |
| 733 "id": "SetIamPolicyRequest", |
| 734 "properties": { |
| 735 "policy": { |
| 736 "$ref": "Policy", |
| 737 "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." |
| 738 } |
| 739 }, |
| 740 "type": "object" |
| 741 }, |
| 742 "PubsubMessage": { |
| 743 "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.", |
| 744 "id": "PubsubMessage", |
| 745 "properties": { |
| 746 "messageId": { |
| 747 "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.", |
| 748 "type": "string" |
| 749 }, |
| 750 "attributes": { |
| 751 "additionalProperties": { |
| 752 "type": "string" |
| 753 }, |
| 754 "description": "Optional attributes for this message.", |
| 755 "type": "object" |
| 756 }, |
| 757 "publishTime": { |
| 758 "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.", |
| 759 "format": "google-datetime", |
| 760 "type": "string" |
| 761 }, |
| 762 "data": { |
| 763 "description": "The message payload. For JSON requests, the
value of this field must be\n[base64-encoded](https://tools.ietf.org/html/rfc464
8).", |
| 764 "format": "byte", |
| 765 "type": "string" |
| 766 } |
| 767 }, |
| 768 "type": "object" |
| 769 }, |
| 770 "ModifyPushConfigRequest": { |
| 771 "description": "Request for the ModifyPushConfig method.", |
| 772 "id": "ModifyPushConfigRequest", |
| 773 "properties": { |
| 774 "pushConfig": { |
| 775 "$ref": "PushConfig", |
| 776 "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." |
| 777 } |
| 778 }, |
| 779 "type": "object" |
| 780 }, |
| 781 "Binding": { |
| 782 "description": "Associates `members` with a `role`.", |
| 783 "id": "Binding", |
| 784 "properties": { |
| 785 "members": { |
| 786 "description": "Specifies the identities requesting access f
or a Cloud Platform resource.\n`members` can have the following values:\n\n* `al
lUsers`: A special identifier that represents anyone who is\n on the internet;
with or without a Google account.\n\n* `allAuthenticatedUsers`: A special ident
ifier that represents anyone\n who is authenticated with a Google account or a
service account.\n\n* `user:{emailid}`: An email address that represents a spec
ific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\
n\n* `serviceAccount:{emailid}`: An email address that represents a service\n
account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{e
mailid}`: An email address that represents a Google group.\n For example, `adm
ins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that repre
sents all the\n users of that domain. For example, `google.com` or `example.co
m`.\n\n", |
| 787 "items": { |
| 788 "type": "string" |
| 789 }, |
| 790 "type": "array" |
| 791 }, |
| 792 "role": { |
| 793 "description": "Role that is assigned to `members`.\nFor exa
mple, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired", |
| 794 "type": "string" |
| 795 } |
| 796 }, |
| 797 "type": "object" |
| 798 }, |
| 799 "AcknowledgeRequest": { |
| 800 "description": "Request for the Acknowledge method.", |
| 801 "id": "AcknowledgeRequest", |
| 802 "properties": { |
| 803 "ackIds": { |
| 804 "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.", |
| 805 "items": { |
| 806 "type": "string" |
| 807 }, |
| 808 "type": "array" |
| 809 } |
| 810 }, |
| 811 "type": "object" |
| 812 }, |
| 813 "Empty": { |
| 814 "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 `{}`.", |
| 815 "id": "Empty", |
| 816 "properties": {}, |
| 817 "type": "object" |
| 818 }, |
| 819 "ListTopicsResponse": { |
| 820 "description": "Response for the `ListTopics` method.", |
| 821 "id": "ListTopicsResponse", |
| 822 "properties": { |
| 823 "nextPageToken": { |
| 824 "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`.", |
| 825 "type": "string" |
| 826 }, |
| 827 "topics": { |
| 828 "description": "The resulting topics.", |
| 829 "items": { |
| 830 "$ref": "Topic" |
| 831 }, |
| 832 "type": "array" |
| 833 } |
| 834 }, |
| 835 "type": "object" |
| 836 }, |
| 837 "ListTopicSubscriptionsResponse": { |
| 838 "description": "Response for the `ListTopicSubscriptions` method.", |
| 839 "id": "ListTopicSubscriptionsResponse", |
| 840 "properties": { |
| 841 "nextPageToken": { |
| 842 "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.", |
| 843 "type": "string" |
| 844 }, |
| 845 "subscriptions": { |
| 846 "description": "The names of the subscriptions that match th
e request.", |
| 847 "items": { |
| 848 "type": "string" |
| 849 }, |
| 850 "type": "array" |
| 851 } |
| 852 }, |
| 853 "type": "object" |
| 854 }, |
| 855 "PullResponse": { |
| 856 "description": "Response for the `Pull` method.", |
| 857 "id": "PullResponse", |
| 858 "properties": { |
| 859 "receivedMessages": { |
| 860 "description": "Received Pub/Sub messages. The Pub/Sub syste
m will return zero messages if\nthere are no more available in the backlog. The
Pub/Sub system may return\nfewer than the `maxMessages` requested even if there
are more messages\navailable in the backlog.", |
| 861 "items": { |
| 862 "$ref": "ReceivedMessage" |
| 863 }, |
| 864 "type": "array" |
| 865 } |
| 866 }, |
| 867 "type": "object" |
| 868 }, |
708 "ReceivedMessage": { | 869 "ReceivedMessage": { |
709 "description": "A message and its corresponding acknowledgment ID.", | 870 "description": "A message and its corresponding acknowledgment ID.", |
710 "id": "ReceivedMessage", | 871 "id": "ReceivedMessage", |
711 "properties": { | 872 "properties": { |
712 "message": { | 873 "message": { |
713 "$ref": "PubsubMessage", | 874 "$ref": "PubsubMessage", |
714 "description": "The message." | 875 "description": "The message." |
715 }, | 876 }, |
716 "ackId": { | 877 "ackId": { |
717 "description": "This ID can be used to acknowledge the recei
ved message.", | 878 "description": "This ID can be used to acknowledge the recei
ved message.", |
(...skipping 31 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
749 }, | 910 }, |
750 "type": "array" | 911 "type": "array" |
751 } | 912 } |
752 }, | 913 }, |
753 "type": "object" | 914 "type": "object" |
754 }, | 915 }, |
755 "PullRequest": { | 916 "PullRequest": { |
756 "description": "Request for the `Pull` method.", | 917 "description": "Request for the `Pull` method.", |
757 "id": "PullRequest", | 918 "id": "PullRequest", |
758 "properties": { | 919 "properties": { |
| 920 "returnImmediately": { |
| 921 "description": "If this is specified as true the system will
respond immediately even if\nit is not able to return a message in the `Pull` r
esponse. Otherwise the\nsystem is allowed to wait until at least one message is
available rather\nthan returning no messages. The client may cancel the request
if it does\nnot wish to wait any longer for the response.", |
| 922 "type": "boolean" |
| 923 }, |
759 "maxMessages": { | 924 "maxMessages": { |
760 "description": "The maximum number of messages returned for
this request. The Pub/Sub\nsystem may return fewer than the number specified.", | 925 "description": "The maximum number of messages returned for
this request. The Pub/Sub\nsystem may return fewer than the number specified.", |
761 "format": "int32", | 926 "format": "int32", |
762 "type": "integer" | 927 "type": "integer" |
763 }, | |
764 "returnImmediately": { | |
765 "description": "If this is specified as true the system will
respond immediately even if\nit is not able to return a message in the `Pull` r
esponse. Otherwise the\nsystem is allowed to wait until at least one message is
available rather\nthan returning no messages. The client may cancel the request
if it does\nnot wish to wait any longer for the response.", | |
766 "type": "boolean" | |
767 } | 928 } |
768 }, | 929 }, |
769 "type": "object" | 930 "type": "object" |
770 }, | 931 }, |
771 "ListSubscriptionsResponse": { | 932 "ListSubscriptionsResponse": { |
772 "description": "Response for the `ListSubscriptions` method.", | 933 "description": "Response for the `ListSubscriptions` method.", |
773 "id": "ListSubscriptionsResponse", | 934 "id": "ListSubscriptionsResponse", |
774 "properties": { | 935 "properties": { |
775 "nextPageToken": { | 936 "nextPageToken": { |
776 "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.", | 937 "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.", |
(...skipping 34 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
811 }, | 972 }, |
812 "type": "array" | 973 "type": "array" |
813 } | 974 } |
814 }, | 975 }, |
815 "type": "object" | 976 "type": "object" |
816 }, | 977 }, |
817 "Subscription": { | 978 "Subscription": { |
818 "description": "A subscription resource.", | 979 "description": "A subscription resource.", |
819 "id": "Subscription", | 980 "id": "Subscription", |
820 "properties": { | 981 "properties": { |
821 "topic": { | |
822 "description": "The name of the topic from which this subscr
iption is receiving messages.\nThe value of this field will be `_deleted-topic_`
if the topic has been\ndeleted.", | |
823 "type": "string" | |
824 }, | |
825 "pushConfig": { | |
826 "$ref": "PushConfig", | |
827 "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." | |
828 }, | |
829 "ackDeadlineSeconds": { | 982 "ackDeadlineSeconds": { |
830 "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 pull.\nThe maximum custom deadline you can specify is 600 seconds (10 min
utes).\n\nFor push delivery, this value 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 eventually redeliver the message.\n\nIf this p
arameter is 0, a default value of 10 seconds is used.", | 983 "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 pull.\nThe maximum custom deadline you can specify is 600 seconds (10 min
utes).\n\nFor push delivery, this value 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 eventually redeliver the message.\n\nIf this p
arameter is 0, a default value of 10 seconds is used.", |
831 "format": "int32", | 984 "format": "int32", |
832 "type": "integer" | 985 "type": "integer" |
833 }, | 986 }, |
834 "name": { | 987 "name": { |
835 "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\"`.", | 988 "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\"`.", |
836 "type": "string" | 989 "type": "string" |
| 990 }, |
| 991 "topic": { |
| 992 "description": "The name of the topic from which this subscr
iption is receiving messages.\nThe value of this field will be `_deleted-topic_`
if the topic has been\ndeleted.", |
| 993 "type": "string" |
| 994 }, |
| 995 "pushConfig": { |
| 996 "$ref": "PushConfig", |
| 997 "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." |
837 } | 998 } |
838 }, | 999 }, |
839 "type": "object" | 1000 "type": "object" |
840 }, | 1001 }, |
841 "TestIamPermissionsRequest": { | 1002 "TestIamPermissionsRequest": { |
842 "description": "Request message for `TestIamPermissions` method.", | 1003 "description": "Request message for `TestIamPermissions` method.", |
843 "id": "TestIamPermissionsRequest", | 1004 "id": "TestIamPermissionsRequest", |
844 "properties": { | 1005 "properties": { |
845 "permissions": { | 1006 "permissions": { |
846 "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).", | 1007 "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).", |
847 "items": { | 1008 "items": { |
848 "type": "string" | 1009 "type": "string" |
849 }, | 1010 }, |
850 "type": "array" | 1011 "type": "array" |
851 } | 1012 } |
852 }, | 1013 }, |
853 "type": "object" | 1014 "type": "object" |
854 }, | 1015 }, |
855 "Policy": { | 1016 "Policy": { |
856 "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).", | 1017 "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).", |
857 "id": "Policy", | 1018 "id": "Policy", |
858 "properties": { | 1019 "properties": { |
| 1020 "bindings": { |
| 1021 "description": "Associates a list of `members` to a `role`.\
n`bindings` with no members will result in an error.", |
| 1022 "items": { |
| 1023 "$ref": "Binding" |
| 1024 }, |
| 1025 "type": "array" |
| 1026 }, |
859 "etag": { | 1027 "etag": { |
860 "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.", | 1028 "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.", |
861 "format": "byte", | 1029 "format": "byte", |
862 "type": "string" | 1030 "type": "string" |
863 }, | 1031 }, |
864 "version": { | 1032 "version": { |
865 "description": "Version of the `Policy`. The default version
is 0.", | 1033 "description": "Version of the `Policy`. The default version
is 0.", |
866 "format": "int32", | 1034 "format": "int32", |
867 "type": "integer" | 1035 "type": "integer" |
868 }, | |
869 "bindings": { | |
870 "description": "Associates a list of `members` to a `role`.\
n`bindings` with no members will result in an error.", | |
871 "items": { | |
872 "$ref": "Binding" | |
873 }, | |
874 "type": "array" | |
875 } | 1036 } |
876 }, | 1037 }, |
877 "type": "object" | 1038 "type": "object" |
878 }, | 1039 }, |
879 "Topic": { | 1040 "Topic": { |
880 "description": "A topic resource.", | 1041 "description": "A topic resource.", |
881 "id": "Topic", | 1042 "id": "Topic", |
882 "properties": { | 1043 "properties": { |
883 "name": { | 1044 "name": { |
884 "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\"`.", | 1045 "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\"`.", |
885 "type": "string" | 1046 "type": "string" |
886 } | 1047 } |
887 }, | 1048 }, |
888 "type": "object" | 1049 "type": "object" |
889 }, | |
890 "ModifyAckDeadlineRequest": { | |
891 "description": "Request for the ModifyAckDeadline method.", | |
892 "id": "ModifyAckDeadlineRequest", | |
893 "properties": { | |
894 "ackIds": { | |
895 "description": "List of acknowledgment IDs.", | |
896 "items": { | |
897 "type": "string" | |
898 }, | |
899 "type": "array" | |
900 }, | |
901 "ackId": { | |
902 "description": "The acknowledgment ID. Either this or ack_id
s must be populated, but not\nboth.", | |
903 "type": "string" | |
904 }, | |
905 "ackDeadlineSeconds": { | |
906 "description": "The new ack deadline with respect to the tim
e this request was sent to\nthe Pub/Sub system. Must be >= 0. For example, if th
e value is 10, the new\nack deadline will expire 10 seconds after the `ModifyAck
Deadline` call\nwas made. Specifying zero may immediately make the message avail
able for\nanother pull request.", | |
907 "format": "int32", | |
908 "type": "integer" | |
909 } | |
910 }, | |
911 "type": "object" | |
912 }, | |
913 "SetIamPolicyRequest": { | |
914 "description": "Request message for `SetIamPolicy` method.", | |
915 "id": "SetIamPolicyRequest", | |
916 "properties": { | |
917 "policy": { | |
918 "$ref": "Policy", | |
919 "description": "REQUIRED: The complete policy to be applied
to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An emp
ty policy is a\nvalid policy but certain Cloud Platform services (such as Projec
ts)\nmight reject them." | |
920 } | |
921 }, | |
922 "type": "object" | |
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 }, | |
935 "PubsubMessage": { | |
936 "description": "A message data and its attributes. The message paylo
ad must not be empty;\nit must contain either a non-empty data field, or at leas
t one attribute.", | |
937 "id": "PubsubMessage", | |
938 "properties": { | |
939 "messageId": { | |
940 "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.", | |
941 "type": "string" | |
942 }, | |
943 "attributes": { | |
944 "additionalProperties": { | |
945 "type": "string" | |
946 }, | |
947 "description": "Optional attributes for this message.", | |
948 "type": "object" | |
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. For JSON requests, the
value of this field must be\n[base64-encoded](https://tools.ietf.org/html/rfc464
8).", | |
957 "format": "byte", | |
958 "type": "string" | |
959 } | |
960 }, | |
961 "type": "object" | |
962 }, | |
963 "Binding": { | |
964 "description": "Associates `members` with a `role`.", | |
965 "id": "Binding", | |
966 "properties": { | |
967 "members": { | |
968 "description": "Specifies the identities requesting access f
or a Cloud Platform resource.\n`members` can have the following values:\n\n* `al
lUsers`: A special identifier that represents anyone who is\n on the internet;
with or without a Google account.\n\n* `allAuthenticatedUsers`: A special ident
ifier that represents anyone\n who is authenticated with a Google account or a
service account.\n\n* `user:{emailid}`: An email address that represents a spec
ific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\
n\n* `serviceAccount:{emailid}`: An email address that represents a service\n
account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{e
mailid}`: An email address that represents a Google group.\n For example, `adm
ins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that repre
sents all the\n users of that domain. For example, `google.com` or `example.co
m`.\n\n", | |
969 "items": { | |
970 "type": "string" | |
971 }, | |
972 "type": "array" | |
973 }, | |
974 "role": { | |
975 "description": "Role that is assigned to `members`.\nFor exa
mple, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired", | |
976 "type": "string" | |
977 } | |
978 }, | |
979 "type": "object" | |
980 }, | |
981 "Empty": { | |
982 "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 `{}`.", | |
983 "id": "Empty", | |
984 "properties": {}, | |
985 "type": "object" | |
986 }, | |
987 "AcknowledgeRequest": { | |
988 "description": "Request for the Acknowledge method.", | |
989 "id": "AcknowledgeRequest", | |
990 "properties": { | |
991 "ackIds": { | |
992 "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.", | |
993 "items": { | |
994 "type": "string" | |
995 }, | |
996 "type": "array" | |
997 } | |
998 }, | |
999 "type": "object" | |
1000 }, | |
1001 "ListTopicsResponse": { | |
1002 "description": "Response for the `ListTopics` method.", | |
1003 "id": "ListTopicsResponse", | |
1004 "properties": { | |
1005 "topics": { | |
1006 "description": "The resulting topics.", | |
1007 "items": { | |
1008 "$ref": "Topic" | |
1009 }, | |
1010 "type": "array" | |
1011 }, | |
1012 "nextPageToken": { | |
1013 "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`.", | |
1014 "type": "string" | |
1015 } | |
1016 }, | |
1017 "type": "object" | |
1018 }, | |
1019 "ListTopicSubscriptionsResponse": { | |
1020 "description": "Response for the `ListTopicSubscriptions` method.", | |
1021 "id": "ListTopicSubscriptionsResponse", | |
1022 "properties": { | |
1023 "nextPageToken": { | |
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.", | |
1025 "type": "string" | |
1026 }, | |
1027 "subscriptions": { | |
1028 "description": "The names of the subscriptions that match th
e request.", | |
1029 "items": { | |
1030 "type": "string" | |
1031 }, | |
1032 "type": "array" | |
1033 } | |
1034 }, | |
1035 "type": "object" | |
1036 }, | |
1037 "PullResponse": { | |
1038 "description": "Response for the `Pull` method.", | |
1039 "id": "PullResponse", | |
1040 "properties": { | |
1041 "receivedMessages": { | |
1042 "description": "Received Pub/Sub messages. The Pub/Sub syste
m will return zero messages if\nthere are no more available in the backlog. The
Pub/Sub system may return\nfewer than the `maxMessages` requested even if there
are more messages\navailable in the backlog.", | |
1043 "items": { | |
1044 "$ref": "ReceivedMessage" | |
1045 }, | |
1046 "type": "array" | |
1047 } | |
1048 }, | |
1049 "type": "object" | |
1050 } | 1050 } |
1051 }, | 1051 }, |
1052 "servicePath": "", | 1052 "servicePath": "", |
1053 "title": "Google Cloud Pub/Sub API", | 1053 "title": "Google Cloud Pub/Sub API", |
1054 "version": "v1beta2" | 1054 "version": "v1beta2" |
1055 } | 1055 } |
OLD | NEW |