OLD | NEW |
1 { | 1 { |
2 "auth": { | 2 "auth": { |
3 "oauth2": { | 3 "oauth2": { |
4 "scopes": { | 4 "scopes": { |
| 5 "https://www.googleapis.com/auth/pubsub": { |
| 6 "description": "View and manage Pub/Sub topics and subscript
ions" |
| 7 }, |
5 "https://www.googleapis.com/auth/cloud-platform": { | 8 "https://www.googleapis.com/auth/cloud-platform": { |
6 "description": "View and manage your data across Google Clou
d Platform services" | 9 "description": "View and manage your data across Google Clou
d Platform services" |
7 }, | |
8 "https://www.googleapis.com/auth/pubsub": { | |
9 "description": "View and manage Pub/Sub topics and subscript
ions" | |
10 } | 10 } |
11 } | 11 } |
12 } | 12 } |
13 }, | 13 }, |
14 "basePath": "", | 14 "basePath": "", |
15 "baseUrl": "https://pubsub.googleapis.com/", | 15 "baseUrl": "https://pubsub.googleapis.com/", |
16 "batchPath": "batch", | 16 "batchPath": "batch", |
17 "canonicalName": "Pubsub", | 17 "canonicalName": "Pubsub", |
18 "description": "Provides reliable, many-to-many, asynchronous messaging betw
een applications.\n", | 18 "description": "Provides reliable, many-to-many, asynchronous messaging betw
een applications.\n", |
19 "discoveryVersion": "v1", | 19 "discoveryVersion": "v1", |
20 "documentationLink": "https://cloud.google.com/pubsub/docs", | 20 "documentationLink": "https://cloud.google.com/pubsub/docs", |
21 "icons": { | 21 "icons": { |
22 "x16": "http://www.google.com/images/icons/product/search-16.gif", | 22 "x16": "http://www.google.com/images/icons/product/search-16.gif", |
23 "x32": "http://www.google.com/images/icons/product/search-32.gif" | 23 "x32": "http://www.google.com/images/icons/product/search-32.gif" |
24 }, | 24 }, |
25 "id": "pubsub:v1", | 25 "id": "pubsub:v1", |
26 "kind": "discovery#restDescription", | 26 "kind": "discovery#restDescription", |
27 "name": "pubsub", | 27 "name": "pubsub", |
28 "ownerDomain": "google.com", | 28 "ownerDomain": "google.com", |
29 "ownerName": "Google", | 29 "ownerName": "Google", |
30 "parameters": { | 30 "parameters": { |
31 "key": { | |
32 "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.", | |
33 "location": "query", | |
34 "type": "string" | |
35 }, | |
36 "access_token": { | |
37 "description": "OAuth access 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": { | |
53 "description": "OAuth 2.0 token for the current user.", | |
54 "location": "query", | |
55 "type": "string" | |
56 }, | |
57 "bearer_token": { | |
58 "description": "OAuth bearer token.", | |
59 "location": "query", | |
60 "type": "string" | |
61 }, | |
62 "upload_protocol": { | 31 "upload_protocol": { |
63 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", | 32 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", |
64 "location": "query", | 33 "location": "query", |
65 "type": "string" | 34 "type": "string" |
66 }, | 35 }, |
67 "prettyPrint": { | 36 "prettyPrint": { |
68 "default": "true", | 37 "default": "true", |
69 "description": "Returns response with indentations and line breaks."
, | 38 "description": "Returns response with indentations and line breaks."
, |
70 "location": "query", | 39 "location": "query", |
71 "type": "boolean" | 40 "type": "boolean" |
(...skipping 34 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
106 "media", | 75 "media", |
107 "proto" | 76 "proto" |
108 ], | 77 ], |
109 "enumDescriptions": [ | 78 "enumDescriptions": [ |
110 "Responses with Content-Type of application/json", | 79 "Responses with Content-Type of application/json", |
111 "Media download with context-dependent Content-Type", | 80 "Media download with context-dependent Content-Type", |
112 "Responses with Content-Type of application/x-protobuf" | 81 "Responses with Content-Type of application/x-protobuf" |
113 ], | 82 ], |
114 "location": "query", | 83 "location": "query", |
115 "type": "string" | 84 "type": "string" |
| 85 }, |
| 86 "key": { |
| 87 "description": "API key. Your API key identifies your project and pr
ovides you with API access, quota, and reports. Required unless you provide an O
Auth 2.0 token.", |
| 88 "location": "query", |
| 89 "type": "string" |
| 90 }, |
| 91 "access_token": { |
| 92 "description": "OAuth access token.", |
| 93 "location": "query", |
| 94 "type": "string" |
| 95 }, |
| 96 "quotaUser": { |
| 97 "description": "Available to use for quota purposes for server-side
applications. Can be any arbitrary string assigned to a user, but should not exc
eed 40 characters.", |
| 98 "location": "query", |
| 99 "type": "string" |
| 100 }, |
| 101 "pp": { |
| 102 "default": "true", |
| 103 "description": "Pretty-print response.", |
| 104 "location": "query", |
| 105 "type": "boolean" |
| 106 }, |
| 107 "oauth_token": { |
| 108 "description": "OAuth 2.0 token for the current user.", |
| 109 "location": "query", |
| 110 "type": "string" |
| 111 }, |
| 112 "bearer_token": { |
| 113 "description": "OAuth bearer token.", |
| 114 "location": "query", |
| 115 "type": "string" |
116 } | 116 } |
117 }, | 117 }, |
118 "protocol": "rest", | 118 "protocol": "rest", |
119 "resources": { | 119 "resources": { |
120 "projects": { | 120 "projects": { |
121 "resources": { | 121 "resources": { |
122 "topics": { | 122 "topics": { |
123 "methods": { | 123 "methods": { |
124 "getIamPolicy": { | 124 "getIamPolicy": { |
125 "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.", | 125 "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.", |
(...skipping 127 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
253 ] | 253 ] |
254 }, | 254 }, |
255 "list": { | 255 "list": { |
256 "description": "Lists matching topics.", | 256 "description": "Lists matching topics.", |
257 "httpMethod": "GET", | 257 "httpMethod": "GET", |
258 "id": "pubsub.projects.topics.list", | 258 "id": "pubsub.projects.topics.list", |
259 "parameterOrder": [ | 259 "parameterOrder": [ |
260 "project" | 260 "project" |
261 ], | 261 ], |
262 "parameters": { | 262 "parameters": { |
263 "pageToken": { | |
264 "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.", | |
265 "location": "query", | |
266 "type": "string" | |
267 }, | |
268 "pageSize": { | 263 "pageSize": { |
269 "description": "Maximum number of topics to
return.", | 264 "description": "Maximum number of topics to
return.", |
270 "format": "int32", | 265 "format": "int32", |
271 "location": "query", | 266 "location": "query", |
272 "type": "integer" | 267 "type": "integer" |
273 }, | 268 }, |
274 "project": { | 269 "project": { |
275 "description": "The name of the cloud projec
t that topics belong to.\nFormat is `projects/{project}`.", | 270 "description": "The name of the cloud projec
t that topics belong to.\nFormat is `projects/{project}`.", |
276 "location": "path", | 271 "location": "path", |
277 "pattern": "^projects/[^/]+$", | 272 "pattern": "^projects/[^/]+$", |
278 "required": true, | 273 "required": true, |
279 "type": "string" | 274 "type": "string" |
| 275 }, |
| 276 "pageToken": { |
| 277 "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.", |
| 278 "location": "query", |
| 279 "type": "string" |
280 } | 280 } |
281 }, | 281 }, |
282 "path": "v1/{+project}/topics", | 282 "path": "v1/{+project}/topics", |
283 "response": { | 283 "response": { |
284 "$ref": "ListTopicsResponse" | 284 "$ref": "ListTopicsResponse" |
285 }, | 285 }, |
286 "scopes": [ | 286 "scopes": [ |
287 "https://www.googleapis.com/auth/cloud-platform"
, | 287 "https://www.googleapis.com/auth/cloud-platform"
, |
288 "https://www.googleapis.com/auth/pubsub" | 288 "https://www.googleapis.com/auth/pubsub" |
289 ] | 289 ] |
(...skipping 93 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
383 "https://www.googleapis.com/auth/cloud-p
latform", | 383 "https://www.googleapis.com/auth/cloud-p
latform", |
384 "https://www.googleapis.com/auth/pubsub" | 384 "https://www.googleapis.com/auth/pubsub" |
385 ] | 385 ] |
386 } | 386 } |
387 } | 387 } |
388 } | 388 } |
389 } | 389 } |
390 }, | 390 }, |
391 "snapshots": { | 391 "snapshots": { |
392 "methods": { | 392 "methods": { |
393 "setIamPolicy": { | |
394 "description": "Sets the access control policy on th
e specified resource. Replaces any\nexisting policy.", | |
395 "httpMethod": "POST", | |
396 "id": "pubsub.projects.snapshots.setIamPolicy", | |
397 "parameterOrder": [ | |
398 "resource" | |
399 ], | |
400 "parameters": { | |
401 "resource": { | |
402 "description": "REQUIRED: The resource for w
hich the policy is being specified.\nSee the operation documentation for the app
ropriate value for this field.", | |
403 "location": "path", | |
404 "pattern": "^projects/[^/]+/snapshots/[^/]+$
", | |
405 "required": true, | |
406 "type": "string" | |
407 } | |
408 }, | |
409 "path": "v1/{+resource}:setIamPolicy", | |
410 "request": { | |
411 "$ref": "SetIamPolicyRequest" | |
412 }, | |
413 "response": { | |
414 "$ref": "Policy" | |
415 }, | |
416 "scopes": [ | |
417 "https://www.googleapis.com/auth/cloud-platform"
, | |
418 "https://www.googleapis.com/auth/pubsub" | |
419 ] | |
420 }, | |
421 "testIamPermissions": { | 393 "testIamPermissions": { |
422 "description": "Returns permissions that a caller ha
s on the specified resource.\nIf the resource does not exist, this will return a
n empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is d
esigned to be used for building permission-aware\nUIs and command-line tools, no
t for authorization checking. This operation\nmay \"fail open\" without warning.
", | 394 "description": "Returns permissions that a caller ha
s on the specified resource.\nIf the resource does not exist, this will return a
n empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is d
esigned to be used for building permission-aware\nUIs and command-line tools, no
t for authorization checking. This operation\nmay \"fail open\" without warning.
", |
423 "httpMethod": "POST", | 395 "httpMethod": "POST", |
424 "id": "pubsub.projects.snapshots.testIamPermissions"
, | 396 "id": "pubsub.projects.snapshots.testIamPermissions"
, |
425 "parameterOrder": [ | 397 "parameterOrder": [ |
426 "resource" | 398 "resource" |
427 ], | 399 ], |
428 "parameters": { | 400 "parameters": { |
429 "resource": { | 401 "resource": { |
430 "description": "REQUIRED: The resource for w
hich the policy detail is being requested.\nSee the operation documentation for
the appropriate value for this field.", | 402 "description": "REQUIRED: The resource for w
hich the policy detail is being requested.\nSee the operation documentation for
the appropriate value for this field.", |
(...skipping 32 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
463 } | 435 } |
464 }, | 436 }, |
465 "path": "v1/{+resource}:getIamPolicy", | 437 "path": "v1/{+resource}:getIamPolicy", |
466 "response": { | 438 "response": { |
467 "$ref": "Policy" | 439 "$ref": "Policy" |
468 }, | 440 }, |
469 "scopes": [ | 441 "scopes": [ |
470 "https://www.googleapis.com/auth/cloud-platform"
, | 442 "https://www.googleapis.com/auth/cloud-platform"
, |
471 "https://www.googleapis.com/auth/pubsub" | 443 "https://www.googleapis.com/auth/pubsub" |
472 ] | 444 ] |
473 } | |
474 } | |
475 }, | |
476 "subscriptions": { | |
477 "methods": { | |
478 "list": { | |
479 "description": "Lists matching subscriptions.", | |
480 "httpMethod": "GET", | |
481 "id": "pubsub.projects.subscriptions.list", | |
482 "parameterOrder": [ | |
483 "project" | |
484 ], | |
485 "parameters": { | |
486 "project": { | |
487 "description": "The name of the cloud projec
t that subscriptions belong to.\nFormat is `projects/{project}`.", | |
488 "location": "path", | |
489 "pattern": "^projects/[^/]+$", | |
490 "required": true, | |
491 "type": "string" | |
492 }, | |
493 "pageToken": { | |
494 "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.", | |
495 "location": "query", | |
496 "type": "string" | |
497 }, | |
498 "pageSize": { | |
499 "description": "Maximum number of subscripti
ons to return.", | |
500 "format": "int32", | |
501 "location": "query", | |
502 "type": "integer" | |
503 } | |
504 }, | |
505 "path": "v1/{+project}/subscriptions", | |
506 "response": { | |
507 "$ref": "ListSubscriptionsResponse" | |
508 }, | |
509 "scopes": [ | |
510 "https://www.googleapis.com/auth/cloud-platform"
, | |
511 "https://www.googleapis.com/auth/pubsub" | |
512 ] | |
513 }, | 445 }, |
514 "setIamPolicy": { | 446 "setIamPolicy": { |
515 "description": "Sets the access control policy on th
e specified resource. Replaces any\nexisting policy.", | 447 "description": "Sets the access control policy on th
e specified resource. Replaces any\nexisting policy.", |
516 "httpMethod": "POST", | 448 "httpMethod": "POST", |
517 "id": "pubsub.projects.subscriptions.setIamPolicy", | 449 "id": "pubsub.projects.snapshots.setIamPolicy", |
518 "parameterOrder": [ | 450 "parameterOrder": [ |
519 "resource" | 451 "resource" |
520 ], | 452 ], |
521 "parameters": { | 453 "parameters": { |
522 "resource": { | 454 "resource": { |
523 "description": "REQUIRED: The resource for w
hich the policy is being specified.\nSee the operation documentation for the app
ropriate value for this field.", | 455 "description": "REQUIRED: The resource for w
hich the policy is being specified.\nSee the operation documentation for the app
ropriate value for this field.", |
524 "location": "path", | 456 "location": "path", |
525 "pattern": "^projects/[^/]+/subscriptions/[^
/]+$", | 457 "pattern": "^projects/[^/]+/snapshots/[^/]+$
", |
526 "required": true, | 458 "required": true, |
527 "type": "string" | 459 "type": "string" |
528 } | 460 } |
529 }, | 461 }, |
530 "path": "v1/{+resource}:setIamPolicy", | 462 "path": "v1/{+resource}:setIamPolicy", |
531 "request": { | 463 "request": { |
532 "$ref": "SetIamPolicyRequest" | 464 "$ref": "SetIamPolicyRequest" |
533 }, | 465 }, |
534 "response": { | 466 "response": { |
535 "$ref": "Policy" | 467 "$ref": "Policy" |
536 }, | 468 }, |
537 "scopes": [ | 469 "scopes": [ |
538 "https://www.googleapis.com/auth/cloud-platform"
, | 470 "https://www.googleapis.com/auth/cloud-platform"
, |
539 "https://www.googleapis.com/auth/pubsub" | 471 "https://www.googleapis.com/auth/pubsub" |
540 ] | 472 ] |
541 }, | 473 } |
542 "create": { | 474 } |
543 "description": "Creates a subscription to a given to
pic.\nIf the subscription already exists, returns `ALREADY_EXISTS`.\nIf the corr
esponding topic doesn't exist, returns `NOT_FOUND`.\n\nIf the name is not provid
ed in the request, the server will assign a random\nname for this subscription o
n the same project as the topic, conforming\nto the\n[resource name format](http
s://cloud.google.com/pubsub/docs/overview#names).\nThe generated name is populat
ed in the returned Subscription object.\nNote that for REST API requests, you mu
st specify a name in the request.", | 475 }, |
544 "httpMethod": "PUT", | 476 "subscriptions": { |
545 "id": "pubsub.projects.subscriptions.create", | 477 "methods": { |
| 478 "testIamPermissions": { |
| 479 "description": "Returns permissions that a caller ha
s on the specified resource.\nIf the resource does not exist, this will return a
n empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is d
esigned to be used for building permission-aware\nUIs and command-line tools, no
t for authorization checking. This operation\nmay \"fail open\" without warning.
", |
| 480 "httpMethod": "POST", |
| 481 "id": "pubsub.projects.subscriptions.testIamPermissi
ons", |
546 "parameterOrder": [ | 482 "parameterOrder": [ |
547 "name" | 483 "resource" |
548 ], | 484 ], |
549 "parameters": { | 485 "parameters": { |
550 "name": { | 486 "resource": { |
551 "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\"`.", | 487 "description": "REQUIRED: The resource for w
hich the policy detail is being requested.\nSee the operation documentation for
the appropriate value for this field.", |
552 "location": "path", | 488 "location": "path", |
553 "pattern": "^projects/[^/]+/subscriptions/[^
/]+$", | 489 "pattern": "^projects/[^/]+/subscriptions/[^
/]+$", |
554 "required": true, | 490 "required": true, |
555 "type": "string" | 491 "type": "string" |
556 } | 492 } |
557 }, | 493 }, |
558 "path": "v1/{+name}", | 494 "path": "v1/{+resource}:testIamPermissions", |
559 "request": { | 495 "request": { |
560 "$ref": "Subscription" | 496 "$ref": "TestIamPermissionsRequest" |
561 }, | 497 }, |
562 "response": { | 498 "response": { |
563 "$ref": "Subscription" | 499 "$ref": "TestIamPermissionsResponse" |
564 }, | 500 }, |
565 "scopes": [ | 501 "scopes": [ |
566 "https://www.googleapis.com/auth/cloud-platform"
, | 502 "https://www.googleapis.com/auth/cloud-platform"
, |
567 "https://www.googleapis.com/auth/pubsub" | 503 "https://www.googleapis.com/auth/pubsub" |
568 ] | 504 ] |
569 }, | 505 }, |
570 "acknowledge": { | 506 "modifyPushConfig": { |
571 "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.", | 507 "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`
.", |
572 "httpMethod": "POST", | 508 "httpMethod": "POST", |
573 "id": "pubsub.projects.subscriptions.acknowledge", | 509 "id": "pubsub.projects.subscriptions.modifyPushConfi
g", |
574 "parameterOrder": [ | 510 "parameterOrder": [ |
575 "subscription" | 511 "subscription" |
576 ], | 512 ], |
577 "parameters": { | 513 "parameters": { |
578 "subscription": { | 514 "subscription": { |
579 "description": "The subscription whose messa
ge is being acknowledged.\nFormat is `projects/{project}/subscriptions/{sub}`.", | 515 "description": "The name of the subscription
.\nFormat is `projects/{project}/subscriptions/{sub}`.", |
580 "location": "path", | 516 "location": "path", |
581 "pattern": "^projects/[^/]+/subscriptions/[^
/]+$", | 517 "pattern": "^projects/[^/]+/subscriptions/[^
/]+$", |
582 "required": true, | 518 "required": true, |
583 "type": "string" | 519 "type": "string" |
584 } | 520 } |
585 }, | 521 }, |
586 "path": "v1/{+subscription}:acknowledge", | 522 "path": "v1/{+subscription}:modifyPushConfig", |
587 "request": { | 523 "request": { |
588 "$ref": "AcknowledgeRequest" | 524 "$ref": "ModifyPushConfigRequest" |
589 }, | 525 }, |
590 "response": { | 526 "response": { |
591 "$ref": "Empty" | 527 "$ref": "Empty" |
592 }, | 528 }, |
593 "scopes": [ | 529 "scopes": [ |
594 "https://www.googleapis.com/auth/cloud-platform"
, | 530 "https://www.googleapis.com/auth/cloud-platform"
, |
595 "https://www.googleapis.com/auth/pubsub" | 531 "https://www.googleapis.com/auth/pubsub" |
596 ] | 532 ] |
597 }, | 533 }, |
598 "modifyAckDeadline": { | 534 "pull": { |
599 "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.", | 535 "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.", |
600 "httpMethod": "POST", | 536 "httpMethod": "POST", |
601 "id": "pubsub.projects.subscriptions.modifyAckDeadli
ne", | 537 "id": "pubsub.projects.subscriptions.pull", |
602 "parameterOrder": [ | 538 "parameterOrder": [ |
603 "subscription" | 539 "subscription" |
604 ], | 540 ], |
605 "parameters": { | 541 "parameters": { |
606 "subscription": { | 542 "subscription": { |
607 "description": "The name of the subscription
.\nFormat is `projects/{project}/subscriptions/{sub}`.", | 543 "description": "The subscription from which
messages should be pulled.\nFormat is `projects/{project}/subscriptions/{sub}`."
, |
608 "location": "path", | 544 "location": "path", |
609 "pattern": "^projects/[^/]+/subscriptions/[^
/]+$", | 545 "pattern": "^projects/[^/]+/subscriptions/[^
/]+$", |
610 "required": true, | 546 "required": true, |
611 "type": "string" | 547 "type": "string" |
612 } | 548 } |
613 }, | 549 }, |
614 "path": "v1/{+subscription}:modifyAckDeadline", | 550 "path": "v1/{+subscription}:pull", |
615 "request": { | 551 "request": { |
616 "$ref": "ModifyAckDeadlineRequest" | 552 "$ref": "PullRequest" |
617 }, | 553 }, |
618 "response": { | 554 "response": { |
| 555 "$ref": "PullResponse" |
| 556 }, |
| 557 "scopes": [ |
| 558 "https://www.googleapis.com/auth/cloud-platform"
, |
| 559 "https://www.googleapis.com/auth/pubsub" |
| 560 ] |
| 561 }, |
| 562 "delete": { |
| 563 "description": "Deletes an existing subscription. Al
l messages retained in the subscription\nare immediately dropped. Calls to `Pull
` after deletion will return\n`NOT_FOUND`. After a subscription is deleted, a ne
w one may be created with\nthe same name, but the new one has no association wit
h the old\nsubscription or its topic unless the same topic is specified.", |
| 564 "httpMethod": "DELETE", |
| 565 "id": "pubsub.projects.subscriptions.delete", |
| 566 "parameterOrder": [ |
| 567 "subscription" |
| 568 ], |
| 569 "parameters": { |
| 570 "subscription": { |
| 571 "description": "The subscription to delete.\
nFormat is `projects/{project}/subscriptions/{sub}`.", |
| 572 "location": "path", |
| 573 "pattern": "^projects/[^/]+/subscriptions/[^
/]+$", |
| 574 "required": true, |
| 575 "type": "string" |
| 576 } |
| 577 }, |
| 578 "path": "v1/{+subscription}", |
| 579 "response": { |
619 "$ref": "Empty" | 580 "$ref": "Empty" |
620 }, | 581 }, |
621 "scopes": [ | 582 "scopes": [ |
622 "https://www.googleapis.com/auth/cloud-platform"
, | 583 "https://www.googleapis.com/auth/cloud-platform"
, |
623 "https://www.googleapis.com/auth/pubsub" | 584 "https://www.googleapis.com/auth/pubsub" |
624 ] | 585 ] |
625 }, | 586 }, |
| 587 "list": { |
| 588 "description": "Lists matching subscriptions.", |
| 589 "httpMethod": "GET", |
| 590 "id": "pubsub.projects.subscriptions.list", |
| 591 "parameterOrder": [ |
| 592 "project" |
| 593 ], |
| 594 "parameters": { |
| 595 "pageSize": { |
| 596 "description": "Maximum number of subscripti
ons to return.", |
| 597 "format": "int32", |
| 598 "location": "query", |
| 599 "type": "integer" |
| 600 }, |
| 601 "project": { |
| 602 "description": "The name of the cloud projec
t that subscriptions belong to.\nFormat is `projects/{project}`.", |
| 603 "location": "path", |
| 604 "pattern": "^projects/[^/]+$", |
| 605 "required": true, |
| 606 "type": "string" |
| 607 }, |
| 608 "pageToken": { |
| 609 "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.", |
| 610 "location": "query", |
| 611 "type": "string" |
| 612 } |
| 613 }, |
| 614 "path": "v1/{+project}/subscriptions", |
| 615 "response": { |
| 616 "$ref": "ListSubscriptionsResponse" |
| 617 }, |
| 618 "scopes": [ |
| 619 "https://www.googleapis.com/auth/cloud-platform"
, |
| 620 "https://www.googleapis.com/auth/pubsub" |
| 621 ] |
| 622 }, |
| 623 "create": { |
| 624 "description": "Creates a subscription to a given to
pic.\nIf the subscription already exists, returns `ALREADY_EXISTS`.\nIf the corr
esponding topic doesn't exist, returns `NOT_FOUND`.\n\nIf the name is not provid
ed in the request, the server will assign a random\nname for this subscription o
n the same project as the topic, conforming\nto the\n[resource name format](http
s://cloud.google.com/pubsub/docs/overview#names).\nThe generated name is populat
ed in the returned Subscription object.\nNote that for REST API requests, you mu
st specify a name in the request.", |
| 625 "httpMethod": "PUT", |
| 626 "id": "pubsub.projects.subscriptions.create", |
| 627 "parameterOrder": [ |
| 628 "name" |
| 629 ], |
| 630 "parameters": { |
| 631 "name": { |
| 632 "description": "The name of the subscription
. It must have the format\n`\"projects/{project}/subscriptions/{subscription}\"`
. `{subscription}` must\nstart with a letter, and contain only letters (`[A-Za-z
]`), numbers\n(`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes
(`~`),\nplus (`+`) or percent signs (`%`). It must be between 3 and 255 characte
rs\nin length, and it must not start with `\"goog\"`.", |
| 633 "location": "path", |
| 634 "pattern": "^projects/[^/]+/subscriptions/[^
/]+$", |
| 635 "required": true, |
| 636 "type": "string" |
| 637 } |
| 638 }, |
| 639 "path": "v1/{+name}", |
| 640 "request": { |
| 641 "$ref": "Subscription" |
| 642 }, |
| 643 "response": { |
| 644 "$ref": "Subscription" |
| 645 }, |
| 646 "scopes": [ |
| 647 "https://www.googleapis.com/auth/cloud-platform"
, |
| 648 "https://www.googleapis.com/auth/pubsub" |
| 649 ] |
| 650 }, |
| 651 "setIamPolicy": { |
| 652 "description": "Sets the access control policy on th
e specified resource. Replaces any\nexisting policy.", |
| 653 "httpMethod": "POST", |
| 654 "id": "pubsub.projects.subscriptions.setIamPolicy", |
| 655 "parameterOrder": [ |
| 656 "resource" |
| 657 ], |
| 658 "parameters": { |
| 659 "resource": { |
| 660 "description": "REQUIRED: The resource for w
hich the policy is being specified.\nSee the operation documentation for the app
ropriate value for this field.", |
| 661 "location": "path", |
| 662 "pattern": "^projects/[^/]+/subscriptions/[^
/]+$", |
| 663 "required": true, |
| 664 "type": "string" |
| 665 } |
| 666 }, |
| 667 "path": "v1/{+resource}:setIamPolicy", |
| 668 "request": { |
| 669 "$ref": "SetIamPolicyRequest" |
| 670 }, |
| 671 "response": { |
| 672 "$ref": "Policy" |
| 673 }, |
| 674 "scopes": [ |
| 675 "https://www.googleapis.com/auth/cloud-platform"
, |
| 676 "https://www.googleapis.com/auth/pubsub" |
| 677 ] |
| 678 }, |
626 "getIamPolicy": { | 679 "getIamPolicy": { |
627 "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.", | 680 "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.", |
628 "httpMethod": "GET", | 681 "httpMethod": "GET", |
629 "id": "pubsub.projects.subscriptions.getIamPolicy", | 682 "id": "pubsub.projects.subscriptions.getIamPolicy", |
630 "parameterOrder": [ | 683 "parameterOrder": [ |
631 "resource" | 684 "resource" |
632 ], | 685 ], |
633 "parameters": { | 686 "parameters": { |
634 "resource": { | 687 "resource": { |
635 "description": "REQUIRED: The resource for w
hich the policy is being requested.\nSee the operation documentation for the app
ropriate value for this field.", | 688 "description": "REQUIRED: The resource for w
hich the policy is being requested.\nSee the operation documentation for the app
ropriate value for this field.", |
636 "location": "path", | 689 "location": "path", |
637 "pattern": "^projects/[^/]+/subscriptions/[^
/]+$", | 690 "pattern": "^projects/[^/]+/subscriptions/[^
/]+$", |
638 "required": true, | 691 "required": true, |
639 "type": "string" | 692 "type": "string" |
640 } | 693 } |
641 }, | 694 }, |
642 "path": "v1/{+resource}:getIamPolicy", | 695 "path": "v1/{+resource}:getIamPolicy", |
643 "response": { | 696 "response": { |
644 "$ref": "Policy" | 697 "$ref": "Policy" |
645 }, | 698 }, |
646 "scopes": [ | 699 "scopes": [ |
647 "https://www.googleapis.com/auth/cloud-platform"
, | 700 "https://www.googleapis.com/auth/cloud-platform"
, |
648 "https://www.googleapis.com/auth/pubsub" | 701 "https://www.googleapis.com/auth/pubsub" |
649 ] | 702 ] |
650 }, | 703 }, |
651 "get": { | 704 "acknowledge": { |
652 "description": "Gets the configuration details of a
subscription.", | 705 "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.", |
653 "httpMethod": "GET", | 706 "httpMethod": "POST", |
654 "id": "pubsub.projects.subscriptions.get", | 707 "id": "pubsub.projects.subscriptions.acknowledge", |
655 "parameterOrder": [ | 708 "parameterOrder": [ |
656 "subscription" | 709 "subscription" |
657 ], | 710 ], |
658 "parameters": { | 711 "parameters": { |
659 "subscription": { | 712 "subscription": { |
660 "description": "The name of the subscription
to get.\nFormat is `projects/{project}/subscriptions/{sub}`.", | 713 "description": "The subscription whose messa
ge is being acknowledged.\nFormat is `projects/{project}/subscriptions/{sub}`.", |
661 "location": "path", | 714 "location": "path", |
662 "pattern": "^projects/[^/]+/subscriptions/[^
/]+$", | 715 "pattern": "^projects/[^/]+/subscriptions/[^
/]+$", |
663 "required": true, | 716 "required": true, |
664 "type": "string" | 717 "type": "string" |
665 } | 718 } |
666 }, | 719 }, |
667 "path": "v1/{+subscription}", | 720 "path": "v1/{+subscription}:acknowledge", |
668 "response": { | |
669 "$ref": "Subscription" | |
670 }, | |
671 "scopes": [ | |
672 "https://www.googleapis.com/auth/cloud-platform"
, | |
673 "https://www.googleapis.com/auth/pubsub" | |
674 ] | |
675 }, | |
676 "testIamPermissions": { | |
677 "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.
", | |
678 "httpMethod": "POST", | |
679 "id": "pubsub.projects.subscriptions.testIamPermissi
ons", | |
680 "parameterOrder": [ | |
681 "resource" | |
682 ], | |
683 "parameters": { | |
684 "resource": { | |
685 "description": "REQUIRED: The resource for w
hich the policy detail is being requested.\nSee the operation documentation for
the appropriate value for this field.", | |
686 "location": "path", | |
687 "pattern": "^projects/[^/]+/subscriptions/[^
/]+$", | |
688 "required": true, | |
689 "type": "string" | |
690 } | |
691 }, | |
692 "path": "v1/{+resource}:testIamPermissions", | |
693 "request": { | 721 "request": { |
694 "$ref": "TestIamPermissionsRequest" | 722 "$ref": "AcknowledgeRequest" |
695 }, | |
696 "response": { | |
697 "$ref": "TestIamPermissionsResponse" | |
698 }, | |
699 "scopes": [ | |
700 "https://www.googleapis.com/auth/cloud-platform"
, | |
701 "https://www.googleapis.com/auth/pubsub" | |
702 ] | |
703 }, | |
704 "modifyPushConfig": { | |
705 "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`
.", | |
706 "httpMethod": "POST", | |
707 "id": "pubsub.projects.subscriptions.modifyPushConfi
g", | |
708 "parameterOrder": [ | |
709 "subscription" | |
710 ], | |
711 "parameters": { | |
712 "subscription": { | |
713 "description": "The name of the subscription
.\nFormat is `projects/{project}/subscriptions/{sub}`.", | |
714 "location": "path", | |
715 "pattern": "^projects/[^/]+/subscriptions/[^
/]+$", | |
716 "required": true, | |
717 "type": "string" | |
718 } | |
719 }, | |
720 "path": "v1/{+subscription}:modifyPushConfig", | |
721 "request": { | |
722 "$ref": "ModifyPushConfigRequest" | |
723 }, | 723 }, |
724 "response": { | 724 "response": { |
725 "$ref": "Empty" | 725 "$ref": "Empty" |
726 }, | 726 }, |
727 "scopes": [ | 727 "scopes": [ |
728 "https://www.googleapis.com/auth/cloud-platform"
, | 728 "https://www.googleapis.com/auth/cloud-platform"
, |
729 "https://www.googleapis.com/auth/pubsub" | 729 "https://www.googleapis.com/auth/pubsub" |
730 ] | 730 ] |
731 }, | 731 }, |
732 "pull": { | 732 "modifyAckDeadline": { |
733 "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.", | 733 "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.", |
734 "httpMethod": "POST", | 734 "httpMethod": "POST", |
735 "id": "pubsub.projects.subscriptions.pull", | 735 "id": "pubsub.projects.subscriptions.modifyAckDeadli
ne", |
736 "parameterOrder": [ | 736 "parameterOrder": [ |
737 "subscription" | 737 "subscription" |
738 ], | 738 ], |
739 "parameters": { | 739 "parameters": { |
740 "subscription": { | 740 "subscription": { |
741 "description": "The subscription from which
messages should be pulled.\nFormat is `projects/{project}/subscriptions/{sub}`."
, | 741 "description": "The name of the subscription
.\nFormat is `projects/{project}/subscriptions/{sub}`.", |
742 "location": "path", | 742 "location": "path", |
743 "pattern": "^projects/[^/]+/subscriptions/[^
/]+$", | 743 "pattern": "^projects/[^/]+/subscriptions/[^
/]+$", |
744 "required": true, | 744 "required": true, |
745 "type": "string" | 745 "type": "string" |
746 } | 746 } |
747 }, | 747 }, |
748 "path": "v1/{+subscription}:pull", | 748 "path": "v1/{+subscription}:modifyAckDeadline", |
749 "request": { | 749 "request": { |
750 "$ref": "PullRequest" | 750 "$ref": "ModifyAckDeadlineRequest" |
751 }, | 751 }, |
752 "response": { | 752 "response": { |
753 "$ref": "PullResponse" | 753 "$ref": "Empty" |
754 }, | 754 }, |
755 "scopes": [ | 755 "scopes": [ |
756 "https://www.googleapis.com/auth/cloud-platform"
, | 756 "https://www.googleapis.com/auth/cloud-platform"
, |
757 "https://www.googleapis.com/auth/pubsub" | 757 "https://www.googleapis.com/auth/pubsub" |
758 ] | 758 ] |
759 }, | 759 }, |
760 "delete": { | 760 "get": { |
761 "description": "Deletes an existing subscription. Al
l messages retained in the subscription\nare immediately dropped. Calls to `Pull
` after deletion will return\n`NOT_FOUND`. After a subscription is deleted, a ne
w one may be created with\nthe same name, but the new one has no association wit
h the old\nsubscription or its topic unless the same topic is specified.", | 761 "description": "Gets the configuration details of a
subscription.", |
762 "httpMethod": "DELETE", | 762 "httpMethod": "GET", |
763 "id": "pubsub.projects.subscriptions.delete", | 763 "id": "pubsub.projects.subscriptions.get", |
764 "parameterOrder": [ | 764 "parameterOrder": [ |
765 "subscription" | 765 "subscription" |
766 ], | 766 ], |
767 "parameters": { | 767 "parameters": { |
768 "subscription": { | 768 "subscription": { |
769 "description": "The subscription to delete.\
nFormat is `projects/{project}/subscriptions/{sub}`.", | 769 "description": "The name of the subscription
to get.\nFormat is `projects/{project}/subscriptions/{sub}`.", |
770 "location": "path", | 770 "location": "path", |
771 "pattern": "^projects/[^/]+/subscriptions/[^
/]+$", | 771 "pattern": "^projects/[^/]+/subscriptions/[^
/]+$", |
772 "required": true, | 772 "required": true, |
773 "type": "string" | 773 "type": "string" |
774 } | 774 } |
775 }, | 775 }, |
776 "path": "v1/{+subscription}", | 776 "path": "v1/{+subscription}", |
777 "response": { | 777 "response": { |
778 "$ref": "Empty" | 778 "$ref": "Subscription" |
779 }, | 779 }, |
780 "scopes": [ | 780 "scopes": [ |
781 "https://www.googleapis.com/auth/cloud-platform"
, | 781 "https://www.googleapis.com/auth/cloud-platform"
, |
782 "https://www.googleapis.com/auth/pubsub" | 782 "https://www.googleapis.com/auth/pubsub" |
783 ] | 783 ] |
784 } | 784 } |
785 } | 785 } |
786 } | 786 } |
787 } | 787 } |
788 } | 788 } |
789 }, | 789 }, |
790 "revision": "20170630", | 790 "revision": "20170630", |
791 "rootUrl": "https://pubsub.googleapis.com/", | 791 "rootUrl": "https://pubsub.googleapis.com/", |
792 "schemas": { | 792 "schemas": { |
793 "SetIamPolicyRequest": { | 793 "PullRequest": { |
794 "description": "Request message for `SetIamPolicy` method.", | 794 "description": "Request for the `Pull` method.", |
795 "id": "SetIamPolicyRequest", | 795 "id": "PullRequest", |
796 "properties": { | 796 "properties": { |
797 "policy": { | 797 "returnImmediately": { |
798 "$ref": "Policy", | 798 "description": "If this field set to true, the system will r
espond immediately even if\nit there are no messages available to return in the
`Pull` response.\nOtherwise, the system may wait (for a bounded amount of time)
until at\nleast one message is available, rather than returning no messages. The
\nclient may cancel the request if it does not wish to wait any longer for\nthe
response.", |
799 "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." | 799 "type": "boolean" |
| 800 }, |
| 801 "maxMessages": { |
| 802 "description": "The maximum number of messages returned for
this request. The Pub/Sub\nsystem may return fewer than the number specified.", |
| 803 "format": "int32", |
| 804 "type": "integer" |
800 } | 805 } |
801 }, | 806 }, |
802 "type": "object" | 807 "type": "object" |
803 }, | 808 }, |
804 "PubsubMessage": { | 809 "ListSubscriptionsResponse": { |
805 "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.", | 810 "description": "Response for the `ListSubscriptions` method.", |
806 "id": "PubsubMessage", | 811 "id": "ListSubscriptionsResponse", |
807 "properties": { | 812 "properties": { |
808 "messageId": { | 813 "nextPageToken": { |
809 "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.", | 814 "description": "If not empty, indicates that there may be mo
re subscriptions that match\nthe request; this value should be passed in a new\n
`ListSubscriptionsRequest` to get more subscriptions.", |
810 "type": "string" | 815 "type": "string" |
811 }, | 816 }, |
812 "attributes": { | 817 "subscriptions": { |
813 "additionalProperties": { | 818 "description": "The subscriptions that match the request.", |
814 "type": "string" | 819 "items": { |
| 820 "$ref": "Subscription" |
815 }, | 821 }, |
816 "description": "Optional attributes for this message.", | 822 "type": "array" |
817 "type": "object" | |
818 }, | |
819 "publishTime": { | |
820 "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.", | |
821 "format": "google-datetime", | |
822 "type": "string" | |
823 }, | |
824 "data": { | |
825 "description": "The message payload.", | |
826 "format": "byte", | |
827 "type": "string" | |
828 } | 823 } |
829 }, | 824 }, |
830 "type": "object" | 825 "type": "object" |
831 }, | 826 }, |
832 "ModifyPushConfigRequest": { | 827 "PublishRequest": { |
833 "description": "Request for the ModifyPushConfig method.", | 828 "description": "Request for the Publish method.", |
834 "id": "ModifyPushConfigRequest", | 829 "id": "PublishRequest", |
835 "properties": { | 830 "properties": { |
836 "pushConfig": { | 831 "messages": { |
837 "$ref": "PushConfig", | 832 "description": "The messages to publish.", |
838 "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." | 833 "items": { |
| 834 "$ref": "PubsubMessage" |
| 835 }, |
| 836 "type": "array" |
839 } | 837 } |
840 }, | 838 }, |
841 "type": "object" | 839 "type": "object" |
842 }, | 840 }, |
843 "Binding": { | 841 "PublishResponse": { |
844 "description": "Associates `members` with a `role`.", | 842 "description": "Response for the `Publish` method.", |
845 "id": "Binding", | 843 "id": "PublishResponse", |
846 "properties": { | 844 "properties": { |
847 "role": { | 845 "messageIds": { |
848 "description": "Role that is assigned to `members`.\nFor exa
mple, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired", | 846 "description": "The server-assigned ID of each published mes
sage, in the same order as\nthe messages in the request. IDs are guaranteed to b
e unique within\nthe topic.", |
849 "type": "string" | |
850 }, | |
851 "members": { | |
852 "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", | |
853 "items": { | 847 "items": { |
854 "type": "string" | 848 "type": "string" |
855 }, | 849 }, |
856 "type": "array" | 850 "type": "array" |
857 } | 851 } |
858 }, | 852 }, |
859 "type": "object" | 853 "type": "object" |
860 }, | 854 }, |
861 "AcknowledgeRequest": { | 855 "Subscription": { |
862 "description": "Request for the Acknowledge method.", | 856 "description": "A subscription resource.", |
863 "id": "AcknowledgeRequest", | 857 "id": "Subscription", |
864 "properties": { | 858 "properties": { |
865 "ackIds": { | 859 "topic": { |
866 "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.", | 860 "description": "The name of the topic from which this subscr
iption is receiving messages.\nFormat is `projects/{project}/topics/{topic}`.\nT
he value of this field will be `_deleted-topic_` if the topic has been\ndeleted.
", |
| 861 "type": "string" |
| 862 }, |
| 863 "pushConfig": { |
| 864 "$ref": "PushConfig", |
| 865 "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." |
| 866 }, |
| 867 "ackDeadlineSeconds": { |
| 868 "description": "This value is the maximum time after a subsc
riber receives a message\nbefore the subscriber should acknowledge the message.
After message\ndelivery but before the ack deadline expires and before the messa
ge is\nacknowledged, it is an outstanding message and will not be delivered\naga
in during that time (on a best-effort basis).\n\nFor pull subscriptions, this va
lue is used as the initial value for the ack\ndeadline. To override this value f
or a given message, call\n`ModifyAckDeadline` with the corresponding `ack_id` if
using\npull.\nThe minimum custom deadline you can specify is 10 seconds.\nThe m
aximum custom deadline you can specify is 600 seconds (10 minutes).\nIf this par
ameter is 0, a default value of 10 seconds is used.\n\nFor push delivery, this v
alue is also used to set the request timeout for\nthe call to the push endpoint.
\n\nIf the subscriber never acknowledges the message, the Pub/Sub\nsystem will e
ventually redeliver the message.", |
| 869 "format": "int32", |
| 870 "type": "integer" |
| 871 }, |
| 872 "name": { |
| 873 "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\"`.", |
| 874 "type": "string" |
| 875 } |
| 876 }, |
| 877 "type": "object" |
| 878 }, |
| 879 "TestIamPermissionsRequest": { |
| 880 "description": "Request message for `TestIamPermissions` method.", |
| 881 "id": "TestIamPermissionsRequest", |
| 882 "properties": { |
| 883 "permissions": { |
| 884 "description": "The set of permissions to check for the `res
ource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed
. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/ov
erview#permissions).", |
867 "items": { | 885 "items": { |
868 "type": "string" | 886 "type": "string" |
869 }, | 887 }, |
870 "type": "array" | 888 "type": "array" |
871 } | 889 } |
872 }, | 890 }, |
873 "type": "object" | 891 "type": "object" |
874 }, | 892 }, |
875 "Empty": { | 893 "Topic": { |
876 "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 `{}`.", | 894 "description": "A topic resource.", |
877 "id": "Empty", | 895 "id": "Topic", |
878 "properties": {}, | 896 "properties": { |
| 897 "name": { |
| 898 "description": "The name of the topic. It must have the form
at\n`\"projects/{project}/topics/{topic}\"`. `{topic}` must start with a letter,
\nand contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`),\nunder
scores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent\nsigns (`%`). I
t must be between 3 and 255 characters in length, and it\nmust not start with `\
"goog\"`.", |
| 899 "type": "string" |
| 900 } |
| 901 }, |
879 "type": "object" | 902 "type": "object" |
880 }, | 903 }, |
881 "ListTopicsResponse": { | 904 "Policy": { |
882 "description": "Response for the `ListTopics` method.", | 905 "description": "Defines an Identity and Access Management (IAM) poli
cy. It is used to\nspecify access control policies for Cloud Platform resources.
\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n
`members` to a `role`, where the members can be user accounts, Google groups,\nG
oogle domains, and service accounts. A `role` is a named list of permissions\nde
fined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n
\"role\": \"roles/owner\",\n \"members\": [\n \"user:mike
@example.com\",\n \"group:admins@example.com\",\n \"domain
:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccoun
t.com\",\n ]\n },\n {\n \"role\": \"roles/viewer
\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n
}\n\nFor a description of IAM and its features, see the\n[IAM developer's guide
](https://cloud.google.com/iam).", |
883 "id": "ListTopicsResponse", | 906 "id": "Policy", |
884 "properties": { | 907 "properties": { |
885 "nextPageToken": { | 908 "etag": { |
886 "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`.", | 909 "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.", |
| 910 "format": "byte", |
887 "type": "string" | 911 "type": "string" |
888 }, | 912 }, |
889 "topics": { | 913 "version": { |
890 "description": "The resulting topics.", | 914 "description": "Version of the `Policy`. The default version
is 0.", |
| 915 "format": "int32", |
| 916 "type": "integer" |
| 917 }, |
| 918 "bindings": { |
| 919 "description": "Associates a list of `members` to a `role`.\
n`bindings` with no members will result in an error.", |
891 "items": { | 920 "items": { |
892 "$ref": "Topic" | 921 "$ref": "Binding" |
893 }, | 922 }, |
894 "type": "array" | 923 "type": "array" |
895 } | 924 } |
896 }, | 925 }, |
897 "type": "object" | 926 "type": "object" |
898 }, | 927 }, |
899 "ListTopicSubscriptionsResponse": { | 928 "ModifyAckDeadlineRequest": { |
900 "description": "Response for the `ListTopicSubscriptions` method.", | 929 "description": "Request for the ModifyAckDeadline method.", |
901 "id": "ListTopicSubscriptionsResponse", | 930 "id": "ModifyAckDeadlineRequest", |
902 "properties": { | 931 "properties": { |
903 "nextPageToken": { | 932 "ackDeadlineSeconds": { |
904 "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.", | 933 "description": "The new ack deadline with respect to the tim
e this request was sent to\nthe Pub/Sub system. For example, if the value is 10,
the new\nack deadline will expire 10 seconds after the `ModifyAckDeadline` call
\nwas made. Specifying zero may immediately make the message available for\nanot
her pull request.\nThe minimum deadline you can specify is 0 seconds.\nThe maxim
um deadline you can specify is 600 seconds (10 minutes).", |
905 "type": "string" | 934 "format": "int32", |
| 935 "type": "integer" |
906 }, | 936 }, |
907 "subscriptions": { | 937 "ackIds": { |
908 "description": "The names of the subscriptions that match th
e request.", | 938 "description": "List of acknowledgment IDs.", |
909 "items": { | 939 "items": { |
910 "type": "string" | 940 "type": "string" |
911 }, | 941 }, |
912 "type": "array" | 942 "type": "array" |
913 } | 943 } |
914 }, | 944 }, |
915 "type": "object" | 945 "type": "object" |
916 }, | 946 }, |
917 "PullResponse": { | 947 "SetIamPolicyRequest": { |
918 "description": "Response for the `Pull` method.", | 948 "description": "Request message for `SetIamPolicy` method.", |
919 "id": "PullResponse", | 949 "id": "SetIamPolicyRequest", |
920 "properties": { | 950 "properties": { |
921 "receivedMessages": { | 951 "policy": { |
922 "description": "Received Pub/Sub messages. The Pub/Sub syste
m will return zero messages if\nthere are no more available in the backlog. The
Pub/Sub system may return\nfewer than the `maxMessages` requested even if there
are more messages\navailable in the backlog.", | 952 "$ref": "Policy", |
| 953 "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." |
| 954 } |
| 955 }, |
| 956 "type": "object" |
| 957 }, |
| 958 "ModifyPushConfigRequest": { |
| 959 "description": "Request for the ModifyPushConfig method.", |
| 960 "id": "ModifyPushConfigRequest", |
| 961 "properties": { |
| 962 "pushConfig": { |
| 963 "$ref": "PushConfig", |
| 964 "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." |
| 965 } |
| 966 }, |
| 967 "type": "object" |
| 968 }, |
| 969 "PubsubMessage": { |
| 970 "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.", |
| 971 "id": "PubsubMessage", |
| 972 "properties": { |
| 973 "data": { |
| 974 "description": "The message payload.", |
| 975 "format": "byte", |
| 976 "type": "string" |
| 977 }, |
| 978 "messageId": { |
| 979 "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.", |
| 980 "type": "string" |
| 981 }, |
| 982 "attributes": { |
| 983 "additionalProperties": { |
| 984 "type": "string" |
| 985 }, |
| 986 "description": "Optional attributes for this message.", |
| 987 "type": "object" |
| 988 }, |
| 989 "publishTime": { |
| 990 "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.", |
| 991 "format": "google-datetime", |
| 992 "type": "string" |
| 993 } |
| 994 }, |
| 995 "type": "object" |
| 996 }, |
| 997 "Binding": { |
| 998 "description": "Associates `members` with a `role`.", |
| 999 "id": "Binding", |
| 1000 "properties": { |
| 1001 "members": { |
| 1002 "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", |
923 "items": { | 1003 "items": { |
924 "$ref": "ReceivedMessage" | 1004 "type": "string" |
| 1005 }, |
| 1006 "type": "array" |
| 1007 }, |
| 1008 "role": { |
| 1009 "description": "Role that is assigned to `members`.\nFor exa
mple, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired", |
| 1010 "type": "string" |
| 1011 } |
| 1012 }, |
| 1013 "type": "object" |
| 1014 }, |
| 1015 "ListTopicsResponse": { |
| 1016 "description": "Response for the `ListTopics` method.", |
| 1017 "id": "ListTopicsResponse", |
| 1018 "properties": { |
| 1019 "nextPageToken": { |
| 1020 "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`.", |
| 1021 "type": "string" |
| 1022 }, |
| 1023 "topics": { |
| 1024 "description": "The resulting topics.", |
| 1025 "items": { |
| 1026 "$ref": "Topic" |
925 }, | 1027 }, |
926 "type": "array" | 1028 "type": "array" |
927 } | 1029 } |
928 }, | 1030 }, |
929 "type": "object" | 1031 "type": "object" |
930 }, | 1032 }, |
931 "ReceivedMessage": { | 1033 "Empty": { |
932 "description": "A message and its corresponding acknowledgment ID.", | 1034 "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 `{}`.", |
933 "id": "ReceivedMessage", | 1035 "id": "Empty", |
934 "properties": { | 1036 "properties": {}, |
935 "message": { | |
936 "$ref": "PubsubMessage", | |
937 "description": "The message." | |
938 }, | |
939 "ackId": { | |
940 "description": "This ID can be used to acknowledge the recei
ved message.", | |
941 "type": "string" | |
942 } | |
943 }, | |
944 "type": "object" | 1037 "type": "object" |
945 }, | 1038 }, |
946 "PushConfig": { | 1039 "AcknowledgeRequest": { |
947 "description": "Configuration for a push delivery endpoint.", | 1040 "description": "Request for the Acknowledge method.", |
948 "id": "PushConfig", | 1041 "id": "AcknowledgeRequest", |
949 "properties": { | 1042 "properties": { |
950 "attributes": { | 1043 "ackIds": { |
951 "additionalProperties": { | 1044 "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.", |
952 "type": "string" | |
953 }, | |
954 "description": "Endpoint configuration attributes.\n\nEvery
endpoint has a set of API supported attributes that can be used to\ncontrol diff
erent aspects of the message delivery.\n\nThe currently supported attribute is `
x-goog-version`, which you can\nuse to change the format of the pushed message.
This attribute\nindicates the version of the data expected by the endpoint. This
\ncontrols the shape of the pushed message (i.e., its fields and metadata).\nThe
endpoint version is based on the version of the Pub/Sub API.\n\nIf not present
during the `CreateSubscription` call, it will default to\nthe version of the API
used to make such call. If not present during a\n`ModifyPushConfig` call, its v
alue will not be changed. `GetSubscription`\ncalls will always return a valid ve
rsion, even if the subscription was\ncreated without this attribute.\n\nThe poss
ible values for this attribute are:\n\n* `v1beta1`: uses the push format defined
in the v1beta1 Pub/Sub API.\n* `v1` or `v1beta2`: uses the push format defined
in the v1 Pub/Sub API.", | |
955 "type": "object" | |
956 }, | |
957 "pushEndpoint": { | |
958 "description": "A URL locating the endpoint to which message
s should be pushed.\nFor example, a Webhook endpoint might use \"https://example
.com/push\".", | |
959 "type": "string" | |
960 } | |
961 }, | |
962 "type": "object" | |
963 }, | |
964 "TestIamPermissionsResponse": { | |
965 "description": "Response message for `TestIamPermissions` method.", | |
966 "id": "TestIamPermissionsResponse", | |
967 "properties": { | |
968 "permissions": { | |
969 "description": "A subset of `TestPermissionsRequest.permissi
ons` that the caller is\nallowed.", | |
970 "items": { | 1045 "items": { |
971 "type": "string" | 1046 "type": "string" |
972 }, | 1047 }, |
973 "type": "array" | |
974 } | |
975 }, | |
976 "type": "object" | |
977 }, | |
978 "PullRequest": { | |
979 "description": "Request for the `Pull` method.", | |
980 "id": "PullRequest", | |
981 "properties": { | |
982 "returnImmediately": { | |
983 "description": "If this field set to true, the system will r
espond immediately even if\nit there are no messages available to return in the
`Pull` response.\nOtherwise, the system may wait (for a bounded amount of time)
until at\nleast one message is available, rather than returning no messages. The
\nclient may cancel the request if it does not wish to wait any longer for\nthe
response.", | |
984 "type": "boolean" | |
985 }, | |
986 "maxMessages": { | |
987 "description": "The maximum number of messages returned for
this request. The Pub/Sub\nsystem may return fewer than the number specified.", | |
988 "format": "int32", | |
989 "type": "integer" | |
990 } | |
991 }, | |
992 "type": "object" | |
993 }, | |
994 "ListSubscriptionsResponse": { | |
995 "description": "Response for the `ListSubscriptions` method.", | |
996 "id": "ListSubscriptionsResponse", | |
997 "properties": { | |
998 "nextPageToken": { | |
999 "description": "If not empty, indicates that there may be mo
re subscriptions that match\nthe request; this value should be passed in a new\n
`ListSubscriptionsRequest` to get more subscriptions.", | |
1000 "type": "string" | |
1001 }, | |
1002 "subscriptions": { | |
1003 "description": "The subscriptions that match the request.", | |
1004 "items": { | |
1005 "$ref": "Subscription" | |
1006 }, | |
1007 "type": "array" | |
1008 } | |
1009 }, | |
1010 "type": "object" | |
1011 }, | |
1012 "PublishRequest": { | |
1013 "description": "Request for the Publish method.", | |
1014 "id": "PublishRequest", | |
1015 "properties": { | |
1016 "messages": { | |
1017 "description": "The messages to publish.", | |
1018 "items": { | |
1019 "$ref": "PubsubMessage" | |
1020 }, | |
1021 "type": "array" | |
1022 } | |
1023 }, | |
1024 "type": "object" | |
1025 }, | |
1026 "PublishResponse": { | |
1027 "description": "Response for the `Publish` method.", | |
1028 "id": "PublishResponse", | |
1029 "properties": { | |
1030 "messageIds": { | |
1031 "description": "The server-assigned ID of each published mes
sage, in the same order as\nthe messages in the request. IDs are guaranteed to b
e unique within\nthe topic.", | |
1032 "items": { | |
1033 "type": "string" | |
1034 }, | |
1035 "type": "array" | 1048 "type": "array" |
1036 } | 1049 } |
1037 }, | 1050 }, |
1038 "type": "object" | 1051 "type": "object" |
1039 }, | 1052 }, |
1040 "Subscription": { | 1053 "ListTopicSubscriptionsResponse": { |
1041 "description": "A subscription resource.", | 1054 "description": "Response for the `ListTopicSubscriptions` method.", |
1042 "id": "Subscription", | 1055 "id": "ListTopicSubscriptionsResponse", |
1043 "properties": { | 1056 "properties": { |
1044 "ackDeadlineSeconds": { | 1057 "nextPageToken": { |
1045 "description": "This value is the maximum time after a subsc
riber receives a message\nbefore the subscriber should acknowledge the message.
After message\ndelivery but before the ack deadline expires and before the messa
ge is\nacknowledged, it is an outstanding message and will not be delivered\naga
in during that time (on a best-effort basis).\n\nFor pull subscriptions, this va
lue is used as the initial value for the ack\ndeadline. To override this value f
or a given message, call\n`ModifyAckDeadline` with the corresponding `ack_id` if
using\npull.\nThe minimum custom deadline you can specify is 10 seconds.\nThe m
aximum custom deadline you can specify is 600 seconds (10 minutes).\nIf this par
ameter is 0, a default value of 10 seconds is used.\n\nFor push delivery, this v
alue is also used to set the request timeout for\nthe call to the push endpoint.
\n\nIf the subscriber never acknowledges the message, the Pub/Sub\nsystem will e
ventually redeliver the message.", | 1058 "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.", |
1046 "format": "int32", | |
1047 "type": "integer" | |
1048 }, | |
1049 "name": { | |
1050 "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\"`.", | |
1051 "type": "string" | 1059 "type": "string" |
1052 }, | 1060 }, |
1053 "topic": { | 1061 "subscriptions": { |
1054 "description": "The name of the topic from which this subscr
iption is receiving messages.\nFormat is `projects/{project}/topics/{topic}`.\nT
he value of this field will be `_deleted-topic_` if the topic has been\ndeleted.
", | 1062 "description": "The names of the subscriptions that match th
e request.", |
1055 "type": "string" | |
1056 }, | |
1057 "pushConfig": { | |
1058 "$ref": "PushConfig", | |
1059 "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." | |
1060 } | |
1061 }, | |
1062 "type": "object" | |
1063 }, | |
1064 "TestIamPermissionsRequest": { | |
1065 "description": "Request message for `TestIamPermissions` method.", | |
1066 "id": "TestIamPermissionsRequest", | |
1067 "properties": { | |
1068 "permissions": { | |
1069 "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).", | |
1070 "items": { | 1063 "items": { |
1071 "type": "string" | 1064 "type": "string" |
1072 }, | 1065 }, |
1073 "type": "array" | 1066 "type": "array" |
1074 } | 1067 } |
1075 }, | 1068 }, |
1076 "type": "object" | 1069 "type": "object" |
1077 }, | 1070 }, |
1078 "Policy": { | 1071 "PullResponse": { |
1079 "description": "Defines an Identity and Access Management (IAM) poli
cy. It is used to\nspecify access control policies for Cloud Platform resources.
\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n
`members` to a `role`, where the members can be user accounts, Google groups,\nG
oogle domains, and service accounts. A `role` is a named list of permissions\nde
fined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n
\"role\": \"roles/owner\",\n \"members\": [\n \"user:mike
@example.com\",\n \"group:admins@example.com\",\n \"domain
:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccoun
t.com\",\n ]\n },\n {\n \"role\": \"roles/viewer
\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n
}\n\nFor a description of IAM and its features, see the\n[IAM developer's guide
](https://cloud.google.com/iam).", | 1072 "description": "Response for the `Pull` method.", |
1080 "id": "Policy", | 1073 "id": "PullResponse", |
1081 "properties": { | 1074 "properties": { |
1082 "bindings": { | 1075 "receivedMessages": { |
1083 "description": "Associates a list of `members` to a `role`.\
n`bindings` with no members will result in an error.", | 1076 "description": "Received Pub/Sub messages. The Pub/Sub syste
m will return zero messages if\nthere are no more available in the backlog. The
Pub/Sub system may return\nfewer than the `maxMessages` requested even if there
are more messages\navailable in the backlog.", |
1084 "items": { | 1077 "items": { |
1085 "$ref": "Binding" | 1078 "$ref": "ReceivedMessage" |
1086 }, | 1079 }, |
1087 "type": "array" | 1080 "type": "array" |
1088 }, | |
1089 "etag": { | |
1090 "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.", | |
1091 "format": "byte", | |
1092 "type": "string" | |
1093 }, | |
1094 "version": { | |
1095 "description": "Version of the `Policy`. The default version
is 0.", | |
1096 "format": "int32", | |
1097 "type": "integer" | |
1098 } | 1081 } |
1099 }, | 1082 }, |
1100 "type": "object" | 1083 "type": "object" |
1101 }, | 1084 }, |
1102 "Topic": { | 1085 "ReceivedMessage": { |
1103 "description": "A topic resource.", | 1086 "description": "A message and its corresponding acknowledgment ID.", |
1104 "id": "Topic", | 1087 "id": "ReceivedMessage", |
1105 "properties": { | 1088 "properties": { |
1106 "name": { | 1089 "message": { |
1107 "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\"`.", | 1090 "$ref": "PubsubMessage", |
| 1091 "description": "The message." |
| 1092 }, |
| 1093 "ackId": { |
| 1094 "description": "This ID can be used to acknowledge the recei
ved message.", |
1108 "type": "string" | 1095 "type": "string" |
1109 } | 1096 } |
1110 }, | 1097 }, |
1111 "type": "object" | 1098 "type": "object" |
1112 }, | 1099 }, |
1113 "ModifyAckDeadlineRequest": { | 1100 "PushConfig": { |
1114 "description": "Request for the ModifyAckDeadline method.", | 1101 "description": "Configuration for a push delivery endpoint.", |
1115 "id": "ModifyAckDeadlineRequest", | 1102 "id": "PushConfig", |
1116 "properties": { | 1103 "properties": { |
1117 "ackDeadlineSeconds": { | 1104 "attributes": { |
1118 "description": "The new ack deadline with respect to the tim
e this request was sent to\nthe Pub/Sub system. For example, if the value is 10,
the new\nack deadline will expire 10 seconds after the `ModifyAckDeadline` call
\nwas made. Specifying zero may immediately make the message available for\nanot
her pull request.\nThe minimum deadline you can specify is 0 seconds.\nThe maxim
um deadline you can specify is 600 seconds (10 minutes).", | 1105 "additionalProperties": { |
1119 "format": "int32", | 1106 "type": "string" |
1120 "type": "integer" | 1107 }, |
| 1108 "description": "Endpoint configuration attributes.\n\nEvery
endpoint has a set of API supported attributes that can be used to\ncontrol diff
erent aspects of the message delivery.\n\nThe currently supported attribute is `
x-goog-version`, which you can\nuse to change the format of the pushed message.
This attribute\nindicates the version of the data expected by the endpoint. This
\ncontrols the shape of the pushed message (i.e., its fields and metadata).\nThe
endpoint version is based on the version of the Pub/Sub API.\n\nIf not present
during the `CreateSubscription` call, it will default to\nthe version of the API
used to make such call. If not present during a\n`ModifyPushConfig` call, its v
alue will not be changed. `GetSubscription`\ncalls will always return a valid ve
rsion, even if the subscription was\ncreated without this attribute.\n\nThe poss
ible values for this attribute are:\n\n* `v1beta1`: uses the push format defined
in the v1beta1 Pub/Sub API.\n* `v1` or `v1beta2`: uses the push format defined
in the v1 Pub/Sub API.", |
| 1109 "type": "object" |
1121 }, | 1110 }, |
1122 "ackIds": { | 1111 "pushEndpoint": { |
1123 "description": "List of acknowledgment IDs.", | 1112 "description": "A URL locating the endpoint to which message
s should be pushed.\nFor example, a Webhook endpoint might use \"https://example
.com/push\".", |
| 1113 "type": "string" |
| 1114 } |
| 1115 }, |
| 1116 "type": "object" |
| 1117 }, |
| 1118 "TestIamPermissionsResponse": { |
| 1119 "description": "Response message for `TestIamPermissions` method.", |
| 1120 "id": "TestIamPermissionsResponse", |
| 1121 "properties": { |
| 1122 "permissions": { |
| 1123 "description": "A subset of `TestPermissionsRequest.permissi
ons` that the caller is\nallowed.", |
1124 "items": { | 1124 "items": { |
1125 "type": "string" | 1125 "type": "string" |
1126 }, | 1126 }, |
1127 "type": "array" | 1127 "type": "array" |
1128 } | 1128 } |
1129 }, | 1129 }, |
1130 "type": "object" | 1130 "type": "object" |
1131 } | 1131 } |
1132 }, | 1132 }, |
1133 "servicePath": "", | 1133 "servicePath": "", |
1134 "title": "Google Cloud Pub/Sub API", | 1134 "title": "Google Cloud Pub/Sub API", |
1135 "version": "v1" | 1135 "version": "v1" |
1136 } | 1136 } |
OLD | NEW |