| OLD | NEW |
|---|
| 1 { | 1 { |
| 2 "auth": { | 2 "auth": { |
| 3 "oauth2": { | 3 "oauth2": { |
| 4 "scopes": { | 4 "scopes": { |
| 5 "https://www.googleapis.com/auth/cloud-platform": { | 5 "https://www.googleapis.com/auth/cloud-platform": { |
| 6 "description": "View and manage your data across Google Clou
d Platform services" | 6 "description": "View and manage your data across Google Clou
d Platform services" |
| 7 }, | 7 }, |
| 8 "https://www.googleapis.com/auth/pubsub": { | 8 "https://www.googleapis.com/auth/pubsub": { |
| 9 "description": "View and manage Pub/Sub topics and subscript
ions" | 9 "description": "View and manage Pub/Sub topics and subscript
ions" |
| 10 } | 10 } |
| 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 "description": "Provides reliable, many-to-many, asynchronous messaging betw
een applications.", | 17 "description": "Provides reliable, many-to-many, asynchronous messaging betw
een applications.\n", |
| 18 "discoveryVersion": "v1", | 18 "discoveryVersion": "v1", |
| 19 "documentationLink": "https://cloud.google.com/pubsub/docs", | 19 "documentationLink": "https://cloud.google.com/pubsub/docs", |
| 20 "etag": "\"tbys6C40o18GZwyMen5GMkdK-3s/0vA2xGfn2MUMrRKKZWbff76Y_7U\"", | |
| 21 "icons": { | 20 "icons": { |
| 22 "x16": "http://www.google.com/images/icons/product/search-16.gif", | 21 "x16": "http://www.google.com/images/icons/product/search-16.gif", |
| 23 "x32": "http://www.google.com/images/icons/product/search-32.gif" | 22 "x32": "http://www.google.com/images/icons/product/search-32.gif" |
| 24 }, | 23 }, |
| 25 "id": "pubsub:v1beta2", | 24 "id": "pubsub:v1beta2", |
| 26 "kind": "discovery#restDescription", | 25 "kind": "discovery#restDescription", |
| 27 "name": "pubsub", | 26 "name": "pubsub", |
| 28 "ownerDomain": "google.com", | 27 "ownerDomain": "google.com", |
| 29 "ownerName": "Google", | 28 "ownerName": "Google", |
| 30 "parameters": { | 29 "parameters": { |
| 31 "access_token": { | 30 "access_token": { |
| 32 "description": "OAuth access token.", | 31 "description": "OAuth access token.", |
| 33 "location": "query", | 32 "location": "query", |
| 34 "type": "string" | 33 "type": "string" |
| 35 }, | 34 }, |
| 35 "prettyPrint": { |
| 36 "default": "true", |
| 37 "description": "Returns response with indentations and line breaks."
, |
| 38 "location": "query", |
| 39 "type": "boolean" |
| 40 }, |
| 41 "key": { |
| 42 "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.", |
| 43 "location": "query", |
| 44 "type": "string" |
| 45 }, |
| 46 "quotaUser": { |
| 47 "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.", |
| 48 "location": "query", |
| 49 "type": "string" |
| 50 }, |
| 51 "pp": { |
| 52 "default": "true", |
| 53 "description": "Pretty-print response.", |
| 54 "location": "query", |
| 55 "type": "boolean" |
| 56 }, |
| 57 "fields": { |
| 58 "description": "Selector specifying which fields to include in a par
tial response.", |
| 59 "location": "query", |
| 60 "type": "string" |
| 61 }, |
| 36 "alt": { | 62 "alt": { |
| 37 "default": "json", | 63 "default": "json", |
| 38 "description": "Data format for response.", | 64 "description": "Data format for response.", |
| 65 "enum": [ |
| 66 "json", |
| 67 "media", |
| 68 "proto" |
| 69 ], |
| 39 "enumDescriptions": [ | 70 "enumDescriptions": [ |
| 40 "Responses with Content-Type of application/json", | 71 "Responses with Content-Type of application/json", |
| 41 "Media download with context-dependent Content-Type", | 72 "Media download with context-dependent Content-Type", |
| 42 "Responses with Content-Type of application/x-protobuf" | 73 "Responses with Content-Type of application/x-protobuf" |
| 43 ], | 74 ], |
| 44 "location": "query", | 75 "location": "query", |
| 45 "type": "string" | 76 "type": "string" |
| 46 }, | 77 }, |
| 47 "bearer_token": { | 78 "$.xgafv": { |
| 48 "description": "OAuth bearer token.", | 79 "description": "V1 error format.", |
| 80 "enum": [ |
| 81 "1", |
| 82 "2" |
| 83 ], |
| 84 "enumDescriptions": [ |
| 85 "v1 error format", |
| 86 "v2 error format" |
| 87 ], |
| 49 "location": "query", | 88 "location": "query", |
| 50 "type": "string" | 89 "type": "string" |
| 51 }, | 90 }, |
| 52 "callback": { | 91 "callback": { |
| 53 "description": "JSONP", | 92 "description": "JSONP", |
| 54 "location": "query", | 93 "location": "query", |
| 55 "type": "string" | 94 "type": "string" |
| 56 }, | 95 }, |
| 57 "fields": { | |
| 58 "description": "Selector specifying which fields to include in a par
tial response.", | |
| 59 "location": "query", | |
| 60 "type": "string" | |
| 61 }, | |
| 62 "key": { | |
| 63 "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.", | |
| 64 "location": "query", | |
| 65 "type": "string" | |
| 66 }, | |
| 67 "oauth_token": { | 96 "oauth_token": { |
| 68 "description": "OAuth 2.0 token for the current user.", | 97 "description": "OAuth 2.0 token for the current user.", |
| 69 "location": "query", | 98 "location": "query", |
| 70 "type": "string" | 99 "type": "string" |
| 71 }, | 100 }, |
| 72 "pp": { | 101 "uploadType": { |
| 73 "default": "true", | 102 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", |
| 74 "description": "Pretty-print response.", | |
| 75 "location": "query", | |
| 76 "type": "boolean" | |
| 77 }, | |
| 78 "prettyPrint": { | |
| 79 "default": "true", | |
| 80 "description": "Returns response with indentations and line breaks."
, | |
| 81 "location": "query", | |
| 82 "type": "boolean" | |
| 83 }, | |
| 84 "quotaUser": { | |
| 85 "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.", | |
| 86 "location": "query", | 103 "location": "query", |
| 87 "type": "string" | 104 "type": "string" |
| 88 }, | 105 }, |
| 106 "bearer_token": { |
| 107 "description": "OAuth bearer token.", |
| 108 "location": "query", |
| 109 "type": "string" |
| 110 }, |
| 89 "upload_protocol": { | 111 "upload_protocol": { |
| 90 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", | 112 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", |
| 91 "location": "query", | 113 "location": "query", |
| 92 "type": "string" | 114 "type": "string" |
| 93 }, | |
| 94 "uploadType": { | |
| 95 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", | |
| 96 "location": "query", | |
| 97 "type": "string" | |
| 98 }, | |
| 99 "$.xgafv": { | |
| 100 "description": "V1 error format.", | |
| 101 "enumDescriptions": [ | |
| 102 "v1 error format", | |
| 103 "v2 error format" | |
| 104 ], | |
| 105 "location": "query", | |
| 106 "type": "string" | |
| 107 } | 115 } |
| 108 }, | 116 }, |
| 109 "protocol": "rest", | 117 "protocol": "rest", |
| 110 "resources": { | 118 "resources": { |
| 111 "projects": { | 119 "projects": { |
| 112 "resources": { | 120 "resources": { |
| 113 "topics": { | 121 "subscriptions": { |
| 114 "methods": { | 122 "methods": { |
| 115 "setIamPolicy": { | 123 "modifyPushConfig": { |
| 116 "description": "Sets the access control policy on th
e specified resource. Replaces any existing policy.", | 124 "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`
.", |
| 117 "httpMethod": "POST", | 125 "httpMethod": "POST", |
| 118 "id": "pubsub.projects.topics.setIamPolicy", | 126 "id": "pubsub.projects.subscriptions.modifyPushConfi
g", |
| 119 "parameterOrder": [ | 127 "parameterOrder": [ |
| 120 "resource" | 128 "subscription" |
| 121 ], | 129 ], |
| 122 "parameters": { | 130 "parameters": { |
| 123 "resource": { | 131 "subscription": { |
| 124 "description": "REQUIRED: The resource for w
hich the policy is being specified. `resource` is usually specified as a path. F
or example, a Project resource is specified as `projects/{project}`.", | 132 "description": "The name of the subscription
.", |
| 125 "location": "path", | 133 "location": "path", |
| 126 "pattern": "^projects/[^/]*/topics/[^/]*$", | 134 "pattern": "^projects/[^/]+/subscriptions/[^
/]+$", |
| 127 "required": true, | 135 "required": true, |
| 128 "type": "string" | 136 "type": "string" |
| 129 } | 137 } |
| 130 }, | 138 }, |
| 131 "path": "v1beta2/{+resource}:setIamPolicy", | 139 "path": "v1beta2/{+subscription}:modifyPushConfig", |
| 132 "request": { | 140 "request": { |
| 133 "$ref": "SetIamPolicyRequest" | 141 "$ref": "ModifyPushConfigRequest" |
| 134 }, | 142 }, |
| 135 "response": { | 143 "response": { |
| 136 "$ref": "Policy" | 144 "$ref": "Empty" |
| 137 }, | 145 }, |
| 138 "scopes": [ | 146 "scopes": [ |
| 139 "https://www.googleapis.com/auth/cloud-platform"
, | 147 "https://www.googleapis.com/auth/cloud-platform"
, |
| 140 "https://www.googleapis.com/auth/pubsub" | 148 "https://www.googleapis.com/auth/pubsub" |
| 141 ] | 149 ] |
| 142 }, | 150 }, |
| 143 "getIamPolicy": { | 151 "getIamPolicy": { |
| 144 "description": "Gets the access control policy for a
resource. Returns an empty policy if the resource exists and does not have a po
licy set.", | 152 "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.", |
| 145 "httpMethod": "GET", | 153 "httpMethod": "GET", |
| 146 "id": "pubsub.projects.topics.getIamPolicy", | 154 "id": "pubsub.projects.subscriptions.getIamPolicy", |
| 147 "parameterOrder": [ | 155 "parameterOrder": [ |
| 148 "resource" | 156 "resource" |
| 149 ], | 157 ], |
| 150 "parameters": { | 158 "parameters": { |
| 151 "resource": { | 159 "resource": { |
| 152 "description": "REQUIRED: The resource for w
hich the policy is being requested. `resource` is usually specified as a path. F
or example, a Project resource is specified as `projects/{project}`.", | 160 "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}`.", |
| 153 "location": "path", | 161 "location": "path", |
| 154 "pattern": "^projects/[^/]*/topics/[^/]*$", | 162 "pattern": "^projects/[^/]+/subscriptions/[^
/]+$", |
| 155 "required": true, | 163 "required": true, |
| 156 "type": "string" | 164 "type": "string" |
| 157 } | 165 } |
| 158 }, | 166 }, |
| 159 "path": "v1beta2/{+resource}:getIamPolicy", | 167 "path": "v1beta2/{+resource}:getIamPolicy", |
| 160 "response": { | 168 "response": { |
| 161 "$ref": "Policy" | 169 "$ref": "Policy" |
| 162 }, | 170 }, |
| 163 "scopes": [ | 171 "scopes": [ |
| 164 "https://www.googleapis.com/auth/cloud-platform"
, | 172 "https://www.googleapis.com/auth/cloud-platform"
, |
| 165 "https://www.googleapis.com/auth/pubsub" | 173 "https://www.googleapis.com/auth/pubsub" |
| 166 ] | 174 ] |
| 167 }, | 175 }, |
| 168 "testIamPermissions": { | 176 "pull": { |
| 169 "description": "Returns permissions that a caller ha
s on the specified resource.", | 177 "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.", |
| 170 "httpMethod": "POST", | 178 "httpMethod": "POST", |
| 171 "id": "pubsub.projects.topics.testIamPermissions", | 179 "id": "pubsub.projects.subscriptions.pull", |
| 172 "parameterOrder": [ | 180 "parameterOrder": [ |
| 173 "resource" | 181 "subscription" |
| 174 ], | 182 ], |
| 175 "parameters": { | 183 "parameters": { |
| 176 "resource": { | 184 "subscription": { |
| 177 "description": "REQUIRED: The resource for w
hich the policy detail is being requested. `resource` is usually specified as a
path. For example, a Project resource is specified as `projects/{project}`.", | 185 "description": "The subscription from which
messages should be pulled.", |
| 178 "location": "path", | 186 "location": "path", |
| 179 "pattern": "^projects/[^/]*/topics/[^/]*$", | 187 "pattern": "^projects/[^/]+/subscriptions/[^
/]+$", |
| 180 "required": true, | 188 "required": true, |
| 181 "type": "string" | 189 "type": "string" |
| 182 } | 190 } |
| 183 }, | 191 }, |
| 184 "path": "v1beta2/{+resource}:testIamPermissions", | 192 "path": "v1beta2/{+subscription}:pull", |
| 185 "request": { | 193 "request": { |
| 186 "$ref": "TestIamPermissionsRequest" | 194 "$ref": "PullRequest" |
| 187 }, | 195 }, |
| 188 "response": { | 196 "response": { |
| 189 "$ref": "TestIamPermissionsResponse" | 197 "$ref": "PullResponse" |
| 198 }, |
| 199 "scopes": [ |
| 200 "https://www.googleapis.com/auth/cloud-platform"
, |
| 201 "https://www.googleapis.com/auth/pubsub" |
| 202 ] |
| 203 }, |
| 204 "list": { |
| 205 "description": "Lists matching subscriptions.", |
| 206 "httpMethod": "GET", |
| 207 "id": "pubsub.projects.subscriptions.list", |
| 208 "parameterOrder": [ |
| 209 "project" |
| 210 ], |
| 211 "parameters": { |
| 212 "pageSize": { |
| 213 "description": "Maximum number of subscripti
ons to return.", |
| 214 "format": "int32", |
| 215 "location": "query", |
| 216 "type": "integer" |
| 217 }, |
| 218 "project": { |
| 219 "description": "The name of the cloud projec
t that subscriptions belong to.", |
| 220 "location": "path", |
| 221 "pattern": "^projects/[^/]+$", |
| 222 "required": true, |
| 223 "type": "string" |
| 224 }, |
| 225 "pageToken": { |
| 226 "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.", |
| 227 "location": "query", |
| 228 "type": "string" |
| 229 } |
| 230 }, |
| 231 "path": "v1beta2/{+project}/subscriptions", |
| 232 "response": { |
| 233 "$ref": "ListSubscriptionsResponse" |
| 234 }, |
| 235 "scopes": [ |
| 236 "https://www.googleapis.com/auth/cloud-platform"
, |
| 237 "https://www.googleapis.com/auth/pubsub" |
| 238 ] |
| 239 }, |
| 240 "get": { |
| 241 "description": "Gets the configuration details of a
subscription.", |
| 242 "httpMethod": "GET", |
| 243 "id": "pubsub.projects.subscriptions.get", |
| 244 "parameterOrder": [ |
| 245 "subscription" |
| 246 ], |
| 247 "parameters": { |
| 248 "subscription": { |
| 249 "description": "The name of the subscription
to get.", |
| 250 "location": "path", |
| 251 "pattern": "^projects/[^/]+/subscriptions/[^
/]+$", |
| 252 "required": true, |
| 253 "type": "string" |
| 254 } |
| 255 }, |
| 256 "path": "v1beta2/{+subscription}", |
| 257 "response": { |
| 258 "$ref": "Subscription" |
| 190 }, | 259 }, |
| 191 "scopes": [ | 260 "scopes": [ |
| 192 "https://www.googleapis.com/auth/cloud-platform"
, | 261 "https://www.googleapis.com/auth/cloud-platform"
, |
| 193 "https://www.googleapis.com/auth/pubsub" | 262 "https://www.googleapis.com/auth/pubsub" |
| 194 ] | 263 ] |
| 195 }, | 264 }, |
| 196 "create": { | 265 "create": { |
| 197 "description": "Creates the given topic with the giv
en name.", | 266 "description": "Creates a subscription to a given to
pic.\nIf the subscription already exists, returns `ALREADY_EXISTS`.\nIf the corr
esponding topic doesn't exist, returns `NOT_FOUND`.\n\nIf the name is not provid
ed in the request, the server will assign a random\nname for this subscription o
n the same project as the topic. Note that\nfor REST API requests, you must spec
ify a name.", |
| 198 "httpMethod": "PUT", | 267 "httpMethod": "PUT", |
| 199 "id": "pubsub.projects.topics.create", | 268 "id": "pubsub.projects.subscriptions.create", |
| 200 "parameterOrder": [ | 269 "parameterOrder": [ |
| 201 "name" | 270 "name" |
| 202 ], | 271 ], |
| 203 "parameters": { | 272 "parameters": { |
| 204 "name": { | 273 "name": { |
| 205 "description": "The name of the topic. It mu
st have the format `\"projects/{project}/topics/{topic}\"`. `{topic}` must start
with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes
(`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent si
gns (`%`). It must be between 3 and 255 characters in length, and it must not st
art with `\"goog\"`.", | 274 "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\"`.", |
| 206 "location": "path", | 275 "location": "path", |
| 207 "pattern": "^projects/[^/]*/topics/[^/]*$", | 276 "pattern": "^projects/[^/]+/subscriptions/[^
/]+$", |
| 208 "required": true, | 277 "required": true, |
| 209 "type": "string" | 278 "type": "string" |
| 210 } | 279 } |
| 211 }, | 280 }, |
| 212 "path": "v1beta2/{+name}", | 281 "path": "v1beta2/{+name}", |
| 213 "request": { | 282 "request": { |
| 214 "$ref": "Topic" | 283 "$ref": "Subscription" |
| 215 }, | 284 }, |
| 216 "response": { | 285 "response": { |
| 217 "$ref": "Topic" | 286 "$ref": "Subscription" |
| 218 }, | 287 }, |
| 219 "scopes": [ | 288 "scopes": [ |
| 220 "https://www.googleapis.com/auth/cloud-platform"
, | 289 "https://www.googleapis.com/auth/cloud-platform"
, |
| 221 "https://www.googleapis.com/auth/pubsub" | 290 "https://www.googleapis.com/auth/pubsub" |
| 222 ] | 291 ] |
| 223 }, | 292 }, |
| 224 "publish": { | 293 "modifyAckDeadline": { |
| 225 "description": "Adds one or more messages to the top
ic. Returns `NOT_FOUND` if the topic does not exist. The message payload must no
t be empty; it must contain either a non-empty data field, or at least one attri
bute.", | 294 "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.", |
| 226 "httpMethod": "POST", | 295 "httpMethod": "POST", |
| 227 "id": "pubsub.projects.topics.publish", | 296 "id": "pubsub.projects.subscriptions.modifyAckDeadli
ne", |
| 228 "parameterOrder": [ | 297 "parameterOrder": [ |
| 229 "topic" | 298 "subscription" |
| 230 ], | 299 ], |
| 231 "parameters": { | 300 "parameters": { |
| 232 "topic": { | 301 "subscription": { |
| 233 "description": "The messages in the request
will be published on this topic.", | 302 "description": "The name of the subscription
.", |
| 234 "location": "path", | 303 "location": "path", |
| 235 "pattern": "^projects/[^/]*/topics/[^/]*$", | 304 "pattern": "^projects/[^/]+/subscriptions/[^
/]+$", |
| 236 "required": true, | 305 "required": true, |
| 237 "type": "string" | 306 "type": "string" |
| 238 } | 307 } |
| 239 }, | 308 }, |
| 240 "path": "v1beta2/{+topic}:publish", | 309 "path": "v1beta2/{+subscription}:modifyAckDeadline", |
| 241 "request": { | 310 "request": { |
| 242 "$ref": "PublishRequest" | 311 "$ref": "ModifyAckDeadlineRequest" |
| 243 }, | 312 }, |
| 244 "response": { | 313 "response": { |
| 245 "$ref": "PublishResponse" | 314 "$ref": "Empty" |
| 246 }, | 315 }, |
| 247 "scopes": [ | 316 "scopes": [ |
| 248 "https://www.googleapis.com/auth/cloud-platform"
, | 317 "https://www.googleapis.com/auth/cloud-platform"
, |
| 249 "https://www.googleapis.com/auth/pubsub" | 318 "https://www.googleapis.com/auth/pubsub" |
| 250 ] | 319 ] |
| 251 }, | 320 }, |
| 252 "get": { | 321 "setIamPolicy": { |
| 253 "description": "Gets the configuration of a topic.", | 322 "description": "Sets the access control policy on th
e specified resource. Replaces any\nexisting policy.", |
| 254 "httpMethod": "GET", | 323 "httpMethod": "POST", |
| 255 "id": "pubsub.projects.topics.get", | 324 "id": "pubsub.projects.subscriptions.setIamPolicy", |
| 256 "parameterOrder": [ | 325 "parameterOrder": [ |
| 257 "topic" | 326 "resource" |
| 258 ], | 327 ], |
| 259 "parameters": { | 328 "parameters": { |
| 260 "topic": { | 329 "resource": { |
| 261 "description": "The name of the topic to get
.", | 330 "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}`.", |
| 262 "location": "path", | 331 "location": "path", |
| 263 "pattern": "^projects/[^/]*/topics/[^/]*$", | 332 "pattern": "^projects/[^/]+/subscriptions/[^
/]+$", |
| 264 "required": true, | 333 "required": true, |
| 265 "type": "string" | 334 "type": "string" |
| 266 } | 335 } |
| 267 }, | 336 }, |
| 268 "path": "v1beta2/{+topic}", | 337 "path": "v1beta2/{+resource}:setIamPolicy", |
| 338 "request": { |
| 339 "$ref": "SetIamPolicyRequest" |
| 340 }, |
| 269 "response": { | 341 "response": { |
| 270 "$ref": "Topic" | 342 "$ref": "Policy" |
| 271 }, | 343 }, |
| 272 "scopes": [ | 344 "scopes": [ |
| 273 "https://www.googleapis.com/auth/cloud-platform"
, | 345 "https://www.googleapis.com/auth/cloud-platform"
, |
| 274 "https://www.googleapis.com/auth/pubsub" | |
| 275 ] | |
| 276 }, | |
| 277 "list": { | |
| 278 "description": "Lists matching topics.", | |
| 279 "httpMethod": "GET", | |
| 280 "id": "pubsub.projects.topics.list", | |
| 281 "parameterOrder": [ | |
| 282 "project" | |
| 283 ], | |
| 284 "parameters": { | |
| 285 "project": { | |
| 286 "description": "The name of the cloud projec
t that topics belong to.", | |
| 287 "location": "path", | |
| 288 "pattern": "^projects/[^/]*$", | |
| 289 "required": true, | |
| 290 "type": "string" | |
| 291 }, | |
| 292 "pageSize": { | |
| 293 "description": "Maximum number of topics to
return.", | |
| 294 "format": "int32", | |
| 295 "location": "query", | |
| 296 "type": "integer" | |
| 297 }, | |
| 298 "pageToken": { | |
| 299 "description": "The value returned by the la
st `ListTopicsResponse`; indicates that this is a continuation of a prior `ListT
opics` call, and that the system should return the next page of data.", | |
| 300 "location": "query", | |
| 301 "type": "string" | |
| 302 } | |
| 303 }, | |
| 304 "path": "v1beta2/{+project}/topics", | |
| 305 "response": { | |
| 306 "$ref": "ListTopicsResponse" | |
| 307 }, | |
| 308 "scopes": [ | |
| 309 "https://www.googleapis.com/auth/cloud-platform"
, | |
| 310 "https://www.googleapis.com/auth/pubsub" | 346 "https://www.googleapis.com/auth/pubsub" |
| 311 ] | 347 ] |
| 312 }, | 348 }, |
| 313 "delete": { | 349 "delete": { |
| 314 "description": "Deletes the topic with the given nam
e. Returns `NOT_FOUND` if the topic does not exist. After a topic is deleted, a
new topic may be created with the same name; this is an entirely new topic with
none of the old configuration or subscriptions. Existing subscriptions to this t
opic are not deleted, but their `topic` field is set to `_deleted-topic_`.", | 350 "description": "Deletes an existing subscription. Al
l pending messages in the subscription\nare immediately dropped. Calls to `Pull`
after deletion will return\n`NOT_FOUND`. After a subscription is deleted, a new
one may be created with\nthe same name, but the new one has no association with
the old\nsubscription, or its topic unless the same topic is specified.", |
| 315 "httpMethod": "DELETE", | 351 "httpMethod": "DELETE", |
| 316 "id": "pubsub.projects.topics.delete", | 352 "id": "pubsub.projects.subscriptions.delete", |
| 317 "parameterOrder": [ | 353 "parameterOrder": [ |
| 318 "topic" | 354 "subscription" |
| 319 ], | 355 ], |
| 320 "parameters": { | 356 "parameters": { |
| 321 "topic": { | 357 "subscription": { |
| 322 "description": "Name of the topic to delete.
", | 358 "description": "The subscription to delete."
, |
| 323 "location": "path", | 359 "location": "path", |
| 324 "pattern": "^projects/[^/]*/topics/[^/]*$", | 360 "pattern": "^projects/[^/]+/subscriptions/[^
/]+$", |
| 325 "required": true, | 361 "required": true, |
| 326 "type": "string" | 362 "type": "string" |
| 327 } | 363 } |
| 328 }, | 364 }, |
| 329 "path": "v1beta2/{+topic}", | 365 "path": "v1beta2/{+subscription}", |
| 330 "response": { | 366 "response": { |
| 331 "$ref": "Empty" | 367 "$ref": "Empty" |
| 332 }, | 368 }, |
| 333 "scopes": [ | 369 "scopes": [ |
| 334 "https://www.googleapis.com/auth/cloud-platform"
, | 370 "https://www.googleapis.com/auth/cloud-platform"
, |
| 335 "https://www.googleapis.com/auth/pubsub" | 371 "https://www.googleapis.com/auth/pubsub" |
| 336 ] | 372 ] |
| 337 } | |
| 338 }, | |
| 339 "resources": { | |
| 340 "subscriptions": { | |
| 341 "methods": { | |
| 342 "list": { | |
| 343 "description": "Lists the name of the subscr
iptions for this topic.", | |
| 344 "httpMethod": "GET", | |
| 345 "id": "pubsub.projects.topics.subscriptions.
list", | |
| 346 "parameterOrder": [ | |
| 347 "topic" | |
| 348 ], | |
| 349 "parameters": { | |
| 350 "topic": { | |
| 351 "description": "The name of the topi
c that subscriptions are attached to.", | |
| 352 "location": "path", | |
| 353 "pattern": "^projects/[^/]*/topics/[
^/]*$", | |
| 354 "required": true, | |
| 355 "type": "string" | |
| 356 }, | |
| 357 "pageSize": { | |
| 358 "description": "Maximum number of su
bscription names to return.", | |
| 359 "format": "int32", | |
| 360 "location": "query", | |
| 361 "type": "integer" | |
| 362 }, | |
| 363 "pageToken": { | |
| 364 "description": "The value returned b
y the last `ListTopicSubscriptionsResponse`; indicates that this is a continuati
on of a prior `ListTopicSubscriptions` call, and that the system should return t
he next page of data.", | |
| 365 "location": "query", | |
| 366 "type": "string" | |
| 367 } | |
| 368 }, | |
| 369 "path": "v1beta2/{+topic}/subscriptions", | |
| 370 "response": { | |
| 371 "$ref": "ListTopicSubscriptionsResponse" | |
| 372 }, | |
| 373 "scopes": [ | |
| 374 "https://www.googleapis.com/auth/cloud-p
latform", | |
| 375 "https://www.googleapis.com/auth/pubsub" | |
| 376 ] | |
| 377 } | |
| 378 } | |
| 379 } | |
| 380 } | |
| 381 }, | |
| 382 "subscriptions": { | |
| 383 "methods": { | |
| 384 "setIamPolicy": { | |
| 385 "description": "Sets the access control policy on th
e specified resource. Replaces any existing policy.", | |
| 386 "httpMethod": "POST", | |
| 387 "id": "pubsub.projects.subscriptions.setIamPolicy", | |
| 388 "parameterOrder": [ | |
| 389 "resource" | |
| 390 ], | |
| 391 "parameters": { | |
| 392 "resource": { | |
| 393 "description": "REQUIRED: The resource for w
hich the policy is being specified. `resource` is usually specified as a path. F
or example, a Project resource is specified as `projects/{project}`.", | |
| 394 "location": "path", | |
| 395 "pattern": "^projects/[^/]*/subscriptions/[^
/]*$", | |
| 396 "required": true, | |
| 397 "type": "string" | |
| 398 } | |
| 399 }, | |
| 400 "path": "v1beta2/{+resource}:setIamPolicy", | |
| 401 "request": { | |
| 402 "$ref": "SetIamPolicyRequest" | |
| 403 }, | |
| 404 "response": { | |
| 405 "$ref": "Policy" | |
| 406 }, | |
| 407 "scopes": [ | |
| 408 "https://www.googleapis.com/auth/cloud-platform"
, | |
| 409 "https://www.googleapis.com/auth/pubsub" | |
| 410 ] | |
| 411 }, | |
| 412 "getIamPolicy": { | |
| 413 "description": "Gets the access control policy for a
resource. Returns an empty policy if the resource exists and does not have a po
licy set.", | |
| 414 "httpMethod": "GET", | |
| 415 "id": "pubsub.projects.subscriptions.getIamPolicy", | |
| 416 "parameterOrder": [ | |
| 417 "resource" | |
| 418 ], | |
| 419 "parameters": { | |
| 420 "resource": { | |
| 421 "description": "REQUIRED: The resource for w
hich the policy is being requested. `resource` is usually specified as a path. F
or example, a Project resource is specified as `projects/{project}`.", | |
| 422 "location": "path", | |
| 423 "pattern": "^projects/[^/]*/subscriptions/[^
/]*$", | |
| 424 "required": true, | |
| 425 "type": "string" | |
| 426 } | |
| 427 }, | |
| 428 "path": "v1beta2/{+resource}:getIamPolicy", | |
| 429 "response": { | |
| 430 "$ref": "Policy" | |
| 431 }, | |
| 432 "scopes": [ | |
| 433 "https://www.googleapis.com/auth/cloud-platform"
, | |
| 434 "https://www.googleapis.com/auth/pubsub" | |
| 435 ] | |
| 436 }, | 373 }, |
| 437 "testIamPermissions": { | 374 "testIamPermissions": { |
| 438 "description": "Returns permissions that a caller ha
s on the specified resource.", | 375 "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.", |
| 439 "httpMethod": "POST", | 376 "httpMethod": "POST", |
| 440 "id": "pubsub.projects.subscriptions.testIamPermissi
ons", | 377 "id": "pubsub.projects.subscriptions.testIamPermissi
ons", |
| 441 "parameterOrder": [ | 378 "parameterOrder": [ |
| 442 "resource" | 379 "resource" |
| 443 ], | 380 ], |
| 444 "parameters": { | 381 "parameters": { |
| 445 "resource": { | 382 "resource": { |
| 446 "description": "REQUIRED: The resource for w
hich the policy detail is being requested. `resource` is usually specified as a
path. For example, a Project resource is specified as `projects/{project}`.", | 383 "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}`.", |
| 447 "location": "path", | 384 "location": "path", |
| 448 "pattern": "^projects/[^/]*/subscriptions/[^
/]*$", | 385 "pattern": "^projects/[^/]+/subscriptions/[^
/]+$", |
| 449 "required": true, | 386 "required": true, |
| 450 "type": "string" | 387 "type": "string" |
| 451 } | 388 } |
| 452 }, | 389 }, |
| 453 "path": "v1beta2/{+resource}:testIamPermissions", | 390 "path": "v1beta2/{+resource}:testIamPermissions", |
| 454 "request": { | 391 "request": { |
| 455 "$ref": "TestIamPermissionsRequest" | 392 "$ref": "TestIamPermissionsRequest" |
| 456 }, | 393 }, |
| 457 "response": { | 394 "response": { |
| 458 "$ref": "TestIamPermissionsResponse" | 395 "$ref": "TestIamPermissionsResponse" |
| 459 }, | 396 }, |
| 460 "scopes": [ | 397 "scopes": [ |
| 461 "https://www.googleapis.com/auth/cloud-platform"
, | 398 "https://www.googleapis.com/auth/cloud-platform"
, |
| 462 "https://www.googleapis.com/auth/pubsub" | 399 "https://www.googleapis.com/auth/pubsub" |
| 463 ] | 400 ] |
| 464 }, | 401 }, |
| 465 "create": { | 402 "acknowledge": { |
| 466 "description": "Creates a subscription to a given to
pic. If the subscription already exists, returns `ALREADY_EXISTS`. If the corres
ponding topic doesn't exist, returns `NOT_FOUND`. If the name is not provided in
the request, the server will assign a random name for this subscription on the
same project as the topic. Note that for REST API requests, you must specify a n
ame.", | 403 "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.", |
| 467 "httpMethod": "PUT", | 404 "httpMethod": "POST", |
| 468 "id": "pubsub.projects.subscriptions.create", | 405 "id": "pubsub.projects.subscriptions.acknowledge", |
| 469 "parameterOrder": [ | 406 "parameterOrder": [ |
| 470 "name" | 407 "subscription" |
| 471 ], | 408 ], |
| 472 "parameters": { | 409 "parameters": { |
| 473 "name": { | 410 "subscription": { |
| 474 "description": "The name of the subscription
. It must have the format `\"projects/{project}/subscriptions/{subscription}\"`.
`{subscription}` must start with a letter, and contain only letters (`[A-Za-z]`
), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~
`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters i
n length, and it must not start with `\"goog\"`.", | 411 "description": "The subscription whose messa
ge is being acknowledged.", |
| 475 "location": "path", | 412 "location": "path", |
| 476 "pattern": "^projects/[^/]*/subscriptions/[^
/]*$", | 413 "pattern": "^projects/[^/]+/subscriptions/[^
/]+$", |
| 477 "required": true, | 414 "required": true, |
| 478 "type": "string" | 415 "type": "string" |
| 479 } | 416 } |
| 480 }, | 417 }, |
| 481 "path": "v1beta2/{+name}", | 418 "path": "v1beta2/{+subscription}:acknowledge", |
| 482 "request": { | 419 "request": { |
| 483 "$ref": "Subscription" | 420 "$ref": "AcknowledgeRequest" |
| 484 }, | 421 }, |
| 485 "response": { | 422 "response": { |
| 486 "$ref": "Subscription" | 423 "$ref": "Empty" |
| 424 }, |
| 425 "scopes": [ |
| 426 "https://www.googleapis.com/auth/cloud-platform"
, |
| 427 "https://www.googleapis.com/auth/pubsub" |
| 428 ] |
| 429 } |
| 430 } |
| 431 }, |
| 432 "topics": { |
| 433 "methods": { |
| 434 "getIamPolicy": { |
| 435 "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.", |
| 436 "httpMethod": "GET", |
| 437 "id": "pubsub.projects.topics.getIamPolicy", |
| 438 "parameterOrder": [ |
| 439 "resource" |
| 440 ], |
| 441 "parameters": { |
| 442 "resource": { |
| 443 "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}`.", |
| 444 "location": "path", |
| 445 "pattern": "^projects/[^/]+/topics/[^/]+$", |
| 446 "required": true, |
| 447 "type": "string" |
| 448 } |
| 449 }, |
| 450 "path": "v1beta2/{+resource}:getIamPolicy", |
| 451 "response": { |
| 452 "$ref": "Policy" |
| 487 }, | 453 }, |
| 488 "scopes": [ | 454 "scopes": [ |
| 489 "https://www.googleapis.com/auth/cloud-platform"
, | 455 "https://www.googleapis.com/auth/cloud-platform"
, |
| 490 "https://www.googleapis.com/auth/pubsub" | 456 "https://www.googleapis.com/auth/pubsub" |
| 491 ] | 457 ] |
| 492 }, | 458 }, |
| 493 "get": { | 459 "publish": { |
| 494 "description": "Gets the configuration details of a
subscription.", | 460 "description": "Adds one or more messages to the top
ic. Returns `NOT_FOUND` if the topic\ndoes not exist. The message payload must n
ot be empty; it must contain\n either a non-empty data field, or at least one at
tribute.", |
| 495 "httpMethod": "GET", | 461 "httpMethod": "POST", |
| 496 "id": "pubsub.projects.subscriptions.get", | 462 "id": "pubsub.projects.topics.publish", |
| 497 "parameterOrder": [ | 463 "parameterOrder": [ |
| 498 "subscription" | 464 "topic" |
| 499 ], | 465 ], |
| 500 "parameters": { | 466 "parameters": { |
| 501 "subscription": { | 467 "topic": { |
| 502 "description": "The name of the subscription
to get.", | 468 "description": "The messages in the request
will be published on this topic.", |
| 503 "location": "path", | 469 "location": "path", |
| 504 "pattern": "^projects/[^/]*/subscriptions/[^
/]*$", | 470 "pattern": "^projects/[^/]+/topics/[^/]+$", |
| 505 "required": true, | 471 "required": true, |
| 506 "type": "string" | 472 "type": "string" |
| 507 } | 473 } |
| 508 }, | 474 }, |
| 509 "path": "v1beta2/{+subscription}", | 475 "path": "v1beta2/{+topic}:publish", |
| 476 "request": { |
| 477 "$ref": "PublishRequest" |
| 478 }, |
| 510 "response": { | 479 "response": { |
| 511 "$ref": "Subscription" | 480 "$ref": "PublishResponse" |
| 512 }, | 481 }, |
| 513 "scopes": [ | 482 "scopes": [ |
| 514 "https://www.googleapis.com/auth/cloud-platform"
, | 483 "https://www.googleapis.com/auth/cloud-platform"
, |
| 515 "https://www.googleapis.com/auth/pubsub" | 484 "https://www.googleapis.com/auth/pubsub" |
| 516 ] | 485 ] |
| 517 }, | 486 }, |
| 518 "list": { | 487 "list": { |
| 519 "description": "Lists matching subscriptions.", | 488 "description": "Lists matching topics.", |
| 520 "httpMethod": "GET", | 489 "httpMethod": "GET", |
| 521 "id": "pubsub.projects.subscriptions.list", | 490 "id": "pubsub.projects.topics.list", |
| 522 "parameterOrder": [ | 491 "parameterOrder": [ |
| 523 "project" | 492 "project" |
| 524 ], | 493 ], |
| 525 "parameters": { | 494 "parameters": { |
| 526 "project": { | |
| 527 "description": "The name of the cloud projec
t that subscriptions belong to.", | |
| 528 "location": "path", | |
| 529 "pattern": "^projects/[^/]*$", | |
| 530 "required": true, | |
| 531 "type": "string" | |
| 532 }, | |
| 533 "pageSize": { | 495 "pageSize": { |
| 534 "description": "Maximum number of subscripti
ons to return.", | 496 "description": "Maximum number of topics to
return.", |
| 535 "format": "int32", | 497 "format": "int32", |
| 536 "location": "query", | 498 "location": "query", |
| 537 "type": "integer" | 499 "type": "integer" |
| 538 }, | 500 }, |
| 501 "project": { |
| 502 "description": "The name of the cloud projec
t that topics belong to.", |
| 503 "location": "path", |
| 504 "pattern": "^projects/[^/]+$", |
| 505 "required": true, |
| 506 "type": "string" |
| 507 }, |
| 539 "pageToken": { | 508 "pageToken": { |
| 540 "description": "The value returned by the la
st `ListSubscriptionsResponse`; indicates that this is a continuation of a prior
`ListSubscriptions` call, and that the system should return the next page of da
ta.", | 509 "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.", |
| 541 "location": "query", | 510 "location": "query", |
| 542 "type": "string" | 511 "type": "string" |
| 543 } | 512 } |
| 544 }, | 513 }, |
| 545 "path": "v1beta2/{+project}/subscriptions", | 514 "path": "v1beta2/{+project}/topics", |
| 546 "response": { | 515 "response": { |
| 547 "$ref": "ListSubscriptionsResponse" | 516 "$ref": "ListTopicsResponse" |
| 517 }, |
| 518 "scopes": [ |
| 519 "https://www.googleapis.com/auth/cloud-platform"
, |
| 520 "https://www.googleapis.com/auth/pubsub" |
| 521 ] |
| 522 }, |
| 523 "get": { |
| 524 "description": "Gets the configuration of a topic.", |
| 525 "httpMethod": "GET", |
| 526 "id": "pubsub.projects.topics.get", |
| 527 "parameterOrder": [ |
| 528 "topic" |
| 529 ], |
| 530 "parameters": { |
| 531 "topic": { |
| 532 "description": "The name of the topic to get
.", |
| 533 "location": "path", |
| 534 "pattern": "^projects/[^/]+/topics/[^/]+$", |
| 535 "required": true, |
| 536 "type": "string" |
| 537 } |
| 538 }, |
| 539 "path": "v1beta2/{+topic}", |
| 540 "response": { |
| 541 "$ref": "Topic" |
| 542 }, |
| 543 "scopes": [ |
| 544 "https://www.googleapis.com/auth/cloud-platform"
, |
| 545 "https://www.googleapis.com/auth/pubsub" |
| 546 ] |
| 547 }, |
| 548 "create": { |
| 549 "description": "Creates the given topic with the giv
en name.", |
| 550 "httpMethod": "PUT", |
| 551 "id": "pubsub.projects.topics.create", |
| 552 "parameterOrder": [ |
| 553 "name" |
| 554 ], |
| 555 "parameters": { |
| 556 "name": { |
| 557 "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\"`.", |
| 558 "location": "path", |
| 559 "pattern": "^projects/[^/]+/topics/[^/]+$", |
| 560 "required": true, |
| 561 "type": "string" |
| 562 } |
| 563 }, |
| 564 "path": "v1beta2/{+name}", |
| 565 "request": { |
| 566 "$ref": "Topic" |
| 567 }, |
| 568 "response": { |
| 569 "$ref": "Topic" |
| 570 }, |
| 571 "scopes": [ |
| 572 "https://www.googleapis.com/auth/cloud-platform"
, |
| 573 "https://www.googleapis.com/auth/pubsub" |
| 574 ] |
| 575 }, |
| 576 "setIamPolicy": { |
| 577 "description": "Sets the access control policy on th
e specified resource. Replaces any\nexisting policy.", |
| 578 "httpMethod": "POST", |
| 579 "id": "pubsub.projects.topics.setIamPolicy", |
| 580 "parameterOrder": [ |
| 581 "resource" |
| 582 ], |
| 583 "parameters": { |
| 584 "resource": { |
| 585 "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}`.", |
| 586 "location": "path", |
| 587 "pattern": "^projects/[^/]+/topics/[^/]+$", |
| 588 "required": true, |
| 589 "type": "string" |
| 590 } |
| 591 }, |
| 592 "path": "v1beta2/{+resource}:setIamPolicy", |
| 593 "request": { |
| 594 "$ref": "SetIamPolicyRequest" |
| 595 }, |
| 596 "response": { |
| 597 "$ref": "Policy" |
| 548 }, | 598 }, |
| 549 "scopes": [ | 599 "scopes": [ |
| 550 "https://www.googleapis.com/auth/cloud-platform"
, | 600 "https://www.googleapis.com/auth/cloud-platform"
, |
| 551 "https://www.googleapis.com/auth/pubsub" | 601 "https://www.googleapis.com/auth/pubsub" |
| 552 ] | 602 ] |
| 553 }, | 603 }, |
| 554 "delete": { | 604 "delete": { |
| 555 "description": "Deletes an existing subscription. Al
l pending messages in the subscription are immediately dropped. Calls to `Pull`
after deletion will return `NOT_FOUND`. After a subscription is deleted, a new o
ne may be created with the same name, but the new one has no association with th
e old subscription, or its topic unless the same topic is specified.", | 605 "description": "Deletes the topic with the given nam
e. Returns `NOT_FOUND` if the topic\ndoes not exist. After a topic is deleted, a
new topic may be created with\nthe same name; this is an entirely new topic wit
h none of the old\nconfiguration or subscriptions. Existing subscriptions to thi
s topic are\nnot deleted, but their `topic` field is set to `_deleted-topic_`.", |
| 556 "httpMethod": "DELETE", | 606 "httpMethod": "DELETE", |
| 557 "id": "pubsub.projects.subscriptions.delete", | 607 "id": "pubsub.projects.topics.delete", |
| 558 "parameterOrder": [ | 608 "parameterOrder": [ |
| 559 "subscription" | 609 "topic" |
| 560 ], | 610 ], |
| 561 "parameters": { | 611 "parameters": { |
| 562 "subscription": { | 612 "topic": { |
| 563 "description": "The subscription to delete."
, | 613 "description": "Name of the topic to delete.
", |
| 564 "location": "path", | 614 "location": "path", |
| 565 "pattern": "^projects/[^/]*/subscriptions/[^
/]*$", | 615 "pattern": "^projects/[^/]+/topics/[^/]+$", |
| 566 "required": true, | 616 "required": true, |
| 567 "type": "string" | 617 "type": "string" |
| 568 } | 618 } |
| 569 }, | 619 }, |
| 570 "path": "v1beta2/{+subscription}", | 620 "path": "v1beta2/{+topic}", |
| 571 "response": { | 621 "response": { |
| 572 "$ref": "Empty" | 622 "$ref": "Empty" |
| 573 }, | 623 }, |
| 574 "scopes": [ | 624 "scopes": [ |
| 575 "https://www.googleapis.com/auth/cloud-platform"
, | 625 "https://www.googleapis.com/auth/cloud-platform"
, |
| 576 "https://www.googleapis.com/auth/pubsub" | 626 "https://www.googleapis.com/auth/pubsub" |
| 577 ] | 627 ] |
| 578 }, | 628 }, |
| 579 "modifyAckDeadline": { | 629 "testIamPermissions": { |
| 580 "description": "Modifies the ack deadline for a spec
ific message. This method is useful to indicate that more time is needed to proc
ess a message by the subscriber, or to make the message available for redelivery
if the processing was interrupted. Note that this does not modify the subscript
ion-level `ackDeadlineSeconds` used for subsequent messages.", | 630 "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.", |
| 581 "httpMethod": "POST", | 631 "httpMethod": "POST", |
| 582 "id": "pubsub.projects.subscriptions.modifyAckDeadli
ne", | 632 "id": "pubsub.projects.topics.testIamPermissions", |
| 583 "parameterOrder": [ | 633 "parameterOrder": [ |
| 584 "subscription" | 634 "resource" |
| 585 ], | 635 ], |
| 586 "parameters": { | 636 "parameters": { |
| 587 "subscription": { | 637 "resource": { |
| 588 "description": "The name of the subscription
.", | 638 "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}`.", |
| 589 "location": "path", | 639 "location": "path", |
| 590 "pattern": "^projects/[^/]*/subscriptions/[^
/]*$", | 640 "pattern": "^projects/[^/]+/topics/[^/]+$", |
| 591 "required": true, | 641 "required": true, |
| 592 "type": "string" | 642 "type": "string" |
| 593 } | 643 } |
| 594 }, | 644 }, |
| 595 "path": "v1beta2/{+subscription}:modifyAckDeadline", | 645 "path": "v1beta2/{+resource}:testIamPermissions", |
| 596 "request": { | 646 "request": { |
| 597 "$ref": "ModifyAckDeadlineRequest" | 647 "$ref": "TestIamPermissionsRequest" |
| 598 }, | 648 }, |
| 599 "response": { | 649 "response": { |
| 600 "$ref": "Empty" | 650 "$ref": "TestIamPermissionsResponse" |
| 601 }, | 651 }, |
| 602 "scopes": [ | 652 "scopes": [ |
| 603 "https://www.googleapis.com/auth/cloud-platform"
, | 653 "https://www.googleapis.com/auth/cloud-platform"
, |
| 604 "https://www.googleapis.com/auth/pubsub" | 654 "https://www.googleapis.com/auth/pubsub" |
| 605 ] | 655 ] |
| 606 }, | 656 } |
| 607 "acknowledge": { | 657 }, |
| 608 "description": "Acknowledges the messages associated
with the `ack_ids` in the `AcknowledgeRequest`. The Pub/Sub system can remove t
he relevant messages from the subscription. Acknowledging a message whose ack de
adline has expired may succeed, but such a message may be redelivered later. Ack
nowledging a message more than once will not result in an error.", | 658 "resources": { |
| 609 "httpMethod": "POST", | 659 "subscriptions": { |
| 610 "id": "pubsub.projects.subscriptions.acknowledge", | 660 "methods": { |
| 611 "parameterOrder": [ | 661 "list": { |
| 612 "subscription" | 662 "description": "Lists the name of the subscr
iptions for this topic.", |
| 613 ], | 663 "httpMethod": "GET", |
| 614 "parameters": { | 664 "id": "pubsub.projects.topics.subscriptions.
list", |
| 615 "subscription": { | 665 "parameterOrder": [ |
| 616 "description": "The subscription whose messa
ge is being acknowledged.", | 666 "topic" |
| 617 "location": "path", | 667 ], |
| 618 "pattern": "^projects/[^/]*/subscriptions/[^
/]*$", | 668 "parameters": { |
| 619 "required": true, | 669 "topic": { |
| 620 "type": "string" | 670 "description": "The name of the topi
c that subscriptions are attached to.", |
| 621 } | 671 "location": "path", |
| 622 }, | 672 "pattern": "^projects/[^/]+/topics/[
^/]+$", |
| 623 "path": "v1beta2/{+subscription}:acknowledge", | 673 "required": true, |
| 624 "request": { | 674 "type": "string" |
| 625 "$ref": "AcknowledgeRequest" | 675 }, |
| 626 }, | 676 "pageSize": { |
| 627 "response": { | 677 "description": "Maximum number of su
bscription names to return.", |
| 628 "$ref": "Empty" | 678 "format": "int32", |
| 629 }, | 679 "location": "query", |
| 630 "scopes": [ | 680 "type": "integer" |
| 631 "https://www.googleapis.com/auth/cloud-platform"
, | 681 }, |
| 632 "https://www.googleapis.com/auth/pubsub" | 682 "pageToken": { |
| 633 ] | 683 "description": "The value returned b
y the last `ListTopicSubscriptionsResponse`; indicates\nthat this is a continuat
ion of a prior `ListTopicSubscriptions` call, and\nthat the system should return
the next page of data.", |
| 634 }, | 684 "location": "query", |
| 635 "pull": { | 685 "type": "string" |
| 636 "description": "Pulls messages from the server. Retu
rns an empty list if there are no messages available in the backlog. The server
may return `UNAVAILABLE` if there are too many concurrent pull requests pending
for the given subscription.", | 686 } |
| 637 "httpMethod": "POST", | 687 }, |
| 638 "id": "pubsub.projects.subscriptions.pull", | 688 "path": "v1beta2/{+topic}/subscriptions", |
| 639 "parameterOrder": [ | 689 "response": { |
| 640 "subscription" | 690 "$ref": "ListTopicSubscriptionsResponse" |
| 641 ], | 691 }, |
| 642 "parameters": { | 692 "scopes": [ |
| 643 "subscription": { | 693 "https://www.googleapis.com/auth/cloud-p
latform", |
| 644 "description": "The subscription from which
messages should be pulled.", | 694 "https://www.googleapis.com/auth/pubsub" |
| 645 "location": "path", | 695 ] |
| 646 "pattern": "^projects/[^/]*/subscriptions/[^
/]*$", | 696 } |
| 647 "required": true, | 697 } |
| 648 "type": "string" | |
| 649 } | |
| 650 }, | |
| 651 "path": "v1beta2/{+subscription}:pull", | |
| 652 "request": { | |
| 653 "$ref": "PullRequest" | |
| 654 }, | |
| 655 "response": { | |
| 656 "$ref": "PullResponse" | |
| 657 }, | |
| 658 "scopes": [ | |
| 659 "https://www.googleapis.com/auth/cloud-platform"
, | |
| 660 "https://www.googleapis.com/auth/pubsub" | |
| 661 ] | |
| 662 }, | |
| 663 "modifyPushConfig": { | |
| 664 "description": "Modifies the `PushConfig` for a spec
ified subscription. This may be used to change a push subscription to a pull one
(signified by an empty `PushConfig`) or vice versa, or change the endpoint URL
and other attributes of a push subscription. Messages will accumulate for delive
ry continuously through the call regardless of changes to the `PushConfig`.", | |
| 665 "httpMethod": "POST", | |
| 666 "id": "pubsub.projects.subscriptions.modifyPushConfi
g", | |
| 667 "parameterOrder": [ | |
| 668 "subscription" | |
| 669 ], | |
| 670 "parameters": { | |
| 671 "subscription": { | |
| 672 "description": "The name of the subscription
.", | |
| 673 "location": "path", | |
| 674 "pattern": "^projects/[^/]*/subscriptions/[^
/]*$", | |
| 675 "required": true, | |
| 676 "type": "string" | |
| 677 } | |
| 678 }, | |
| 679 "path": "v1beta2/{+subscription}:modifyPushConfig", | |
| 680 "request": { | |
| 681 "$ref": "ModifyPushConfigRequest" | |
| 682 }, | |
| 683 "response": { | |
| 684 "$ref": "Empty" | |
| 685 }, | |
| 686 "scopes": [ | |
| 687 "https://www.googleapis.com/auth/cloud-platform"
, | |
| 688 "https://www.googleapis.com/auth/pubsub" | |
| 689 ] | |
| 690 } | 698 } |
| 691 } | 699 } |
| 692 } | 700 } |
| 693 } | 701 } |
| 694 } | 702 } |
| 695 }, | 703 }, |
| 696 "revision": "20161003", | 704 "revision": "20170105", |
| 697 "rootUrl": "https://pubsub.googleapis.com/", | 705 "rootUrl": "https://pubsub.googleapis.com/", |
| 698 "schemas": { | 706 "schemas": { |
| 707 "Topic": { |
| 708 "description": "A topic resource.", |
| 709 "id": "Topic", |
| 710 "properties": { |
| 711 "name": { |
| 712 "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\"`.", |
| 713 "type": "string" |
| 714 } |
| 715 }, |
| 716 "type": "object" |
| 717 }, |
| 699 "SetIamPolicyRequest": { | 718 "SetIamPolicyRequest": { |
| 700 "description": "Request message for `SetIamPolicy` method.", | 719 "description": "Request message for `SetIamPolicy` method.", |
| 701 "id": "SetIamPolicyRequest", | 720 "id": "SetIamPolicyRequest", |
| 702 "properties": { | 721 "properties": { |
| 703 "policy": { | 722 "policy": { |
| 704 "$ref": "Policy", | 723 "$ref": "Policy", |
| 705 "description": "REQUIRED: The complete policy to be applied
to the `resource`. The size of the policy is limited to a few 10s of KB. An empt
y policy is a valid policy but certain Cloud Platform services (such as Projects
) might reject them." | 724 "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." |
| 706 } | 725 } |
| 707 }, | 726 }, |
| 708 "type": "object" | 727 "type": "object" |
| 709 }, | 728 }, |
| 710 "Policy": { | 729 "ReceivedMessage": { |
| 711 "description": "Defines an Identity and Access Management (IAM) poli
cy. It is used to specify access control policies for Cloud Platform resources.
A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `member
s` to a `role`, where the members can be user accounts, Google groups, Google do
mains, and service accounts. A `role` is a named list of permissions defined by
IAM. **Example** { \"bindings\": [ { \"role\": \"roles/owner\", \"members\": [ \
"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \
"serviceAccount:my-other-app@appspot.gserviceaccount.com\", ] }, { \"role\": \"r
oles/viewer\", \"members\": [\"user:sean@example.com\"] } ] } For a description
of IAM and its features, see the [IAM developer's guide](https://cloud.google.co
m/iam).", | 730 "description": "A message and its corresponding acknowledgment ID.", |
| 712 "id": "Policy", | 731 "id": "ReceivedMessage", |
| 713 "properties": { | 732 "properties": { |
| 714 "version": { | 733 "ackId": { |
| 715 "description": "Version of the `Policy`. The default version
is 0.", | 734 "description": "This ID can be used to acknowledge the recei
ved message.", |
| 716 "format": "int32", | 735 "type": "string" |
| 717 "type": "integer" | |
| 718 }, | 736 }, |
| 719 "bindings": { | 737 "message": { |
| 720 "description": "Associates a list of `members` to a `role`.
Multiple `bindings` must not be specified for the same `role`. `bindings` with n
o members will result in an error.", | 738 "$ref": "PubsubMessage", |
| 721 "items": { | 739 "description": "The message." |
| 722 "$ref": "Binding" | |
| 723 }, | |
| 724 "type": "array" | |
| 725 }, | |
| 726 "etag": { | |
| 727 "description": "`etag` is used for optimistic concurrency co
ntrol as a way to help prevent simultaneous updates of a policy from overwriting
each other. It is strongly suggested that systems make use of the `etag` in the
read-modify-write cycle to perform policy updates in order to avoid race condit
ions: An `etag` is returned in the response to `getIamPolicy`, and systems are e
xpected to put that etag in the request to `setIamPolicy` to ensure that their c
hange will be applied to the same version of the policy. If no `etag` is provide
d in the call to `setIamPolicy`, then the existing policy is overwritten blindly
.", | |
| 728 "format": "byte", | |
| 729 "type": "string" | |
| 730 } | 740 } |
| 731 }, | 741 }, |
| 732 "type": "object" | 742 "type": "object" |
| 733 }, | |
| 734 "Binding": { | |
| 735 "description": "Associates `members` with a `role`.", | |
| 736 "id": "Binding", | |
| 737 "properties": { | |
| 738 "role": { | |
| 739 "description": "Role that is assigned to `members`. For exam
ple, `roles/viewer`, `roles/editor`, or `roles/owner`. Required", | |
| 740 "type": "string" | |
| 741 }, | |
| 742 "members": { | |
| 743 "description": "Specifies the identities requesting access f
or a Cloud Platform resource. `members` can have the following values: * `allUse
rs`: A special identifier that represents anyone who is on the internet; with or
without a Google account. * `allAuthenticatedUsers`: A special identifier that
represents anyone who is authenticated with a Google account or a service accoun
t. * `user:{emailid}`: An email address that represents a specific Google accoun
t. For example, `alice@gmail.com` or `joe@example.com`. * `serviceAccount:{email
id}`: An email address that represents a service account. For example, `my-other
-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that re
presents a Google group. For example, `admins@example.com`. * `domain:{domain}`:
A Google Apps domain name that represents all the users of that domain. For exa
mple, `google.com` or `example.com`.", | |
| 744 "items": { | |
| 745 "type": "string" | |
| 746 }, | |
| 747 "type": "array" | |
| 748 } | |
| 749 }, | |
| 750 "type": "object" | |
| 751 }, | |
| 752 "TestIamPermissionsRequest": { | |
| 753 "description": "Request message for `TestIamPermissions` method.", | |
| 754 "id": "TestIamPermissionsRequest", | |
| 755 "properties": { | |
| 756 "permissions": { | |
| 757 "description": "The set of permissions to check for the `res
ource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
For more information see [IAM Overview](https://cloud.google.com/iam/docs/overv
iew#permissions).", | |
| 758 "items": { | |
| 759 "type": "string" | |
| 760 }, | |
| 761 "type": "array" | |
| 762 } | |
| 763 }, | |
| 764 "type": "object" | |
| 765 }, | |
| 766 "TestIamPermissionsResponse": { | |
| 767 "description": "Response message for `TestIamPermissions` method.", | |
| 768 "id": "TestIamPermissionsResponse", | |
| 769 "properties": { | |
| 770 "permissions": { | |
| 771 "description": "A subset of `TestPermissionsRequest.permissi
ons` that the caller is allowed.", | |
| 772 "items": { | |
| 773 "type": "string" | |
| 774 }, | |
| 775 "type": "array" | |
| 776 } | |
| 777 }, | |
| 778 "type": "object" | |
| 779 }, | |
| 780 "Topic": { | |
| 781 "description": "A topic resource.", | |
| 782 "id": "Topic", | |
| 783 "properties": { | |
| 784 "name": { | |
| 785 "description": "The name of the topic. It must have the form
at `\"projects/{project}/topics/{topic}\"`. `{topic}` must start with a letter,
and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), undersco
res (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It mu
st be between 3 and 255 characters in length, and it must not start with `\"goog
\"`.", | |
| 786 "type": "string" | |
| 787 } | |
| 788 }, | |
| 789 "type": "object" | |
| 790 }, | 743 }, |
| 791 "PublishRequest": { | 744 "PublishRequest": { |
| 792 "description": "Request for the Publish method.", | 745 "description": "Request for the Publish method.", |
| 793 "id": "PublishRequest", | 746 "id": "PublishRequest", |
| 794 "properties": { | 747 "properties": { |
| 795 "messages": { | 748 "messages": { |
| 796 "description": "The messages to publish.", | 749 "description": "The messages to publish.", |
| 797 "items": { | 750 "items": { |
| 798 "$ref": "PubsubMessage" | 751 "$ref": "PubsubMessage" |
| 799 }, | 752 }, |
| 800 "type": "array" | 753 "type": "array" |
| 801 } | 754 } |
| 802 }, | 755 }, |
| 803 "type": "object" | 756 "type": "object" |
| 804 }, | 757 }, |
| 805 "PubsubMessage": { | 758 "TestIamPermissionsResponse": { |
| 806 "description": "A message data and its attributes. The message paylo
ad must not be empty; it must contain either a non-empty data field, or at least
one attribute.", | 759 "description": "Response message for `TestIamPermissions` method.", |
| 807 "id": "PubsubMessage", | 760 "id": "TestIamPermissionsResponse", |
| 808 "properties": { | 761 "properties": { |
| 809 "data": { | 762 "permissions": { |
| 810 "description": "The message payload. For JSON requests, the
value of this field must be [base64-encoded](https://tools.ietf.org/html/rfc4648
).", | 763 "description": "A subset of `TestPermissionsRequest.permissi
ons` that the caller is\nallowed.", |
| 811 "format": "byte", | 764 "items": { |
| 812 "type": "string" | |
| 813 }, | |
| 814 "attributes": { | |
| 815 "additionalProperties": { | |
| 816 "type": "string" | 765 "type": "string" |
| 817 }, | 766 }, |
| 818 "description": "Optional attributes for this message.", | 767 "type": "array" |
| 819 "type": "object" | |
| 820 }, | |
| 821 "messageId": { | |
| 822 "description": "ID of this message, assigned by the server w
hen the message is published. Guaranteed to be unique within the topic. This val
ue may be read by a subscriber that receives a `PubsubMessage` via a `Pull` call
or a push delivery. It must not be populated by the publisher in a `Publish` ca
ll.", | |
| 823 "type": "string" | |
| 824 }, | |
| 825 "publishTime": { | |
| 826 "description": "The time at which the message was published,
populated by the server when it receives the `Publish` call. It must not be pop
ulated by the publisher in a `Publish` call.", | |
| 827 "type": "string" | |
| 828 } | 768 } |
| 829 }, | 769 }, |
| 830 "type": "object" | 770 "type": "object" |
| 831 }, | 771 }, |
| 832 "PublishResponse": { | 772 "PublishResponse": { |
| 833 "description": "Response for the `Publish` method.", | 773 "description": "Response for the `Publish` method.", |
| 834 "id": "PublishResponse", | 774 "id": "PublishResponse", |
| 835 "properties": { | 775 "properties": { |
| 836 "messageIds": { | 776 "messageIds": { |
| 837 "description": "The server-assigned ID of each published mes
sage, in the same order as the messages in the request. IDs are guaranteed to be
unique within the topic.", | 777 "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.", |
| 838 "items": { | 778 "items": { |
| 839 "type": "string" | 779 "type": "string" |
| 840 }, | 780 }, |
| 841 "type": "array" | 781 "type": "array" |
| 842 } | 782 } |
| 843 }, | 783 }, |
| 844 "type": "object" | 784 "type": "object" |
| 845 }, | 785 }, |
| 846 "ListTopicsResponse": { | 786 "ListSubscriptionsResponse": { |
| 847 "description": "Response for the `ListTopics` method.", | 787 "description": "Response for the `ListSubscriptions` method.", |
| 848 "id": "ListTopicsResponse", | 788 "id": "ListSubscriptionsResponse", |
| 849 "properties": { | 789 "properties": { |
| 850 "topics": { | 790 "subscriptions": { |
| 851 "description": "The resulting topics.", | 791 "description": "The subscriptions that match the request.", |
| 852 "items": { | 792 "items": { |
| 853 "$ref": "Topic" | 793 "$ref": "Subscription" |
| 854 }, | 794 }, |
| 855 "type": "array" | 795 "type": "array" |
| 856 }, | 796 }, |
| 857 "nextPageToken": { | 797 "nextPageToken": { |
| 858 "description": "If not empty, indicates that there may be mo
re topics that match the request; this value should be passed in a new `ListTopi
csRequest`.", | 798 "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.", |
| 859 "type": "string" | 799 "type": "string" |
| 860 } | 800 } |
| 861 }, | 801 }, |
| 862 "type": "object" | 802 "type": "object" |
| 863 }, | 803 }, |
| 804 "Policy": { |
| 805 "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).", |
| 806 "id": "Policy", |
| 807 "properties": { |
| 808 "bindings": { |
| 809 "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.", |
| 810 "items": { |
| 811 "$ref": "Binding" |
| 812 }, |
| 813 "type": "array" |
| 814 }, |
| 815 "etag": { |
| 816 "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.", |
| 817 "format": "byte", |
| 818 "type": "string" |
| 819 }, |
| 820 "version": { |
| 821 "description": "Version of the `Policy`. The default version
is 0.", |
| 822 "format": "int32", |
| 823 "type": "integer" |
| 824 } |
| 825 }, |
| 826 "type": "object" |
| 827 }, |
| 864 "ListTopicSubscriptionsResponse": { | 828 "ListTopicSubscriptionsResponse": { |
| 865 "description": "Response for the `ListTopicSubscriptions` method.", | 829 "description": "Response for the `ListTopicSubscriptions` method.", |
| 866 "id": "ListTopicSubscriptionsResponse", | 830 "id": "ListTopicSubscriptionsResponse", |
| 867 "properties": { | 831 "properties": { |
| 868 "subscriptions": { | 832 "subscriptions": { |
| 869 "description": "The names of the subscriptions that match th
e request.", | 833 "description": "The names of the subscriptions that match th
e request.", |
| 870 "items": { | 834 "items": { |
| 871 "type": "string" | 835 "type": "string" |
| 872 }, | 836 }, |
| 873 "type": "array" | 837 "type": "array" |
| 874 }, | 838 }, |
| 875 "nextPageToken": { | 839 "nextPageToken": { |
| 876 "description": "If not empty, indicates that there may be mo
re subscriptions that match the request; this value should be passed in a new `L
istTopicSubscriptionsRequest` to get more subscriptions.", | 840 "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.", |
| 877 "type": "string" | 841 "type": "string" |
| 878 } | 842 } |
| 879 }, | 843 }, |
| 880 "type": "object" | 844 "type": "object" |
| 881 }, | 845 }, |
| 882 "Empty": { | |
| 883 "description": "A generic empty message that you can re-use to avoid
defining duplicated empty messages in your APIs. A typical example is to use it
as the request or the response type of an API method. For instance: service Foo
{ rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON re
presentation for `Empty` is empty JSON object `{}`.", | |
| 884 "id": "Empty", | |
| 885 "type": "object" | |
| 886 }, | |
| 887 "Subscription": { | 846 "Subscription": { |
| 888 "description": "A subscription resource.", | 847 "description": "A subscription resource.", |
| 889 "id": "Subscription", | 848 "id": "Subscription", |
| 890 "properties": { | 849 "properties": { |
| 891 "name": { | 850 "pushConfig": { |
| 892 "description": "The name of the subscription. It must have t
he format `\"projects/{project}/subscriptions/{subscription}\"`. `{subscription}
` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-
9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) o
r percent signs (`%`). It must be between 3 and 255 characters in length, and it
must not start with `\"goog\"`.", | 851 "$ref": "PushConfig", |
| 852 "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." |
| 853 }, |
| 854 "topic": { |
| 855 "description": "The name of the topic from which this subscr
iption is receiving messages.\nThe value of this field will be `_deleted-topic_`
if the topic has been\ndeleted.", |
| 893 "type": "string" | 856 "type": "string" |
| 894 }, | 857 }, |
| 895 "topic": { | |
| 896 "description": "The name of the topic from which this subscr
iption is receiving messages. The value of this field will be `_deleted-topic_`
if the topic has been deleted.", | |
| 897 "type": "string" | |
| 898 }, | |
| 899 "pushConfig": { | |
| 900 "$ref": "PushConfig", | |
| 901 "description": "If push delivery is used with this subscript
ion, this field is used to configure it. An empty `pushConfig` signifies that th
e subscriber will pull and ack messages using API methods." | |
| 902 }, | |
| 903 "ackDeadlineSeconds": { | 858 "ackDeadlineSeconds": { |
| 904 "description": "This value is the maximum time after a subsc
riber receives a message before the subscriber should acknowledge the message. A
fter message delivery but before the ack deadline expires and before the message
is acknowledged, it is an outstanding message and will not be delivered again d
uring that time (on a best-effort basis). For pull subscriptions, this value is
used as the initial value for the ack deadline. To override this value for a giv
en message, call `ModifyAckDeadline` with the corresponding `ack_id` if using pu
ll. The maximum custom deadline you can specify is 600 seconds (10 minutes). For
push delivery, this value is also used to set the request timeout for the call
to the push endpoint. If the subscriber never acknowledges the message, the Pub/
Sub system will eventually redeliver the message. If this parameter is 0, a defa
ult value of 10 seconds is used.", | 859 "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.", |
| 905 "format": "int32", | 860 "format": "int32", |
| 906 "type": "integer" | 861 "type": "integer" |
| 907 } | |
| 908 }, | |
| 909 "type": "object" | |
| 910 }, | |
| 911 "PushConfig": { | |
| 912 "description": "Configuration for a push delivery endpoint.", | |
| 913 "id": "PushConfig", | |
| 914 "properties": { | |
| 915 "pushEndpoint": { | |
| 916 "description": "A URL locating the endpoint to which message
s should be pushed. For example, a Webhook endpoint might use \"https://example.
com/push\".", | |
| 917 "type": "string" | |
| 918 }, | 862 }, |
| 919 "attributes": { | 863 "name": { |
| 920 "additionalProperties": { | 864 "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\"`.", |
| 921 "type": "string" | |
| 922 }, | |
| 923 "description": "Endpoint configuration attributes. Every end
point has a set of API supported attributes that can be used to control differen
t aspects of the message delivery. The currently supported attribute is `x-goog-
version`, which you can use to change the format of the push message. This attri
bute indicates the version of the data expected by the endpoint. This controls t
he shape of the envelope (i.e. its fields and metadata). The endpoint version is
based on the version of the Pub/Sub API. If not present during the `CreateSubsc
ription` call, it will default to the version of the API used to make such call.
If not present during a `ModifyPushConfig` call, its value will not be changed.
`GetSubscription` calls will always return a valid version, even if the subscri
ption was created without this attribute. The possible values for this attribute
are: * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API. * `v
1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API.", | |
| 924 "type": "object" | |
| 925 } | |
| 926 }, | |
| 927 "type": "object" | |
| 928 }, | |
| 929 "ListSubscriptionsResponse": { | |
| 930 "description": "Response for the `ListSubscriptions` method.", | |
| 931 "id": "ListSubscriptionsResponse", | |
| 932 "properties": { | |
| 933 "subscriptions": { | |
| 934 "description": "The subscriptions that match the request.", | |
| 935 "items": { | |
| 936 "$ref": "Subscription" | |
| 937 }, | |
| 938 "type": "array" | |
| 939 }, | |
| 940 "nextPageToken": { | |
| 941 "description": "If not empty, indicates that there may be mo
re subscriptions that match the request; this value should be passed in a new `L
istSubscriptionsRequest` to get more subscriptions.", | |
| 942 "type": "string" | 865 "type": "string" |
| 943 } | 866 } |
| 944 }, | 867 }, |
| 945 "type": "object" | 868 "type": "object" |
| 946 }, | 869 }, |
| 947 "ModifyAckDeadlineRequest": { | 870 "ModifyAckDeadlineRequest": { |
| 948 "description": "Request for the ModifyAckDeadline method.", | 871 "description": "Request for the ModifyAckDeadline method.", |
| 949 "id": "ModifyAckDeadlineRequest", | 872 "id": "ModifyAckDeadlineRequest", |
| 950 "properties": { | 873 "properties": { |
| 874 "ackDeadlineSeconds": { |
| 875 "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.", |
| 876 "format": "int32", |
| 877 "type": "integer" |
| 878 }, |
| 951 "ackId": { | 879 "ackId": { |
| 952 "description": "The acknowledgment ID. Either this or ack_id
s must be populated, but not both.", | 880 "description": "The acknowledgment ID. Either this or ack_id
s must be populated, but not\nboth.", |
| 953 "type": "string" | 881 "type": "string" |
| 954 }, | 882 }, |
| 955 "ackIds": { | 883 "ackIds": { |
| 956 "description": "List of acknowledgment IDs.", | 884 "description": "List of acknowledgment IDs.", |
| 957 "items": { | 885 "items": { |
| 958 "type": "string" | 886 "type": "string" |
| 959 }, | 887 }, |
| 960 "type": "array" | 888 "type": "array" |
| 961 }, | |
| 962 "ackDeadlineSeconds": { | |
| 963 "description": "The new ack deadline with respect to the tim
e this request was sent to the Pub/Sub system. Must be >= 0. For example, if the
value is 10, the new ack deadline will expire 10 seconds after the `ModifyAckDe
adline` call was made. Specifying zero may immediately make the message availabl
e for another pull request.", | |
| 964 "format": "int32", | |
| 965 "type": "integer" | |
| 966 } | 889 } |
| 967 }, | 890 }, |
| 968 "type": "object" | 891 "type": "object" |
| 969 }, | 892 }, |
| 970 "AcknowledgeRequest": { | 893 "TestIamPermissionsRequest": { |
| 971 "description": "Request for the Acknowledge method.", | 894 "description": "Request message for `TestIamPermissions` method.", |
| 972 "id": "AcknowledgeRequest", | 895 "id": "TestIamPermissionsRequest", |
| 973 "properties": { | 896 "properties": { |
| 974 "ackIds": { | 897 "permissions": { |
| 975 "description": "The acknowledgment ID for the messages being
acknowledged that was returned by the Pub/Sub system in the `Pull` response. Mu
st not be empty.", | 898 "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).", |
| 976 "items": { | 899 "items": { |
| 977 "type": "string" | 900 "type": "string" |
| 978 }, | 901 }, |
| 979 "type": "array" | 902 "type": "array" |
| 980 } | 903 } |
| 981 }, | 904 }, |
| 982 "type": "object" | 905 "type": "object" |
| 983 }, | 906 }, |
| 907 "PushConfig": { |
| 908 "description": "Configuration for a push delivery endpoint.", |
| 909 "id": "PushConfig", |
| 910 "properties": { |
| 911 "attributes": { |
| 912 "additionalProperties": { |
| 913 "type": "string" |
| 914 }, |
| 915 "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.", |
| 916 "type": "object" |
| 917 }, |
| 918 "pushEndpoint": { |
| 919 "description": "A URL locating the endpoint to which message
s should be pushed.\nFor example, a Webhook endpoint might use \"https://example
.com/push\".", |
| 920 "type": "string" |
| 921 } |
| 922 }, |
| 923 "type": "object" |
| 924 }, |
| 984 "PullRequest": { | 925 "PullRequest": { |
| 985 "description": "Request for the `Pull` method.", | 926 "description": "Request for the `Pull` method.", |
| 986 "id": "PullRequest", | 927 "id": "PullRequest", |
| 987 "properties": { | 928 "properties": { |
| 988 "returnImmediately": { | 929 "returnImmediately": { |
| 989 "description": "If this is specified as true the system will
respond immediately even if it is not able to return a message in the `Pull` re
sponse. Otherwise the system is allowed to wait until at least one message is av
ailable rather than returning no messages. The client may cancel the request if
it does not wish to wait any longer for the response.", | 930 "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.", |
| 990 "type": "boolean" | 931 "type": "boolean" |
| 991 }, | 932 }, |
| 992 "maxMessages": { | 933 "maxMessages": { |
| 993 "description": "The maximum number of messages returned for
this request. The Pub/Sub system may return fewer than the number specified.", | 934 "description": "The maximum number of messages returned for
this request. The Pub/Sub\nsystem may return fewer than the number specified.", |
| 994 "format": "int32", | 935 "format": "int32", |
| 995 "type": "integer" | 936 "type": "integer" |
| 996 } | 937 } |
| 997 }, | 938 }, |
| 998 "type": "object" | 939 "type": "object" |
| 999 }, | 940 }, |
| 941 "ModifyPushConfigRequest": { |
| 942 "description": "Request for the ModifyPushConfig method.", |
| 943 "id": "ModifyPushConfigRequest", |
| 944 "properties": { |
| 945 "pushConfig": { |
| 946 "$ref": "PushConfig", |
| 947 "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." |
| 948 } |
| 949 }, |
| 950 "type": "object" |
| 951 }, |
| 1000 "PullResponse": { | 952 "PullResponse": { |
| 1001 "description": "Response for the `Pull` method.", | 953 "description": "Response for the `Pull` method.", |
| 1002 "id": "PullResponse", | 954 "id": "PullResponse", |
| 1003 "properties": { | 955 "properties": { |
| 1004 "receivedMessages": { | 956 "receivedMessages": { |
| 1005 "description": "Received Pub/Sub messages. The Pub/Sub syste
m will return zero messages if there are no more available in the backlog. The P
ub/Sub system may return fewer than the `maxMessages` requested even if there ar
e more messages available in the backlog.", | 957 "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.", |
| 1006 "items": { | 958 "items": { |
| 1007 "$ref": "ReceivedMessage" | 959 "$ref": "ReceivedMessage" |
| 1008 }, | 960 }, |
| 1009 "type": "array" | 961 "type": "array" |
| 1010 } | 962 } |
| 1011 }, | 963 }, |
| 1012 "type": "object" | 964 "type": "object" |
| 1013 }, | 965 }, |
| 1014 "ReceivedMessage": { | 966 "PubsubMessage": { |
| 1015 "description": "A message and its corresponding acknowledgment ID.", | 967 "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.", |
| 1016 "id": "ReceivedMessage", | 968 "id": "PubsubMessage", |
| 1017 "properties": { | 969 "properties": { |
| 1018 "ackId": { | 970 "data": { |
| 1019 "description": "This ID can be used to acknowledge the recei
ved message.", | 971 "description": "The message payload. For JSON requests, the
value of this field must be\n[base64-encoded](https://tools.ietf.org/html/rfc464
8).", |
| 972 "format": "byte", |
| 1020 "type": "string" | 973 "type": "string" |
| 1021 }, | 974 }, |
| 1022 "message": { | 975 "attributes": { |
| 1023 "$ref": "PubsubMessage", | 976 "additionalProperties": { |
| 1024 "description": "The message." | 977 "type": "string" |
| 978 }, |
| 979 "description": "Optional attributes for this message.", |
| 980 "type": "object" |
| 981 }, |
| 982 "messageId": { |
| 983 "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.", |
| 984 "type": "string" |
| 985 }, |
| 986 "publishTime": { |
| 987 "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.", |
| 988 "format": "google-datetime", |
| 989 "type": "string" |
| 1025 } | 990 } |
| 1026 }, | 991 }, |
| 1027 "type": "object" | 992 "type": "object" |
| 1028 }, | 993 }, |
| 1029 "ModifyPushConfigRequest": { | 994 "AcknowledgeRequest": { |
| 1030 "description": "Request for the ModifyPushConfig method.", | 995 "description": "Request for the Acknowledge method.", |
| 1031 "id": "ModifyPushConfigRequest", | 996 "id": "AcknowledgeRequest", |
| 1032 "properties": { | 997 "properties": { |
| 1033 "pushConfig": { | 998 "ackIds": { |
| 1034 "$ref": "PushConfig", | 999 "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.", |
| 1035 "description": "The push configuration for future deliveries
. An empty `pushConfig` indicates that the Pub/Sub system should stop pushing me
ssages from the given subscription and allow messages to be pulled and acknowled
ged - effectively pausing the subscription if `Pull` is not called." | 1000 "items": { |
| 1001 "type": "string" |
| 1002 }, |
| 1003 "type": "array" |
| 1036 } | 1004 } |
| 1037 }, | 1005 }, |
| 1038 "type": "object" | 1006 "type": "object" |
| 1007 }, |
| 1008 "Empty": { |
| 1009 "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 `{}`.", |
| 1010 "id": "Empty", |
| 1011 "properties": {}, |
| 1012 "type": "object" |
| 1013 }, |
| 1014 "ListTopicsResponse": { |
| 1015 "description": "Response for the `ListTopics` method.", |
| 1016 "id": "ListTopicsResponse", |
| 1017 "properties": { |
| 1018 "nextPageToken": { |
| 1019 "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`.", |
| 1020 "type": "string" |
| 1021 }, |
| 1022 "topics": { |
| 1023 "description": "The resulting topics.", |
| 1024 "items": { |
| 1025 "$ref": "Topic" |
| 1026 }, |
| 1027 "type": "array" |
| 1028 } |
| 1029 }, |
| 1030 "type": "object" |
| 1031 }, |
| 1032 "Binding": { |
| 1033 "description": "Associates `members` with a `role`.", |
| 1034 "id": "Binding", |
| 1035 "properties": { |
| 1036 "members": { |
| 1037 "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", |
| 1038 "items": { |
| 1039 "type": "string" |
| 1040 }, |
| 1041 "type": "array" |
| 1042 }, |
| 1043 "role": { |
| 1044 "description": "Role that is assigned to `members`.\nFor exa
mple, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired", |
| 1045 "type": "string" |
| 1046 } |
| 1047 }, |
| 1048 "type": "object" |
| 1039 } | 1049 } |
| 1040 }, | 1050 }, |
| 1041 "servicePath": "", | 1051 "servicePath": "", |
| 1042 "title": "Google Cloud Pub/Sub API", | 1052 "title": "Google Cloud Pub/Sub API", |
| 1043 "version": "v1beta2" | 1053 "version": "v1beta2" |
| 1044 } | 1054 } |
| OLD | NEW |
|---|
Chromium Code Reviews
Issue 2649893002:
Api-roll 44: 2017-01-23 (Closed)
