discovery/googleapis_beta/pubsub__v1beta2.json - Issue 2936613002: Api-Roll 50: 2017-06-12

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

Issue 2936613002: Api-Roll 50: 2017-06-12 (Closed)

Patch Set: Created 3 years, 6 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 "access_token": {	31 "bearer_token": {

32 "description": "OAuth access token.",	32 "description": "OAuth bearer token.",

33 "location": "query",	33 "location": "query",

34 "type": "string"	34 "type": "string"

35 },	35 },

36 "key": {

37 "description": "API key. Your API key identifies your project and pr ovides you with API access, quota, and reports. Required unless you provide an O Auth 2.0 token.",

38 "location": "query",

39 "type": "string"

40 },

41 "quotaUser": {

42 "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exc eed 40 characters.",

43 "location": "query",

44 "type": "string"

45 },

46 "pp": {

47 "default": "true",

48 "description": "Pretty-print response.",

49 "location": "query",

50 "type": "boolean"

51 },

52 "oauth_token": {	36 "oauth_token": {

53 "description": "OAuth 2.0 token for the current user.",	37 "description": "OAuth 2.0 token for the current user.",

54 "location": "query",	38 "location": "query",

55 "type": "string"	39 "type": "string"

56 },	40 },

57 "bearer_token": {

58 "description": "OAuth bearer token.",

59 "location": "query",

60 "type": "string"

61 },

62 "upload_protocol": {	41 "upload_protocol": {

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

64 "location": "query",	43 "location": "query",

65 "type": "string"	44 "type": "string"

66 },	45 },

67 "prettyPrint": {	46 "prettyPrint": {

68 "default": "true",	47 "default": "true",

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

70 "location": "query",	49 "location": "query",

71 "type": "boolean"	50 "type": "boolean"

72 },	51 },

73 "fields": {	52 "fields": {

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

75 "location": "query",	54 "location": "query",

76 "type": "string"	55 "type": "string"

77 },	56 },

78 "uploadType": {	57 "uploadType": {

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

80 "location": "query",	59 "location": "query",

81 "type": "string"	60 "type": "string"

82 },	61 },

	62 "callback": {

	63 "description": "JSONP",

	64 "location": "query",

	65 "type": "string"

	66 },

83 "$.xgafv": {	67 "$.xgafv": {

84 "description": "V1 error format.",	68 "description": "V1 error format.",

85 "enum": [	69 "enum": [

86 "1",	70 "1",

87 "2"	71 "2"

88 ],	72 ],

89 "enumDescriptions": [	73 "enumDescriptions": [

90 "v1 error format",	74 "v1 error format",

91 "v2 error format"	75 "v2 error format"

92 ],	76 ],

93 "location": "query",	77 "location": "query",

94 "type": "string"	78 "type": "string"

95 },	79 },

96 "callback": {

97 "description": "JSONP",

98 "location": "query",

99 "type": "string"

100 },

101 "alt": {	80 "alt": {

102 "default": "json",	81 "default": "json",

103 "description": "Data format for response.",	82 "description": "Data format for response.",

104 "enum": [	83 "enum": [

105 "json",	84 "json",

106 "media",	85 "media",

107 "proto"	86 "proto"

108 ],	87 ],

109 "enumDescriptions": [	88 "enumDescriptions": [

110 "Responses with Content-Type of application/json",	89 "Responses with Content-Type of application/json",

111 "Media download with context-dependent Content-Type",	90 "Media download with context-dependent Content-Type",

112 "Responses with Content-Type of application/x-protobuf"	91 "Responses with Content-Type of application/x-protobuf"

113 ],	92 ],

114 "location": "query",	93 "location": "query",

115 "type": "string"	94 "type": "string"

	95 },

	96 "access_token": {

	97 "description": "OAuth access token.",

	98 "location": "query",

	99 "type": "string"

	100 },

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

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

	108 "location": "query",

	109 "type": "string"

	110 },

	111 "pp": {

	112 "default": "true",

	113 "description": "Pretty-print response.",

	114 "location": "query",

	115 "type": "boolean"

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

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

177 "testIamPermissions": {	124 "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. ",	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. ",

179 "httpMethod": "POST",	126 "httpMethod": "POST",

180 "id": "pubsub.projects.topics.testIamPermissions",	127 "id": "pubsub.projects.subscriptions.testIamPermissi ons",

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

182 "resource"	129 "resource"

183 ],	130 ],

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

185 "resource": {	132 "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.",	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.",

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

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

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

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

191 }	138 }

192 },	139 },

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

194 "request": {	141 "request": {

195 "$ref": "TestIamPermissionsRequest"	142 "$ref": "TestIamPermissionsRequest"

196 },	143 },

197 "response": {	144 "response": {

198 "$ref": "TestIamPermissionsResponse"	145 "$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 "modifyPushConfig": {

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

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

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

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 name of the subscription .",

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}:modifyPushConfig",

	169 "request": {

	170 "$ref": "ModifyPushConfigRequest"

	171 },

222 "response": {	172 "response": {

223 "$ref": "Empty"	173 "$ref": "Empty"

224 },	174 },

225 "scopes": [	175 "scopes": [

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

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

	178 ]

	179 },

	180 "delete": {

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

	182 "httpMethod": "DELETE",

	183 "id": "pubsub.projects.subscriptions.delete",

	184 "parameterOrder": [

	185 "subscription"

	186 ],

	187 "parameters": {

	188 "subscription": {

	189 "description": "The subscription to delete." ,

	190 "location": "path",

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

	192 "required": true,

	193 "type": "string"

	194 }

	195 },

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

	197 "response": {

	198 "$ref": "Empty"

	199 },

	200 "scopes": [

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

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

	203 ]

	204 },

	205 "pull": {

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

	207 "httpMethod": "POST",

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

	209 "parameterOrder": [

	210 "subscription"

	211 ],

	212 "parameters": {

	213 "subscription": {

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

	215 "location": "path",

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

	217 "required": true,

	218 "type": "string"

	219 }

	220 },

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

	222 "request": {

	223 "$ref": "PullRequest"

	224 },

	225 "response": {

	226 "$ref": "PullResponse"

	227 },

	228 "scopes": [

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

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

228 ]	231 ]

229 },	232 },

230 "list": {	233 "list": {

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

232 "httpMethod": "GET",	235 "httpMethod": "GET",

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

234 "parameterOrder": [	237 "parameterOrder": [

235 "project"	238 "project"

236 ],	239 ],

237 "parameters": {	240 "parameters": {

	241 "pageToken": {

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

	243 "location": "query",

	244 "type": "string"

	245 },

238 "pageSize": {	246 "pageSize": {

239 "description": "Maximum number of topics to return.",	247 "description": "Maximum number of subscripti ons to return.",

240 "format": "int32",	248 "format": "int32",

241 "location": "query",	249 "location": "query",

242 "type": "integer"	250 "type": "integer"

243 },	251 },

244 "project": {	252 "project": {

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

246 "location": "path",	254 "location": "path",

247 "pattern": "^projects/[^/]+$",	255 "pattern": "^projects/[^/]+$",

248 "required": true,	256 "required": true,

249 "type": "string"	257 "type": "string"

250 },

251 "pageToken": {

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

253 "location": "query",

254 "type": "string"

255 }	258 }

256 },	259 },

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

258 "response": {	261 "response": {

259 "$ref": "ListTopicsResponse"	262 "$ref": "ListSubscriptionsResponse"

260 },	263 },

261 "scopes": [	264 "scopes": [

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

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

264 ]

265 },

266 "setIamPolicy": {

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

268 "httpMethod": "POST",

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

270 "parameterOrder": [

271 "resource"

272 ],

273 "parameters": {

274 "resource": {

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

276 "location": "path",

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

278 "required": true,

279 "type": "string"

280 }

281 },

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

283 "request": {

284 "$ref": "SetIamPolicyRequest"

285 },

286 "response": {

287 "$ref": "Policy"

288 },

289 "scopes": [

290 "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 "create": {	269 "create": {

295 "description": "Creates the given topic with the giv en name.",	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.",

296 "httpMethod": "PUT",	271 "httpMethod": "PUT",

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

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

299 "name"	274 "name"

300 ],	275 ],

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

302 "name": {	277 "name": {

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

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/{+name}",	285 "path": "v1beta2/{+name}",

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

312 "$ref": "Topic"	287 "$ref": "Subscription"

313 },	288 },

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

315 "$ref": "Topic"	290 "$ref": "Subscription"

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

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": "Sets the access control policy on th e specified resource. Replaces any\nexisting policy.",

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

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

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 specified.\nSee the operation documentation for the app ropriate value for this field.",

332 "location": "path",

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

334 "required": true,

335 "type": "string"

336 }

337 },

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

339 "response": {

340 "$ref": "Policy"

341 },

342 "scopes": [

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

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

345 ]

346 }

347 },

348 "resources": {

349 "subscriptions": {

350 "methods": {

351 "list": {

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

353 "httpMethod": "GET",

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

355 "parameterOrder": [

356 "topic"

357 ],

358 "parameters": {

359 "pageToken": {

360 "description": "The value returned b y the last `ListTopicSubscriptionsResponse`; indicates\nthat this is a continuat ion of a prior `ListTopicSubscriptions` call, and\nthat the system should return the next page of data.",

361 "location": "query",

362 "type": "string"

363 },

364 "pageSize": {

365 "description": "Maximum number of su bscription names to return.",

366 "format": "int32",

367 "location": "query",

368 "type": "integer"

369 },

370 "topic": {

371 "description": "The name of the topi c that subscriptions are attached to.",

372 "location": "path",

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

374 "required": true,

375 "type": "string"

376 }

377 },

378 "path": "v1beta2/{+topic}/subscriptions",

379 "response": {

380 "$ref": "ListTopicSubscriptionsResponse"

381 },

382 "scopes": [

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

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

385 ]

386 }

387 }

388 }

389 }

390 },

391 "subscriptions": {

392 "methods": {

393 "getIamPolicy": {

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

395 "httpMethod": "GET",

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

397 "parameterOrder": [

398 "resource"

399 ],

400 "parameters": {

401 "resource": {

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

403 "location": "path",	307 "location": "path",

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

405 "required": true,	309 "required": true,

406 "type": "string"	310 "type": "string"

407 }	311 }

408 },	312 },

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

	314 "request": {

	315 "$ref": "SetIamPolicyRequest"

	316 },

410 "response": {	317 "response": {

411 "$ref": "Policy"	318 "$ref": "Policy"

412 },	319 },

413 "scopes": [	320 "scopes": [

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

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

416 ]	323 ]

417 },	324 },

418 "acknowledge": {	325 "acknowledge": {

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

(...skipping 44 matching lines...) Expand 10 before \| Expand all \| Expand 10 after Loading...
464 "$ref": "ModifyAckDeadlineRequest"	371 "$ref": "ModifyAckDeadlineRequest"

465 },	372 },

466 "response": {	373 "response": {

467 "$ref": "Empty"	374 "$ref": "Empty"

468 },	375 },

469 "scopes": [	376 "scopes": [

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

471 "https://www.googleapis.com/auth/pubsub"	378 "https://www.googleapis.com/auth/pubsub"

472 ]	379 ]

473 },	380 },

	381 "getIamPolicy": {

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

	383 "httpMethod": "GET",

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

	385 "parameterOrder": [

	386 "resource"

	387 ],

	388 "parameters": {

	389 "resource": {

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

	391 "location": "path",

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

	393 "required": true,

	394 "type": "string"

	395 }

	396 },

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

	398 "response": {

	399 "$ref": "Policy"

	400 },

	401 "scopes": [

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

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

	404 ]

	405 },

474 "get": {	406 "get": {

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

476 "httpMethod": "GET",	408 "httpMethod": "GET",

477 "id": "pubsub.projects.subscriptions.get",	409 "id": "pubsub.projects.subscriptions.get",

478 "parameterOrder": [	410 "parameterOrder": [

479 "subscription"	411 "subscription"

480 ],	412 ],

481 "parameters": {	413 "parameters": {

482 "subscription": {	414 "subscription": {

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

484 "location": "path",	416 "location": "path",

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

486 "required": true,	418 "required": true,

487 "type": "string"	419 "type": "string"

488 }	420 }

489 },	421 },

490 "path": "v1beta2/{+subscription}",	422 "path": "v1beta2/{+subscription}",

491 "response": {	423 "response": {

492 "$ref": "Subscription"	424 "$ref": "Subscription"

493 },	425 },

494 "scopes": [	426 "scopes": [

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

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

497 ]	429 ]

	430 }

	431 }

	432 },

	433 "topics": {

	434 "methods": {

	435 "create": {

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

	437 "httpMethod": "PUT",

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

	439 "parameterOrder": [

	440 "name"

	441 ],

	442 "parameters": {

	443 "name": {

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

	445 "location": "path",

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

	447 "required": true,

	448 "type": "string"

	449 }

	450 },

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

	452 "request": {

	453 "$ref": "Topic"

	454 },

	455 "response": {

	456 "$ref": "Topic"

	457 },

	458 "scopes": [

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

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

	461 ]

	462 },

	463 "setIamPolicy": {

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

	465 "httpMethod": "POST",

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

	467 "parameterOrder": [

	468 "resource"

	469 ],

	470 "parameters": {

	471 "resource": {

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

	473 "location": "path",

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

	475 "required": true,

	476 "type": "string"

	477 }

	478 },

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

	480 "request": {

	481 "$ref": "SetIamPolicyRequest"

	482 },

	483 "response": {

	484 "$ref": "Policy"

	485 },

	486 "scopes": [

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

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

	489 ]

	490 },

	491 "getIamPolicy": {

	492 "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a p olicy\nset.",

	493 "httpMethod": "GET",

	494 "id": "pubsub.projects.topics.getIamPolicy",

	495 "parameterOrder": [

	496 "resource"

	497 ],

	498 "parameters": {

	499 "resource": {

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

	501 "location": "path",

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

	503 "required": true,

	504 "type": "string"

	505 }

	506 },

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

	508 "response": {

	509 "$ref": "Policy"

	510 },

	511 "scopes": [

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

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

	514 ]

	515 },

	516 "get": {

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

	518 "httpMethod": "GET",

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

	520 "parameterOrder": [

	521 "topic"

	522 ],

	523 "parameters": {

	524 "topic": {

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

	526 "location": "path",

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

	528 "required": true,

	529 "type": "string"

	530 }

	531 },

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

	533 "response": {

	534 "$ref": "Topic"

	535 },

	536 "scopes": [

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

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

	539 ]

	540 },

	541 "publish": {

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

	543 "httpMethod": "POST",

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

	545 "parameterOrder": [

	546 "topic"

	547 ],

	548 "parameters": {

	549 "topic": {

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

	551 "location": "path",

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

	553 "required": true,

	554 "type": "string"

	555 }

	556 },

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

	558 "request": {

	559 "$ref": "PublishRequest"

	560 },

	561 "response": {

	562 "$ref": "PublishResponse"

	563 },

	564 "scopes": [

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

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

	567 ]

498 },	568 },

499 "testIamPermissions": {	569 "testIamPermissions": {

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

501 "httpMethod": "POST",	571 "httpMethod": "POST",

502 "id": "pubsub.projects.subscriptions.testIamPermissi ons",	572 "id": "pubsub.projects.topics.testIamPermissions",

503 "parameterOrder": [	573 "parameterOrder": [

504 "resource"	574 "resource"

505 ],	575 ],

506 "parameters": {	576 "parameters": {

507 "resource": {	577 "resource": {

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

509 "location": "path",	579 "location": "path",

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

511 "required": true,	581 "required": true,

512 "type": "string"	582 "type": "string"

513 }	583 }

514 },	584 },

515 "path": "v1beta2/{+resource}:testIamPermissions",	585 "path": "v1beta2/{+resource}:testIamPermissions",

516 "request": {	586 "request": {

517 "$ref": "TestIamPermissionsRequest"	587 "$ref": "TestIamPermissionsRequest"

518 },	588 },

519 "response": {	589 "response": {

520 "$ref": "TestIamPermissionsResponse"	590 "$ref": "TestIamPermissionsResponse"

521 },	591 },

522 "scopes": [	592 "scopes": [

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

524 "https://www.googleapis.com/auth/pubsub"	594 "https://www.googleapis.com/auth/pubsub"

525 ]	595 ]

526 },	596 },

527 "modifyPushConfig": {	597 "delete": {

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

529 "httpMethod": "POST",	599 "httpMethod": "DELETE",

530 "id": "pubsub.projects.subscriptions.modifyPushConfi g",	600 "id": "pubsub.projects.topics.delete",

531 "parameterOrder": [	601 "parameterOrder": [

532 "subscription"	602 "topic"

533 ],	603 ],

534 "parameters": {	604 "parameters": {

535 "subscription": {	605 "topic": {

536 "description": "The name of the subscription .",	606 "description": "Name of the topic to delete. ",

537 "location": "path",	607 "location": "path",

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

539 "required": true,	609 "required": true,

540 "type": "string"	610 "type": "string"

541 }	611 }

542 },	612 },

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

544 "request": {

545 "$ref": "ModifyPushConfigRequest"

546 },

547 "response": {	614 "response": {

548 "$ref": "Empty"	615 "$ref": "Empty"

549 },	616 },

550 "scopes": [	617 "scopes": [

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

552 "https://www.googleapis.com/auth/pubsub"	619 "https://www.googleapis.com/auth/pubsub"

553 ]	620 ]

554 },	621 },

555 "delete": {

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

557 "httpMethod": "DELETE",

558 "id": "pubsub.projects.subscriptions.delete",

559 "parameterOrder": [

560 "subscription"

561 ],

562 "parameters": {

563 "subscription": {

564 "description": "The subscription to delete." ,

565 "location": "path",

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

567 "required": true,

568 "type": "string"

569 }

570 },

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

572 "response": {

573 "$ref": "Empty"

574 },

575 "scopes": [

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

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

578 ]

579 },

580 "pull": {

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

582 "httpMethod": "POST",

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

584 "parameterOrder": [

585 "subscription"

586 ],

587 "parameters": {

588 "subscription": {

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

590 "location": "path",

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

592 "required": true,

593 "type": "string"

594 }

595 },

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

597 "request": {

598 "$ref": "PullRequest"

599 },

600 "response": {

601 "$ref": "PullResponse"

602 },

603 "scopes": [

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

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

606 ]

607 },

608 "list": {	622 "list": {

609 "description": "Lists matching subscriptions.",	623 "description": "Lists matching topics.",

610 "httpMethod": "GET",	624 "httpMethod": "GET",

611 "id": "pubsub.projects.subscriptions.list",	625 "id": "pubsub.projects.topics.list",

612 "parameterOrder": [	626 "parameterOrder": [

613 "project"	627 "project"

614 ],	628 ],

615 "parameters": {	629 "parameters": {

	630 "pageToken": {

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

	632 "location": "query",

	633 "type": "string"

	634 },

616 "pageSize": {	635 "pageSize": {

617 "description": "Maximum number of subscripti ons to return.",	636 "description": "Maximum number of topics to return.",

618 "format": "int32",	637 "format": "int32",

619 "location": "query",	638 "location": "query",

620 "type": "integer"	639 "type": "integer"

621 },	640 },

622 "project": {	641 "project": {

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

624 "location": "path",	643 "location": "path",

625 "pattern": "^projects/[^/]+$",	644 "pattern": "^projects/[^/]+$",

626 "required": true,	645 "required": true,

627 "type": "string"	646 "type": "string"

628 },	647 }

629 "pageToken": {	648 },

630 "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.",	649 "path": "v1beta2/{+project}/topics",

631 "location": "query",	650 "response": {

632 "type": "string"	651 "$ref": "ListTopicsResponse"

633 }	652 },

634 },	653 "scopes": [

635 "path": "v1beta2/{+project}/subscriptions",	654 "https://www.googleapis.com/auth/cloud-platform" ,

636 "response": {	655 "https://www.googleapis.com/auth/pubsub"

637 "$ref": "ListSubscriptionsResponse"	656 ]

638 },	657 }

639 "scopes": [	658 },

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

641 "https://www.googleapis.com/auth/pubsub"	660 "subscriptions": {

642 ]	661 "methods": {

643 },	662 "list": {

644 "create": {	663 "description": "Lists the name of the subscr iptions for this topic.",

645 "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.",	664 "httpMethod": "GET",

646 "httpMethod": "PUT",	665 "id": "pubsub.projects.topics.subscriptions. list",

647 "id": "pubsub.projects.subscriptions.create",	666 "parameterOrder": [

648 "parameterOrder": [	667 "topic"

649 "name"	668 ],

650 ],	669 "parameters": {

651 "parameters": {	670 "pageToken": {

652 "name": {	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.",

653 "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\"`.",	672 "location": "query",

654 "location": "path",	673 "type": "string"

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

656 "required": true,	675 "pageSize": {

657 "type": "string"	676 "description": "Maximum number of su bscription names to return.",

658 }	677 "format": "int32",

659 },	678 "location": "query",

660 "path": "v1beta2/{+name}",	679 "type": "integer"

661 "request": {	680 },

662 "$ref": "Subscription"	681 "topic": {

663 },	682 "description": "The name of the topi c that subscriptions are attached to.",

664 "response": {	683 "location": "path",

665 "$ref": "Subscription"	684 "pattern": "^projects/[^/]+/topics/[ ^/]+$",

666 },	685 "required": true,

667 "scopes": [	686 "type": "string"

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

669 "https://www.googleapis.com/auth/pubsub"	688 },

670 ]	689 "path": "v1beta2/{+topic}/subscriptions",

671 },	690 "response": {

672 "setIamPolicy": {	691 "$ref": "ListTopicSubscriptionsResponse"

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

674 "httpMethod": "POST",	693 "scopes": [

675 "id": "pubsub.projects.subscriptions.setIamPolicy",	694 "https://www.googleapis.com/auth/cloud-p latform",

676 "parameterOrder": [	695 "https://www.googleapis.com/auth/pubsub"

677 "resource"	696 ]

678 ],	697 }

679 "parameters": {	698 }

680 "resource": {

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

682 "location": "path",

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

684 "required": true,

685 "type": "string"

686 }

687 },

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

689 "request": {

690 "$ref": "SetIamPolicyRequest"

691 },

692 "response": {

693 "$ref": "Policy"

694 },

695 "scopes": [

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

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

698 ]

699 }	699 }

700 }	700 }

701 }	701 }

702 }	702 }

703 }	703 }

704 },	704 },

705 "revision": "20170502",	705 "revision": "20170502",

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

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

	714 "format": "int32",

	715 "type": "integer"

	716 },

	717 "ackIds": {

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

	719 "items": {

	720 "type": "string"

	721 },

	722 "type": "array"

	723 },

	724 "ackId": {

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

	726 "type": "string"

	727 }

	728 },

	729 "type": "object"

	730 },

708 "SetIamPolicyRequest": {	731 "SetIamPolicyRequest": {

709 "description": "Request message for `SetIamPolicy` method.",	732 "description": "Request message for `SetIamPolicy` method.",

710 "id": "SetIamPolicyRequest",	733 "id": "SetIamPolicyRequest",

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

712 "policy": {	735 "policy": {

713 "$ref": "Policy",	736 "$ref": "Policy",

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

715 }	738 }

716 },	739 },

717 "type": "object"	740 "type": "object"

718 },	741 },

	742 "ModifyPushConfigRequest": {

	743 "description": "Request for the ModifyPushConfig method.",

	744 "id": "ModifyPushConfigRequest",

	745 "properties": {

	746 "pushConfig": {

	747 "$ref": "PushConfig",

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

	749 }

	750 },

	751 "type": "object"

	752 },

719 "PubsubMessage": {	753 "PubsubMessage": {

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

721 "id": "PubsubMessage",	755 "id": "PubsubMessage",

722 "properties": {	756 "properties": {

	757 "data": {

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

	759 "format": "byte",

	760 "type": "string"

	761 },

723 "attributes": {	762 "attributes": {

724 "additionalProperties": {	763 "additionalProperties": {

725 "type": "string"	764 "type": "string"

726 },	765 },

727 "description": "Optional attributes for this message.",	766 "description": "Optional attributes for this message.",

728 "type": "object"	767 "type": "object"

729 },	768 },

730 "messageId": {	769 "messageId": {

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

732 "type": "string"	771 "type": "string"

733 },	772 },

734 "publishTime": {	773 "publishTime": {

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

736 "format": "google-datetime",	775 "format": "google-datetime",

737 "type": "string"	776 "type": "string"

738 },

739 "data": {

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

741 "format": "byte",

742 "type": "string"

743 }	777 }

744 },	778 },

745 "type": "object"	779 "type": "object"

746 },

747 "ModifyPushConfigRequest": {

748 "description": "Request for the ModifyPushConfig method.",

749 "id": "ModifyPushConfigRequest",

750 "properties": {

751 "pushConfig": {

752 "$ref": "PushConfig",

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

754 }

755 },

756 "type": "object"

757 },	780 },

758 "Binding": {	781 "Binding": {

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

760 "id": "Binding",	783 "id": "Binding",

761 "properties": {	784 "properties": {

762 "members": {	785 "members": {

763 "description": "Specifies the identities requesting access f or a Cloud Platform resource.\n`members` can have the following values:\n\n* `al lUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special ident ifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a spec ific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\ n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{e mailid}`: An email address that represents a Google group.\n For example, `adm ins@example.com`.\n\n* `domain:{domain}`: A Google Apps domain name that represe nts all the\n users of that domain. For example, `google.com` or `example.com` .\n\n",	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* `domain:{domain}`: A Google Apps domain name that represe nts all the\n users of that domain. For example, `google.com` or `example.com` .\n\n",

764 "items": {	787 "items": {

765 "type": "string"	788 "type": "string"

766 },	789 },

767 "type": "array"	790 "type": "array"

768 },	791 },

769 "role": {	792 "role": {

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

771 "type": "string"	794 "type": "string"

772 }	795 }

773 },	796 },

774 "type": "object"	797 "type": "object"

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

776 "ListTopicsResponse": {	813 "ListTopicsResponse": {

777 "description": "Response for the `ListTopics` method.",	814 "description": "Response for the `ListTopics` method.",

778 "id": "ListTopicsResponse",	815 "id": "ListTopicsResponse",

779 "properties": {	816 "properties": {

780 "nextPageToken": {	817 "nextPageToken": {

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

782 "type": "string"	819 "type": "string"

783 },	820 },

784 "topics": {	821 "topics": {

785 "description": "The resulting topics.",	822 "description": "The resulting topics.",

786 "items": {	823 "items": {

787 "$ref": "Topic"	824 "$ref": "Topic"

788 },	825 },

789 "type": "array"	826 "type": "array"

790 }	827 }

791 },	828 },

792 "type": "object"	829 "type": "object"

793 },	830 },

794 "Empty": {	831 "Empty": {

795 "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 `{}`.",	832 "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 `{}`.",

796 "id": "Empty",	833 "id": "Empty",

797 "properties": {},	834 "properties": {},

798 "type": "object"	835 "type": "object"

799 },	836 },

800 "AcknowledgeRequest": {

801 "description": "Request for the Acknowledge method.",

802 "id": "AcknowledgeRequest",

803 "properties": {

804 "ackIds": {

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

806 "items": {

807 "type": "string"

808 },

809 "type": "array"

810 }

811 },

812 "type": "object"

813 },

814 "ListTopicSubscriptionsResponse": {	837 "ListTopicSubscriptionsResponse": {

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

816 "id": "ListTopicSubscriptionsResponse",	839 "id": "ListTopicSubscriptionsResponse",

817 "properties": {	840 "properties": {

818 "nextPageToken": {	841 "nextPageToken": {

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

820 "type": "string"	843 "type": "string"

821 },	844 },

822 "subscriptions": {	845 "subscriptions": {

823 "description": "The names of the subscriptions that match th e request.",	846 "description": "The names of the subscriptions that match th e request.",

(...skipping 159 matching lines...) Expand 10 before \| Expand all \| Expand 10 after Loading...
983 "permissions": {	1006 "permissions": {

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

985 "items": {	1008 "items": {

986 "type": "string"	1009 "type": "string"

987 },	1010 },

988 "type": "array"	1011 "type": "array"

989 }	1012 }

990 },	1013 },

991 "type": "object"	1014 "type": "object"

992 },	1015 },

993 "Policy": {

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

995 "id": "Policy",

996 "properties": {

997 "bindings": {

998 "description": "Associates a list of `members` to a `role`.\ nMultiple `bindings` must not be specified for the same `role`.\n`bindings` with no members will result in an error.",

999 "items": {

1000 "$ref": "Binding"

1001 },

1002 "type": "array"

1003 },

1004 "etag": {

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

1006 "format": "byte",

1007 "type": "string"

1008 },

1009 "version": {

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

1011 "format": "int32",

1012 "type": "integer"

1013 }

1014 },

1015 "type": "object"

1016 },

1017 "Topic": {	1016 "Topic": {

1018 "description": "A topic resource.",	1017 "description": "A topic resource.",

1019 "id": "Topic",	1018 "id": "Topic",

1020 "properties": {	1019 "properties": {

1021 "name": {	1020 "name": {

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

1023 "type": "string"	1022 "type": "string"

1024 }	1023 }

1025 },	1024 },

1026 "type": "object"	1025 "type": "object"

1027 },	1026 },

1028 "ModifyAckDeadlineRequest": {	1027 "Policy": {

1029 "description": "Request for the ModifyAckDeadline method.",	1028 "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).",

1030 "id": "ModifyAckDeadlineRequest",	1029 "id": "Policy",

1031 "properties": {	1030 "properties": {

1032 "ackId": {	1031 "etag": {

1033 "description": "The acknowledgment ID. Either this or ack_id s must be populated, but not\nboth.",	1032 "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.",

	1033 "format": "byte",

1034 "type": "string"	1034 "type": "string"

1035 },	1035 },

1036 "ackDeadlineSeconds": {	1036 "version": {

1037 "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.",	1037 "description": "Version of the `Policy`. The default version is 0.",

1038 "format": "int32",	1038 "format": "int32",

1039 "type": "integer"	1039 "type": "integer"

1040 },	1040 },

1041 "ackIds": {	1041 "bindings": {

1042 "description": "List of acknowledgment IDs.",	1042 "description": "Associates a list of `members` to a `role`.\ nMultiple `bindings` must not be specified for the same `role`.\n`bindings` with no members will result in an error.",

1043 "items": {	1043 "items": {

1044 "type": "string"	1044 "$ref": "Binding"

1045 },	1045 },

1046 "type": "array"	1046 "type": "array"

1047 }	1047 }

1048 },	1048 },

1049 "type": "object"	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/runtimeconfig__v1beta1.json » ('j') | no next file with comments »