| 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.\n", | 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 "icons": { | 20 "icons": { |
| 21 "x16": "http://www.google.com/images/icons/product/search-16.gif", | 21 "x16": "http://www.google.com/images/icons/product/search-16.gif", |
| 22 "x32": "http://www.google.com/images/icons/product/search-32.gif" | 22 "x32": "http://www.google.com/images/icons/product/search-32.gif" |
| 23 }, | 23 }, |
| 24 "id": "pubsub:v1", | 24 "id": "pubsub:v1", |
| 25 "kind": "discovery#restDescription", | 25 "kind": "discovery#restDescription", |
| 26 "name": "pubsub", | 26 "name": "pubsub", |
| 27 "ownerDomain": "google.com", | 27 "ownerDomain": "google.com", |
| 28 "ownerName": "Google", | 28 "ownerName": "Google", |
| 29 "parameters": { | 29 "parameters": { |
| 30 "access_token": { | |
| 31 "description": "OAuth access token.", | |
| 32 "location": "query", | |
| 33 "type": "string" | |
| 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": { | 30 "fields": { |
| 58 "description": "Selector specifying which fields to include in a par
tial response.", | 31 "description": "Selector specifying which fields to include in a par
tial response.", |
| 59 "location": "query", | 32 "location": "query", |
| 60 "type": "string" | 33 "type": "string" |
| 61 }, | 34 }, |
| 35 "uploadType": { |
| 36 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", |
| 37 "location": "query", |
| 38 "type": "string" |
| 39 }, |
| 40 "$.xgafv": { |
| 41 "description": "V1 error format.", |
| 42 "enum": [ |
| 43 "1", |
| 44 "2" |
| 45 ], |
| 46 "enumDescriptions": [ |
| 47 "v1 error format", |
| 48 "v2 error format" |
| 49 ], |
| 50 "location": "query", |
| 51 "type": "string" |
| 52 }, |
| 53 "callback": { |
| 54 "description": "JSONP", |
| 55 "location": "query", |
| 56 "type": "string" |
| 57 }, |
| 62 "alt": { | 58 "alt": { |
| 63 "default": "json", | 59 "default": "json", |
| 64 "description": "Data format for response.", | 60 "description": "Data format for response.", |
| 65 "enum": [ | 61 "enum": [ |
| 66 "json", | 62 "json", |
| 67 "media", | 63 "media", |
| 68 "proto" | 64 "proto" |
| 69 ], | 65 ], |
| 70 "enumDescriptions": [ | 66 "enumDescriptions": [ |
| 71 "Responses with Content-Type of application/json", | 67 "Responses with Content-Type of application/json", |
| 72 "Media download with context-dependent Content-Type", | 68 "Media download with context-dependent Content-Type", |
| 73 "Responses with Content-Type of application/x-protobuf" | 69 "Responses with Content-Type of application/x-protobuf" |
| 74 ], | 70 ], |
| 75 "location": "query", | 71 "location": "query", |
| 76 "type": "string" | 72 "type": "string" |
| 77 }, | 73 }, |
| 78 "$.xgafv": { | 74 "access_token": { |
| 79 "description": "V1 error format.", | 75 "description": "OAuth access token.", |
| 80 "enum": [ | |
| 81 "1", | |
| 82 "2" | |
| 83 ], | |
| 84 "enumDescriptions": [ | |
| 85 "v1 error format", | |
| 86 "v2 error format" | |
| 87 ], | |
| 88 "location": "query", | 76 "location": "query", |
| 89 "type": "string" | 77 "type": "string" |
| 90 }, | 78 }, |
| 91 "callback": { | 79 "key": { |
| 92 "description": "JSONP", | 80 "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.", |
| 93 "location": "query", | 81 "location": "query", |
| 94 "type": "string" | 82 "type": "string" |
| 95 }, | 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", |
| 87 "type": "string" |
| 88 }, |
| 89 "pp": { |
| 90 "default": "true", |
| 91 "description": "Pretty-print response.", |
| 92 "location": "query", |
| 93 "type": "boolean" |
| 94 }, |
| 96 "oauth_token": { | 95 "oauth_token": { |
| 97 "description": "OAuth 2.0 token for the current user.", | 96 "description": "OAuth 2.0 token for the current user.", |
| 98 "location": "query", | 97 "location": "query", |
| 99 "type": "string" | 98 "type": "string" |
| 100 }, | 99 }, |
| 101 "uploadType": { | |
| 102 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", | |
| 103 "location": "query", | |
| 104 "type": "string" | |
| 105 }, | |
| 106 "bearer_token": { | 100 "bearer_token": { |
| 107 "description": "OAuth bearer token.", | 101 "description": "OAuth bearer token.", |
| 108 "location": "query", | 102 "location": "query", |
| 109 "type": "string" | 103 "type": "string" |
| 110 }, | 104 }, |
| 111 "upload_protocol": { | 105 "upload_protocol": { |
| 112 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", | 106 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", |
| 113 "location": "query", | 107 "location": "query", |
| 114 "type": "string" | 108 "type": "string" |
| 109 }, |
| 110 "prettyPrint": { |
| 111 "default": "true", |
| 112 "description": "Returns response with indentations and line breaks."
, |
| 113 "location": "query", |
| 114 "type": "boolean" |
| 115 } | 115 } |
| 116 }, | 116 }, |
| 117 "protocol": "rest", | 117 "protocol": "rest", |
| 118 "resources": { | 118 "resources": { |
| 119 "projects": { | 119 "projects": { |
| 120 "resources": { | 120 "resources": { |
| 121 "subscriptions": { | 121 "subscriptions": { |
| 122 "methods": { | 122 "methods": { |
| 123 "modifyPushConfig": { | 123 "acknowledge": { |
| 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`
.", | 124 "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 "httpMethod": "POST", | 125 "httpMethod": "POST", |
| 126 "id": "pubsub.projects.subscriptions.modifyPushConfi
g", | 126 "id": "pubsub.projects.subscriptions.acknowledge", |
| 127 "parameterOrder": [ | 127 "parameterOrder": [ |
| 128 "subscription" | 128 "subscription" |
| 129 ], | 129 ], |
| 130 "parameters": { | 130 "parameters": { |
| 131 "subscription": { | 131 "subscription": { |
| 132 "description": "The name of the subscription
.\nFormat is `projects/{project}/subscriptions/{sub}`.", | 132 "description": "The subscription whose messa
ge is being acknowledged.\nFormat is `projects/{project}/subscriptions/{sub}`.", |
| 133 "location": "path", | 133 "location": "path", |
| 134 "pattern": "^projects/[^/]+/subscriptions/[^
/]+$", | 134 "pattern": "^projects/[^/]+/subscriptions/[^
/]+$", |
| 135 "required": true, | 135 "required": true, |
| 136 "type": "string" | 136 "type": "string" |
| 137 } | 137 } |
| 138 }, | 138 }, |
| 139 "path": "v1/{+subscription}:modifyPushConfig", | 139 "path": "v1/{+subscription}:acknowledge", |
| 140 "request": { | 140 "request": { |
| 141 "$ref": "ModifyPushConfigRequest" | 141 "$ref": "AcknowledgeRequest" |
| 142 }, | 142 }, |
| 143 "response": { | 143 "response": { |
| 144 "$ref": "Empty" | 144 "$ref": "Empty" |
| 145 }, | 145 }, |
| 146 "scopes": [ | 146 "scopes": [ |
| 147 "https://www.googleapis.com/auth/cloud-platform"
, | 147 "https://www.googleapis.com/auth/cloud-platform"
, |
| 148 "https://www.googleapis.com/auth/pubsub" | 148 "https://www.googleapis.com/auth/pubsub" |
| 149 ] | 149 ] |
| 150 }, | 150 }, |
| 151 "modifyAckDeadline": { |
| 152 "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.", |
| 153 "httpMethod": "POST", |
| 154 "id": "pubsub.projects.subscriptions.modifyAckDeadli
ne", |
| 155 "parameterOrder": [ |
| 156 "subscription" |
| 157 ], |
| 158 "parameters": { |
| 159 "subscription": { |
| 160 "description": "The name of the subscription
.\nFormat is `projects/{project}/subscriptions/{sub}`.", |
| 161 "location": "path", |
| 162 "pattern": "^projects/[^/]+/subscriptions/[^
/]+$", |
| 163 "required": true, |
| 164 "type": "string" |
| 165 } |
| 166 }, |
| 167 "path": "v1/{+subscription}:modifyAckDeadline", |
| 168 "request": { |
| 169 "$ref": "ModifyAckDeadlineRequest" |
| 170 }, |
| 171 "response": { |
| 172 "$ref": "Empty" |
| 173 }, |
| 174 "scopes": [ |
| 175 "https://www.googleapis.com/auth/cloud-platform"
, |
| 176 "https://www.googleapis.com/auth/pubsub" |
| 177 ] |
| 178 }, |
| 151 "getIamPolicy": { | 179 "getIamPolicy": { |
| 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.", | 180 "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.", |
| 153 "httpMethod": "GET", | 181 "httpMethod": "GET", |
| 154 "id": "pubsub.projects.subscriptions.getIamPolicy", | 182 "id": "pubsub.projects.subscriptions.getIamPolicy", |
| 155 "parameterOrder": [ | 183 "parameterOrder": [ |
| 156 "resource" | 184 "resource" |
| 157 ], | 185 ], |
| 158 "parameters": { | 186 "parameters": { |
| 159 "resource": { | 187 "resource": { |
| 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}`.", | 188 "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}`.", |
| 161 "location": "path", | 189 "location": "path", |
| 162 "pattern": "^projects/[^/]+/subscriptions/[^
/]+$", | 190 "pattern": "^projects/[^/]+/subscriptions/[^
/]+$", |
| 163 "required": true, | 191 "required": true, |
| 164 "type": "string" | 192 "type": "string" |
| 165 } | 193 } |
| 166 }, | 194 }, |
| 167 "path": "v1/{+resource}:getIamPolicy", | 195 "path": "v1/{+resource}:getIamPolicy", |
| 168 "response": { | 196 "response": { |
| 169 "$ref": "Policy" | 197 "$ref": "Policy" |
| 170 }, | 198 }, |
| 171 "scopes": [ | 199 "scopes": [ |
| 172 "https://www.googleapis.com/auth/cloud-platform"
, | 200 "https://www.googleapis.com/auth/cloud-platform"
, |
| 173 "https://www.googleapis.com/auth/pubsub" | |
| 174 ] | |
| 175 }, | |
| 176 "pull": { | |
| 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.", | |
| 178 "httpMethod": "POST", | |
| 179 "id": "pubsub.projects.subscriptions.pull", | |
| 180 "parameterOrder": [ | |
| 181 "subscription" | |
| 182 ], | |
| 183 "parameters": { | |
| 184 "subscription": { | |
| 185 "description": "The subscription from which
messages should be pulled.\nFormat is `projects/{project}/subscriptions/{sub}`."
, | |
| 186 "location": "path", | |
| 187 "pattern": "^projects/[^/]+/subscriptions/[^
/]+$", | |
| 188 "required": true, | |
| 189 "type": "string" | |
| 190 } | |
| 191 }, | |
| 192 "path": "v1/{+subscription}:pull", | |
| 193 "request": { | |
| 194 "$ref": "PullRequest" | |
| 195 }, | |
| 196 "response": { | |
| 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.\nFormat is `projects/{project}`.", | |
| 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": "v1/{+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" | 201 "https://www.googleapis.com/auth/pubsub" |
| 238 ] | 202 ] |
| 239 }, | 203 }, |
| 240 "get": { | 204 "get": { |
| 241 "description": "Gets the configuration details of a
subscription.", | 205 "description": "Gets the configuration details of a
subscription.", |
| 242 "httpMethod": "GET", | 206 "httpMethod": "GET", |
| 243 "id": "pubsub.projects.subscriptions.get", | 207 "id": "pubsub.projects.subscriptions.get", |
| 244 "parameterOrder": [ | 208 "parameterOrder": [ |
| 245 "subscription" | 209 "subscription" |
| 246 ], | 210 ], |
| 247 "parameters": { | 211 "parameters": { |
| 248 "subscription": { | 212 "subscription": { |
| 249 "description": "The name of the subscription
to get.\nFormat is `projects/{project}/subscriptions/{sub}`.", | 213 "description": "The name of the subscription
to get.\nFormat is `projects/{project}/subscriptions/{sub}`.", |
| 250 "location": "path", | 214 "location": "path", |
| 251 "pattern": "^projects/[^/]+/subscriptions/[^
/]+$", | 215 "pattern": "^projects/[^/]+/subscriptions/[^
/]+$", |
| 252 "required": true, | 216 "required": true, |
| 253 "type": "string" | 217 "type": "string" |
| 254 } | 218 } |
| 255 }, | 219 }, |
| 256 "path": "v1/{+subscription}", | 220 "path": "v1/{+subscription}", |
| 257 "response": { | 221 "response": { |
| 258 "$ref": "Subscription" | 222 "$ref": "Subscription" |
| 259 }, | 223 }, |
| 260 "scopes": [ | 224 "scopes": [ |
| 261 "https://www.googleapis.com/auth/cloud-platform"
, | 225 "https://www.googleapis.com/auth/cloud-platform"
, |
| 262 "https://www.googleapis.com/auth/pubsub" | 226 "https://www.googleapis.com/auth/pubsub" |
| 263 ] | 227 ] |
| 264 }, | 228 }, |
| 265 "create": { | 229 "testIamPermissions": { |
| 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, conforming\nto the\n[resource name format](http
s://cloud.google.com/pubsub/docs/overview#names).\nThe generated name is populat
ed in the returned Subscription object.\nNote that for REST API requests, you mu
st specify a name in the request.", | 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.", |
| 267 "httpMethod": "PUT", | 231 "httpMethod": "POST", |
| 268 "id": "pubsub.projects.subscriptions.create", | 232 "id": "pubsub.projects.subscriptions.testIamPermissi
ons", |
| 269 "parameterOrder": [ | 233 "parameterOrder": [ |
| 270 "name" | 234 "resource" |
| 271 ], | 235 ], |
| 272 "parameters": { | 236 "parameters": { |
| 273 "name": { | 237 "resource": { |
| 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\"`.", | 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}`.", |
| 275 "location": "path", | 239 "location": "path", |
| 276 "pattern": "^projects/[^/]+/subscriptions/[^
/]+$", | 240 "pattern": "^projects/[^/]+/subscriptions/[^
/]+$", |
| 277 "required": true, | 241 "required": true, |
| 278 "type": "string" | 242 "type": "string" |
| 279 } | 243 } |
| 280 }, | 244 }, |
| 281 "path": "v1/{+name}", | 245 "path": "v1/{+resource}:testIamPermissions", |
| 282 "request": { | 246 "request": { |
| 283 "$ref": "Subscription" | 247 "$ref": "TestIamPermissionsRequest" |
| 284 }, | 248 }, |
| 285 "response": { | 249 "response": { |
| 286 "$ref": "Subscription" | 250 "$ref": "TestIamPermissionsResponse" |
| 287 }, | 251 }, |
| 288 "scopes": [ | 252 "scopes": [ |
| 289 "https://www.googleapis.com/auth/cloud-platform"
, | 253 "https://www.googleapis.com/auth/cloud-platform"
, |
| 290 "https://www.googleapis.com/auth/pubsub" | 254 "https://www.googleapis.com/auth/pubsub" |
| 291 ] | 255 ] |
| 292 }, | 256 }, |
| 293 "modifyAckDeadline": { | 257 "modifyPushConfig": { |
| 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.", | 258 "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`
.", |
| 295 "httpMethod": "POST", | 259 "httpMethod": "POST", |
| 296 "id": "pubsub.projects.subscriptions.modifyAckDeadli
ne", | 260 "id": "pubsub.projects.subscriptions.modifyPushConfi
g", |
| 297 "parameterOrder": [ | 261 "parameterOrder": [ |
| 298 "subscription" | 262 "subscription" |
| 299 ], | 263 ], |
| 300 "parameters": { | 264 "parameters": { |
| 301 "subscription": { | 265 "subscription": { |
| 302 "description": "The name of the subscription
.\nFormat is `projects/{project}/subscriptions/{sub}`.", | 266 "description": "The name of the subscription
.\nFormat is `projects/{project}/subscriptions/{sub}`.", |
| 303 "location": "path", | 267 "location": "path", |
| 304 "pattern": "^projects/[^/]+/subscriptions/[^
/]+$", | 268 "pattern": "^projects/[^/]+/subscriptions/[^
/]+$", |
| 305 "required": true, | 269 "required": true, |
| 306 "type": "string" | 270 "type": "string" |
| 307 } | 271 } |
| 308 }, | 272 }, |
| 309 "path": "v1/{+subscription}:modifyAckDeadline", | 273 "path": "v1/{+subscription}:modifyPushConfig", |
| 310 "request": { | 274 "request": { |
| 311 "$ref": "ModifyAckDeadlineRequest" | 275 "$ref": "ModifyPushConfigRequest" |
| 312 }, | 276 }, |
| 313 "response": { | 277 "response": { |
| 314 "$ref": "Empty" | 278 "$ref": "Empty" |
| 315 }, | 279 }, |
| 316 "scopes": [ | 280 "scopes": [ |
| 317 "https://www.googleapis.com/auth/cloud-platform"
, | 281 "https://www.googleapis.com/auth/cloud-platform"
, |
| 318 "https://www.googleapis.com/auth/pubsub" | 282 "https://www.googleapis.com/auth/pubsub" |
| 319 ] | 283 ] |
| 320 }, | 284 }, |
| 321 "setIamPolicy": { | |
| 322 "description": "Sets the access control policy on th
e specified resource. Replaces any\nexisting policy.", | |
| 323 "httpMethod": "POST", | |
| 324 "id": "pubsub.projects.subscriptions.setIamPolicy", | |
| 325 "parameterOrder": [ | |
| 326 "resource" | |
| 327 ], | |
| 328 "parameters": { | |
| 329 "resource": { | |
| 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}`.", | |
| 331 "location": "path", | |
| 332 "pattern": "^projects/[^/]+/subscriptions/[^
/]+$", | |
| 333 "required": true, | |
| 334 "type": "string" | |
| 335 } | |
| 336 }, | |
| 337 "path": "v1/{+resource}:setIamPolicy", | |
| 338 "request": { | |
| 339 "$ref": "SetIamPolicyRequest" | |
| 340 }, | |
| 341 "response": { | |
| 342 "$ref": "Policy" | |
| 343 }, | |
| 344 "scopes": [ | |
| 345 "https://www.googleapis.com/auth/cloud-platform"
, | |
| 346 "https://www.googleapis.com/auth/pubsub" | |
| 347 ] | |
| 348 }, | |
| 349 "delete": { | 285 "delete": { |
| 350 "description": "Deletes an existing subscription. Al
l messages retained in the subscription\nare immediately dropped. Calls to `Pull
` after deletion will return\n`NOT_FOUND`. After a subscription is deleted, a ne
w one may be created with\nthe same name, but the new one has no association wit
h the old\nsubscription or its topic unless the same topic is specified.", | 286 "description": "Deletes an existing subscription. Al
l messages retained in the subscription\nare immediately dropped. Calls to `Pull
` after deletion will return\n`NOT_FOUND`. After a subscription is deleted, a ne
w one may be created with\nthe same name, but the new one has no association wit
h the old\nsubscription or its topic unless the same topic is specified.", |
| 351 "httpMethod": "DELETE", | 287 "httpMethod": "DELETE", |
| 352 "id": "pubsub.projects.subscriptions.delete", | 288 "id": "pubsub.projects.subscriptions.delete", |
| 353 "parameterOrder": [ | 289 "parameterOrder": [ |
| 354 "subscription" | 290 "subscription" |
| 355 ], | 291 ], |
| 356 "parameters": { | 292 "parameters": { |
| 357 "subscription": { | 293 "subscription": { |
| 358 "description": "The subscription to delete.\
nFormat is `projects/{project}/subscriptions/{sub}`.", | 294 "description": "The subscription to delete.\
nFormat is `projects/{project}/subscriptions/{sub}`.", |
| 359 "location": "path", | 295 "location": "path", |
| 360 "pattern": "^projects/[^/]+/subscriptions/[^
/]+$", | 296 "pattern": "^projects/[^/]+/subscriptions/[^
/]+$", |
| 361 "required": true, | 297 "required": true, |
| 362 "type": "string" | 298 "type": "string" |
| 363 } | 299 } |
| 364 }, | 300 }, |
| 365 "path": "v1/{+subscription}", | 301 "path": "v1/{+subscription}", |
| 366 "response": { | 302 "response": { |
| 367 "$ref": "Empty" | 303 "$ref": "Empty" |
| 368 }, | 304 }, |
| 369 "scopes": [ | 305 "scopes": [ |
| 370 "https://www.googleapis.com/auth/cloud-platform"
, | 306 "https://www.googleapis.com/auth/cloud-platform"
, |
| 371 "https://www.googleapis.com/auth/pubsub" | 307 "https://www.googleapis.com/auth/pubsub" |
| 372 ] | 308 ] |
| 373 }, | 309 }, |
| 374 "testIamPermissions": { | 310 "pull": { |
| 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.", | 311 "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.", |
| 376 "httpMethod": "POST", | 312 "httpMethod": "POST", |
| 377 "id": "pubsub.projects.subscriptions.testIamPermissi
ons", | 313 "id": "pubsub.projects.subscriptions.pull", |
| 378 "parameterOrder": [ | 314 "parameterOrder": [ |
| 379 "resource" | 315 "subscription" |
| 380 ], | 316 ], |
| 381 "parameters": { | 317 "parameters": { |
| 382 "resource": { | 318 "subscription": { |
| 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}`.", | 319 "description": "The subscription from which
messages should be pulled.\nFormat is `projects/{project}/subscriptions/{sub}`."
, |
| 384 "location": "path", | 320 "location": "path", |
| 385 "pattern": "^projects/[^/]+/subscriptions/[^
/]+$", | 321 "pattern": "^projects/[^/]+/subscriptions/[^
/]+$", |
| 386 "required": true, | 322 "required": true, |
| 387 "type": "string" | 323 "type": "string" |
| 388 } | 324 } |
| 389 }, | 325 }, |
| 390 "path": "v1/{+resource}:testIamPermissions", | 326 "path": "v1/{+subscription}:pull", |
| 391 "request": { | 327 "request": { |
| 392 "$ref": "TestIamPermissionsRequest" | 328 "$ref": "PullRequest" |
| 393 }, | 329 }, |
| 394 "response": { | 330 "response": { |
| 395 "$ref": "TestIamPermissionsResponse" | 331 "$ref": "PullResponse" |
| 396 }, | 332 }, |
| 397 "scopes": [ | 333 "scopes": [ |
| 398 "https://www.googleapis.com/auth/cloud-platform"
, | 334 "https://www.googleapis.com/auth/cloud-platform"
, |
| 399 "https://www.googleapis.com/auth/pubsub" | 335 "https://www.googleapis.com/auth/pubsub" |
| 400 ] | 336 ] |
| 401 }, | 337 }, |
| 402 "acknowledge": { | 338 "list": { |
| 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.", | 339 "description": "Lists matching subscriptions.", |
| 404 "httpMethod": "POST", | 340 "httpMethod": "GET", |
| 405 "id": "pubsub.projects.subscriptions.acknowledge", | 341 "id": "pubsub.projects.subscriptions.list", |
| 406 "parameterOrder": [ | 342 "parameterOrder": [ |
| 407 "subscription" | 343 "project" |
| 408 ], | 344 ], |
| 409 "parameters": { | 345 "parameters": { |
| 410 "subscription": { | 346 "pageToken": { |
| 411 "description": "The subscription whose messa
ge is being acknowledged.\nFormat is `projects/{project}/subscriptions/{sub}`.", | 347 "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.", |
| 348 "location": "query", |
| 349 "type": "string" |
| 350 }, |
| 351 "pageSize": { |
| 352 "description": "Maximum number of subscripti
ons to return.", |
| 353 "format": "int32", |
| 354 "location": "query", |
| 355 "type": "integer" |
| 356 }, |
| 357 "project": { |
| 358 "description": "The name of the cloud projec
t that subscriptions belong to.\nFormat is `projects/{project}`.", |
| 359 "location": "path", |
| 360 "pattern": "^projects/[^/]+$", |
| 361 "required": true, |
| 362 "type": "string" |
| 363 } |
| 364 }, |
| 365 "path": "v1/{+project}/subscriptions", |
| 366 "response": { |
| 367 "$ref": "ListSubscriptionsResponse" |
| 368 }, |
| 369 "scopes": [ |
| 370 "https://www.googleapis.com/auth/cloud-platform"
, |
| 371 "https://www.googleapis.com/auth/pubsub" |
| 372 ] |
| 373 }, |
| 374 "create": { |
| 375 "description": "Creates a subscription to a given to
pic.\nIf the subscription already exists, returns `ALREADY_EXISTS`.\nIf the corr
esponding topic doesn't exist, returns `NOT_FOUND`.\n\nIf the name is not provid
ed in the request, the server will assign a random\nname for this subscription o
n the same project as the topic, conforming\nto the\n[resource name format](http
s://cloud.google.com/pubsub/docs/overview#names).\nThe generated name is populat
ed in the returned Subscription object.\nNote that for REST API requests, you mu
st specify a name in the request.", |
| 376 "httpMethod": "PUT", |
| 377 "id": "pubsub.projects.subscriptions.create", |
| 378 "parameterOrder": [ |
| 379 "name" |
| 380 ], |
| 381 "parameters": { |
| 382 "name": { |
| 383 "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\"`.", |
| 412 "location": "path", | 384 "location": "path", |
| 413 "pattern": "^projects/[^/]+/subscriptions/[^
/]+$", | 385 "pattern": "^projects/[^/]+/subscriptions/[^
/]+$", |
| 414 "required": true, | 386 "required": true, |
| 415 "type": "string" | 387 "type": "string" |
| 416 } | 388 } |
| 417 }, | 389 }, |
| 418 "path": "v1/{+subscription}:acknowledge", | 390 "path": "v1/{+name}", |
| 419 "request": { | 391 "request": { |
| 420 "$ref": "AcknowledgeRequest" | 392 "$ref": "Subscription" |
| 421 }, | 393 }, |
| 422 "response": { | 394 "response": { |
| 423 "$ref": "Empty" | 395 "$ref": "Subscription" |
| 424 }, | 396 }, |
| 425 "scopes": [ | 397 "scopes": [ |
| 426 "https://www.googleapis.com/auth/cloud-platform"
, | 398 "https://www.googleapis.com/auth/cloud-platform"
, |
| 399 "https://www.googleapis.com/auth/pubsub" |
| 400 ] |
| 401 }, |
| 402 "setIamPolicy": { |
| 403 "description": "Sets the access control policy on th
e specified resource. Replaces any\nexisting policy.", |
| 404 "httpMethod": "POST", |
| 405 "id": "pubsub.projects.subscriptions.setIamPolicy", |
| 406 "parameterOrder": [ |
| 407 "resource" |
| 408 ], |
| 409 "parameters": { |
| 410 "resource": { |
| 411 "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}`.", |
| 412 "location": "path", |
| 413 "pattern": "^projects/[^/]+/subscriptions/[^
/]+$", |
| 414 "required": true, |
| 415 "type": "string" |
| 416 } |
| 417 }, |
| 418 "path": "v1/{+resource}:setIamPolicy", |
| 419 "request": { |
| 420 "$ref": "SetIamPolicyRequest" |
| 421 }, |
| 422 "response": { |
| 423 "$ref": "Policy" |
| 424 }, |
| 425 "scopes": [ |
| 426 "https://www.googleapis.com/auth/cloud-platform"
, |
| 427 "https://www.googleapis.com/auth/pubsub" | 427 "https://www.googleapis.com/auth/pubsub" |
| 428 ] | 428 ] |
| 429 } | 429 } |
| 430 } | 430 } |
| 431 }, | 431 }, |
| 432 "topics": { | 432 "snapshots": { |
| 433 "methods": { | 433 "methods": { |
| 434 "getIamPolicy": { | 434 "setIamPolicy": { |
| 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.", | 435 "description": "Sets the access control policy on th
e specified resource. Replaces any\nexisting policy.", |
| 436 "httpMethod": "GET", | 436 "httpMethod": "POST", |
| 437 "id": "pubsub.projects.topics.getIamPolicy", | 437 "id": "pubsub.projects.snapshots.setIamPolicy", |
| 438 "parameterOrder": [ | 438 "parameterOrder": [ |
| 439 "resource" | 439 "resource" |
| 440 ], | 440 ], |
| 441 "parameters": { | 441 "parameters": { |
| 442 "resource": { | 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}`.", | 443 "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}`.", |
| 444 "location": "path", | 444 "location": "path", |
| 445 "pattern": "^projects/[^/]+/topics/[^/]+$", | 445 "pattern": "^projects/[^/]+/snapshots/[^/]+$
", |
| 446 "required": true, | 446 "required": true, |
| 447 "type": "string" | 447 "type": "string" |
| 448 } | 448 } |
| 449 }, | 449 }, |
| 450 "path": "v1/{+resource}:getIamPolicy", | 450 "path": "v1/{+resource}:setIamPolicy", |
| 451 "request": { |
| 452 "$ref": "SetIamPolicyRequest" |
| 453 }, |
| 451 "response": { | 454 "response": { |
| 452 "$ref": "Policy" | 455 "$ref": "Policy" |
| 453 }, | 456 }, |
| 454 "scopes": [ | 457 "scopes": [ |
| 455 "https://www.googleapis.com/auth/cloud-platform"
, | 458 "https://www.googleapis.com/auth/cloud-platform"
, |
| 456 "https://www.googleapis.com/auth/pubsub" | 459 "https://www.googleapis.com/auth/pubsub" |
| 457 ] | 460 ] |
| 458 }, | 461 }, |
| 459 "publish": { | 462 "testIamPermissions": { |
| 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.", | 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.", |
| 461 "httpMethod": "POST", | 464 "httpMethod": "POST", |
| 462 "id": "pubsub.projects.topics.publish", | 465 "id": "pubsub.projects.snapshots.testIamPermissions"
, |
| 463 "parameterOrder": [ | 466 "parameterOrder": [ |
| 464 "topic" | 467 "resource" |
| 465 ], | 468 ], |
| 466 "parameters": { | 469 "parameters": { |
| 467 "topic": { | 470 "resource": { |
| 468 "description": "The messages in the request
will be published on this topic.\nFormat is `projects/{project}/topics/{topic}`.
", | 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}`.", |
| 469 "location": "path", | 472 "location": "path", |
| 470 "pattern": "^projects/[^/]+/topics/[^/]+$", | 473 "pattern": "^projects/[^/]+/snapshots/[^/]+$
", |
| 471 "required": true, | 474 "required": true, |
| 472 "type": "string" | 475 "type": "string" |
| 473 } | 476 } |
| 474 }, | 477 }, |
| 475 "path": "v1/{+topic}:publish", | 478 "path": "v1/{+resource}:testIamPermissions", |
| 476 "request": { | 479 "request": { |
| 477 "$ref": "PublishRequest" | 480 "$ref": "TestIamPermissionsRequest" |
| 478 }, | 481 }, |
| 479 "response": { | 482 "response": { |
| 480 "$ref": "PublishResponse" | 483 "$ref": "TestIamPermissionsResponse" |
| 481 }, | 484 }, |
| 482 "scopes": [ | 485 "scopes": [ |
| 483 "https://www.googleapis.com/auth/cloud-platform"
, | 486 "https://www.googleapis.com/auth/cloud-platform"
, |
| 484 "https://www.googleapis.com/auth/pubsub" | 487 "https://www.googleapis.com/auth/pubsub" |
| 485 ] | 488 ] |
| 486 }, | 489 }, |
| 487 "list": { | 490 "getIamPolicy": { |
| 488 "description": "Lists matching topics.", | 491 "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.", |
| 489 "httpMethod": "GET", | 492 "httpMethod": "GET", |
| 490 "id": "pubsub.projects.topics.list", | 493 "id": "pubsub.projects.snapshots.getIamPolicy", |
| 491 "parameterOrder": [ | 494 "parameterOrder": [ |
| 492 "project" | 495 "resource" |
| 493 ], | 496 ], |
| 494 "parameters": { | 497 "parameters": { |
| 495 "pageSize": { | 498 "resource": { |
| 496 "description": "Maximum number of topics to
return.", | 499 "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}`.", |
| 497 "format": "int32", | |
| 498 "location": "query", | |
| 499 "type": "integer" | |
| 500 }, | |
| 501 "project": { | |
| 502 "description": "The name of the cloud projec
t that topics belong to.\nFormat is `projects/{project}`.", | |
| 503 "location": "path", | 500 "location": "path", |
| 504 "pattern": "^projects/[^/]+$", | 501 "pattern": "^projects/[^/]+/snapshots/[^/]+$
", |
| 505 "required": true, | 502 "required": true, |
| 506 "type": "string" | 503 "type": "string" |
| 507 }, | |
| 508 "pageToken": { | |
| 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.", | |
| 510 "location": "query", | |
| 511 "type": "string" | |
| 512 } | 504 } |
| 513 }, | 505 }, |
| 514 "path": "v1/{+project}/topics", | 506 "path": "v1/{+resource}:getIamPolicy", |
| 515 "response": { | 507 "response": { |
| 516 "$ref": "ListTopicsResponse" | 508 "$ref": "Policy" |
| 517 }, | 509 }, |
| 518 "scopes": [ | 510 "scopes": [ |
| 519 "https://www.googleapis.com/auth/cloud-platform"
, | 511 "https://www.googleapis.com/auth/cloud-platform"
, |
| 520 "https://www.googleapis.com/auth/pubsub" | 512 "https://www.googleapis.com/auth/pubsub" |
| 521 ] | 513 ] |
| 522 }, | 514 } |
| 515 } |
| 516 }, |
| 517 "topics": { |
| 518 "methods": { |
| 523 "get": { | 519 "get": { |
| 524 "description": "Gets the configuration of a topic.", | 520 "description": "Gets the configuration of a topic.", |
| 525 "httpMethod": "GET", | 521 "httpMethod": "GET", |
| 526 "id": "pubsub.projects.topics.get", | 522 "id": "pubsub.projects.topics.get", |
| 527 "parameterOrder": [ | 523 "parameterOrder": [ |
| 528 "topic" | 524 "topic" |
| 529 ], | 525 ], |
| 530 "parameters": { | 526 "parameters": { |
| 531 "topic": { | 527 "topic": { |
| 532 "description": "The name of the topic to get
.\nFormat is `projects/{project}/topics/{topic}`.", | 528 "description": "The name of the topic to get
.\nFormat is `projects/{project}/topics/{topic}`.", |
| 533 "location": "path", | 529 "location": "path", |
| 534 "pattern": "^projects/[^/]+/topics/[^/]+$", | 530 "pattern": "^projects/[^/]+/topics/[^/]+$", |
| 535 "required": true, | 531 "required": true, |
| 536 "type": "string" | 532 "type": "string" |
| 537 } | 533 } |
| 538 }, | 534 }, |
| 539 "path": "v1/{+topic}", | 535 "path": "v1/{+topic}", |
| 540 "response": { | 536 "response": { |
| 541 "$ref": "Topic" | 537 "$ref": "Topic" |
| 542 }, | 538 }, |
| 543 "scopes": [ | 539 "scopes": [ |
| 544 "https://www.googleapis.com/auth/cloud-platform"
, | 540 "https://www.googleapis.com/auth/cloud-platform"
, |
| 545 "https://www.googleapis.com/auth/pubsub" | 541 "https://www.googleapis.com/auth/pubsub" |
| 546 ] | 542 ] |
| 547 }, | 543 }, |
| 548 "create": { | 544 "publish": { |
| 549 "description": "Creates the given topic with the giv
en name.", | 545 "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.", |
| 550 "httpMethod": "PUT", | 546 "httpMethod": "POST", |
| 551 "id": "pubsub.projects.topics.create", | 547 "id": "pubsub.projects.topics.publish", |
| 552 "parameterOrder": [ | 548 "parameterOrder": [ |
| 553 "name" | 549 "topic" |
| 554 ], | 550 ], |
| 555 "parameters": { | 551 "parameters": { |
| 556 "name": { | 552 "topic": { |
| 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\"`.", | 553 "description": "The messages in the request
will be published on this topic.\nFormat is `projects/{project}/topics/{topic}`.
", |
| 558 "location": "path", | 554 "location": "path", |
| 559 "pattern": "^projects/[^/]+/topics/[^/]+$", | 555 "pattern": "^projects/[^/]+/topics/[^/]+$", |
| 560 "required": true, | 556 "required": true, |
| 561 "type": "string" | 557 "type": "string" |
| 562 } | 558 } |
| 563 }, | 559 }, |
| 564 "path": "v1/{+name}", | 560 "path": "v1/{+topic}:publish", |
| 565 "request": { | 561 "request": { |
| 566 "$ref": "Topic" | 562 "$ref": "PublishRequest" |
| 567 }, | 563 }, |
| 568 "response": { | 564 "response": { |
| 569 "$ref": "Topic" | 565 "$ref": "PublishResponse" |
| 570 }, | 566 }, |
| 571 "scopes": [ | 567 "scopes": [ |
| 572 "https://www.googleapis.com/auth/cloud-platform"
, | 568 "https://www.googleapis.com/auth/cloud-platform"
, |
| 573 "https://www.googleapis.com/auth/pubsub" | 569 "https://www.googleapis.com/auth/pubsub" |
| 574 ] | 570 ] |
| 575 }, | 571 }, |
| 576 "setIamPolicy": { | 572 "testIamPermissions": { |
| 577 "description": "Sets the access control policy on th
e specified resource. Replaces any\nexisting policy.", | 573 "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.", |
| 578 "httpMethod": "POST", | 574 "httpMethod": "POST", |
| 579 "id": "pubsub.projects.topics.setIamPolicy", | 575 "id": "pubsub.projects.topics.testIamPermissions", |
| 580 "parameterOrder": [ | 576 "parameterOrder": [ |
| 581 "resource" | 577 "resource" |
| 582 ], | 578 ], |
| 583 "parameters": { | 579 "parameters": { |
| 584 "resource": { | 580 "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}`.", | 581 "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}`.", |
| 586 "location": "path", | 582 "location": "path", |
| 587 "pattern": "^projects/[^/]+/topics/[^/]+$", | 583 "pattern": "^projects/[^/]+/topics/[^/]+$", |
| 588 "required": true, | 584 "required": true, |
| 589 "type": "string" | 585 "type": "string" |
| 590 } | 586 } |
| 591 }, | 587 }, |
| 592 "path": "v1/{+resource}:setIamPolicy", | 588 "path": "v1/{+resource}:testIamPermissions", |
| 593 "request": { | 589 "request": { |
| 594 "$ref": "SetIamPolicyRequest" | 590 "$ref": "TestIamPermissionsRequest" |
| 595 }, | 591 }, |
| 596 "response": { | 592 "response": { |
| 597 "$ref": "Policy" | 593 "$ref": "TestIamPermissionsResponse" |
| 598 }, | 594 }, |
| 599 "scopes": [ | 595 "scopes": [ |
| 600 "https://www.googleapis.com/auth/cloud-platform"
, | 596 "https://www.googleapis.com/auth/cloud-platform"
, |
| 601 "https://www.googleapis.com/auth/pubsub" | 597 "https://www.googleapis.com/auth/pubsub" |
| 602 ] | 598 ] |
| 603 }, | 599 }, |
| 604 "delete": { | 600 "delete": { |
| 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_`.", | 601 "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_`.", |
| 606 "httpMethod": "DELETE", | 602 "httpMethod": "DELETE", |
| 607 "id": "pubsub.projects.topics.delete", | 603 "id": "pubsub.projects.topics.delete", |
| (...skipping 11 matching lines...) Expand all Loading... |
| 619 }, | 615 }, |
| 620 "path": "v1/{+topic}", | 616 "path": "v1/{+topic}", |
| 621 "response": { | 617 "response": { |
| 622 "$ref": "Empty" | 618 "$ref": "Empty" |
| 623 }, | 619 }, |
| 624 "scopes": [ | 620 "scopes": [ |
| 625 "https://www.googleapis.com/auth/cloud-platform"
, | 621 "https://www.googleapis.com/auth/cloud-platform"
, |
| 626 "https://www.googleapis.com/auth/pubsub" | 622 "https://www.googleapis.com/auth/pubsub" |
| 627 ] | 623 ] |
| 628 }, | 624 }, |
| 629 "testIamPermissions": { | 625 "list": { |
| 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.", | 626 "description": "Lists matching topics.", |
| 631 "httpMethod": "POST", | 627 "httpMethod": "GET", |
| 632 "id": "pubsub.projects.topics.testIamPermissions", | 628 "id": "pubsub.projects.topics.list", |
| 633 "parameterOrder": [ | 629 "parameterOrder": [ |
| 634 "resource" | 630 "project" |
| 635 ], | 631 ], |
| 636 "parameters": { | 632 "parameters": { |
| 637 "resource": { | 633 "pageToken": { |
| 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}`.", | 634 "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.", |
| 635 "location": "query", |
| 636 "type": "string" |
| 637 }, |
| 638 "pageSize": { |
| 639 "description": "Maximum number of topics to
return.", |
| 640 "format": "int32", |
| 641 "location": "query", |
| 642 "type": "integer" |
| 643 }, |
| 644 "project": { |
| 645 "description": "The name of the cloud projec
t that topics belong to.\nFormat is `projects/{project}`.", |
| 646 "location": "path", |
| 647 "pattern": "^projects/[^/]+$", |
| 648 "required": true, |
| 649 "type": "string" |
| 650 } |
| 651 }, |
| 652 "path": "v1/{+project}/topics", |
| 653 "response": { |
| 654 "$ref": "ListTopicsResponse" |
| 655 }, |
| 656 "scopes": [ |
| 657 "https://www.googleapis.com/auth/cloud-platform"
, |
| 658 "https://www.googleapis.com/auth/pubsub" |
| 659 ] |
| 660 }, |
| 661 "create": { |
| 662 "description": "Creates the given topic with the giv
en name.", |
| 663 "httpMethod": "PUT", |
| 664 "id": "pubsub.projects.topics.create", |
| 665 "parameterOrder": [ |
| 666 "name" |
| 667 ], |
| 668 "parameters": { |
| 669 "name": { |
| 670 "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\"`.", |
| 639 "location": "path", | 671 "location": "path", |
| 640 "pattern": "^projects/[^/]+/topics/[^/]+$", | 672 "pattern": "^projects/[^/]+/topics/[^/]+$", |
| 641 "required": true, | 673 "required": true, |
| 642 "type": "string" | 674 "type": "string" |
| 643 } | 675 } |
| 644 }, | 676 }, |
| 645 "path": "v1/{+resource}:testIamPermissions", | 677 "path": "v1/{+name}", |
| 646 "request": { | 678 "request": { |
| 647 "$ref": "TestIamPermissionsRequest" | 679 "$ref": "Topic" |
| 648 }, | 680 }, |
| 649 "response": { | 681 "response": { |
| 650 "$ref": "TestIamPermissionsResponse" | 682 "$ref": "Topic" |
| 683 }, |
| 684 "scopes": [ |
| 685 "https://www.googleapis.com/auth/cloud-platform"
, |
| 686 "https://www.googleapis.com/auth/pubsub" |
| 687 ] |
| 688 }, |
| 689 "setIamPolicy": { |
| 690 "description": "Sets the access control policy on th
e specified resource. Replaces any\nexisting policy.", |
| 691 "httpMethod": "POST", |
| 692 "id": "pubsub.projects.topics.setIamPolicy", |
| 693 "parameterOrder": [ |
| 694 "resource" |
| 695 ], |
| 696 "parameters": { |
| 697 "resource": { |
| 698 "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}`.", |
| 699 "location": "path", |
| 700 "pattern": "^projects/[^/]+/topics/[^/]+$", |
| 701 "required": true, |
| 702 "type": "string" |
| 703 } |
| 704 }, |
| 705 "path": "v1/{+resource}:setIamPolicy", |
| 706 "request": { |
| 707 "$ref": "SetIamPolicyRequest" |
| 708 }, |
| 709 "response": { |
| 710 "$ref": "Policy" |
| 711 }, |
| 712 "scopes": [ |
| 713 "https://www.googleapis.com/auth/cloud-platform"
, |
| 714 "https://www.googleapis.com/auth/pubsub" |
| 715 ] |
| 716 }, |
| 717 "getIamPolicy": { |
| 718 "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.", |
| 719 "httpMethod": "GET", |
| 720 "id": "pubsub.projects.topics.getIamPolicy", |
| 721 "parameterOrder": [ |
| 722 "resource" |
| 723 ], |
| 724 "parameters": { |
| 725 "resource": { |
| 726 "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}`.", |
| 727 "location": "path", |
| 728 "pattern": "^projects/[^/]+/topics/[^/]+$", |
| 729 "required": true, |
| 730 "type": "string" |
| 731 } |
| 732 }, |
| 733 "path": "v1/{+resource}:getIamPolicy", |
| 734 "response": { |
| 735 "$ref": "Policy" |
| 651 }, | 736 }, |
| 652 "scopes": [ | 737 "scopes": [ |
| 653 "https://www.googleapis.com/auth/cloud-platform"
, | 738 "https://www.googleapis.com/auth/cloud-platform"
, |
| 654 "https://www.googleapis.com/auth/pubsub" | 739 "https://www.googleapis.com/auth/pubsub" |
| 655 ] | 740 ] |
| 656 } | 741 } |
| 657 }, | 742 }, |
| 658 "resources": { | 743 "resources": { |
| 659 "subscriptions": { | 744 "subscriptions": { |
| 660 "methods": { | 745 "methods": { |
| 661 "list": { | 746 "list": { |
| 662 "description": "Lists the name of the subscr
iptions for this topic.", | 747 "description": "Lists the name of the subscr
iptions for this topic.", |
| 663 "httpMethod": "GET", | 748 "httpMethod": "GET", |
| 664 "id": "pubsub.projects.topics.subscriptions.
list", | 749 "id": "pubsub.projects.topics.subscriptions.
list", |
| 665 "parameterOrder": [ | 750 "parameterOrder": [ |
| 666 "topic" | 751 "topic" |
| 667 ], | 752 ], |
| 668 "parameters": { | 753 "parameters": { |
| 754 "pageSize": { |
| 755 "description": "Maximum number of su
bscription names to return.", |
| 756 "format": "int32", |
| 757 "location": "query", |
| 758 "type": "integer" |
| 759 }, |
| 669 "topic": { | 760 "topic": { |
| 670 "description": "The name of the topi
c that subscriptions are attached to.\nFormat is `projects/{project}/topics/{top
ic}`.", | 761 "description": "The name of the topi
c that subscriptions are attached to.\nFormat is `projects/{project}/topics/{top
ic}`.", |
| 671 "location": "path", | 762 "location": "path", |
| 672 "pattern": "^projects/[^/]+/topics/[
^/]+$", | 763 "pattern": "^projects/[^/]+/topics/[
^/]+$", |
| 673 "required": true, | 764 "required": true, |
| 674 "type": "string" | 765 "type": "string" |
| 675 }, | 766 }, |
| 676 "pageSize": { | |
| 677 "description": "Maximum number of su
bscription names to return.", | |
| 678 "format": "int32", | |
| 679 "location": "query", | |
| 680 "type": "integer" | |
| 681 }, | |
| 682 "pageToken": { | 767 "pageToken": { |
| 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.", | 768 "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.", |
| 684 "location": "query", | 769 "location": "query", |
| 685 "type": "string" | 770 "type": "string" |
| 686 } | 771 } |
| 687 }, | 772 }, |
| 688 "path": "v1/{+topic}/subscriptions", | 773 "path": "v1/{+topic}/subscriptions", |
| 689 "response": { | 774 "response": { |
| 690 "$ref": "ListTopicSubscriptionsResponse" | 775 "$ref": "ListTopicSubscriptionsResponse" |
| 691 }, | 776 }, |
| 692 "scopes": [ | 777 "scopes": [ |
| 693 "https://www.googleapis.com/auth/cloud-p
latform", | 778 "https://www.googleapis.com/auth/cloud-p
latform", |
| 694 "https://www.googleapis.com/auth/pubsub" | 779 "https://www.googleapis.com/auth/pubsub" |
| 695 ] | 780 ] |
| 696 } | 781 } |
| 697 } | 782 } |
| 698 } | 783 } |
| 699 } | 784 } |
| 700 }, | |
| 701 "snapshots": { | |
| 702 "methods": { | |
| 703 "testIamPermissions": { | |
| 704 "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.", | |
| 705 "httpMethod": "POST", | |
| 706 "id": "pubsub.projects.snapshots.testIamPermissions"
, | |
| 707 "parameterOrder": [ | |
| 708 "resource" | |
| 709 ], | |
| 710 "parameters": { | |
| 711 "resource": { | |
| 712 "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}`.", | |
| 713 "location": "path", | |
| 714 "pattern": "^projects/[^/]+/snapshots/[^/]+$
", | |
| 715 "required": true, | |
| 716 "type": "string" | |
| 717 } | |
| 718 }, | |
| 719 "path": "v1/{+resource}:testIamPermissions", | |
| 720 "request": { | |
| 721 "$ref": "TestIamPermissionsRequest" | |
| 722 }, | |
| 723 "response": { | |
| 724 "$ref": "TestIamPermissionsResponse" | |
| 725 }, | |
| 726 "scopes": [ | |
| 727 "https://www.googleapis.com/auth/cloud-platform"
, | |
| 728 "https://www.googleapis.com/auth/pubsub" | |
| 729 ] | |
| 730 }, | |
| 731 "setIamPolicy": { | |
| 732 "description": "Sets the access control policy on th
e specified resource. Replaces any\nexisting policy.", | |
| 733 "httpMethod": "POST", | |
| 734 "id": "pubsub.projects.snapshots.setIamPolicy", | |
| 735 "parameterOrder": [ | |
| 736 "resource" | |
| 737 ], | |
| 738 "parameters": { | |
| 739 "resource": { | |
| 740 "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}`.", | |
| 741 "location": "path", | |
| 742 "pattern": "^projects/[^/]+/snapshots/[^/]+$
", | |
| 743 "required": true, | |
| 744 "type": "string" | |
| 745 } | |
| 746 }, | |
| 747 "path": "v1/{+resource}:setIamPolicy", | |
| 748 "request": { | |
| 749 "$ref": "SetIamPolicyRequest" | |
| 750 }, | |
| 751 "response": { | |
| 752 "$ref": "Policy" | |
| 753 }, | |
| 754 "scopes": [ | |
| 755 "https://www.googleapis.com/auth/cloud-platform"
, | |
| 756 "https://www.googleapis.com/auth/pubsub" | |
| 757 ] | |
| 758 }, | |
| 759 "getIamPolicy": { | |
| 760 "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.", | |
| 761 "httpMethod": "GET", | |
| 762 "id": "pubsub.projects.snapshots.getIamPolicy", | |
| 763 "parameterOrder": [ | |
| 764 "resource" | |
| 765 ], | |
| 766 "parameters": { | |
| 767 "resource": { | |
| 768 "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}`.", | |
| 769 "location": "path", | |
| 770 "pattern": "^projects/[^/]+/snapshots/[^/]+$
", | |
| 771 "required": true, | |
| 772 "type": "string" | |
| 773 } | |
| 774 }, | |
| 775 "path": "v1/{+resource}:getIamPolicy", | |
| 776 "response": { | |
| 777 "$ref": "Policy" | |
| 778 }, | |
| 779 "scopes": [ | |
| 780 "https://www.googleapis.com/auth/cloud-platform"
, | |
| 781 "https://www.googleapis.com/auth/pubsub" | |
| 782 ] | |
| 783 } | |
| 784 } | |
| 785 } | 785 } |
| 786 } | 786 } |
| 787 } | 787 } |
| 788 }, | 788 }, |
| 789 "revision": "20170105", | 789 "revision": "20170124", |
| 790 "rootUrl": "https://pubsub.googleapis.com/", | 790 "rootUrl": "https://pubsub.googleapis.com/", |
| 791 "schemas": { | 791 "schemas": { |
| 792 "Topic": { | 792 "PullRequest": { |
| 793 "description": "A topic resource.", | 793 "description": "Request for the `Pull` method.", |
| 794 "id": "Topic", | 794 "id": "PullRequest", |
| 795 "properties": { | 795 "properties": { |
| 796 "name": { | 796 "returnImmediately": { |
| 797 "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\"`.", | 797 "description": "If this field set to true, the system will r
espond immediately even if\nit there are no messages available to return in the
`Pull` response.\nOtherwise, the system may wait (for a bounded amount of time)
until at\nleast one message is available, rather than returning no messages. The
\nclient may cancel the request if it does not wish to wait any longer for\nthe
response.", |
| 798 "type": "string" | 798 "type": "boolean" |
| 799 }, |
| 800 "maxMessages": { |
| 801 "description": "The maximum number of messages returned for
this request. The Pub/Sub\nsystem may return fewer than the number specified.", |
| 802 "format": "int32", |
| 803 "type": "integer" |
| 799 } | 804 } |
| 800 }, | 805 }, |
| 801 "type": "object" | 806 "type": "object" |
| 802 }, | 807 }, |
| 803 "SetIamPolicyRequest": { | 808 "ListSubscriptionsResponse": { |
| 804 "description": "Request message for `SetIamPolicy` method.", | 809 "description": "Response for the `ListSubscriptions` method.", |
| 805 "id": "SetIamPolicyRequest", | 810 "id": "ListSubscriptionsResponse", |
| 806 "properties": { | 811 "properties": { |
| 807 "policy": { | 812 "nextPageToken": { |
| 808 "$ref": "Policy", | 813 "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.", |
| 809 "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." | 814 "type": "string" |
| 815 }, |
| 816 "subscriptions": { |
| 817 "description": "The subscriptions that match the request.", |
| 818 "items": { |
| 819 "$ref": "Subscription" |
| 820 }, |
| 821 "type": "array" |
| 810 } | 822 } |
| 811 }, | 823 }, |
| 812 "type": "object" | 824 "type": "object" |
| 813 }, | |
| 814 "ReceivedMessage": { | |
| 815 "description": "A message and its corresponding acknowledgment ID.", | |
| 816 "id": "ReceivedMessage", | |
| 817 "properties": { | |
| 818 "ackId": { | |
| 819 "description": "This ID can be used to acknowledge the recei
ved message.", | |
| 820 "type": "string" | |
| 821 }, | |
| 822 "message": { | |
| 823 "$ref": "PubsubMessage", | |
| 824 "description": "The message." | |
| 825 } | |
| 826 }, | |
| 827 "type": "object" | |
| 828 }, | 825 }, |
| 829 "PublishRequest": { | 826 "PublishRequest": { |
| 830 "description": "Request for the Publish method.", | 827 "description": "Request for the Publish method.", |
| 831 "id": "PublishRequest", | 828 "id": "PublishRequest", |
| 832 "properties": { | 829 "properties": { |
| 833 "messages": { | 830 "messages": { |
| 834 "description": "The messages to publish.", | 831 "description": "The messages to publish.", |
| 835 "items": { | 832 "items": { |
| 836 "$ref": "PubsubMessage" | 833 "$ref": "PubsubMessage" |
| 837 }, | 834 }, |
| 838 "type": "array" | 835 "type": "array" |
| 839 } | 836 } |
| 840 }, | 837 }, |
| 841 "type": "object" | 838 "type": "object" |
| 842 }, | 839 }, |
| 843 "TestIamPermissionsResponse": { | |
| 844 "description": "Response message for `TestIamPermissions` method.", | |
| 845 "id": "TestIamPermissionsResponse", | |
| 846 "properties": { | |
| 847 "permissions": { | |
| 848 "description": "A subset of `TestPermissionsRequest.permissi
ons` that the caller is\nallowed.", | |
| 849 "items": { | |
| 850 "type": "string" | |
| 851 }, | |
| 852 "type": "array" | |
| 853 } | |
| 854 }, | |
| 855 "type": "object" | |
| 856 }, | |
| 857 "PublishResponse": { | 840 "PublishResponse": { |
| 858 "description": "Response for the `Publish` method.", | 841 "description": "Response for the `Publish` method.", |
| 859 "id": "PublishResponse", | 842 "id": "PublishResponse", |
| 860 "properties": { | 843 "properties": { |
| 861 "messageIds": { | 844 "messageIds": { |
| 862 "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.", | 845 "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.", |
| 863 "items": { | 846 "items": { |
| 864 "type": "string" | 847 "type": "string" |
| 865 }, | 848 }, |
| 866 "type": "array" | 849 "type": "array" |
| 867 } | 850 } |
| 868 }, | 851 }, |
| 869 "type": "object" | 852 "type": "object" |
| 870 }, | 853 }, |
| 871 "ListSubscriptionsResponse": { | |
| 872 "description": "Response for the `ListSubscriptions` method.", | |
| 873 "id": "ListSubscriptionsResponse", | |
| 874 "properties": { | |
| 875 "subscriptions": { | |
| 876 "description": "The subscriptions that match the request.", | |
| 877 "items": { | |
| 878 "$ref": "Subscription" | |
| 879 }, | |
| 880 "type": "array" | |
| 881 }, | |
| 882 "nextPageToken": { | |
| 883 "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.", | |
| 884 "type": "string" | |
| 885 } | |
| 886 }, | |
| 887 "type": "object" | |
| 888 }, | |
| 889 "Policy": { | |
| 890 "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).", | |
| 891 "id": "Policy", | |
| 892 "properties": { | |
| 893 "bindings": { | |
| 894 "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.", | |
| 895 "items": { | |
| 896 "$ref": "Binding" | |
| 897 }, | |
| 898 "type": "array" | |
| 899 }, | |
| 900 "etag": { | |
| 901 "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.", | |
| 902 "format": "byte", | |
| 903 "type": "string" | |
| 904 }, | |
| 905 "version": { | |
| 906 "description": "Version of the `Policy`. The default version
is 0.", | |
| 907 "format": "int32", | |
| 908 "type": "integer" | |
| 909 } | |
| 910 }, | |
| 911 "type": "object" | |
| 912 }, | |
| 913 "ListTopicSubscriptionsResponse": { | |
| 914 "description": "Response for the `ListTopicSubscriptions` method.", | |
| 915 "id": "ListTopicSubscriptionsResponse", | |
| 916 "properties": { | |
| 917 "subscriptions": { | |
| 918 "description": "The names of the subscriptions that match th
e request.", | |
| 919 "items": { | |
| 920 "type": "string" | |
| 921 }, | |
| 922 "type": "array" | |
| 923 }, | |
| 924 "nextPageToken": { | |
| 925 "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.", | |
| 926 "type": "string" | |
| 927 } | |
| 928 }, | |
| 929 "type": "object" | |
| 930 }, | |
| 931 "Subscription": { | 854 "Subscription": { |
| 932 "description": "A subscription resource.", | 855 "description": "A subscription resource.", |
| 933 "id": "Subscription", | 856 "id": "Subscription", |
| 934 "properties": { | 857 "properties": { |
| 858 "topic": { |
| 859 "description": "The name of the topic from which this subscr
iption is receiving messages.\nFormat is `projects/{project}/topics/{topic}`.\nT
he value of this field will be `_deleted-topic_` if the topic has been\ndeleted.
", |
| 860 "type": "string" |
| 861 }, |
| 935 "pushConfig": { | 862 "pushConfig": { |
| 936 "$ref": "PushConfig", | 863 "$ref": "PushConfig", |
| 937 "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." | 864 "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." |
| 938 }, | 865 }, |
| 939 "topic": { | |
| 940 "description": "The name of the topic from which this subscr
iption is receiving messages.\nFormat is `projects/{project}/topics/{topic}`.\nT
he value of this field will be `_deleted-topic_` if the topic has been\ndeleted.
", | |
| 941 "type": "string" | |
| 942 }, | |
| 943 "ackDeadlineSeconds": { | 866 "ackDeadlineSeconds": { |
| 944 "description": "This value is the maximum time after a subsc
riber receives a message\nbefore the subscriber should acknowledge the message.
After message\ndelivery but before the ack deadline expires and before the messa
ge is\nacknowledged, it is an outstanding message and will not be delivered\naga
in during that time (on a best-effort basis).\n\nFor pull subscriptions, this va
lue is used as the initial value for the ack\ndeadline. To override this value f
or a given message, call\n`ModifyAckDeadline` with the corresponding `ack_id` if
using\npull.\nThe minimum custom deadline you can specify is 10 seconds.\nThe m
aximum custom deadline you can specify is 600 seconds (10 minutes).\nIf this par
ameter is 0, a default value of 10 seconds is used.\n\nFor push delivery, this v
alue is also used to set the request timeout for\nthe call to the push endpoint.
\n\nIf the subscriber never acknowledges the message, the Pub/Sub\nsystem will e
ventually redeliver the message.", | 867 "description": "This value is the maximum time after a subsc
riber receives a message\nbefore the subscriber should acknowledge the message.
After message\ndelivery but before the ack deadline expires and before the messa
ge is\nacknowledged, it is an outstanding message and will not be delivered\naga
in during that time (on a best-effort basis).\n\nFor pull subscriptions, this va
lue is used as the initial value for the ack\ndeadline. To override this value f
or a given message, call\n`ModifyAckDeadline` with the corresponding `ack_id` if
using\npull.\nThe minimum custom deadline you can specify is 10 seconds.\nThe m
aximum custom deadline you can specify is 600 seconds (10 minutes).\nIf this par
ameter is 0, a default value of 10 seconds is used.\n\nFor push delivery, this v
alue is also used to set the request timeout for\nthe call to the push endpoint.
\n\nIf the subscriber never acknowledges the message, the Pub/Sub\nsystem will e
ventually redeliver the message.", |
| 945 "format": "int32", | 868 "format": "int32", |
| 946 "type": "integer" | 869 "type": "integer" |
| 947 }, | 870 }, |
| 948 "name": { | 871 "name": { |
| 949 "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\"`.", | 872 "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\"`.", |
| 950 "type": "string" | 873 "type": "string" |
| 951 } | 874 } |
| 952 }, | 875 }, |
| 953 "type": "object" | 876 "type": "object" |
| 954 }, | 877 }, |
| 955 "ModifyAckDeadlineRequest": { | |
| 956 "description": "Request for the ModifyAckDeadline method.", | |
| 957 "id": "ModifyAckDeadlineRequest", | |
| 958 "properties": { | |
| 959 "ackDeadlineSeconds": { | |
| 960 "description": "The new ack deadline with respect to the tim
e this request was sent to\nthe Pub/Sub system. For example, if the value is 10,
the new\nack deadline will expire 10 seconds after the `ModifyAckDeadline` call
\nwas made. Specifying zero may immediately make the message available for\nanot
her pull request.\nThe minimum deadline you can specify is 0 seconds.\nThe maxim
um deadline you can specify is 600 seconds (10 minutes).", | |
| 961 "format": "int32", | |
| 962 "type": "integer" | |
| 963 }, | |
| 964 "ackIds": { | |
| 965 "description": "List of acknowledgment IDs.", | |
| 966 "items": { | |
| 967 "type": "string" | |
| 968 }, | |
| 969 "type": "array" | |
| 970 } | |
| 971 }, | |
| 972 "type": "object" | |
| 973 }, | |
| 974 "TestIamPermissionsRequest": { | 878 "TestIamPermissionsRequest": { |
| 975 "description": "Request message for `TestIamPermissions` method.", | 879 "description": "Request message for `TestIamPermissions` method.", |
| 976 "id": "TestIamPermissionsRequest", | 880 "id": "TestIamPermissionsRequest", |
| 977 "properties": { | 881 "properties": { |
| 978 "permissions": { | 882 "permissions": { |
| 979 "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).", | 883 "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).", |
| 980 "items": { | 884 "items": { |
| 981 "type": "string" | 885 "type": "string" |
| 982 }, | 886 }, |
| 983 "type": "array" | 887 "type": "array" |
| 984 } | 888 } |
| 985 }, | 889 }, |
| 986 "type": "object" | 890 "type": "object" |
| 987 }, | 891 }, |
| 988 "PushConfig": { | 892 "Topic": { |
| 989 "description": "Configuration for a push delivery endpoint.", | 893 "description": "A topic resource.", |
| 990 "id": "PushConfig", | 894 "id": "Topic", |
| 991 "properties": { | 895 "properties": { |
| 992 "attributes": { | 896 "name": { |
| 993 "additionalProperties": { | 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\"`.", |
| 994 "type": "string" | |
| 995 }, | |
| 996 "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.", | |
| 997 "type": "object" | |
| 998 }, | |
| 999 "pushEndpoint": { | |
| 1000 "description": "A URL locating the endpoint to which message
s should be pushed.\nFor example, a Webhook endpoint might use \"https://example
.com/push\".", | |
| 1001 "type": "string" | 898 "type": "string" |
| 1002 } | 899 } |
| 1003 }, | 900 }, |
| 1004 "type": "object" | 901 "type": "object" |
| 1005 }, | 902 }, |
| 1006 "PullRequest": { | 903 "Policy": { |
| 1007 "description": "Request for the `Pull` method.", | 904 "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).", |
| 1008 "id": "PullRequest", | 905 "id": "Policy", |
| 1009 "properties": { | 906 "properties": { |
| 1010 "returnImmediately": { | 907 "etag": { |
| 1011 "description": "If this field set to true, the system will r
espond immediately even if\nit there are no messages available to return in the
`Pull` response.\nOtherwise, the system may wait (for a bounded amount of time)
until at\nleast one message is available, rather than returning no messages. The
\nclient may cancel the request if it does not wish to wait any longer for\nthe
response.", | 908 "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.", |
| 1012 "type": "boolean" | 909 "format": "byte", |
| 910 "type": "string" |
| 1013 }, | 911 }, |
| 1014 "maxMessages": { | 912 "version": { |
| 1015 "description": "The maximum number of messages returned for
this request. The Pub/Sub\nsystem may return fewer than the number specified.", | 913 "description": "Version of the `Policy`. The default version
is 0.", |
| 914 "format": "int32", |
| 915 "type": "integer" |
| 916 }, |
| 917 "bindings": { |
| 918 "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.", |
| 919 "items": { |
| 920 "$ref": "Binding" |
| 921 }, |
| 922 "type": "array" |
| 923 } |
| 924 }, |
| 925 "type": "object" |
| 926 }, |
| 927 "ModifyAckDeadlineRequest": { |
| 928 "description": "Request for the ModifyAckDeadline method.", |
| 929 "id": "ModifyAckDeadlineRequest", |
| 930 "properties": { |
| 931 "ackIds": { |
| 932 "description": "List of acknowledgment IDs.", |
| 933 "items": { |
| 934 "type": "string" |
| 935 }, |
| 936 "type": "array" |
| 937 }, |
| 938 "ackDeadlineSeconds": { |
| 939 "description": "The new ack deadline with respect to the tim
e this request was sent to\nthe Pub/Sub system. For example, if the value is 10,
the new\nack deadline will expire 10 seconds after the `ModifyAckDeadline` call
\nwas made. Specifying zero may immediately make the message available for\nanot
her pull request.\nThe minimum deadline you can specify is 0 seconds.\nThe maxim
um deadline you can specify is 600 seconds (10 minutes).", |
| 1016 "format": "int32", | 940 "format": "int32", |
| 1017 "type": "integer" | 941 "type": "integer" |
| 1018 } | 942 } |
| 1019 }, | 943 }, |
| 1020 "type": "object" | 944 "type": "object" |
| 945 }, |
| 946 "SetIamPolicyRequest": { |
| 947 "description": "Request message for `SetIamPolicy` method.", |
| 948 "id": "SetIamPolicyRequest", |
| 949 "properties": { |
| 950 "policy": { |
| 951 "$ref": "Policy", |
| 952 "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." |
| 953 } |
| 954 }, |
| 955 "type": "object" |
| 1021 }, | 956 }, |
| 1022 "ModifyPushConfigRequest": { | 957 "ModifyPushConfigRequest": { |
| 1023 "description": "Request for the ModifyPushConfig method.", | 958 "description": "Request for the ModifyPushConfig method.", |
| 1024 "id": "ModifyPushConfigRequest", | 959 "id": "ModifyPushConfigRequest", |
| 1025 "properties": { | 960 "properties": { |
| 1026 "pushConfig": { | 961 "pushConfig": { |
| 1027 "$ref": "PushConfig", | 962 "$ref": "PushConfig", |
| 1028 "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." | 963 "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." |
| 1029 } | 964 } |
| 1030 }, | 965 }, |
| 1031 "type": "object" | 966 "type": "object" |
| 1032 }, | 967 }, |
| 1033 "PullResponse": { | |
| 1034 "description": "Response for the `Pull` method.", | |
| 1035 "id": "PullResponse", | |
| 1036 "properties": { | |
| 1037 "receivedMessages": { | |
| 1038 "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.", | |
| 1039 "items": { | |
| 1040 "$ref": "ReceivedMessage" | |
| 1041 }, | |
| 1042 "type": "array" | |
| 1043 } | |
| 1044 }, | |
| 1045 "type": "object" | |
| 1046 }, | |
| 1047 "PubsubMessage": { | 968 "PubsubMessage": { |
| 1048 "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.", | 969 "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.", |
| 1049 "id": "PubsubMessage", | 970 "id": "PubsubMessage", |
| 1050 "properties": { | 971 "properties": { |
| 1051 "data": { | |
| 1052 "description": "The message payload.", | |
| 1053 "format": "byte", | |
| 1054 "type": "string" | |
| 1055 }, | |
| 1056 "attributes": { | 972 "attributes": { |
| 1057 "additionalProperties": { | 973 "additionalProperties": { |
| 1058 "type": "string" | 974 "type": "string" |
| 1059 }, | 975 }, |
| 1060 "description": "Optional attributes for this message.", | 976 "description": "Optional attributes for this message.", |
| 1061 "type": "object" | 977 "type": "object" |
| 1062 }, | 978 }, |
| 1063 "messageId": { | 979 "messageId": { |
| 1064 "description": "ID of this message, assigned by the server w
hen the message is published.\nGuaranteed to be unique within the topic. This va
lue may be read by a\nsubscriber that receives a `PubsubMessage` via a `Pull` ca
ll or a push\ndelivery. It must not be populated by the publisher in a `Publish`
call.", | 980 "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.", |
| 1065 "type": "string" | 981 "type": "string" |
| 1066 }, | 982 }, |
| 1067 "publishTime": { | 983 "publishTime": { |
| 1068 "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.", | 984 "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.", |
| 1069 "format": "google-datetime", | 985 "format": "google-datetime", |
| 1070 "type": "string" | 986 "type": "string" |
| 987 }, |
| 988 "data": { |
| 989 "description": "The message payload.", |
| 990 "format": "byte", |
| 991 "type": "string" |
| 1071 } | 992 } |
| 1072 }, | 993 }, |
| 1073 "type": "object" | 994 "type": "object" |
| 995 }, |
| 996 "Binding": { |
| 997 "description": "Associates `members` with a `role`.", |
| 998 "id": "Binding", |
| 999 "properties": { |
| 1000 "members": { |
| 1001 "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", |
| 1002 "items": { |
| 1003 "type": "string" |
| 1004 }, |
| 1005 "type": "array" |
| 1006 }, |
| 1007 "role": { |
| 1008 "description": "Role that is assigned to `members`.\nFor exa
mple, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired", |
| 1009 "type": "string" |
| 1010 } |
| 1011 }, |
| 1012 "type": "object" |
| 1013 }, |
| 1014 "ListTopicsResponse": { |
| 1015 "description": "Response for the `ListTopics` method.", |
| 1016 "id": "ListTopicsResponse", |
| 1017 "properties": { |
| 1018 "topics": { |
| 1019 "description": "The resulting topics.", |
| 1020 "items": { |
| 1021 "$ref": "Topic" |
| 1022 }, |
| 1023 "type": "array" |
| 1024 }, |
| 1025 "nextPageToken": { |
| 1026 "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`.", |
| 1027 "type": "string" |
| 1028 } |
| 1029 }, |
| 1030 "type": "object" |
| 1074 }, | 1031 }, |
| 1075 "AcknowledgeRequest": { | 1032 "AcknowledgeRequest": { |
| 1076 "description": "Request for the Acknowledge method.", | 1033 "description": "Request for the Acknowledge method.", |
| 1077 "id": "AcknowledgeRequest", | 1034 "id": "AcknowledgeRequest", |
| 1078 "properties": { | 1035 "properties": { |
| 1079 "ackIds": { | 1036 "ackIds": { |
| 1080 "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.", | 1037 "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.", |
| 1081 "items": { | 1038 "items": { |
| 1082 "type": "string" | 1039 "type": "string" |
| 1083 }, | 1040 }, |
| 1084 "type": "array" | 1041 "type": "array" |
| 1085 } | 1042 } |
| 1086 }, | 1043 }, |
| 1087 "type": "object" | 1044 "type": "object" |
| 1088 }, | 1045 }, |
| 1089 "Empty": { | 1046 "Empty": { |
| 1090 "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 `{}`.", | 1047 "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 `{}`.", |
| 1091 "id": "Empty", | 1048 "id": "Empty", |
| 1092 "properties": {}, | 1049 "properties": {}, |
| 1093 "type": "object" | 1050 "type": "object" |
| 1094 }, | 1051 }, |
| 1095 "ListTopicsResponse": { | 1052 "ListTopicSubscriptionsResponse": { |
| 1096 "description": "Response for the `ListTopics` method.", | 1053 "description": "Response for the `ListTopicSubscriptions` method.", |
| 1097 "id": "ListTopicsResponse", | 1054 "id": "ListTopicSubscriptionsResponse", |
| 1098 "properties": { | 1055 "properties": { |
| 1099 "nextPageToken": { | 1056 "nextPageToken": { |
| 1100 "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`.", | 1057 "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.", |
| 1101 "type": "string" | 1058 "type": "string" |
| 1102 }, | 1059 }, |
| 1103 "topics": { | 1060 "subscriptions": { |
| 1104 "description": "The resulting topics.", | 1061 "description": "The names of the subscriptions that match th
e request.", |
| 1105 "items": { | 1062 "items": { |
| 1106 "$ref": "Topic" | 1063 "type": "string" |
| 1107 }, | 1064 }, |
| 1108 "type": "array" | 1065 "type": "array" |
| 1109 } | 1066 } |
| 1110 }, | 1067 }, |
| 1111 "type": "object" | 1068 "type": "object" |
| 1112 }, | 1069 }, |
| 1113 "Binding": { | 1070 "PullResponse": { |
| 1114 "description": "Associates `members` with a `role`.", | 1071 "description": "Response for the `Pull` method.", |
| 1115 "id": "Binding", | 1072 "id": "PullResponse", |
| 1116 "properties": { | 1073 "properties": { |
| 1117 "members": { | 1074 "receivedMessages": { |
| 1118 "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", | 1075 "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.", |
| 1076 "items": { |
| 1077 "$ref": "ReceivedMessage" |
| 1078 }, |
| 1079 "type": "array" |
| 1080 } |
| 1081 }, |
| 1082 "type": "object" |
| 1083 }, |
| 1084 "ReceivedMessage": { |
| 1085 "description": "A message and its corresponding acknowledgment ID.", |
| 1086 "id": "ReceivedMessage", |
| 1087 "properties": { |
| 1088 "ackId": { |
| 1089 "description": "This ID can be used to acknowledge the recei
ved message.", |
| 1090 "type": "string" |
| 1091 }, |
| 1092 "message": { |
| 1093 "$ref": "PubsubMessage", |
| 1094 "description": "The message." |
| 1095 } |
| 1096 }, |
| 1097 "type": "object" |
| 1098 }, |
| 1099 "PushConfig": { |
| 1100 "description": "Configuration for a push delivery endpoint.", |
| 1101 "id": "PushConfig", |
| 1102 "properties": { |
| 1103 "pushEndpoint": { |
| 1104 "description": "A URL locating the endpoint to which message
s should be pushed.\nFor example, a Webhook endpoint might use \"https://example
.com/push\".", |
| 1105 "type": "string" |
| 1106 }, |
| 1107 "attributes": { |
| 1108 "additionalProperties": { |
| 1109 "type": "string" |
| 1110 }, |
| 1111 "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.", |
| 1112 "type": "object" |
| 1113 } |
| 1114 }, |
| 1115 "type": "object" |
| 1116 }, |
| 1117 "TestIamPermissionsResponse": { |
| 1118 "description": "Response message for `TestIamPermissions` method.", |
| 1119 "id": "TestIamPermissionsResponse", |
| 1120 "properties": { |
| 1121 "permissions": { |
| 1122 "description": "A subset of `TestPermissionsRequest.permissi
ons` that the caller is\nallowed.", |
| 1119 "items": { | 1123 "items": { |
| 1120 "type": "string" | 1124 "type": "string" |
| 1121 }, | 1125 }, |
| 1122 "type": "array" | 1126 "type": "array" |
| 1123 }, | |
| 1124 "role": { | |
| 1125 "description": "Role that is assigned to `members`.\nFor exa
mple, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired", | |
| 1126 "type": "string" | |
| 1127 } | 1127 } |
| 1128 }, | 1128 }, |
| 1129 "type": "object" | 1129 "type": "object" |
| 1130 } | 1130 } |
| 1131 }, | 1131 }, |
| 1132 "servicePath": "", | 1132 "servicePath": "", |
| 1133 "title": "Google Cloud Pub/Sub API", | 1133 "title": "Google Cloud Pub/Sub API", |
| 1134 "version": "v1" | 1134 "version": "v1" |
| 1135 } | 1135 } |
| OLD | NEW |
|---|
Chromium Code Reviews
Issue 2695743002:
Api-roll 45: 2017-02-13 (Closed)
