OLD | NEW |
1 { | 1 { |
2 "auth": { | 2 "auth": { |
3 "oauth2": { | 3 "oauth2": { |
4 "scopes": { | 4 "scopes": { |
| 5 "https://www.googleapis.com/auth/cloud-platform": { |
| 6 "description": "View and manage your data across Google Clou
d Platform services" |
| 7 }, |
5 "https://www.googleapis.com/auth/pubsub": { | 8 "https://www.googleapis.com/auth/pubsub": { |
6 "description": "View and manage Pub/Sub topics and subscript
ions" | 9 "description": "View and manage Pub/Sub topics and subscript
ions" |
7 }, | |
8 "https://www.googleapis.com/auth/cloud-platform": { | |
9 "description": "View and manage your data across Google Clou
d Platform services" | |
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 "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", |
18 "discoveryVersion": "v1", | 19 "discoveryVersion": "v1", |
19 "documentationLink": "https://cloud.google.com/pubsub/docs", | 20 "documentationLink": "https://cloud.google.com/pubsub/docs", |
20 "icons": { | 21 "icons": { |
21 "x16": "http://www.google.com/images/icons/product/search-16.gif", | 22 "x16": "http://www.google.com/images/icons/product/search-16.gif", |
22 "x32": "http://www.google.com/images/icons/product/search-32.gif" | 23 "x32": "http://www.google.com/images/icons/product/search-32.gif" |
23 }, | 24 }, |
24 "id": "pubsub:v1beta2", | 25 "id": "pubsub:v1beta2", |
25 "kind": "discovery#restDescription", | 26 "kind": "discovery#restDescription", |
26 "name": "pubsub", | 27 "name": "pubsub", |
27 "ownerDomain": "google.com", | 28 "ownerDomain": "google.com", |
28 "ownerName": "Google", | 29 "ownerName": "Google", |
29 "parameters": { | 30 "parameters": { |
| 31 "bearer_token": { |
| 32 "description": "OAuth bearer token.", |
| 33 "location": "query", |
| 34 "type": "string" |
| 35 }, |
| 36 "oauth_token": { |
| 37 "description": "OAuth 2.0 token for the current user.", |
| 38 "location": "query", |
| 39 "type": "string" |
| 40 }, |
30 "upload_protocol": { | 41 "upload_protocol": { |
31 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", | 42 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", |
32 "location": "query", | 43 "location": "query", |
33 "type": "string" | 44 "type": "string" |
34 }, | 45 }, |
35 "prettyPrint": { | 46 "prettyPrint": { |
36 "default": "true", | 47 "default": "true", |
37 "description": "Returns response with indentations and line breaks."
, | 48 "description": "Returns response with indentations and line breaks."
, |
38 "location": "query", | 49 "location": "query", |
39 "type": "boolean" | 50 "type": "boolean" |
40 }, | 51 }, |
| 52 "fields": { |
| 53 "description": "Selector specifying which fields to include in a par
tial response.", |
| 54 "location": "query", |
| 55 "type": "string" |
| 56 }, |
41 "uploadType": { | 57 "uploadType": { |
42 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", | 58 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", |
43 "location": "query", | 59 "location": "query", |
44 "type": "string" | 60 "type": "string" |
45 }, | 61 }, |
46 "fields": { | |
47 "description": "Selector specifying which fields to include in a par
tial response.", | |
48 "location": "query", | |
49 "type": "string" | |
50 }, | |
51 "callback": { | 62 "callback": { |
52 "description": "JSONP", | 63 "description": "JSONP", |
53 "location": "query", | 64 "location": "query", |
54 "type": "string" | 65 "type": "string" |
55 }, | 66 }, |
56 "$.xgafv": { | 67 "$.xgafv": { |
57 "description": "V1 error format.", | 68 "description": "V1 error format.", |
58 "enum": [ | 69 "enum": [ |
59 "1", | 70 "1", |
60 "2" | 71 "2" |
(...skipping 14 matching lines...) Expand all Loading... |
75 "proto" | 86 "proto" |
76 ], | 87 ], |
77 "enumDescriptions": [ | 88 "enumDescriptions": [ |
78 "Responses with Content-Type of application/json", | 89 "Responses with Content-Type of application/json", |
79 "Media download with context-dependent Content-Type", | 90 "Media download with context-dependent Content-Type", |
80 "Responses with Content-Type of application/x-protobuf" | 91 "Responses with Content-Type of application/x-protobuf" |
81 ], | 92 ], |
82 "location": "query", | 93 "location": "query", |
83 "type": "string" | 94 "type": "string" |
84 }, | 95 }, |
| 96 "key": { |
| 97 "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.", |
| 98 "location": "query", |
| 99 "type": "string" |
| 100 }, |
85 "access_token": { | 101 "access_token": { |
86 "description": "OAuth access token.", | 102 "description": "OAuth access token.", |
87 "location": "query", | 103 "location": "query", |
88 "type": "string" | 104 "type": "string" |
89 }, | 105 }, |
90 "key": { | |
91 "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.", | |
92 "location": "query", | |
93 "type": "string" | |
94 }, | |
95 "quotaUser": { | 106 "quotaUser": { |
96 "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.", | 107 "description": "Available to use for quota purposes for server-side
applications. Can be any arbitrary string assigned to a user, but should not exc
eed 40 characters.", |
97 "location": "query", | 108 "location": "query", |
98 "type": "string" | 109 "type": "string" |
99 }, | 110 }, |
100 "pp": { | 111 "pp": { |
101 "default": "true", | 112 "default": "true", |
102 "description": "Pretty-print response.", | 113 "description": "Pretty-print response.", |
103 "location": "query", | 114 "location": "query", |
104 "type": "boolean" | 115 "type": "boolean" |
105 }, | |
106 "oauth_token": { | |
107 "description": "OAuth 2.0 token for the current user.", | |
108 "location": "query", | |
109 "type": "string" | |
110 }, | |
111 "bearer_token": { | |
112 "description": "OAuth bearer token.", | |
113 "location": "query", | |
114 "type": "string" | |
115 } | 116 } |
116 }, | 117 }, |
117 "protocol": "rest", | 118 "protocol": "rest", |
118 "resources": { | 119 "resources": { |
119 "projects": { | 120 "projects": { |
120 "resources": { | 121 "resources": { |
121 "subscriptions": { | 122 "subscriptions": { |
122 "methods": { | 123 "methods": { |
123 "getIamPolicy": { | |
124 "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 "httpMethod": "GET", | |
126 "id": "pubsub.projects.subscriptions.getIamPolicy", | |
127 "parameterOrder": [ | |
128 "resource" | |
129 ], | |
130 "parameters": { | |
131 "resource": { | |
132 "description": "REQUIRED: The resource for w
hich the policy is being requested.\n`resource` is usually specified as a path.
For example, a Project\nresource is specified as `projects/{project}`.", | |
133 "location": "path", | |
134 "pattern": "^projects/[^/]+/subscriptions/[^
/]+$", | |
135 "required": true, | |
136 "type": "string" | |
137 } | |
138 }, | |
139 "path": "v1beta2/{+resource}:getIamPolicy", | |
140 "response": { | |
141 "$ref": "Policy" | |
142 }, | |
143 "scopes": [ | |
144 "https://www.googleapis.com/auth/cloud-platform"
, | |
145 "https://www.googleapis.com/auth/pubsub" | |
146 ] | |
147 }, | |
148 "acknowledge": { | 124 "acknowledge": { |
149 "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.", | 125 "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.", |
150 "httpMethod": "POST", | 126 "httpMethod": "POST", |
151 "id": "pubsub.projects.subscriptions.acknowledge", | 127 "id": "pubsub.projects.subscriptions.acknowledge", |
152 "parameterOrder": [ | 128 "parameterOrder": [ |
153 "subscription" | 129 "subscription" |
154 ], | 130 ], |
155 "parameters": { | 131 "parameters": { |
156 "subscription": { | 132 "subscription": { |
157 "description": "The subscription whose messa
ge is being acknowledged.", | 133 "description": "The subscription whose messa
ge is being acknowledged.", |
(...skipping 36 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
194 "$ref": "ModifyAckDeadlineRequest" | 170 "$ref": "ModifyAckDeadlineRequest" |
195 }, | 171 }, |
196 "response": { | 172 "response": { |
197 "$ref": "Empty" | 173 "$ref": "Empty" |
198 }, | 174 }, |
199 "scopes": [ | 175 "scopes": [ |
200 "https://www.googleapis.com/auth/cloud-platform"
, | 176 "https://www.googleapis.com/auth/cloud-platform"
, |
201 "https://www.googleapis.com/auth/pubsub" | 177 "https://www.googleapis.com/auth/pubsub" |
202 ] | 178 ] |
203 }, | 179 }, |
| 180 "getIamPolicy": { |
| 181 "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.", |
| 182 "httpMethod": "GET", |
| 183 "id": "pubsub.projects.subscriptions.getIamPolicy", |
| 184 "parameterOrder": [ |
| 185 "resource" |
| 186 ], |
| 187 "parameters": { |
| 188 "resource": { |
| 189 "description": "REQUIRED: The resource for w
hich the policy is being requested.\n`resource` is usually specified as a path.
For example, a Project\nresource is specified as `projects/{project}`.", |
| 190 "location": "path", |
| 191 "pattern": "^projects/[^/]+/subscriptions/[^
/]+$", |
| 192 "required": true, |
| 193 "type": "string" |
| 194 } |
| 195 }, |
| 196 "path": "v1beta2/{+resource}:getIamPolicy", |
| 197 "response": { |
| 198 "$ref": "Policy" |
| 199 }, |
| 200 "scopes": [ |
| 201 "https://www.googleapis.com/auth/cloud-platform"
, |
| 202 "https://www.googleapis.com/auth/pubsub" |
| 203 ] |
| 204 }, |
204 "get": { | 205 "get": { |
205 "description": "Gets the configuration details of a
subscription.", | 206 "description": "Gets the configuration details of a
subscription.", |
206 "httpMethod": "GET", | 207 "httpMethod": "GET", |
207 "id": "pubsub.projects.subscriptions.get", | 208 "id": "pubsub.projects.subscriptions.get", |
208 "parameterOrder": [ | 209 "parameterOrder": [ |
209 "subscription" | 210 "subscription" |
210 ], | 211 ], |
211 "parameters": { | 212 "parameters": { |
212 "subscription": { | 213 "subscription": { |
213 "description": "The name of the subscription
to get.", | 214 "description": "The name of the subscription
to get.", |
214 "location": "path", | 215 "location": "path", |
215 "pattern": "^projects/[^/]+/subscriptions/[^
/]+$", | 216 "pattern": "^projects/[^/]+/subscriptions/[^
/]+$", |
216 "required": true, | 217 "required": true, |
217 "type": "string" | 218 "type": "string" |
218 } | 219 } |
219 }, | 220 }, |
220 "path": "v1beta2/{+subscription}", | 221 "path": "v1beta2/{+subscription}", |
221 "response": { | 222 "response": { |
222 "$ref": "Subscription" | 223 "$ref": "Subscription" |
223 }, | 224 }, |
224 "scopes": [ | 225 "scopes": [ |
225 "https://www.googleapis.com/auth/cloud-platform"
, | 226 "https://www.googleapis.com/auth/cloud-platform"
, |
226 "https://www.googleapis.com/auth/pubsub" | 227 "https://www.googleapis.com/auth/pubsub" |
227 ] | 228 ] |
228 }, | 229 }, |
229 "testIamPermissions": { | 230 "testIamPermissions": { |
230 "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.", | 231 "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.
", |
231 "httpMethod": "POST", | 232 "httpMethod": "POST", |
232 "id": "pubsub.projects.subscriptions.testIamPermissi
ons", | 233 "id": "pubsub.projects.subscriptions.testIamPermissi
ons", |
233 "parameterOrder": [ | 234 "parameterOrder": [ |
234 "resource" | 235 "resource" |
235 ], | 236 ], |
236 "parameters": { | 237 "parameters": { |
237 "resource": { | 238 "resource": { |
238 "description": "REQUIRED: The resource for w
hich the policy detail is being requested.\n`resource` is usually specified as a
path. For example, a Project\nresource is specified as `projects/{project}`.", | 239 "description": "REQUIRED: The resource for w
hich the policy detail is being requested.\n`resource` is usually specified as a
path. For example, a Project\nresource is specified as `projects/{project}`.", |
239 "location": "path", | 240 "location": "path", |
240 "pattern": "^projects/[^/]+/subscriptions/[^
/]+$", | 241 "pattern": "^projects/[^/]+/subscriptions/[^
/]+$", |
(...skipping 212 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
453 }, | 454 }, |
454 "response": { | 455 "response": { |
455 "$ref": "PublishResponse" | 456 "$ref": "PublishResponse" |
456 }, | 457 }, |
457 "scopes": [ | 458 "scopes": [ |
458 "https://www.googleapis.com/auth/cloud-platform"
, | 459 "https://www.googleapis.com/auth/cloud-platform"
, |
459 "https://www.googleapis.com/auth/pubsub" | 460 "https://www.googleapis.com/auth/pubsub" |
460 ] | 461 ] |
461 }, | 462 }, |
462 "testIamPermissions": { | 463 "testIamPermissions": { |
463 "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.", | 464 "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.
", |
464 "httpMethod": "POST", | 465 "httpMethod": "POST", |
465 "id": "pubsub.projects.topics.testIamPermissions", | 466 "id": "pubsub.projects.topics.testIamPermissions", |
466 "parameterOrder": [ | 467 "parameterOrder": [ |
467 "resource" | 468 "resource" |
468 ], | 469 ], |
469 "parameters": { | 470 "parameters": { |
470 "resource": { | 471 "resource": { |
471 "description": "REQUIRED: The resource for w
hich the policy detail is being requested.\n`resource` is usually specified as a
path. For example, a Project\nresource is specified as `projects/{project}`.", | 472 "description": "REQUIRED: The resource for w
hich the policy detail is being requested.\n`resource` is usually specified as a
path. For example, a Project\nresource is specified as `projects/{project}`.", |
472 "location": "path", | 473 "location": "path", |
473 "pattern": "^projects/[^/]+/topics/[^/]+$", | 474 "pattern": "^projects/[^/]+/topics/[^/]+$", |
(...skipping 39 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
513 ] | 514 ] |
514 }, | 515 }, |
515 "list": { | 516 "list": { |
516 "description": "Lists matching topics.", | 517 "description": "Lists matching topics.", |
517 "httpMethod": "GET", | 518 "httpMethod": "GET", |
518 "id": "pubsub.projects.topics.list", | 519 "id": "pubsub.projects.topics.list", |
519 "parameterOrder": [ | 520 "parameterOrder": [ |
520 "project" | 521 "project" |
521 ], | 522 ], |
522 "parameters": { | 523 "parameters": { |
523 "pageToken": { | |
524 "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.", | |
525 "location": "query", | |
526 "type": "string" | |
527 }, | |
528 "pageSize": { | 524 "pageSize": { |
529 "description": "Maximum number of topics to
return.", | 525 "description": "Maximum number of topics to
return.", |
530 "format": "int32", | 526 "format": "int32", |
531 "location": "query", | 527 "location": "query", |
532 "type": "integer" | 528 "type": "integer" |
533 }, | 529 }, |
534 "project": { | 530 "project": { |
535 "description": "The name of the cloud projec
t that topics belong to.", | 531 "description": "The name of the cloud projec
t that topics belong to.", |
536 "location": "path", | 532 "location": "path", |
537 "pattern": "^projects/[^/]+$", | 533 "pattern": "^projects/[^/]+$", |
538 "required": true, | 534 "required": true, |
539 "type": "string" | 535 "type": "string" |
| 536 }, |
| 537 "pageToken": { |
| 538 "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.", |
| 539 "location": "query", |
| 540 "type": "string" |
540 } | 541 } |
541 }, | 542 }, |
542 "path": "v1beta2/{+project}/topics", | 543 "path": "v1beta2/{+project}/topics", |
543 "response": { | 544 "response": { |
544 "$ref": "ListTopicsResponse" | 545 "$ref": "ListTopicsResponse" |
545 }, | 546 }, |
546 "scopes": [ | 547 "scopes": [ |
547 "https://www.googleapis.com/auth/cloud-platform"
, | 548 "https://www.googleapis.com/auth/cloud-platform"
, |
548 "https://www.googleapis.com/auth/pubsub" | 549 "https://www.googleapis.com/auth/pubsub" |
549 ] | 550 ] |
550 }, | 551 }, |
| 552 "setIamPolicy": { |
| 553 "description": "Sets the access control policy on th
e specified resource. Replaces any\nexisting policy.", |
| 554 "httpMethod": "POST", |
| 555 "id": "pubsub.projects.topics.setIamPolicy", |
| 556 "parameterOrder": [ |
| 557 "resource" |
| 558 ], |
| 559 "parameters": { |
| 560 "resource": { |
| 561 "description": "REQUIRED: The resource for w
hich the policy is being specified.\n`resource` is usually specified as a path.
For example, a Project\nresource is specified as `projects/{project}`.", |
| 562 "location": "path", |
| 563 "pattern": "^projects/[^/]+/topics/[^/]+$", |
| 564 "required": true, |
| 565 "type": "string" |
| 566 } |
| 567 }, |
| 568 "path": "v1beta2/{+resource}:setIamPolicy", |
| 569 "request": { |
| 570 "$ref": "SetIamPolicyRequest" |
| 571 }, |
| 572 "response": { |
| 573 "$ref": "Policy" |
| 574 }, |
| 575 "scopes": [ |
| 576 "https://www.googleapis.com/auth/cloud-platform"
, |
| 577 "https://www.googleapis.com/auth/pubsub" |
| 578 ] |
| 579 }, |
551 "create": { | 580 "create": { |
552 "description": "Creates the given topic with the giv
en name.", | 581 "description": "Creates the given topic with the giv
en name.", |
553 "httpMethod": "PUT", | 582 "httpMethod": "PUT", |
554 "id": "pubsub.projects.topics.create", | 583 "id": "pubsub.projects.topics.create", |
555 "parameterOrder": [ | 584 "parameterOrder": [ |
556 "name" | 585 "name" |
557 ], | 586 ], |
558 "parameters": { | 587 "parameters": { |
559 "name": { | 588 "name": { |
560 "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\"`.", | 589 "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\"`.", |
561 "location": "path", | 590 "location": "path", |
562 "pattern": "^projects/[^/]+/topics/[^/]+$", | 591 "pattern": "^projects/[^/]+/topics/[^/]+$", |
563 "required": true, | 592 "required": true, |
564 "type": "string" | 593 "type": "string" |
565 } | 594 } |
566 }, | 595 }, |
567 "path": "v1beta2/{+name}", | 596 "path": "v1beta2/{+name}", |
568 "request": { | 597 "request": { |
569 "$ref": "Topic" | 598 "$ref": "Topic" |
570 }, | 599 }, |
571 "response": { | 600 "response": { |
572 "$ref": "Topic" | 601 "$ref": "Topic" |
573 }, | 602 }, |
574 "scopes": [ | 603 "scopes": [ |
575 "https://www.googleapis.com/auth/cloud-platform"
, | 604 "https://www.googleapis.com/auth/cloud-platform"
, |
576 "https://www.googleapis.com/auth/pubsub" | |
577 ] | |
578 }, | |
579 "setIamPolicy": { | |
580 "description": "Sets the access control policy on th
e specified resource. Replaces any\nexisting policy.", | |
581 "httpMethod": "POST", | |
582 "id": "pubsub.projects.topics.setIamPolicy", | |
583 "parameterOrder": [ | |
584 "resource" | |
585 ], | |
586 "parameters": { | |
587 "resource": { | |
588 "description": "REQUIRED: The resource for w
hich the policy is being specified.\n`resource` is usually specified as a path.
For example, a Project\nresource is specified as `projects/{project}`.", | |
589 "location": "path", | |
590 "pattern": "^projects/[^/]+/topics/[^/]+$", | |
591 "required": true, | |
592 "type": "string" | |
593 } | |
594 }, | |
595 "path": "v1beta2/{+resource}:setIamPolicy", | |
596 "request": { | |
597 "$ref": "SetIamPolicyRequest" | |
598 }, | |
599 "response": { | |
600 "$ref": "Policy" | |
601 }, | |
602 "scopes": [ | |
603 "https://www.googleapis.com/auth/cloud-platform"
, | |
604 "https://www.googleapis.com/auth/pubsub" | 605 "https://www.googleapis.com/auth/pubsub" |
605 ] | 606 ] |
606 }, | 607 }, |
607 "getIamPolicy": { | 608 "getIamPolicy": { |
608 "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.", | 609 "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.", |
609 "httpMethod": "GET", | 610 "httpMethod": "GET", |
610 "id": "pubsub.projects.topics.getIamPolicy", | 611 "id": "pubsub.projects.topics.getIamPolicy", |
611 "parameterOrder": [ | 612 "parameterOrder": [ |
612 "resource" | 613 "resource" |
613 ], | 614 ], |
(...skipping 80 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
694 "https://www.googleapis.com/auth/pubsub" | 695 "https://www.googleapis.com/auth/pubsub" |
695 ] | 696 ] |
696 } | 697 } |
697 } | 698 } |
698 } | 699 } |
699 } | 700 } |
700 } | 701 } |
701 } | 702 } |
702 } | 703 } |
703 }, | 704 }, |
704 "revision": "20170124", | 705 "revision": "20170214", |
705 "rootUrl": "https://pubsub.googleapis.com/", | 706 "rootUrl": "https://pubsub.googleapis.com/", |
706 "schemas": { | 707 "schemas": { |
707 "PullResponse": { | |
708 "description": "Response for the `Pull` method.", | |
709 "id": "PullResponse", | |
710 "properties": { | |
711 "receivedMessages": { | |
712 "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.", | |
713 "items": { | |
714 "$ref": "ReceivedMessage" | |
715 }, | |
716 "type": "array" | |
717 } | |
718 }, | |
719 "type": "object" | |
720 }, | |
721 "ReceivedMessage": { | |
722 "description": "A message and its corresponding acknowledgment ID.", | |
723 "id": "ReceivedMessage", | |
724 "properties": { | |
725 "message": { | |
726 "$ref": "PubsubMessage", | |
727 "description": "The message." | |
728 }, | |
729 "ackId": { | |
730 "description": "This ID can be used to acknowledge the recei
ved message.", | |
731 "type": "string" | |
732 } | |
733 }, | |
734 "type": "object" | |
735 }, | |
736 "PushConfig": { | |
737 "description": "Configuration for a push delivery endpoint.", | |
738 "id": "PushConfig", | |
739 "properties": { | |
740 "pushEndpoint": { | |
741 "description": "A URL locating the endpoint to which message
s should be pushed.\nFor example, a Webhook endpoint might use \"https://example
.com/push\".", | |
742 "type": "string" | |
743 }, | |
744 "attributes": { | |
745 "additionalProperties": { | |
746 "type": "string" | |
747 }, | |
748 "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 push message. Th
is attribute\nindicates the version of the data expected by the endpoint. This\n
controls the shape of the envelope (i.e. its fields and metadata).\nThe endpoint
version is based on the version of the Pub/Sub\nAPI.\n\nIf not present during t
he `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 value wil
l not be changed. `GetSubscription`\ncalls will always return a valid version, e
ven if the subscription was\ncreated without this attribute.\n\nThe possible val
ues 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 v
1 Pub/Sub API.", | |
749 "type": "object" | |
750 } | |
751 }, | |
752 "type": "object" | |
753 }, | |
754 "TestIamPermissionsResponse": { | |
755 "description": "Response message for `TestIamPermissions` method.", | |
756 "id": "TestIamPermissionsResponse", | |
757 "properties": { | |
758 "permissions": { | |
759 "description": "A subset of `TestPermissionsRequest.permissi
ons` that the caller is\nallowed.", | |
760 "items": { | |
761 "type": "string" | |
762 }, | |
763 "type": "array" | |
764 } | |
765 }, | |
766 "type": "object" | |
767 }, | |
768 "PullRequest": { | |
769 "description": "Request for the `Pull` method.", | |
770 "id": "PullRequest", | |
771 "properties": { | |
772 "maxMessages": { | |
773 "description": "The maximum number of messages returned for
this request. The Pub/Sub\nsystem may return fewer than the number specified.", | |
774 "format": "int32", | |
775 "type": "integer" | |
776 }, | |
777 "returnImmediately": { | |
778 "description": "If this is specified as true the system will
respond immediately even if\nit is not able to return a message in the `Pull` r
esponse. Otherwise the\nsystem is allowed to wait until at least one message is
available rather\nthan returning no messages. The client may cancel the request
if it does\nnot wish to wait any longer for the response.", | |
779 "type": "boolean" | |
780 } | |
781 }, | |
782 "type": "object" | |
783 }, | |
784 "ListSubscriptionsResponse": { | |
785 "description": "Response for the `ListSubscriptions` method.", | |
786 "id": "ListSubscriptionsResponse", | |
787 "properties": { | |
788 "subscriptions": { | |
789 "description": "The subscriptions that match the request.", | |
790 "items": { | |
791 "$ref": "Subscription" | |
792 }, | |
793 "type": "array" | |
794 }, | |
795 "nextPageToken": { | |
796 "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.", | |
797 "type": "string" | |
798 } | |
799 }, | |
800 "type": "object" | |
801 }, | |
802 "PublishRequest": { | |
803 "description": "Request for the Publish method.", | |
804 "id": "PublishRequest", | |
805 "properties": { | |
806 "messages": { | |
807 "description": "The messages to publish.", | |
808 "items": { | |
809 "$ref": "PubsubMessage" | |
810 }, | |
811 "type": "array" | |
812 } | |
813 }, | |
814 "type": "object" | |
815 }, | |
816 "PublishResponse": { | |
817 "description": "Response for the `Publish` method.", | |
818 "id": "PublishResponse", | |
819 "properties": { | |
820 "messageIds": { | |
821 "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.", | |
822 "items": { | |
823 "type": "string" | |
824 }, | |
825 "type": "array" | |
826 } | |
827 }, | |
828 "type": "object" | |
829 }, | |
830 "Subscription": { | 708 "Subscription": { |
831 "description": "A subscription resource.", | 709 "description": "A subscription resource.", |
832 "id": "Subscription", | 710 "id": "Subscription", |
833 "properties": { | 711 "properties": { |
834 "pushConfig": { | 712 "pushConfig": { |
835 "$ref": "PushConfig", | 713 "$ref": "PushConfig", |
836 "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." | 714 "description": "If push delivery is used with this subscript
ion, this field is\nused to configure it. An empty `pushConfig` signifies that t
he subscriber\nwill pull and ack messages using API methods." |
837 }, | 715 }, |
838 "ackDeadlineSeconds": { | 716 "ackDeadlineSeconds": { |
839 "description": "This value is the maximum time after a subsc
riber receives a message\nbefore the subscriber should acknowledge the message.
After message\ndelivery but before the ack deadline expires and before the messa
ge is\nacknowledged, it is an outstanding message and will not be delivered\naga
in during that time (on a best-effort basis).\n\nFor pull subscriptions, this va
lue is used as the initial value for the ack\ndeadline. To override this value f
or a given message, call\n`ModifyAckDeadline` with the corresponding `ack_id` if
using pull.\nThe maximum custom deadline you can specify is 600 seconds (10 min
utes).\n\nFor push delivery, this value is also used to set the request timeout
for\nthe call to the push endpoint.\n\nIf the subscriber never acknowledges the
message, the Pub/Sub\nsystem will eventually redeliver the message.\n\nIf this p
arameter is 0, a default value of 10 seconds is used.", | 717 "description": "This value is the maximum time after a subsc
riber receives a message\nbefore the subscriber should acknowledge the message.
After message\ndelivery but before the ack deadline expires and before the messa
ge is\nacknowledged, it is an outstanding message and will not be delivered\naga
in during that time (on a best-effort basis).\n\nFor pull subscriptions, this va
lue is used as the initial value for the ack\ndeadline. To override this value f
or a given message, call\n`ModifyAckDeadline` with the corresponding `ack_id` if
using pull.\nThe maximum custom deadline you can specify is 600 seconds (10 min
utes).\n\nFor push delivery, this value is also used to set the request timeout
for\nthe call to the push endpoint.\n\nIf the subscriber never acknowledges the
message, the Pub/Sub\nsystem will eventually redeliver the message.\n\nIf this p
arameter is 0, a default value of 10 seconds is used.", |
(...skipping 18 matching lines...) Expand all Loading... |
858 "permissions": { | 736 "permissions": { |
859 "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).", | 737 "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).", |
860 "items": { | 738 "items": { |
861 "type": "string" | 739 "type": "string" |
862 }, | 740 }, |
863 "type": "array" | 741 "type": "array" |
864 } | 742 } |
865 }, | 743 }, |
866 "type": "object" | 744 "type": "object" |
867 }, | 745 }, |
| 746 "Topic": { |
| 747 "description": "A topic resource.", |
| 748 "id": "Topic", |
| 749 "properties": { |
| 750 "name": { |
| 751 "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\"`.", |
| 752 "type": "string" |
| 753 } |
| 754 }, |
| 755 "type": "object" |
| 756 }, |
868 "Policy": { | 757 "Policy": { |
869 "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).", | 758 "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).", |
870 "id": "Policy", | 759 "id": "Policy", |
871 "properties": { | 760 "properties": { |
872 "etag": { | 761 "etag": { |
873 "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.", | 762 "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.", |
874 "format": "byte", | 763 "format": "byte", |
875 "type": "string" | 764 "type": "string" |
876 }, | 765 }, |
877 "version": { | 766 "version": { |
878 "description": "Version of the `Policy`. The default version
is 0.", | 767 "description": "Version of the `Policy`. The default version
is 0.", |
879 "format": "int32", | 768 "format": "int32", |
880 "type": "integer" | 769 "type": "integer" |
881 }, | 770 }, |
882 "bindings": { | 771 "bindings": { |
883 "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.", | 772 "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.", |
884 "items": { | 773 "items": { |
885 "$ref": "Binding" | 774 "$ref": "Binding" |
886 }, | 775 }, |
887 "type": "array" | 776 "type": "array" |
888 } | 777 } |
889 }, | 778 }, |
890 "type": "object" | 779 "type": "object" |
891 }, | 780 }, |
892 "Topic": { | |
893 "description": "A topic resource.", | |
894 "id": "Topic", | |
895 "properties": { | |
896 "name": { | |
897 "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\"`.", | |
898 "type": "string" | |
899 } | |
900 }, | |
901 "type": "object" | |
902 }, | |
903 "ModifyAckDeadlineRequest": { | 781 "ModifyAckDeadlineRequest": { |
904 "description": "Request for the ModifyAckDeadline method.", | 782 "description": "Request for the ModifyAckDeadline method.", |
905 "id": "ModifyAckDeadlineRequest", | 783 "id": "ModifyAckDeadlineRequest", |
906 "properties": { | 784 "properties": { |
907 "ackIds": { | |
908 "description": "List of acknowledgment IDs.", | |
909 "items": { | |
910 "type": "string" | |
911 }, | |
912 "type": "array" | |
913 }, | |
914 "ackId": { | 785 "ackId": { |
915 "description": "The acknowledgment ID. Either this or ack_id
s must be populated, but not\nboth.", | 786 "description": "The acknowledgment ID. Either this or ack_id
s must be populated, but not\nboth.", |
916 "type": "string" | 787 "type": "string" |
917 }, | 788 }, |
918 "ackDeadlineSeconds": { | 789 "ackDeadlineSeconds": { |
919 "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.", | 790 "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.", |
920 "format": "int32", | 791 "format": "int32", |
921 "type": "integer" | 792 "type": "integer" |
| 793 }, |
| 794 "ackIds": { |
| 795 "description": "List of acknowledgment IDs.", |
| 796 "items": { |
| 797 "type": "string" |
| 798 }, |
| 799 "type": "array" |
922 } | 800 } |
923 }, | 801 }, |
924 "type": "object" | 802 "type": "object" |
925 }, | 803 }, |
926 "SetIamPolicyRequest": { | 804 "SetIamPolicyRequest": { |
927 "description": "Request message for `SetIamPolicy` method.", | 805 "description": "Request message for `SetIamPolicy` method.", |
928 "id": "SetIamPolicyRequest", | 806 "id": "SetIamPolicyRequest", |
929 "properties": { | 807 "properties": { |
930 "policy": { | 808 "policy": { |
931 "$ref": "Policy", | 809 "$ref": "Policy", |
932 "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." | 810 "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." |
933 } | 811 } |
934 }, | 812 }, |
935 "type": "object" | 813 "type": "object" |
936 }, | 814 }, |
937 "ModifyPushConfigRequest": { | |
938 "description": "Request for the ModifyPushConfig method.", | |
939 "id": "ModifyPushConfigRequest", | |
940 "properties": { | |
941 "pushConfig": { | |
942 "$ref": "PushConfig", | |
943 "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." | |
944 } | |
945 }, | |
946 "type": "object" | |
947 }, | |
948 "PubsubMessage": { | 815 "PubsubMessage": { |
949 "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.", | 816 "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.", |
950 "id": "PubsubMessage", | 817 "id": "PubsubMessage", |
951 "properties": { | 818 "properties": { |
952 "attributes": { | 819 "attributes": { |
953 "additionalProperties": { | 820 "additionalProperties": { |
954 "type": "string" | 821 "type": "string" |
955 }, | 822 }, |
956 "description": "Optional attributes for this message.", | 823 "description": "Optional attributes for this message.", |
957 "type": "object" | 824 "type": "object" |
958 }, | 825 }, |
959 "messageId": { | 826 "messageId": { |
960 "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.", | 827 "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.", |
961 "type": "string" | 828 "type": "string" |
962 }, | 829 }, |
963 "publishTime": { | 830 "publishTime": { |
964 "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.", | 831 "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.", |
965 "format": "google-datetime", | 832 "format": "google-datetime", |
966 "type": "string" | 833 "type": "string" |
967 }, | 834 }, |
968 "data": { | 835 "data": { |
969 "description": "The message payload. For JSON requests, the
value of this field must be\n[base64-encoded](https://tools.ietf.org/html/rfc464
8).", | 836 "description": "The message payload. For JSON requests, the
value of this field must be\n[base64-encoded](https://tools.ietf.org/html/rfc464
8).", |
970 "format": "byte", | 837 "format": "byte", |
971 "type": "string" | 838 "type": "string" |
972 } | 839 } |
973 }, | 840 }, |
974 "type": "object" | 841 "type": "object" |
975 }, | 842 }, |
| 843 "ModifyPushConfigRequest": { |
| 844 "description": "Request for the ModifyPushConfig method.", |
| 845 "id": "ModifyPushConfigRequest", |
| 846 "properties": { |
| 847 "pushConfig": { |
| 848 "$ref": "PushConfig", |
| 849 "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." |
| 850 } |
| 851 }, |
| 852 "type": "object" |
| 853 }, |
976 "Binding": { | 854 "Binding": { |
977 "description": "Associates `members` with a `role`.", | 855 "description": "Associates `members` with a `role`.", |
978 "id": "Binding", | 856 "id": "Binding", |
979 "properties": { | 857 "properties": { |
980 "members": { | 858 "members": { |
981 "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", | 859 "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", |
982 "items": { | 860 "items": { |
983 "type": "string" | 861 "type": "string" |
984 }, | 862 }, |
985 "type": "array" | 863 "type": "array" |
986 }, | 864 }, |
987 "role": { | 865 "role": { |
988 "description": "Role that is assigned to `members`.\nFor exa
mple, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired", | 866 "description": "Role that is assigned to `members`.\nFor exa
mple, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired", |
989 "type": "string" | 867 "type": "string" |
990 } | 868 } |
991 }, | 869 }, |
992 "type": "object" | 870 "type": "object" |
993 }, | 871 }, |
994 "ListTopicsResponse": { | 872 "AcknowledgeRequest": { |
995 "description": "Response for the `ListTopics` method.", | 873 "description": "Request for the Acknowledge method.", |
996 "id": "ListTopicsResponse", | 874 "id": "AcknowledgeRequest", |
997 "properties": { | 875 "properties": { |
998 "topics": { | 876 "ackIds": { |
999 "description": "The resulting topics.", | 877 "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.", |
1000 "items": { | 878 "items": { |
1001 "$ref": "Topic" | 879 "type": "string" |
1002 }, | 880 }, |
1003 "type": "array" | 881 "type": "array" |
1004 }, | |
1005 "nextPageToken": { | |
1006 "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`.", | |
1007 "type": "string" | |
1008 } | 882 } |
1009 }, | 883 }, |
1010 "type": "object" | 884 "type": "object" |
1011 }, | 885 }, |
1012 "Empty": { | 886 "Empty": { |
1013 "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 `{}`.", | 887 "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 `{}`.", |
1014 "id": "Empty", | 888 "id": "Empty", |
1015 "properties": {}, | 889 "properties": {}, |
1016 "type": "object" | 890 "type": "object" |
1017 }, | 891 }, |
1018 "AcknowledgeRequest": { | 892 "ListTopicsResponse": { |
1019 "description": "Request for the Acknowledge method.", | 893 "description": "Response for the `ListTopics` method.", |
1020 "id": "AcknowledgeRequest", | 894 "id": "ListTopicsResponse", |
1021 "properties": { | 895 "properties": { |
1022 "ackIds": { | 896 "nextPageToken": { |
1023 "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.", | 897 "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`.", |
| 898 "type": "string" |
| 899 }, |
| 900 "topics": { |
| 901 "description": "The resulting topics.", |
1024 "items": { | 902 "items": { |
1025 "type": "string" | 903 "$ref": "Topic" |
1026 }, | 904 }, |
1027 "type": "array" | 905 "type": "array" |
1028 } | 906 } |
1029 }, | 907 }, |
1030 "type": "object" | 908 "type": "object" |
1031 }, | 909 }, |
1032 "ListTopicSubscriptionsResponse": { | 910 "ListTopicSubscriptionsResponse": { |
1033 "description": "Response for the `ListTopicSubscriptions` method.", | 911 "description": "Response for the `ListTopicSubscriptions` method.", |
1034 "id": "ListTopicSubscriptionsResponse", | 912 "id": "ListTopicSubscriptionsResponse", |
1035 "properties": { | 913 "properties": { |
| 914 "nextPageToken": { |
| 915 "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.", |
| 916 "type": "string" |
| 917 }, |
1036 "subscriptions": { | 918 "subscriptions": { |
1037 "description": "The names of the subscriptions that match th
e request.", | 919 "description": "The names of the subscriptions that match th
e request.", |
1038 "items": { | 920 "items": { |
1039 "type": "string" | 921 "type": "string" |
1040 }, | 922 }, |
1041 "type": "array" | 923 "type": "array" |
| 924 } |
| 925 }, |
| 926 "type": "object" |
| 927 }, |
| 928 "PullResponse": { |
| 929 "description": "Response for the `Pull` method.", |
| 930 "id": "PullResponse", |
| 931 "properties": { |
| 932 "receivedMessages": { |
| 933 "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.", |
| 934 "items": { |
| 935 "$ref": "ReceivedMessage" |
| 936 }, |
| 937 "type": "array" |
| 938 } |
| 939 }, |
| 940 "type": "object" |
| 941 }, |
| 942 "ReceivedMessage": { |
| 943 "description": "A message and its corresponding acknowledgment ID.", |
| 944 "id": "ReceivedMessage", |
| 945 "properties": { |
| 946 "message": { |
| 947 "$ref": "PubsubMessage", |
| 948 "description": "The message." |
1042 }, | 949 }, |
1043 "nextPageToken": { | 950 "ackId": { |
1044 "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.", | 951 "description": "This ID can be used to acknowledge the recei
ved message.", |
1045 "type": "string" | 952 "type": "string" |
1046 } | 953 } |
1047 }, | 954 }, |
1048 "type": "object" | 955 "type": "object" |
| 956 }, |
| 957 "PushConfig": { |
| 958 "description": "Configuration for a push delivery endpoint.", |
| 959 "id": "PushConfig", |
| 960 "properties": { |
| 961 "pushEndpoint": { |
| 962 "description": "A URL locating the endpoint to which message
s should be pushed.\nFor example, a Webhook endpoint might use \"https://example
.com/push\".", |
| 963 "type": "string" |
| 964 }, |
| 965 "attributes": { |
| 966 "additionalProperties": { |
| 967 "type": "string" |
| 968 }, |
| 969 "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 push message. Th
is attribute\nindicates the version of the data expected by the endpoint. This\n
controls the shape of the envelope (i.e. its fields and metadata).\nThe endpoint
version is based on the version of the Pub/Sub\nAPI.\n\nIf not present during t
he `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 value wil
l not be changed. `GetSubscription`\ncalls will always return a valid version, e
ven if the subscription was\ncreated without this attribute.\n\nThe possible val
ues 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 v
1 Pub/Sub API.", |
| 970 "type": "object" |
| 971 } |
| 972 }, |
| 973 "type": "object" |
| 974 }, |
| 975 "TestIamPermissionsResponse": { |
| 976 "description": "Response message for `TestIamPermissions` method.", |
| 977 "id": "TestIamPermissionsResponse", |
| 978 "properties": { |
| 979 "permissions": { |
| 980 "description": "A subset of `TestPermissionsRequest.permissi
ons` that the caller is\nallowed.", |
| 981 "items": { |
| 982 "type": "string" |
| 983 }, |
| 984 "type": "array" |
| 985 } |
| 986 }, |
| 987 "type": "object" |
| 988 }, |
| 989 "PullRequest": { |
| 990 "description": "Request for the `Pull` method.", |
| 991 "id": "PullRequest", |
| 992 "properties": { |
| 993 "returnImmediately": { |
| 994 "description": "If this is specified as true the system will
respond immediately even if\nit is not able to return a message in the `Pull` r
esponse. Otherwise the\nsystem is allowed to wait until at least one message is
available rather\nthan returning no messages. The client may cancel the request
if it does\nnot wish to wait any longer for the response.", |
| 995 "type": "boolean" |
| 996 }, |
| 997 "maxMessages": { |
| 998 "description": "The maximum number of messages returned for
this request. The Pub/Sub\nsystem may return fewer than the number specified.", |
| 999 "format": "int32", |
| 1000 "type": "integer" |
| 1001 } |
| 1002 }, |
| 1003 "type": "object" |
| 1004 }, |
| 1005 "ListSubscriptionsResponse": { |
| 1006 "description": "Response for the `ListSubscriptions` method.", |
| 1007 "id": "ListSubscriptionsResponse", |
| 1008 "properties": { |
| 1009 "nextPageToken": { |
| 1010 "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.", |
| 1011 "type": "string" |
| 1012 }, |
| 1013 "subscriptions": { |
| 1014 "description": "The subscriptions that match the request.", |
| 1015 "items": { |
| 1016 "$ref": "Subscription" |
| 1017 }, |
| 1018 "type": "array" |
| 1019 } |
| 1020 }, |
| 1021 "type": "object" |
| 1022 }, |
| 1023 "PublishRequest": { |
| 1024 "description": "Request for the Publish method.", |
| 1025 "id": "PublishRequest", |
| 1026 "properties": { |
| 1027 "messages": { |
| 1028 "description": "The messages to publish.", |
| 1029 "items": { |
| 1030 "$ref": "PubsubMessage" |
| 1031 }, |
| 1032 "type": "array" |
| 1033 } |
| 1034 }, |
| 1035 "type": "object" |
| 1036 }, |
| 1037 "PublishResponse": { |
| 1038 "description": "Response for the `Publish` method.", |
| 1039 "id": "PublishResponse", |
| 1040 "properties": { |
| 1041 "messageIds": { |
| 1042 "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.", |
| 1043 "items": { |
| 1044 "type": "string" |
| 1045 }, |
| 1046 "type": "array" |
| 1047 } |
| 1048 }, |
| 1049 "type": "object" |
1049 } | 1050 } |
1050 }, | 1051 }, |
1051 "servicePath": "", | 1052 "servicePath": "", |
1052 "title": "Google Cloud Pub/Sub API", | 1053 "title": "Google Cloud Pub/Sub API", |
1053 "version": "v1beta2" | 1054 "version": "v1beta2" |
1054 } | 1055 } |
OLD | NEW |