discovery/googleapis_beta/pubsub__v1beta2.json - Issue 3006323002: Api-Roll 54: 2017-09-11

Side by Side Diff: discovery/googleapis_beta/pubsub__v1beta2.json

Issue 3006323002: Api-Roll 54: 2017-09-11 (Closed)

Patch Set: use 2.0.0-dev.infinity sdk constraint in pubspecs Created 3 years, 3 months ago

Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.

Jump to:

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 "upload_protocol": {

32 "description": "Upload protocol for media (e.g. \"raw\", \"multipart \").",

33 "location": "query",

34 "type": "string"

35 },

36 "prettyPrint": {

37 "default": "true",

38 "description": "Returns response with indentations and line breaks." ,

39 "location": "query",

40 "type": "boolean"

41 },

42 "fields": {

43 "description": "Selector specifying which fields to include in a par tial response.",

44 "location": "query",

45 "type": "string"

46 },

47 "uploadType": {

48 "description": "Legacy upload protocol for media (e.g. \"media\", \" multipart\").",

49 "location": "query",

50 "type": "string"

51 },

52 "callback": {

53 "description": "JSONP",

54 "location": "query",

55 "type": "string"

56 },

57 "$.xgafv": {

58 "description": "V1 error format.",

59 "enum": [

60 "1",

61 "2"

62 ],

63 "enumDescriptions": [

64 "v1 error format",

65 "v2 error format"

66 ],

67 "location": "query",

68 "type": "string"

69 },

70 "alt": {	31 "alt": {

71 "default": "json",	32 "default": "json",

72 "description": "Data format for response.",	33 "description": "Data format for response.",

73 "enum": [	34 "enum": [

74 "json",	35 "json",

75 "media",	36 "media",

76 "proto"	37 "proto"

77 ],	38 ],

78 "enumDescriptions": [	39 "enumDescriptions": [

79 "Responses with Content-Type of application/json",	40 "Responses with Content-Type of application/json",

(...skipping 26 matching lines...) Expand all Loading...
106 },	67 },

107 "oauth_token": {	68 "oauth_token": {

108 "description": "OAuth 2.0 token for the current user.",	69 "description": "OAuth 2.0 token for the current user.",

109 "location": "query",	70 "location": "query",

110 "type": "string"	71 "type": "string"

111 },	72 },

112 "bearer_token": {	73 "bearer_token": {

113 "description": "OAuth bearer token.",	74 "description": "OAuth bearer token.",

114 "location": "query",	75 "location": "query",

115 "type": "string"	76 "type": "string"

	77 },

	78 "upload_protocol": {

	79 "description": "Upload protocol for media (e.g. \"raw\", \"multipart \").",

	80 "location": "query",

	81 "type": "string"

	82 },

	83 "prettyPrint": {

	84 "default": "true",

	85 "description": "Returns response with indentations and line breaks." ,

	86 "location": "query",

	87 "type": "boolean"

	88 },

	89 "fields": {

	90 "description": "Selector specifying which fields to include in a par tial response.",

	91 "location": "query",

	92 "type": "string"

	93 },

	94 "uploadType": {

	95 "description": "Legacy upload protocol for media (e.g. \"media\", \" multipart\").",

	96 "location": "query",

	97 "type": "string"

	98 },

	99 "callback": {

	100 "description": "JSONP",

	101 "location": "query",

	102 "type": "string"

	103 },

	104 "$.xgafv": {

	105 "description": "V1 error format.",

	106 "enum": [

	107 "1",

	108 "2"

	109 ],

	110 "enumDescriptions": [

	111 "v1 error format",

	112 "v2 error format"

	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 "topics": {	122 "subscriptions": {

123 "methods": {	123 "methods": {

124 "get": {	124 "modifyPushConfig": {

125 "description": "Gets the configuration of a topic.",	125 "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` .",

126 "httpMethod": "GET",	126 "httpMethod": "POST",

127 "id": "pubsub.projects.topics.get",	127 "id": "pubsub.projects.subscriptions.modifyPushConfi g",

128 "parameterOrder": [	128 "parameterOrder": [

129 "topic"	129 "subscription"

130 ],	130 ],

131 "parameters": {	131 "parameters": {

132 "topic": {	132 "subscription": {

133 "description": "The name of the topic to get .",	133 "description": "The name of the subscription .",

134 "location": "path",	134 "location": "path",

135 "pattern": "^projects/[^/]+/topics/[^/]+$",	135 "pattern": "^projects/[^/]+/subscriptions/[^ /]+$",

136 "required": true,	136 "required": true,

137 "type": "string"	137 "type": "string"

138 }	138 }

139 },	139 },

140 "path": "v1beta2/{+topic}",	140 "path": "v1beta2/{+subscription}:modifyPushConfig",

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": {	141 "request": {

167 "$ref": "PublishRequest"	142 "$ref": "ModifyPushConfigRequest"

168 },	143 },

169 "response": {	144 "response": {

170 "$ref": "PublishResponse"	145 "$ref": "Empty"

171 },

172 "scopes": [

173 "https://www.googleapis.com/auth/cloud-platform" ,

174 "https://www.googleapis.com/auth/pubsub"

175 ]

176 },

177 "testIamPermissions": {

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. ",

179 "httpMethod": "POST",

180 "id": "pubsub.projects.topics.testIamPermissions",

181 "parameterOrder": [

182 "resource"

183 ],

184 "parameters": {

185 "resource": {

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.",

187 "location": "path",

188 "pattern": "^projects/[^/]+/topics/[^/]+$",

189 "required": true,

190 "type": "string"

191 }

192 },

193 "path": "v1beta2/{+resource}:testIamPermissions",

194 "request": {

195 "$ref": "TestIamPermissionsRequest"

196 },

197 "response": {

198 "$ref": "TestIamPermissionsResponse"

199 },	146 },

200 "scopes": [	147 "scopes": [

201 "https://www.googleapis.com/auth/cloud-platform" ,	148 "https://www.googleapis.com/auth/cloud-platform" ,

202 "https://www.googleapis.com/auth/pubsub"	149 "https://www.googleapis.com/auth/pubsub"

203 ]	150 ]

204 },	151 },

205 "delete": {	152 "delete": {

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_`.",	153 "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.",

207 "httpMethod": "DELETE",	154 "httpMethod": "DELETE",

208 "id": "pubsub.projects.topics.delete",	155 "id": "pubsub.projects.subscriptions.delete",

209 "parameterOrder": [	156 "parameterOrder": [

210 "topic"	157 "subscription"

211 ],	158 ],

212 "parameters": {	159 "parameters": {

213 "topic": {	160 "subscription": {

214 "description": "Name of the topic to delete. ",	161 "description": "The subscription to delete." ,

215 "location": "path",	162 "location": "path",

216 "pattern": "^projects/[^/]+/topics/[^/]+$",	163 "pattern": "^projects/[^/]+/subscriptions/[^ /]+$",

217 "required": true,	164 "required": true,

218 "type": "string"	165 "type": "string"

219 }	166 }

220 },	167 },

221 "path": "v1beta2/{+topic}",	168 "path": "v1beta2/{+subscription}",

222 "response": {	169 "response": {

223 "$ref": "Empty"	170 "$ref": "Empty"

224 },	171 },

225 "scopes": [	172 "scopes": [

226 "https://www.googleapis.com/auth/cloud-platform" ,	173 "https://www.googleapis.com/auth/cloud-platform" ,

	174 "https://www.googleapis.com/auth/pubsub"

	175 ]

	176 },

	177 "pull": {

	178 "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.",

	179 "httpMethod": "POST",

	180 "id": "pubsub.projects.subscriptions.pull",

	181 "parameterOrder": [

	182 "subscription"

	183 ],

	184 "parameters": {

	185 "subscription": {

	186 "description": "The subscription from which messages should be pulled.",

	187 "location": "path",

	188 "pattern": "^projects/[^/]+/subscriptions/[^ /]+$",

	189 "required": true,

	190 "type": "string"

	191 }

	192 },

	193 "path": "v1beta2/{+subscription}:pull",

	194 "request": {

	195 "$ref": "PullRequest"

	196 },

	197 "response": {

	198 "$ref": "PullResponse"

	199 },

	200 "scopes": [

	201 "https://www.googleapis.com/auth/cloud-platform" ,

227 "https://www.googleapis.com/auth/pubsub"	202 "https://www.googleapis.com/auth/pubsub"

228 ]	203 ]

229 },	204 },

230 "list": {	205 "list": {

231 "description": "Lists matching topics.",	206 "description": "Lists matching subscriptions.",

232 "httpMethod": "GET",	207 "httpMethod": "GET",

233 "id": "pubsub.projects.topics.list",	208 "id": "pubsub.projects.subscriptions.list",

234 "parameterOrder": [	209 "parameterOrder": [

235 "project"	210 "project"

236 ],	211 ],

237 "parameters": {	212 "parameters": {

	213 "pageToken": {

	214 "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.",

	215 "location": "query",

	216 "type": "string"

	217 },

	218 "pageSize": {

	219 "description": "Maximum number of subscripti ons to return.",

	220 "format": "int32",

	221 "location": "query",

	222 "type": "integer"

	223 },

238 "project": {	224 "project": {

239 "description": "The name of the cloud projec t that topics belong to.",	225 "description": "The name of the cloud projec t that subscriptions belong to.",

240 "location": "path",	226 "location": "path",

241 "pattern": "^projects/[^/]+$",	227 "pattern": "^projects/[^/]+$",

242 "required": true,	228 "required": true,

243 "type": "string"	229 "type": "string"

244 },

245 "pageToken": {

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.",

247 "location": "query",

248 "type": "string"

249 },

250 "pageSize": {

251 "description": "Maximum number of topics to return.",

252 "format": "int32",

253 "location": "query",

254 "type": "integer"

255 }	230 }

256 },	231 },

257 "path": "v1beta2/{+project}/topics",	232 "path": "v1beta2/{+project}/subscriptions",

258 "response": {	233 "response": {

259 "$ref": "ListTopicsResponse"	234 "$ref": "ListSubscriptionsResponse"

260 },	235 },

261 "scopes": [	236 "scopes": [

262 "https://www.googleapis.com/auth/cloud-platform" ,	237 "https://www.googleapis.com/auth/cloud-platform" ,

263 "https://www.googleapis.com/auth/pubsub"	238 "https://www.googleapis.com/auth/pubsub"

264 ]	239 ]

265 },	240 },

266 "create": {	241 "create": {

267 "description": "Creates the given topic with the giv en name.",	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. Note that\nfor REST API requests, you must spec ify a name.",

268 "httpMethod": "PUT",	243 "httpMethod": "PUT",

269 "id": "pubsub.projects.topics.create",	244 "id": "pubsub.projects.subscriptions.create",

270 "parameterOrder": [	245 "parameterOrder": [

271 "name"	246 "name"

272 ],	247 ],

273 "parameters": {	248 "parameters": {

274 "name": {	249 "name": {

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\"`.",	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\"`.",

276 "location": "path",	251 "location": "path",

277 "pattern": "^projects/[^/]+/topics/[^/]+$",	252 "pattern": "^projects/[^/]+/subscriptions/[^ /]+$",

278 "required": true,	253 "required": true,

279 "type": "string"	254 "type": "string"

280 }	255 }

281 },	256 },

282 "path": "v1beta2/{+name}",	257 "path": "v1beta2/{+name}",

283 "request": {	258 "request": {

284 "$ref": "Topic"	259 "$ref": "Subscription"

285 },	260 },

286 "response": {	261 "response": {

287 "$ref": "Topic"	262 "$ref": "Subscription"

288 },	263 },

289 "scopes": [	264 "scopes": [

290 "https://www.googleapis.com/auth/cloud-platform" ,	265 "https://www.googleapis.com/auth/cloud-platform" ,

291 "https://www.googleapis.com/auth/pubsub"	266 "https://www.googleapis.com/auth/pubsub"

292 ]	267 ]

293 },	268 },

294 "setIamPolicy": {	269 "setIamPolicy": {

295 "description": "Sets the access control policy on th e specified resource. Replaces any\nexisting policy.",	270 "description": "Sets the access control policy on th e specified resource. Replaces any\nexisting policy.",

296 "httpMethod": "POST",	271 "httpMethod": "POST",

297 "id": "pubsub.projects.topics.setIamPolicy",	272 "id": "pubsub.projects.subscriptions.setIamPolicy",

298 "parameterOrder": [	273 "parameterOrder": [

299 "resource"	274 "resource"

300 ],	275 ],

301 "parameters": {	276 "parameters": {

302 "resource": {	277 "resource": {

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.",	278 "description": "REQUIRED: The resource for w hich the policy is being specified.\nSee the operation documentation for the app ropriate value for this field.",

304 "location": "path",	279 "location": "path",

305 "pattern": "^projects/[^/]+/topics/[^/]+$",	280 "pattern": "^projects/[^/]+/subscriptions/[^ /]+$",

306 "required": true,	281 "required": true,

307 "type": "string"	282 "type": "string"

308 }	283 }

309 },	284 },

310 "path": "v1beta2/{+resource}:setIamPolicy",	285 "path": "v1beta2/{+resource}:setIamPolicy",

311 "request": {	286 "request": {

312 "$ref": "SetIamPolicyRequest"	287 "$ref": "SetIamPolicyRequest"

313 },	288 },

314 "response": {	289 "response": {

315 "$ref": "Policy"	290 "$ref": "Policy"

316 },	291 },

317 "scopes": [	292 "scopes": [

318 "https://www.googleapis.com/auth/cloud-platform" ,	293 "https://www.googleapis.com/auth/cloud-platform" ,

319 "https://www.googleapis.com/auth/pubsub"	294 "https://www.googleapis.com/auth/pubsub"

320 ]	295 ]

321 },	296 },

322 "getIamPolicy": {	297 "getIamPolicy": {

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.",	298 "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.",

324 "httpMethod": "GET",	299 "httpMethod": "GET",

325 "id": "pubsub.projects.topics.getIamPolicy",	300 "id": "pubsub.projects.subscriptions.getIamPolicy",

326 "parameterOrder": [	301 "parameterOrder": [

327 "resource"	302 "resource"

328 ],	303 ],

329 "parameters": {	304 "parameters": {

330 "resource": {	305 "resource": {

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.",	306 "description": "REQUIRED: The resource for w hich the policy is being requested.\nSee the operation documentation for the app ropriate value for this field.",

332 "location": "path",	307 "location": "path",

333 "pattern": "^projects/[^/]+/topics/[^/]+$",	308 "pattern": "^projects/[^/]+/subscriptions/[^ /]+$",

334 "required": true,	309 "required": true,

335 "type": "string"	310 "type": "string"

336 }	311 }

337 },	312 },

338 "path": "v1beta2/{+resource}:getIamPolicy",	313 "path": "v1beta2/{+resource}:getIamPolicy",

339 "response": {	314 "response": {

340 "$ref": "Policy"	315 "$ref": "Policy"

341 },	316 },

342 "scopes": [	317 "scopes": [

343 "https://www.googleapis.com/auth/cloud-platform" ,	318 "https://www.googleapis.com/auth/cloud-platform" ,

344 "https://www.googleapis.com/auth/pubsub"	319 "https://www.googleapis.com/auth/pubsub"

345 ]	320 ]

	321 },

	322 "modifyAckDeadline": {

	323 "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.",

	324 "httpMethod": "POST",

	325 "id": "pubsub.projects.subscriptions.modifyAckDeadli ne",

	326 "parameterOrder": [

	327 "subscription"

	328 ],

	329 "parameters": {

	330 "subscription": {

	331 "description": "The name of the subscription .",

	332 "location": "path",

	333 "pattern": "^projects/[^/]+/subscriptions/[^ /]+$",

	334 "required": true,

	335 "type": "string"

	336 }

	337 },

	338 "path": "v1beta2/{+subscription}:modifyAckDeadline",

	339 "request": {

	340 "$ref": "ModifyAckDeadlineRequest"

	341 },

	342 "response": {

	343 "$ref": "Empty"

	344 },

	345 "scopes": [

	346 "https://www.googleapis.com/auth/cloud-platform" ,

	347 "https://www.googleapis.com/auth/pubsub"

	348 ]

	349 },

	350 "acknowledge": {

	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.",

	352 "httpMethod": "POST",

	353 "id": "pubsub.projects.subscriptions.acknowledge",

	354 "parameterOrder": [

	355 "subscription"

	356 ],

	357 "parameters": {

	358 "subscription": {

	359 "description": "The subscription whose messa ge is being acknowledged.",

	360 "location": "path",

	361 "pattern": "^projects/[^/]+/subscriptions/[^ /]+$",

	362 "required": true,

	363 "type": "string"

	364 }

	365 },

	366 "path": "v1beta2/{+subscription}:acknowledge",

	367 "request": {

	368 "$ref": "AcknowledgeRequest"

	369 },

	370 "response": {

	371 "$ref": "Empty"

	372 },

	373 "scopes": [

	374 "https://www.googleapis.com/auth/cloud-platform" ,

	375 "https://www.googleapis.com/auth/pubsub"

	376 ]

	377 },

	378 "get": {

	379 "description": "Gets the configuration details of a subscription.",

	380 "httpMethod": "GET",

	381 "id": "pubsub.projects.subscriptions.get",

	382 "parameterOrder": [

	383 "subscription"

	384 ],

	385 "parameters": {

	386 "subscription": {

	387 "description": "The name of the subscription to get.",

	388 "location": "path",

	389 "pattern": "^projects/[^/]+/subscriptions/[^ /]+$",

	390 "required": true,

	391 "type": "string"

	392 }

	393 },

	394 "path": "v1beta2/{+subscription}",

	395 "response": {

	396 "$ref": "Subscription"

	397 },

	398 "scopes": [

	399 "https://www.googleapis.com/auth/cloud-platform" ,

	400 "https://www.googleapis.com/auth/pubsub"

	401 ]

	402 },

	403 "testIamPermissions": {

	404 "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. ",

	405 "httpMethod": "POST",

	406 "id": "pubsub.projects.subscriptions.testIamPermissi ons",

	407 "parameterOrder": [

	408 "resource"

	409 ],

	410 "parameters": {

	411 "resource": {

	412 "description": "REQUIRED: The resource for w hich the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",

	413 "location": "path",

	414 "pattern": "^projects/[^/]+/subscriptions/[^ /]+$",

	415 "required": true,

	416 "type": "string"

	417 }

	418 },

	419 "path": "v1beta2/{+resource}:testIamPermissions",

	420 "request": {

	421 "$ref": "TestIamPermissionsRequest"

	422 },

	423 "response": {

	424 "$ref": "TestIamPermissionsResponse"

	425 },

	426 "scopes": [

	427 "https://www.googleapis.com/auth/cloud-platform" ,

	428 "https://www.googleapis.com/auth/pubsub"

	429 ]

	430 }

	431 }

	432 },

	433 "topics": {

	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.topics.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/[^/]+/topics/[^/]+$",

	447 "required": true,

	448 "type": "string"

	449 }

	450 },

	451 "path": "v1beta2/{+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 "get": {

	461 "description": "Gets the configuration of a topic.",

	462 "httpMethod": "GET",

	463 "id": "pubsub.projects.topics.get",

	464 "parameterOrder": [

	465 "topic"

	466 ],

	467 "parameters": {

	468 "topic": {

	469 "description": "The name of the topic to get .",

	470 "location": "path",

	471 "pattern": "^projects/[^/]+/topics/[^/]+$",

	472 "required": true,

	473 "type": "string"

	474 }

	475 },

	476 "path": "v1beta2/{+topic}",

	477 "response": {

	478 "$ref": "Topic"

	479 },

	480 "scopes": [

	481 "https://www.googleapis.com/auth/cloud-platform" ,

	482 "https://www.googleapis.com/auth/pubsub"

	483 ]

	484 },

	485 "publish": {

	486 "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.",

	487 "httpMethod": "POST",

	488 "id": "pubsub.projects.topics.publish",

	489 "parameterOrder": [

	490 "topic"

	491 ],

	492 "parameters": {

	493 "topic": {

	494 "description": "The messages in the request will be published on this topic.",

	495 "location": "path",

	496 "pattern": "^projects/[^/]+/topics/[^/]+$",

	497 "required": true,

	498 "type": "string"

	499 }

	500 },

	501 "path": "v1beta2/{+topic}:publish",

	502 "request": {

	503 "$ref": "PublishRequest"

	504 },

	505 "response": {

	506 "$ref": "PublishResponse"

	507 },

	508 "scopes": [

	509 "https://www.googleapis.com/auth/cloud-platform" ,

	510 "https://www.googleapis.com/auth/pubsub"

	511 ]

	512 },

	513 "testIamPermissions": {

	514 "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. ",

	515 "httpMethod": "POST",

	516 "id": "pubsub.projects.topics.testIamPermissions",

	517 "parameterOrder": [

	518 "resource"

	519 ],

	520 "parameters": {

	521 "resource": {

	522 "description": "REQUIRED: The resource for w hich the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",

	523 "location": "path",

	524 "pattern": "^projects/[^/]+/topics/[^/]+$",

	525 "required": true,

	526 "type": "string"

	527 }

	528 },

	529 "path": "v1beta2/{+resource}:testIamPermissions",

	530 "request": {

	531 "$ref": "TestIamPermissionsRequest"

	532 },

	533 "response": {

	534 "$ref": "TestIamPermissionsResponse"

	535 },

	536 "scopes": [

	537 "https://www.googleapis.com/auth/cloud-platform" ,

	538 "https://www.googleapis.com/auth/pubsub"

	539 ]

	540 },

	541 "delete": {

	542 "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_`.",

	543 "httpMethod": "DELETE",

	544 "id": "pubsub.projects.topics.delete",

	545 "parameterOrder": [

	546 "topic"

	547 ],

	548 "parameters": {

	549 "topic": {

	550 "description": "Name of the topic to delete. ",

	551 "location": "path",

	552 "pattern": "^projects/[^/]+/topics/[^/]+$",

	553 "required": true,

	554 "type": "string"

	555 }

	556 },

	557 "path": "v1beta2/{+topic}",

	558 "response": {

	559 "$ref": "Empty"

	560 },

	561 "scopes": [

	562 "https://www.googleapis.com/auth/cloud-platform" ,

	563 "https://www.googleapis.com/auth/pubsub"

	564 ]

	565 },

	566 "list": {

	567 "description": "Lists matching topics.",

	568 "httpMethod": "GET",

	569 "id": "pubsub.projects.topics.list",

	570 "parameterOrder": [

	571 "project"

	572 ],

	573 "parameters": {

	574 "pageToken": {

	575 "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.",

	576 "location": "query",

	577 "type": "string"

	578 },

	579 "pageSize": {

	580 "description": "Maximum number of topics to return.",

	581 "format": "int32",

	582 "location": "query",

	583 "type": "integer"

	584 },

	585 "project": {

	586 "description": "The name of the cloud projec t that topics belong to.",

	587 "location": "path",

	588 "pattern": "^projects/[^/]+$",

	589 "required": true,

	590 "type": "string"

	591 }

	592 },

	593 "path": "v1beta2/{+project}/topics",

	594 "response": {

	595 "$ref": "ListTopicsResponse"

	596 },

	597 "scopes": [

	598 "https://www.googleapis.com/auth/cloud-platform" ,

	599 "https://www.googleapis.com/auth/pubsub"

	600 ]

	601 },

	602 "create": {

	603 "description": "Creates the given topic with the giv en name.",

	604 "httpMethod": "PUT",

	605 "id": "pubsub.projects.topics.create",

	606 "parameterOrder": [

	607 "name"

	608 ],

	609 "parameters": {

	610 "name": {

	611 "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\"`.",

	612 "location": "path",

	613 "pattern": "^projects/[^/]+/topics/[^/]+$",

	614 "required": true,

	615 "type": "string"

	616 }

	617 },

	618 "path": "v1beta2/{+name}",

	619 "request": {

	620 "$ref": "Topic"

	621 },

	622 "response": {

	623 "$ref": "Topic"

	624 },

	625 "scopes": [

	626 "https://www.googleapis.com/auth/cloud-platform" ,

	627 "https://www.googleapis.com/auth/pubsub"

	628 ]

	629 },

	630 "setIamPolicy": {

	631 "description": "Sets the access control policy on th e specified resource. Replaces any\nexisting policy.",

	632 "httpMethod": "POST",

	633 "id": "pubsub.projects.topics.setIamPolicy",

	634 "parameterOrder": [

	635 "resource"

	636 ],

	637 "parameters": {

	638 "resource": {

	639 "description": "REQUIRED: The resource for w hich the policy is being specified.\nSee the operation documentation for the app ropriate value for this field.",

	640 "location": "path",

	641 "pattern": "^projects/[^/]+/topics/[^/]+$",

	642 "required": true,

	643 "type": "string"

	644 }

	645 },

	646 "path": "v1beta2/{+resource}:setIamPolicy",

	647 "request": {

	648 "$ref": "SetIamPolicyRequest"

	649 },

	650 "response": {

	651 "$ref": "Policy"

	652 },

	653 "scopes": [

	654 "https://www.googleapis.com/auth/cloud-platform" ,

	655 "https://www.googleapis.com/auth/pubsub"

	656 ]

346 }	657 }

347 },	658 },

348 "resources": {	659 "resources": {

349 "subscriptions": {	660 "subscriptions": {

350 "methods": {	661 "methods": {

351 "list": {	662 "list": {

352 "description": "Lists the name of the subscr iptions for this topic.",	663 "description": "Lists the name of the subscr iptions for this topic.",

353 "httpMethod": "GET",	664 "httpMethod": "GET",

354 "id": "pubsub.projects.topics.subscriptions. list",	665 "id": "pubsub.projects.topics.subscriptions. list",

355 "parameterOrder": [	666 "parameterOrder": [

(...skipping 24 matching lines...) Expand all Loading...
380 "$ref": "ListTopicSubscriptionsResponse"	691 "$ref": "ListTopicSubscriptionsResponse"

381 },	692 },

382 "scopes": [	693 "scopes": [

383 "https://www.googleapis.com/auth/cloud-p latform",	694 "https://www.googleapis.com/auth/cloud-p latform",

384 "https://www.googleapis.com/auth/pubsub"	695 "https://www.googleapis.com/auth/pubsub"

385 ]	696 ]

386 }	697 }

387 }	698 }

388 }	699 }

389 }	700 }

390 },

391 "subscriptions": {

392 "methods": {

393 "get": {

394 "description": "Gets the configuration details of a subscription.",

395 "httpMethod": "GET",

396 "id": "pubsub.projects.subscriptions.get",

397 "parameterOrder": [

398 "subscription"

399 ],

400 "parameters": {

401 "subscription": {

402 "description": "The name of the subscription to get.",

403 "location": "path",

404 "pattern": "^projects/[^/]+/subscriptions/[^ /]+$",

405 "required": true,

406 "type": "string"

407 }

408 },

409 "path": "v1beta2/{+subscription}",

410 "response": {

411 "$ref": "Subscription"

412 },

413 "scopes": [

414 "https://www.googleapis.com/auth/cloud-platform" ,

415 "https://www.googleapis.com/auth/pubsub"

416 ]

417 },

418 "testIamPermissions": {

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. ",

420 "httpMethod": "POST",

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 },

527 "list": {

528 "description": "Lists matching subscriptions.",

529 "httpMethod": "GET",

530 "id": "pubsub.projects.subscriptions.list",

531 "parameterOrder": [

532 "project"

533 ],

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 },

540 "pageSize": {

541 "description": "Maximum number of subscripti ons to return.",

542 "format": "int32",

543 "location": "query",

544 "type": "integer"

545 },

546 "project": {

547 "description": "The name of the cloud projec t that subscriptions belong to.",

548 "location": "path",

549 "pattern": "^projects/[^/]+$",

550 "required": true,

551 "type": "string"

552 }

553 },

554 "path": "v1beta2/{+project}/subscriptions",

555 "response": {

556 "$ref": "ListSubscriptionsResponse"

557 },

558 "scopes": [

559 "https://www.googleapis.com/auth/cloud-platform" ,

560 "https://www.googleapis.com/auth/pubsub"

561 ]

562 },

563 "setIamPolicy": {

564 "description": "Sets the access control policy on th e specified resource. Replaces any\nexisting policy.",

565 "httpMethod": "POST",

566 "id": "pubsub.projects.subscriptions.setIamPolicy",

567 "parameterOrder": [

568 "resource"

569 ],

570 "parameters": {

571 "resource": {

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.",

573 "location": "path",

574 "pattern": "^projects/[^/]+/subscriptions/[^ /]+$",

575 "required": true,

576 "type": "string"

577 }

578 },

579 "path": "v1beta2/{+resource}:setIamPolicy",

580 "request": {

581 "$ref": "SetIamPolicyRequest"

582 },

583 "response": {

584 "$ref": "Policy"

585 },

586 "scopes": [

587 "https://www.googleapis.com/auth/cloud-platform" ,

588 "https://www.googleapis.com/auth/pubsub"

589 ]

590 },

591 "create": {

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.",

593 "httpMethod": "PUT",

594 "id": "pubsub.projects.subscriptions.create",

595 "parameterOrder": [

596 "name"

597 ],

598 "parameters": {

599 "name": {

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\"`.",

601 "location": "path",

602 "pattern": "^projects/[^/]+/subscriptions/[^ /]+$",

603 "required": true,

604 "type": "string"

605 }

606 },

607 "path": "v1beta2/{+name}",

608 "request": {

609 "$ref": "Subscription"

610 },

611 "response": {

612 "$ref": "Subscription"

613 },

614 "scopes": [

615 "https://www.googleapis.com/auth/cloud-platform" ,

616 "https://www.googleapis.com/auth/pubsub"

617 ]

618 },

619 "getIamPolicy": {

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.",

621 "httpMethod": "GET",

622 "id": "pubsub.projects.subscriptions.getIamPolicy",

623 "parameterOrder": [

624 "resource"

625 ],

626 "parameters": {

627 "resource": {

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.",

629 "location": "path",

630 "pattern": "^projects/[^/]+/subscriptions/[^ /]+$",

631 "required": true,

632 "type": "string"

633 }

634 },

635 "path": "v1beta2/{+resource}:getIamPolicy",

636 "response": {

637 "$ref": "Policy"

638 },

639 "scopes": [

640 "https://www.googleapis.com/auth/cloud-platform" ,

641 "https://www.googleapis.com/auth/pubsub"

642 ]

643 },

644 "modifyAckDeadline": {

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.",

646 "httpMethod": "POST",

647 "id": "pubsub.projects.subscriptions.modifyAckDeadli ne",

648 "parameterOrder": [

649 "subscription"

650 ],

651 "parameters": {

652 "subscription": {

653 "description": "The name of the subscription .",

654 "location": "path",

655 "pattern": "^projects/[^/]+/subscriptions/[^ /]+$",

656 "required": true,

657 "type": "string"

658 }

659 },

660 "path": "v1beta2/{+subscription}:modifyAckDeadline",

661 "request": {

662 "$ref": "ModifyAckDeadlineRequest"

663 },

664 "response": {

665 "$ref": "Empty"

666 },

667 "scopes": [

668 "https://www.googleapis.com/auth/cloud-platform" ,

669 "https://www.googleapis.com/auth/pubsub"

670 ]

671 },

672 "acknowledge": {

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.",

674 "httpMethod": "POST",

675 "id": "pubsub.projects.subscriptions.acknowledge",

676 "parameterOrder": [

677 "subscription"

678 ],

679 "parameters": {

680 "subscription": {

681 "description": "The subscription whose messa ge is being acknowledged.",

682 "location": "path",

683 "pattern": "^projects/[^/]+/subscriptions/[^ /]+$",

684 "required": true,

685 "type": "string"

686 }

687 },

688 "path": "v1beta2/{+subscription}:acknowledge",

689 "request": {

690 "$ref": "AcknowledgeRequest"

691 },

692 "response": {

693 "$ref": "Empty"

694 },

695 "scopes": [

696 "https://www.googleapis.com/auth/cloud-platform" ,

697 "https://www.googleapis.com/auth/pubsub"

698 ]

699 }

700 }

701 }	701 }

702 }	702 }

703 }	703 }

704 },	704 },

705 "revision": "20170731",	705 "revision": "20170829",

706 "rootUrl": "https://pubsub.googleapis.com/",	706 "rootUrl": "https://pubsub.googleapis.com/",

707 "schemas": {	707 "schemas": {

708 "ModifyAckDeadlineRequest": {	708 "ModifyPushConfigRequest": {

709 "description": "Request for the ModifyAckDeadline method.",	709 "description": "Request for the ModifyPushConfig method.",

710 "id": "ModifyAckDeadlineRequest",	710 "id": "ModifyPushConfigRequest",

711 "properties": {	711 "properties": {

712 "ackId": {	712 "pushConfig": {

713 "description": "The acknowledgment ID. Either this or ack_id s must be populated, but not\nboth.",	713 "$ref": "PushConfig",

714 "type": "string"	714 "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."

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 }	715 }

728 },	716 },

729 "type": "object"	717 "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 },	718 },

742 "PubsubMessage": {	719 "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.",	720 "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",	721 "id": "PubsubMessage",

745 "properties": {	722 "properties": {

	723 "data": {

	724 "description": "The message payload. For JSON requests, the value of this field must be\n[base64-encoded](https://tools.ietf.org/html/rfc464 8).",

	725 "format": "byte",

	726 "type": "string"

	727 },

746 "messageId": {	728 "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.",	729 "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"	730 "type": "string"

749 },	731 },

750 "attributes": {	732 "attributes": {

751 "additionalProperties": {	733 "additionalProperties": {

752 "type": "string"	734 "type": "string"

753 },	735 },

754 "description": "Optional attributes for this message.",	736 "description": "Optional attributes for this message.",

755 "type": "object"	737 "type": "object"

756 },	738 },

757 "publishTime": {	739 "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.",	740 "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",	741 "format": "google-datetime",

760 "type": "string"	742 "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 }	743 }

767 },	744 },

768 "type": "object"	745 "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 },	746 },

781 "Binding": {	747 "Binding": {

782 "description": "Associates `members` with a `role`.",	748 "description": "Associates `members` with a `role`.",

783 "id": "Binding",	749 "id": "Binding",

784 "properties": {	750 "properties": {

785 "members": {	751 "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",	752 "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": {	753 "items": {

788 "type": "string"	754 "type": "string"

789 },	755 },

790 "type": "array"	756 "type": "array"

791 },	757 },

792 "role": {	758 "role": {

793 "description": "Role that is assigned to `members`.\nFor exa mple, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",	759 "description": "Role that is assigned to `members`.\nFor exa mple, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",

794 "type": "string"	760 "type": "string"

795 }	761 }

796 },	762 },

797 "type": "object"	763 "type": "object"

798 },	764 },

799 "AcknowledgeRequest": {	765 "ListTopicsResponse": {

800 "description": "Request for the Acknowledge method.",	766 "description": "Response for the `ListTopics` method.",

801 "id": "AcknowledgeRequest",	767 "id": "ListTopicsResponse",

802 "properties": {	768 "properties": {

803 "ackIds": {	769 "nextPageToken": {

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.",	770 "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`.",

	771 "type": "string"

	772 },

	773 "topics": {

	774 "description": "The resulting topics.",

805 "items": {	775 "items": {

806 "type": "string"	776 "$ref": "Topic"

807 },	777 },

808 "type": "array"	778 "type": "array"

809 }	779 }

810 },	780 },

811 "type": "object"	781 "type": "object"

812 },	782 },

813 "Empty": {	783 "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 `{}`.",	784 "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",	785 "id": "Empty",

816 "properties": {},	786 "properties": {},

817 "type": "object"	787 "type": "object"

818 },	788 },

819 "ListTopicsResponse": {	789 "AcknowledgeRequest": {

820 "description": "Response for the `ListTopics` method.",	790 "description": "Request for the Acknowledge method.",

821 "id": "ListTopicsResponse",	791 "id": "AcknowledgeRequest",

822 "properties": {	792 "properties": {

823 "nextPageToken": {	793 "ackIds": {

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`.",	794 "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.",

825 "type": "string"

826 },

827 "topics": {

828 "description": "The resulting topics.",

829 "items": {	795 "items": {

830 "$ref": "Topic"	796 "type": "string"

831 },	797 },

832 "type": "array"	798 "type": "array"

833 }	799 }

834 },	800 },

835 "type": "object"	801 "type": "object"

836 },	802 },

837 "ListTopicSubscriptionsResponse": {	803 "ListTopicSubscriptionsResponse": {

838 "description": "Response for the `ListTopicSubscriptions` method.",	804 "description": "Response for the `ListTopicSubscriptions` method.",

839 "id": "ListTopicSubscriptionsResponse",	805 "id": "ListTopicSubscriptionsResponse",

840 "properties": {	806 "properties": {

(...skipping 131 matching lines...) Expand 10 before \| Expand all \| Expand 10 after Loading...
972 },	938 },

973 "type": "array"	939 "type": "array"

974 }	940 }

975 },	941 },

976 "type": "object"	942 "type": "object"

977 },	943 },

978 "Subscription": {	944 "Subscription": {

979 "description": "A subscription resource.",	945 "description": "A subscription resource.",

980 "id": "Subscription",	946 "id": "Subscription",

981 "properties": {	947 "properties": {

	948 "pushConfig": {

	949 "$ref": "PushConfig",

	950 "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."

	951 },

982 "ackDeadlineSeconds": {	952 "ackDeadlineSeconds": {

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.",	953 "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.",

984 "format": "int32",	954 "format": "int32",

985 "type": "integer"	955 "type": "integer"

986 },	956 },

987 "name": {	957 "name": {

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\"`.",	958 "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\"`.",

989 "type": "string"	959 "type": "string"

990 },	960 },

991 "topic": {	961 "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.",	962 "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"	963 "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."

998 }	964 }

999 },	965 },

1000 "type": "object"	966 "type": "object"

1001 },	967 },

1002 "TestIamPermissionsRequest": {	968 "TestIamPermissionsRequest": {

1003 "description": "Request message for `TestIamPermissions` method.",	969 "description": "Request message for `TestIamPermissions` method.",

1004 "id": "TestIamPermissionsRequest",	970 "id": "TestIamPermissionsRequest",

1005 "properties": {	971 "properties": {

1006 "permissions": {	972 "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).",	973 "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).",

1008 "items": {	974 "items": {

1009 "type": "string"	975 "type": "string"

1010 },	976 },

1011 "type": "array"	977 "type": "array"

1012 }	978 }

1013 },	979 },

1014 "type": "object"	980 "type": "object"

1015 },	981 },

1016 "Policy": {	982 "Policy": {

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\nExample\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).",	983 "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\nExample\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).",

1018 "id": "Policy",	984 "id": "Policy",

1019 "properties": {	985 "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 },

1027 "etag": {	986 "etag": {

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.",	987 "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.",

1029 "format": "byte",	988 "format": "byte",

1030 "type": "string"	989 "type": "string"

1031 },	990 },

1032 "version": {	991 "version": {

1033 "description": "Version of the `Policy`. The default version is 0.",	992 "description": "Version of the `Policy`. The default version is 0.",

1034 "format": "int32",	993 "format": "int32",

1035 "type": "integer"	994 "type": "integer"

	995 },

	996 "bindings": {

	997 "description": "Associates a list of `members` to a `role`.\ n`bindings` with no members will result in an error.",

	998 "items": {

	999 "$ref": "Binding"

	1000 },

	1001 "type": "array"

1036 }	1002 }

1037 },	1003 },

1038 "type": "object"	1004 "type": "object"

1039 },	1005 },

1040 "Topic": {	1006 "Topic": {

1041 "description": "A topic resource.",	1007 "description": "A topic resource.",

1042 "id": "Topic",	1008 "id": "Topic",

1043 "properties": {	1009 "properties": {

1044 "name": {	1010 "name": {

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\"`.",	1011 "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\"`.",

1046 "type": "string"	1012 "type": "string"

1047 }	1013 }

1048 },	1014 },

1049 "type": "object"	1015 "type": "object"

	1016 },

	1017 "ModifyAckDeadlineRequest": {

	1018 "description": "Request for the ModifyAckDeadline method.",

	1019 "id": "ModifyAckDeadlineRequest",

	1020 "properties": {

	1021 "ackId": {

	1022 "description": "The acknowledgment ID. Either this or ack_id s must be populated, but not\nboth.",

	1023 "type": "string"

	1024 },

	1025 "ackDeadlineSeconds": {

	1026 "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.",

	1027 "format": "int32",

	1028 "type": "integer"

	1029 },

	1030 "ackIds": {

	1031 "description": "List of acknowledgment IDs.",

	1032 "items": {

	1033 "type": "string"

	1034 },

	1035 "type": "array"

	1036 }

	1037 },

	1038 "type": "object"

	1039 },

	1040 "SetIamPolicyRequest": {

	1041 "description": "Request message for `SetIamPolicy` method.",

	1042 "id": "SetIamPolicyRequest",

	1043 "properties": {

	1044 "policy": {

	1045 "$ref": "Policy",

	1046 "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."

	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

« no previous file with comments | « discovery/googleapis_beta/proximitybeacon__v1beta1.json ('k') | discovery/googleapis_beta/replicapool__v1beta2.json » ('j') | no next file with comments »