Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(52)

Issues Search
    My Issues | Starred     Open | Closed | All

Unified Diff: discovery/googleapis/pubsub__v1.json

Issue 2649893002: Api-roll 44: 2017-01-23 (Closed)
Patch Set: Created 3 years, 11 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « discovery/googleapis/plus__v1.json ('k') | discovery/googleapis/runtimeconfig__v1.json » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: discovery/googleapis/pubsub__v1.json
diff --git a/discovery/googleapis/pubsub__v1.json b/discovery/googleapis/pubsub__v1.json
index 432e1a0b102314301a45243c0318446afcba51ed..3242eab9df962df6473f5471f75ce3cfd558f440 100644
--- a/discovery/googleapis/pubsub__v1.json
+++ b/discovery/googleapis/pubsub__v1.json
@@ -14,10 +14,9 @@
"basePath": "",
"baseUrl": "https://pubsub.googleapis.com/",
"batchPath": "batch",
- "description": "Provides reliable, many-to-many, asynchronous messaging between applications.",
+ "description": "Provides reliable, many-to-many, asynchronous messaging between applications.\n",
"discoveryVersion": "v1",
"documentationLink": "https://cloud.google.com/pubsub/docs",
- "etag": "\"tbys6C40o18GZwyMen5GMkdK-3s/HIsdIvCDXEirzqtPtZbE0wV3MKA\"",
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
@@ -33,9 +32,41 @@
"location": "query",
"type": "string"
},
+ "prettyPrint": {
+ "default": "true",
+ "description": "Returns response with indentations and line breaks.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "location": "query",
+ "type": "string"
+ },
+ "quotaUser": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "location": "query",
+ "type": "string"
+ },
+ "pp": {
+ "default": "true",
+ "description": "Pretty-print response.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "location": "query",
+ "type": "string"
+ },
"alt": {
"default": "json",
"description": "Data format for response.",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
@@ -44,8 +75,16 @@
"location": "query",
"type": "string"
},
- "bearer_token": {
- "description": "OAuth bearer token.",
+ "$.xgafv": {
+ "description": "V1 error format.",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
"location": "query",
"type": "string"
},
@@ -54,35 +93,18 @@
"location": "query",
"type": "string"
},
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query",
- "type": "string"
- },
- "key": {
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "location": "query",
- "type": "string"
- },
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
},
- "pp": {
- "default": "true",
- "description": "Pretty-print response.",
- "location": "query",
- "type": "boolean"
- },
- "prettyPrint": {
- "default": "true",
- "description": "Returns response with indentations and line breaks.",
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location": "query",
- "type": "boolean"
+ "type": "string"
},
- "quotaUser": {
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "bearer_token": {
+ "description": "OAuth bearer token.",
"location": "query",
"type": "string"
},
@@ -90,50 +112,36 @@
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query",
"type": "string"
- },
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "location": "query",
- "type": "string"
- },
- "$.xgafv": {
- "description": "V1 error format.",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "type": "string"
}
},
"protocol": "rest",
"resources": {
"projects": {
"resources": {
- "topics": {
+ "subscriptions": {
"methods": {
- "setIamPolicy": {
- "description": "Sets the access control policy on the specified resource. Replaces any existing policy.",
+ "modifyPushConfig": {
+ "description": "Modifies the `PushConfig` for a specified 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 delivery\ncontinuously through the call regardless of changes to the `PushConfig`.",
"httpMethod": "POST",
- "id": "pubsub.projects.topics.setIamPolicy",
+ "id": "pubsub.projects.subscriptions.modifyPushConfig",
"parameterOrder": [
- "resource"
+ "subscription"
],
"parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy is being specified. `resource` is usually specified as a path. For example, a Project resource is specified as `projects/{project}`.",
+ "subscription": {
+ "description": "The name of the subscription.\nFormat is `projects/{project}/subscriptions/{sub}`.",
"location": "path",
- "pattern": "^projects/[^/]*/topics/[^/]*$",
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
"required": true,
"type": "string"
}
},
- "path": "v1/{+resource}:setIamPolicy",
+ "path": "v1/{+subscription}:modifyPushConfig",
"request": {
- "$ref": "SetIamPolicyRequest"
+ "$ref": "ModifyPushConfigRequest"
},
"response": {
- "$ref": "Policy"
+ "$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
@@ -141,17 +149,17 @@
]
},
"getIamPolicy": {
- "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.",
+ "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.",
"httpMethod": "GET",
- "id": "pubsub.projects.topics.getIamPolicy",
+ "id": "pubsub.projects.subscriptions.getIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
- "description": "REQUIRED: The resource for which the policy is being requested. `resource` is usually specified as a path. For example, a Project resource is specified as `projects/{project}`.",
+ "description": "REQUIRED: The resource for which the policy is being requested.\n`resource` is usually specified as a path. For example, a Project\nresource is specified as `projects/{project}`.",
"location": "path",
- "pattern": "^projects/[^/]*/topics/[^/]*$",
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
"required": true,
"type": "string"
}
@@ -165,28 +173,89 @@
"https://www.googleapis.com/auth/pubsub"
]
},
- "testIamPermissions": {
- "description": "Returns permissions that a caller has on the specified resource.",
+ "pull": {
+ "description": "Pulls messages from the server. Returns 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 pending for the given\nsubscription.",
"httpMethod": "POST",
- "id": "pubsub.projects.topics.testIamPermissions",
+ "id": "pubsub.projects.subscriptions.pull",
"parameterOrder": [
- "resource"
+ "subscription"
],
"parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy detail is being requested. `resource` is usually specified as a path. For example, a Project resource is specified as `projects/{project}`.",
+ "subscription": {
+ "description": "The subscription from which messages should be pulled.\nFormat is `projects/{project}/subscriptions/{sub}`.",
"location": "path",
- "pattern": "^projects/[^/]*/topics/[^/]*$",
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
"required": true,
"type": "string"
}
},
- "path": "v1/{+resource}:testIamPermissions",
+ "path": "v1/{+subscription}:pull",
"request": {
- "$ref": "TestIamPermissionsRequest"
+ "$ref": "PullRequest"
},
"response": {
- "$ref": "TestIamPermissionsResponse"
+ "$ref": "PullResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ]
+ },
+ "list": {
+ "description": "Lists matching subscriptions.",
+ "httpMethod": "GET",
+ "id": "pubsub.projects.subscriptions.list",
+ "parameterOrder": [
+ "project"
+ ],
+ "parameters": {
+ "pageSize": {
+ "description": "Maximum number of subscriptions to return.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "project": {
+ "description": "The name of the cloud project that subscriptions belong to.\nFormat is `projects/{project}`.",
+ "location": "path",
+ "pattern": "^projects/[^/]+$",
+ "required": true,
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "The value returned by the last `ListSubscriptionsResponse`; indicates that\nthis is a continuation of a prior `ListSubscriptions` call, and that the\nsystem should return the next page of data.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1/{+project}/subscriptions",
+ "response": {
+ "$ref": "ListSubscriptionsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ]
+ },
+ "get": {
+ "description": "Gets the configuration details of a subscription.",
+ "httpMethod": "GET",
+ "id": "pubsub.projects.subscriptions.get",
+ "parameterOrder": [
+ "subscription"
+ ],
+ "parameters": {
+ "subscription": {
+ "description": "The name of the subscription to get.\nFormat is `projects/{project}/subscriptions/{sub}`.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+subscription}",
+ "response": {
+ "$ref": "Subscription"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
@@ -194,233 +263,186 @@
]
},
"create": {
- "description": "Creates the given topic with the given name.",
+ "description": "Creates a subscription to a given topic.\nIf the subscription already exists, returns `ALREADY_EXISTS`.\nIf the corresponding topic doesn't exist, returns `NOT_FOUND`.\n\nIf the name is not provided in the request, the server will assign a random\nname for this subscription on the same project as the topic, conforming\nto the\n[resource name format](https://cloud.google.com/pubsub/docs/overview#names).\nThe generated name is populated in the returned Subscription object.\nNote that for REST API requests, you must specify a name in the request.",
"httpMethod": "PUT",
- "id": "pubsub.projects.topics.create",
+ "id": "pubsub.projects.subscriptions.create",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
- "description": "The name of the topic. It must have the format `\"projects/{project}/topics/{topic}\"`. `{topic}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `\"goog\"`.",
+ "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 characters\nin length, and it must not start with `\"goog\"`.",
"location": "path",
- "pattern": "^projects/[^/]*/topics/[^/]*$",
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"request": {
- "$ref": "Topic"
+ "$ref": "Subscription"
},
"response": {
- "$ref": "Topic"
+ "$ref": "Subscription"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/pubsub"
]
},
- "publish": {
- "description": "Adds one or more messages to the topic. Returns `NOT_FOUND` if the topic does not exist. The message payload must not be empty; it must contain either a non-empty data field, or at least one attribute.",
+ "modifyAckDeadline": {
+ "description": "Modifies the ack deadline for a specific message. This method is useful\nto indicate that more time is needed to process a message by the\nsubscriber, or to make the message available for redelivery if the\nprocessing was interrupted. Note that this does not modify the\nsubscription-level `ackDeadlineSeconds` used for subsequent messages.",
"httpMethod": "POST",
- "id": "pubsub.projects.topics.publish",
+ "id": "pubsub.projects.subscriptions.modifyAckDeadline",
"parameterOrder": [
- "topic"
+ "subscription"
],
"parameters": {
- "topic": {
- "description": "The messages in the request will be published on this topic.",
+ "subscription": {
+ "description": "The name of the subscription.\nFormat is `projects/{project}/subscriptions/{sub}`.",
"location": "path",
- "pattern": "^projects/[^/]*/topics/[^/]*$",
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
"required": true,
"type": "string"
}
},
- "path": "v1/{+topic}:publish",
+ "path": "v1/{+subscription}:modifyAckDeadline",
"request": {
- "$ref": "PublishRequest"
+ "$ref": "ModifyAckDeadlineRequest"
},
"response": {
- "$ref": "PublishResponse"
+ "$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/pubsub"
]
},
- "get": {
- "description": "Gets the configuration of a topic.",
- "httpMethod": "GET",
- "id": "pubsub.projects.topics.get",
+ "setIamPolicy": {
+ "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
+ "httpMethod": "POST",
+ "id": "pubsub.projects.subscriptions.setIamPolicy",
"parameterOrder": [
- "topic"
+ "resource"
],
"parameters": {
- "topic": {
- "description": "The name of the topic to get.",
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy is being specified.\n`resource` is usually specified as a path. For example, a Project\nresource is specified as `projects/{project}`.",
"location": "path",
- "pattern": "^projects/[^/]*/topics/[^/]*$",
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
"required": true,
"type": "string"
}
},
- "path": "v1/{+topic}",
+ "path": "v1/{+resource}:setIamPolicy",
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ },
"response": {
- "$ref": "Topic"
+ "$ref": "Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/pubsub"
]
},
- "list": {
- "description": "Lists matching topics.",
- "httpMethod": "GET",
- "id": "pubsub.projects.topics.list",
+ "delete": {
+ "description": "Deletes an existing subscription. All messages retained in the subscription\nare immediately dropped. Calls to `Pull` after deletion will return\n`NOT_FOUND`. After a subscription is deleted, a new one may be created with\nthe same name, but the new one has no association with the old\nsubscription or its topic unless the same topic is specified.",
+ "httpMethod": "DELETE",
+ "id": "pubsub.projects.subscriptions.delete",
"parameterOrder": [
- "project"
+ "subscription"
],
"parameters": {
- "project": {
- "description": "The name of the cloud project that topics belong to.",
+ "subscription": {
+ "description": "The subscription to delete.\nFormat is `projects/{project}/subscriptions/{sub}`.",
"location": "path",
- "pattern": "^projects/[^/]*$",
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
"required": true,
"type": "string"
- },
- "pageSize": {
- "description": "Maximum number of topics to return.",
- "format": "int32",
- "location": "query",
- "type": "integer"
- },
- "pageToken": {
- "description": "The value returned by the last `ListTopicsResponse`; indicates that this is a continuation of a prior `ListTopics` call, and that the system should return the next page of data.",
- "location": "query",
- "type": "string"
}
},
- "path": "v1/{+project}/topics",
+ "path": "v1/{+subscription}",
"response": {
- "$ref": "ListTopicsResponse"
+ "$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/pubsub"
]
},
- "delete": {
- "description": "Deletes the topic with the given name. Returns `NOT_FOUND` if the topic does not exist. After a topic is deleted, a new topic may be created with the same name; this is an entirely new topic with none of the old configuration or subscriptions. Existing subscriptions to this topic are not deleted, but their `topic` field is set to `_deleted-topic_`.",
- "httpMethod": "DELETE",
- "id": "pubsub.projects.topics.delete",
+ "testIamPermissions": {
+ "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.",
+ "httpMethod": "POST",
+ "id": "pubsub.projects.subscriptions.testIamPermissions",
"parameterOrder": [
- "topic"
+ "resource"
],
"parameters": {
- "topic": {
- "description": "Name of the topic to delete.",
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy detail is being requested.\n`resource` is usually specified as a path. For example, a Project\nresource is specified as `projects/{project}`.",
"location": "path",
- "pattern": "^projects/[^/]*/topics/[^/]*$",
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
"required": true,
"type": "string"
}
},
- "path": "v1/{+topic}",
+ "path": "v1/{+resource}:testIamPermissions",
+ "request": {
+ "$ref": "TestIamPermissionsRequest"
+ },
"response": {
- "$ref": "Empty"
+ "$ref": "TestIamPermissionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/pubsub"
]
- }
- },
- "resources": {
- "subscriptions": {
- "methods": {
- "list": {
- "description": "Lists the name of the subscriptions for this topic.",
- "httpMethod": "GET",
- "id": "pubsub.projects.topics.subscriptions.list",
- "parameterOrder": [
- "topic"
- ],
- "parameters": {
- "topic": {
- "description": "The name of the topic that subscriptions are attached to.",
- "location": "path",
- "pattern": "^projects/[^/]*/topics/[^/]*$",
- "required": true,
- "type": "string"
- },
- "pageSize": {
- "description": "Maximum number of subscription names to return.",
- "format": "int32",
- "location": "query",
- "type": "integer"
- },
- "pageToken": {
- "description": "The value returned by the last `ListTopicSubscriptionsResponse`; indicates that this is a continuation of a prior `ListTopicSubscriptions` call, and that the system should return the next page of data.",
- "location": "query",
- "type": "string"
- }
- },
- "path": "v1/{+topic}/subscriptions",
- "response": {
- "$ref": "ListTopicSubscriptionsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ]
- }
- }
- }
- }
- },
- "subscriptions": {
- "methods": {
- "setIamPolicy": {
- "description": "Sets the access control policy on the specified resource. Replaces any existing policy.",
+ },
+ "acknowledge": {
+ "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 ack deadline has expired may succeed,\nbut such a message may be redelivered later. Acknowledging a message more\nthan once will not result in an error.",
"httpMethod": "POST",
- "id": "pubsub.projects.subscriptions.setIamPolicy",
+ "id": "pubsub.projects.subscriptions.acknowledge",
"parameterOrder": [
- "resource"
+ "subscription"
],
"parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy is being specified. `resource` is usually specified as a path. For example, a Project resource is specified as `projects/{project}`.",
+ "subscription": {
+ "description": "The subscription whose message is being acknowledged.\nFormat is `projects/{project}/subscriptions/{sub}`.",
"location": "path",
- "pattern": "^projects/[^/]*/subscriptions/[^/]*$",
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
"required": true,
"type": "string"
}
},
- "path": "v1/{+resource}:setIamPolicy",
+ "path": "v1/{+subscription}:acknowledge",
"request": {
- "$ref": "SetIamPolicyRequest"
+ "$ref": "AcknowledgeRequest"
},
"response": {
- "$ref": "Policy"
+ "$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/pubsub"
]
- },
+ }
+ }
+ },
+ "topics": {
+ "methods": {
"getIamPolicy": {
- "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.",
+ "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.",
"httpMethod": "GET",
- "id": "pubsub.projects.subscriptions.getIamPolicy",
+ "id": "pubsub.projects.topics.getIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
- "description": "REQUIRED: The resource for which the policy is being requested. `resource` is usually specified as a path. For example, a Project resource is specified as `projects/{project}`.",
+ "description": "REQUIRED: The resource for which the policy is being requested.\n`resource` is usually specified as a path. For example, a Project\nresource is specified as `projects/{project}`.",
"location": "path",
- "pattern": "^projects/[^/]*/subscriptions/[^/]*$",
+ "pattern": "^projects/[^/]+/topics/[^/]+$",
"required": true,
"type": "string"
}
@@ -434,56 +456,64 @@
"https://www.googleapis.com/auth/pubsub"
]
},
- "testIamPermissions": {
- "description": "Returns permissions that a caller has on the specified resource.",
+ "publish": {
+ "description": "Adds one or more messages to the topic. Returns `NOT_FOUND` if the topic\ndoes not exist. The message payload must not be empty; it must contain\n either a non-empty data field, or at least one attribute.",
"httpMethod": "POST",
- "id": "pubsub.projects.subscriptions.testIamPermissions",
+ "id": "pubsub.projects.topics.publish",
"parameterOrder": [
- "resource"
+ "topic"
],
"parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy detail is being requested. `resource` is usually specified as a path. For example, a Project resource is specified as `projects/{project}`.",
+ "topic": {
+ "description": "The messages in the request will be published on this topic.\nFormat is `projects/{project}/topics/{topic}`.",
"location": "path",
- "pattern": "^projects/[^/]*/subscriptions/[^/]*$",
+ "pattern": "^projects/[^/]+/topics/[^/]+$",
"required": true,
"type": "string"
}
},
- "path": "v1/{+resource}:testIamPermissions",
+ "path": "v1/{+topic}:publish",
"request": {
- "$ref": "TestIamPermissionsRequest"
+ "$ref": "PublishRequest"
},
"response": {
- "$ref": "TestIamPermissionsResponse"
+ "$ref": "PublishResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/pubsub"
]
},
- "create": {
- "description": "Creates a subscription to a given topic. If the subscription already exists, returns `ALREADY_EXISTS`. If the corresponding topic doesn't exist, returns `NOT_FOUND`. If the name is not provided in the request, the server will assign a random name for this subscription on the same project as the topic. Note that for REST API requests, you must specify a name.",
- "httpMethod": "PUT",
- "id": "pubsub.projects.subscriptions.create",
+ "list": {
+ "description": "Lists matching topics.",
+ "httpMethod": "GET",
+ "id": "pubsub.projects.topics.list",
"parameterOrder": [
- "name"
+ "project"
],
"parameters": {
- "name": {
- "description": "The name of the subscription. It must have the format `\"projects/{project}/subscriptions/{subscription}\"`. `{subscription}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `\"goog\"`.",
+ "pageSize": {
+ "description": "Maximum number of topics to return.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "project": {
+ "description": "The name of the cloud project that topics belong to.\nFormat is `projects/{project}`.",
"location": "path",
- "pattern": "^projects/[^/]*/subscriptions/[^/]*$",
+ "pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
+ },
+ "pageToken": {
+ "description": "The value returned by the last `ListTopicsResponse`; indicates that this is\na continuation of a prior `ListTopics` call, and that the system should\nreturn the next page of data.",
+ "location": "query",
+ "type": "string"
}
},
- "path": "v1/{+name}",
- "request": {
- "$ref": "Subscription"
- },
+ "path": "v1/{+project}/topics",
"response": {
- "$ref": "Subscription"
+ "$ref": "ListTopicsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
@@ -491,111 +521,103 @@
]
},
"get": {
- "description": "Gets the configuration details of a subscription.",
+ "description": "Gets the configuration of a topic.",
"httpMethod": "GET",
- "id": "pubsub.projects.subscriptions.get",
+ "id": "pubsub.projects.topics.get",
"parameterOrder": [
- "subscription"
+ "topic"
],
"parameters": {
- "subscription": {
- "description": "The name of the subscription to get.",
+ "topic": {
+ "description": "The name of the topic to get.\nFormat is `projects/{project}/topics/{topic}`.",
"location": "path",
- "pattern": "^projects/[^/]*/subscriptions/[^/]*$",
+ "pattern": "^projects/[^/]+/topics/[^/]+$",
"required": true,
"type": "string"
}
},
- "path": "v1/{+subscription}",
+ "path": "v1/{+topic}",
"response": {
- "$ref": "Subscription"
+ "$ref": "Topic"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/pubsub"
]
},
- "list": {
- "description": "Lists matching subscriptions.",
- "httpMethod": "GET",
- "id": "pubsub.projects.subscriptions.list",
+ "create": {
+ "description": "Creates the given topic with the given name.",
+ "httpMethod": "PUT",
+ "id": "pubsub.projects.topics.create",
"parameterOrder": [
- "project"
+ "name"
],
"parameters": {
- "project": {
- "description": "The name of the cloud project that subscriptions belong to.",
+ "name": {
+ "description": "The name of the topic. It must have the format\n`\"projects/{project}/topics/{topic}\"`. `{topic}` must start with a letter,\nand contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`),\nunderscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent\nsigns (`%`). It must be between 3 and 255 characters in length, and it\nmust not start with `\"goog\"`.",
"location": "path",
- "pattern": "^projects/[^/]*$",
+ "pattern": "^projects/[^/]+/topics/[^/]+$",
"required": true,
"type": "string"
- },
- "pageSize": {
- "description": "Maximum number of subscriptions to return.",
- "format": "int32",
- "location": "query",
- "type": "integer"
- },
- "pageToken": {
- "description": "The value returned by the last `ListSubscriptionsResponse`; indicates that this is a continuation of a prior `ListSubscriptions` call, and that the system should return the next page of data.",
- "location": "query",
- "type": "string"
}
},
- "path": "v1/{+project}/subscriptions",
+ "path": "v1/{+name}",
+ "request": {
+ "$ref": "Topic"
+ },
"response": {
- "$ref": "ListSubscriptionsResponse"
+ "$ref": "Topic"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/pubsub"
]
},
- "delete": {
- "description": "Deletes an existing subscription. All messages retained in the subscription are immediately dropped. Calls to `Pull` after deletion will return `NOT_FOUND`. After a subscription is deleted, a new one may be created with the same name, but the new one has no association with the old subscription or its topic unless the same topic is specified.",
- "httpMethod": "DELETE",
- "id": "pubsub.projects.subscriptions.delete",
+ "setIamPolicy": {
+ "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
+ "httpMethod": "POST",
+ "id": "pubsub.projects.topics.setIamPolicy",
"parameterOrder": [
- "subscription"
+ "resource"
],
"parameters": {
- "subscription": {
- "description": "The subscription to delete.",
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy is being specified.\n`resource` is usually specified as a path. For example, a Project\nresource is specified as `projects/{project}`.",
"location": "path",
- "pattern": "^projects/[^/]*/subscriptions/[^/]*$",
+ "pattern": "^projects/[^/]+/topics/[^/]+$",
"required": true,
"type": "string"
}
},
- "path": "v1/{+subscription}",
+ "path": "v1/{+resource}:setIamPolicy",
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ },
"response": {
- "$ref": "Empty"
+ "$ref": "Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/pubsub"
]
},
- "modifyAckDeadline": {
- "description": "Modifies the ack deadline for a specific message. This method is useful to indicate that more time is needed to process a message by the subscriber, or to make the message available for redelivery if the processing was interrupted. Note that this does not modify the subscription-level `ackDeadlineSeconds` used for subsequent messages.",
- "httpMethod": "POST",
- "id": "pubsub.projects.subscriptions.modifyAckDeadline",
+ "delete": {
+ "description": "Deletes the topic with the given name. 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 with none of the old\nconfiguration or subscriptions. Existing subscriptions to this topic are\nnot deleted, but their `topic` field is set to `_deleted-topic_`.",
+ "httpMethod": "DELETE",
+ "id": "pubsub.projects.topics.delete",
"parameterOrder": [
- "subscription"
+ "topic"
],
"parameters": {
- "subscription": {
- "description": "The name of the subscription.",
+ "topic": {
+ "description": "Name of the topic to delete.\nFormat is `projects/{project}/topics/{topic}`.",
"location": "path",
- "pattern": "^projects/[^/]*/subscriptions/[^/]*$",
+ "pattern": "^projects/[^/]+/topics/[^/]+$",
"required": true,
"type": "string"
}
},
- "path": "v1/{+subscription}:modifyAckDeadline",
- "request": {
- "$ref": "ModifyAckDeadlineRequest"
- },
+ "path": "v1/{+topic}",
"response": {
"$ref": "Empty"
},
@@ -604,111 +626,125 @@
"https://www.googleapis.com/auth/pubsub"
]
},
- "acknowledge": {
- "description": "Acknowledges the messages associated with the `ack_ids` in the `AcknowledgeRequest`. The Pub/Sub system can remove the relevant messages from the subscription. Acknowledging a message whose ack deadline has expired may succeed, but such a message may be redelivered later. Acknowledging a message more than once will not result in an error.",
+ "testIamPermissions": {
+ "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.",
"httpMethod": "POST",
- "id": "pubsub.projects.subscriptions.acknowledge",
+ "id": "pubsub.projects.topics.testIamPermissions",
"parameterOrder": [
- "subscription"
+ "resource"
],
"parameters": {
- "subscription": {
- "description": "The subscription whose message is being acknowledged.",
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy detail is being requested.\n`resource` is usually specified as a path. For example, a Project\nresource is specified as `projects/{project}`.",
"location": "path",
- "pattern": "^projects/[^/]*/subscriptions/[^/]*$",
+ "pattern": "^projects/[^/]+/topics/[^/]+$",
"required": true,
"type": "string"
}
},
- "path": "v1/{+subscription}:acknowledge",
+ "path": "v1/{+resource}:testIamPermissions",
"request": {
- "$ref": "AcknowledgeRequest"
+ "$ref": "TestIamPermissionsRequest"
},
"response": {
- "$ref": "Empty"
+ "$ref": "TestIamPermissionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/pubsub"
]
- },
- "pull": {
- "description": "Pulls messages from the server. Returns an empty list if there are no messages available in the backlog. The server may return `UNAVAILABLE` if there are too many concurrent pull requests pending for the given subscription.",
+ }
+ },
+ "resources": {
+ "subscriptions": {
+ "methods": {
+ "list": {
+ "description": "Lists the name of the subscriptions for this topic.",
+ "httpMethod": "GET",
+ "id": "pubsub.projects.topics.subscriptions.list",
+ "parameterOrder": [
+ "topic"
+ ],
+ "parameters": {
+ "topic": {
+ "description": "The name of the topic that subscriptions are attached to.\nFormat is `projects/{project}/topics/{topic}`.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/topics/[^/]+$",
+ "required": true,
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Maximum number of subscription names to return.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "The value returned by the last `ListTopicSubscriptionsResponse`; indicates\nthat this is a continuation of a prior `ListTopicSubscriptions` call, and\nthat the system should return the next page of data.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1/{+topic}/subscriptions",
+ "response": {
+ "$ref": "ListTopicSubscriptionsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "snapshots": {
+ "methods": {
+ "testIamPermissions": {
+ "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.",
"httpMethod": "POST",
- "id": "pubsub.projects.subscriptions.pull",
+ "id": "pubsub.projects.snapshots.testIamPermissions",
"parameterOrder": [
- "subscription"
+ "resource"
],
"parameters": {
- "subscription": {
- "description": "The subscription from which messages should be pulled.",
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy detail is being requested.\n`resource` is usually specified as a path. For example, a Project\nresource is specified as `projects/{project}`.",
"location": "path",
- "pattern": "^projects/[^/]*/subscriptions/[^/]*$",
+ "pattern": "^projects/[^/]+/snapshots/[^/]+$",
"required": true,
"type": "string"
}
},
- "path": "v1/{+subscription}:pull",
+ "path": "v1/{+resource}:testIamPermissions",
"request": {
- "$ref": "PullRequest"
+ "$ref": "TestIamPermissionsRequest"
},
"response": {
- "$ref": "PullResponse"
+ "$ref": "TestIamPermissionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/pubsub"
]
},
- "modifyPushConfig": {
- "description": "Modifies the `PushConfig` for a specified subscription. This may be used to change a push subscription to a pull one (signified by an empty `PushConfig`) or vice versa, or change the endpoint URL and other attributes of a push subscription. Messages will accumulate for delivery continuously through the call regardless of changes to the `PushConfig`.",
+ "setIamPolicy": {
+ "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
"httpMethod": "POST",
- "id": "pubsub.projects.subscriptions.modifyPushConfig",
+ "id": "pubsub.projects.snapshots.setIamPolicy",
"parameterOrder": [
- "subscription"
+ "resource"
],
"parameters": {
- "subscription": {
- "description": "The name of the subscription.",
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy is being specified.\n`resource` is usually specified as a path. For example, a Project\nresource is specified as `projects/{project}`.",
"location": "path",
- "pattern": "^projects/[^/]*/subscriptions/[^/]*$",
+ "pattern": "^projects/[^/]+/snapshots/[^/]+$",
"required": true,
"type": "string"
}
},
- "path": "v1/{+subscription}:modifyPushConfig",
- "request": {
- "$ref": "ModifyPushConfigRequest"
- },
- "response": {
- "$ref": "Empty"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ]
- }
- }
- },
- "snapshots": {
- "methods": {
- "setIamPolicy": {
- "description": "Sets the access control policy on the specified resource. Replaces any existing policy.",
- "httpMethod": "POST",
- "id": "pubsub.projects.snapshots.setIamPolicy",
- "parameterOrder": [
- "resource"
- ],
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy is being specified. `resource` is usually specified as a path. For example, a Project resource is specified as `projects/{project}`.",
- "location": "path",
- "pattern": "^projects/[^/]*/snapshots/[^/]*$",
- "required": true,
- "type": "string"
- }
- },
- "path": "v1/{+resource}:setIamPolicy",
+ "path": "v1/{+resource}:setIamPolicy",
"request": {
"$ref": "SetIamPolicyRequest"
},
@@ -721,7 +757,7 @@
]
},
"getIamPolicy": {
- "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.",
+ "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.",
"httpMethod": "GET",
"id": "pubsub.projects.snapshots.getIamPolicy",
"parameterOrder": [
@@ -729,9 +765,9 @@
],
"parameters": {
"resource": {
- "description": "REQUIRED: The resource for which the policy is being requested. `resource` is usually specified as a path. For example, a Project resource is specified as `projects/{project}`.",
+ "description": "REQUIRED: The resource for which the policy is being requested.\n`resource` is usually specified as a path. For example, a Project\nresource is specified as `projects/{project}`.",
"location": "path",
- "pattern": "^projects/[^/]*/snapshots/[^/]*$",
+ "pattern": "^projects/[^/]+/snapshots/[^/]+$",
"required": true,
"type": "string"
}
@@ -744,104 +780,60 @@
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/pubsub"
]
- },
- "testIamPermissions": {
- "description": "Returns permissions that a caller has on the specified resource.",
- "httpMethod": "POST",
- "id": "pubsub.projects.snapshots.testIamPermissions",
- "parameterOrder": [
- "resource"
- ],
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy detail is being requested. `resource` is usually specified as a path. For example, a Project resource is specified as `projects/{project}`.",
- "location": "path",
- "pattern": "^projects/[^/]*/snapshots/[^/]*$",
- "required": true,
- "type": "string"
- }
- },
- "path": "v1/{+resource}:testIamPermissions",
- "request": {
- "$ref": "TestIamPermissionsRequest"
- },
- "response": {
- "$ref": "TestIamPermissionsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ]
}
}
}
}
}
},
- "revision": "20161003",
+ "revision": "20170105",
"rootUrl": "https://pubsub.googleapis.com/",
"schemas": {
- "SetIamPolicyRequest": {
- "description": "Request message for `SetIamPolicy` method.",
- "id": "SetIamPolicyRequest",
+ "Topic": {
+ "description": "A topic resource.",
+ "id": "Topic",
"properties": {
- "policy": {
- "$ref": "Policy",
- "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them."
+ "name": {
+ "description": "The name of the topic. It must have the format\n`\"projects/{project}/topics/{topic}\"`. `{topic}` must start with a letter,\nand contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`),\nunderscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent\nsigns (`%`). It must be between 3 and 255 characters in length, and it\nmust not start with `\"goog\"`.",
+ "type": "string"
}
},
"type": "object"
},
- "Policy": {
- "description": "Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **Example** { \"bindings\": [ { \"role\": \"roles/owner\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-other-app@appspot.gserviceaccount.com\", ] }, { \"role\": \"roles/viewer\", \"members\": [\"user:sean@example.com\"] } ] } For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).",
- "id": "Policy",
+ "SetIamPolicyRequest": {
+ "description": "Request message for `SetIamPolicy` method.",
+ "id": "SetIamPolicyRequest",
"properties": {
- "version": {
- "description": "Version of the `Policy`. The default version is 0.",
- "format": "int32",
- "type": "integer"
- },
- "bindings": {
- "description": "Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.",
- "items": {
- "$ref": "Binding"
- },
- "type": "array"
- },
- "etag": {
- "description": "`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.",
- "format": "byte",
- "type": "string"
+ "policy": {
+ "$ref": "Policy",
+ "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 empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them."
}
},
"type": "object"
},
- "Binding": {
- "description": "Associates `members` with a `role`.",
- "id": "Binding",
+ "ReceivedMessage": {
+ "description": "A message and its corresponding acknowledgment ID.",
+ "id": "ReceivedMessage",
"properties": {
- "role": {
- "description": "Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. Required",
+ "ackId": {
+ "description": "This ID can be used to acknowledge the received message.",
"type": "string"
},
- "members": {
- "description": "Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`. * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.",
- "items": {
- "type": "string"
- },
- "type": "array"
+ "message": {
+ "$ref": "PubsubMessage",
+ "description": "The message."
}
},
"type": "object"
},
- "TestIamPermissionsRequest": {
- "description": "Request message for `TestIamPermissions` method.",
- "id": "TestIamPermissionsRequest",
+ "PublishRequest": {
+ "description": "Request for the Publish method.",
+ "id": "PublishRequest",
"properties": {
- "permissions": {
- "description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
+ "messages": {
+ "description": "The messages to publish.",
"items": {
- "type": "string"
+ "$ref": "PubsubMessage"
},
"type": "array"
}
@@ -853,7 +845,7 @@
"id": "TestIamPermissionsResponse",
"properties": {
"permissions": {
- "description": "A subset of `TestPermissionsRequest.permissions` that the caller is allowed.",
+ "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
"items": {
"type": "string"
},
@@ -862,86 +854,58 @@
},
"type": "object"
},
- "Topic": {
- "description": "A topic resource.",
- "id": "Topic",
- "properties": {
- "name": {
- "description": "The name of the topic. It must have the format `\"projects/{project}/topics/{topic}\"`. `{topic}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `\"goog\"`.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "PublishRequest": {
- "description": "Request for the Publish method.",
- "id": "PublishRequest",
+ "PublishResponse": {
+ "description": "Response for the `Publish` method.",
+ "id": "PublishResponse",
"properties": {
- "messages": {
- "description": "The messages to publish.",
+ "messageIds": {
+ "description": "The server-assigned ID of each published message, in the same order as\nthe messages in the request. IDs are guaranteed to be unique within\nthe topic.",
"items": {
- "$ref": "PubsubMessage"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "PubsubMessage": {
- "description": "A message data and its attributes. The message payload must not be empty; it must contain either a non-empty data field, or at least one attribute.",
- "id": "PubsubMessage",
- "properties": {
- "data": {
- "description": "The message payload. For JSON requests, the value of this field must be [base64-encoded](https://tools.ietf.org/html/rfc4648).",
- "format": "byte",
- "type": "string"
- },
- "attributes": {
- "additionalProperties": {
"type": "string"
},
- "description": "Optional attributes for this message.",
- "type": "object"
- },
- "messageId": {
- "description": "ID of this message, assigned by the server when the message is published. Guaranteed to be unique within the topic. This value may be read by a subscriber that receives a `PubsubMessage` via a `Pull` call or a push delivery. It must not be populated by the publisher in a `Publish` call.",
- "type": "string"
- },
- "publishTime": {
- "description": "The time at which the message was published, populated by the server when it receives the `Publish` call. It must not be populated by the publisher in a `Publish` call.",
- "type": "string"
+ "type": "array"
}
},
"type": "object"
},
- "PublishResponse": {
- "description": "Response for the `Publish` method.",
- "id": "PublishResponse",
+ "ListSubscriptionsResponse": {
+ "description": "Response for the `ListSubscriptions` method.",
+ "id": "ListSubscriptionsResponse",
"properties": {
- "messageIds": {
- "description": "The server-assigned ID of each published message, in the same order as the messages in the request. IDs are guaranteed to be unique within the topic.",
+ "subscriptions": {
+ "description": "The subscriptions that match the request.",
"items": {
- "type": "string"
+ "$ref": "Subscription"
},
"type": "array"
+ },
+ "nextPageToken": {
+ "description": "If not empty, indicates that there may be more subscriptions that match\nthe request; this value should be passed in a new\n`ListSubscriptionsRequest` to get more subscriptions.",
+ "type": "string"
}
},
"type": "object"
},
- "ListTopicsResponse": {
- "description": "Response for the `ListTopics` method.",
- "id": "ListTopicsResponse",
+ "Policy": {
+ "description": "Defines an Identity and Access Management (IAM) policy. 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,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined 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.gserviceaccount.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).",
+ "id": "Policy",
"properties": {
- "topics": {
- "description": "The resulting topics.",
+ "bindings": {
+ "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.",
"items": {
- "$ref": "Topic"
+ "$ref": "Binding"
},
"type": "array"
},
- "nextPageToken": {
- "description": "If not empty, indicates that there may be more topics that match the request; this value should be passed in a new `ListTopicsRequest`.",
+ "etag": {
+ "description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: 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 their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
+ "format": "byte",
"type": "string"
+ },
+ "version": {
+ "description": "Version of the `Policy`. The default version is 0.",
+ "format": "int32",
+ "type": "integer"
}
},
"type": "object"
@@ -958,72 +922,31 @@
"type": "array"
},
"nextPageToken": {
- "description": "If not empty, indicates that there may be more subscriptions that match the request; this value should be passed in a new `ListTopicSubscriptionsRequest` to get more subscriptions.",
+ "description": "If not empty, indicates that there may be more subscriptions that match\nthe request; this value should be passed in a new\n`ListTopicSubscriptionsRequest` to get more subscriptions.",
"type": "string"
}
},
"type": "object"
},
- "Empty": {
- "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.",
- "id": "Empty",
- "type": "object"
- },
"Subscription": {
"description": "A subscription resource.",
"id": "Subscription",
"properties": {
- "name": {
- "description": "The name of the subscription. It must have the format `\"projects/{project}/subscriptions/{subscription}\"`. `{subscription}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `\"goog\"`.",
- "type": "string"
+ "pushConfig": {
+ "$ref": "PushConfig",
+ "description": "If push delivery is used with this subscription, this field is\nused to configure it. An empty `pushConfig` signifies that the subscriber\nwill pull and ack messages using API methods."
},
"topic": {
- "description": "The name of the topic from which this subscription is receiving messages. The value of this field will be `_deleted-topic_` if the topic has been deleted.",
+ "description": "The name of the topic from which this subscription is receiving messages.\nFormat is `projects/{project}/topics/{topic}`.\nThe value of this field will be `_deleted-topic_` if the topic has been\ndeleted.",
"type": "string"
},
- "pushConfig": {
- "$ref": "PushConfig",
- "description": "If push delivery is used with this subscription, this field is used to configure it. An empty `pushConfig` signifies that the subscriber will pull and ack messages using API methods."
- },
"ackDeadlineSeconds": {
- "description": "This value is the maximum time after a subscriber receives a message before the subscriber should acknowledge the message. After message delivery but before the ack deadline expires and before the message is acknowledged, it is an outstanding message and will not be delivered again during that time (on a best-effort basis). For pull subscriptions, this value is used as the initial value for the ack deadline. To override this value for a given message, call `ModifyAckDeadline` with the corresponding `ack_id` if using pull. The maximum custom deadline you can specify is 600 seconds (10 minutes). For push delivery, this value is also used to set the request timeout for the call to the push endpoint. If the subscriber never acknowledges the message, the Pub/Sub system will eventually redeliver the message. If this parameter is 0, a default value of 10 seconds is used.",
+ "description": "This value is the maximum time after a subscriber receives a message\nbefore the subscriber should acknowledge the message. After message\ndelivery but before the ack deadline expires and before the message is\nacknowledged, it is an outstanding message and will not be delivered\nagain during that time (on a best-effort basis).\n\nFor pull subscriptions, this value is used as the initial value for the ack\ndeadline. To override this value for 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 maximum custom deadline you can specify is 600 seconds (10 minutes).\nIf this parameter is 0, a default value of 10 seconds is used.\n\nFor push delivery, this value is also used to set the request timeout for\nthe call to the push endpoint.\n\nIf the subscriber never acknowledges the message, the Pub/Sub\nsystem will eventually redeliver the message.",
"format": "int32",
"type": "integer"
- }
- },
- "type": "object"
- },
- "PushConfig": {
- "description": "Configuration for a push delivery endpoint.",
- "id": "PushConfig",
- "properties": {
- "pushEndpoint": {
- "description": "A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use \"https://example.com/push\".",
- "type": "string"
},
- "attributes": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Endpoint configuration attributes. Every endpoint has a set of API supported attributes that can be used to control different aspects of the message delivery. The currently supported attribute is `x-goog-version`, which you can use to change the format of the push message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the envelope (i.e. its fields and metadata). The endpoint version is based on the version of the Pub/Sub API. If not present during the `CreateSubscription` call, it will default to the version of the API used to make such call. If not present during a `ModifyPushConfig` call, its value will not be changed. `GetSubscription` calls will always return a valid version, even if the subscription was created without this attribute. The possible values for this attribute are: * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API.",
- "type": "object"
- }
- },
- "type": "object"
- },
- "ListSubscriptionsResponse": {
- "description": "Response for the `ListSubscriptions` method.",
- "id": "ListSubscriptionsResponse",
- "properties": {
- "subscriptions": {
- "description": "The subscriptions that match the request.",
- "items": {
- "$ref": "Subscription"
- },
- "type": "array"
- },
- "nextPageToken": {
- "description": "If not empty, indicates that there may be more subscriptions that match the request; this value should be passed in a new `ListSubscriptionsRequest` to get more subscriptions.",
+ "name": {
+ "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 characters\nin length, and it must not start with `\"goog\"`.",
"type": "string"
}
},
@@ -1033,27 +956,27 @@
"description": "Request for the ModifyAckDeadline method.",
"id": "ModifyAckDeadlineRequest",
"properties": {
+ "ackDeadlineSeconds": {
+ "description": "The new ack deadline with respect to the time 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\nanother pull request.\nThe minimum deadline you can specify is 0 seconds.\nThe maximum deadline you can specify is 600 seconds (10 minutes).",
+ "format": "int32",
+ "type": "integer"
+ },
"ackIds": {
"description": "List of acknowledgment IDs.",
"items": {
"type": "string"
},
"type": "array"
- },
- "ackDeadlineSeconds": {
- "description": "The new ack deadline with respect to the time this request was sent to the Pub/Sub system. Must be >= 0. For example, if the value is 10, the new ack deadline will expire 10 seconds after the `ModifyAckDeadline` call was made. Specifying zero may immediately make the message available for another pull request.",
- "format": "int32",
- "type": "integer"
}
},
"type": "object"
},
- "AcknowledgeRequest": {
- "description": "Request for the Acknowledge method.",
- "id": "AcknowledgeRequest",
+ "TestIamPermissionsRequest": {
+ "description": "Request message for `TestIamPermissions` method.",
+ "id": "TestIamPermissionsRequest",
"properties": {
- "ackIds": {
- "description": "The acknowledgment ID for the messages being acknowledged that was returned by the Pub/Sub system in the `Pull` response. Must not be empty.",
+ "permissions": {
+ "description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
"items": {
"type": "string"
},
@@ -1062,28 +985,57 @@
},
"type": "object"
},
+ "PushConfig": {
+ "description": "Configuration for a push delivery endpoint.",
+ "id": "PushConfig",
+ "properties": {
+ "attributes": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Endpoint configuration attributes.\n\nEvery endpoint has a set of API supported attributes that can be used to\ncontrol different 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. This attribute\nindicates the version of the data expected by the endpoint. This\ncontrols 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 the `CreateSubscription` call, it will default to\nthe version of the API used to make such call. If not present during a\n`ModifyPushConfig` call, its value will not be changed. `GetSubscription`\ncalls will always return a valid version, even if the subscription was\ncreated without this attribute.\n\nThe possible values for this attribute are:\n\n* `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API.\n* `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API.",
+ "type": "object"
+ },
+ "pushEndpoint": {
+ "description": "A URL locating the endpoint to which messages should be pushed.\nFor example, a Webhook endpoint might use \"https://example.com/push\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
"PullRequest": {
"description": "Request for the `Pull` method.",
"id": "PullRequest",
"properties": {
"returnImmediately": {
- "description": "If this is specified as true the system will respond immediately even if it is not able to return a message in the `Pull` response. Otherwise the system is allowed to wait until at least one message is available rather than returning no messages. The client may cancel the request if it does not wish to wait any longer for the response.",
+ "description": "If this field set to true, the system will respond 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.",
"type": "boolean"
},
"maxMessages": {
- "description": "The maximum number of messages returned for this request. The Pub/Sub system may return fewer than the number specified.",
+ "description": "The maximum number of messages returned for this request. The Pub/Sub\nsystem may return fewer than the number specified.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
+ "ModifyPushConfigRequest": {
+ "description": "Request for the ModifyPushConfig method.",
+ "id": "ModifyPushConfigRequest",
+ "properties": {
+ "pushConfig": {
+ "$ref": "PushConfig",
+ "description": "The push configuration for future deliveries.\n\nAn empty `pushConfig` indicates that the Pub/Sub system should\nstop pushing messages from the given subscription and allow\nmessages to be pulled and acknowledged - effectively pausing\nthe subscription if `Pull` is not called."
+ }
+ },
+ "type": "object"
+ },
"PullResponse": {
"description": "Response for the `Pull` method.",
"id": "PullResponse",
"properties": {
"receivedMessages": {
- "description": "Received Pub/Sub messages. The Pub/Sub system will return zero messages if there are no more available in the backlog. The Pub/Sub system may return fewer than the `maxMessages` requested even if there are more messages available in the backlog.",
+ "description": "Received Pub/Sub messages. The Pub/Sub system 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.",
"items": {
"$ref": "ReceivedMessage"
},
@@ -1092,28 +1044,86 @@
},
"type": "object"
},
- "ReceivedMessage": {
- "description": "A message and its corresponding acknowledgment ID.",
- "id": "ReceivedMessage",
+ "PubsubMessage": {
+ "description": "A message data and its attributes. The message payload must not be empty;\nit must contain either a non-empty data field, or at least one attribute.",
+ "id": "PubsubMessage",
"properties": {
- "ackId": {
- "description": "This ID can be used to acknowledge the received message.",
+ "data": {
+ "description": "The message payload.",
+ "format": "byte",
"type": "string"
},
- "message": {
- "$ref": "PubsubMessage",
- "description": "The message."
+ "attributes": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Optional attributes for this message.",
+ "type": "object"
+ },
+ "messageId": {
+ "description": "ID of this message, assigned by the server when the message is published.\nGuaranteed to be unique within the topic. This value may be read by a\nsubscriber that receives a `PubsubMessage` via a `Pull` call or a push\ndelivery. It must not be populated by the publisher in a `Publish` call.",
+ "type": "string"
+ },
+ "publishTime": {
+ "description": "The time at which the message was published, populated by the server when\nit receives the `Publish` call. It must not be populated by the\npublisher in a `Publish` call.",
+ "format": "google-datetime",
+ "type": "string"
}
},
"type": "object"
},
- "ModifyPushConfigRequest": {
- "description": "Request for the ModifyPushConfig method.",
- "id": "ModifyPushConfigRequest",
+ "AcknowledgeRequest": {
+ "description": "Request for the Acknowledge method.",
+ "id": "AcknowledgeRequest",
"properties": {
- "pushConfig": {
- "$ref": "PushConfig",
- "description": "The push configuration for future deliveries. An empty `pushConfig` indicates that the Pub/Sub system should stop pushing messages from the given subscription and allow messages to be pulled and acknowledged - effectively pausing the subscription if `Pull` is not called."
+ "ackIds": {
+ "description": "The acknowledgment ID for the messages being acknowledged that was returned\nby the Pub/Sub system in the `Pull` response. Must not be empty.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "Empty": {
+ "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 it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
+ "id": "Empty",
+ "properties": {},
+ "type": "object"
+ },
+ "ListTopicsResponse": {
+ "description": "Response for the `ListTopics` method.",
+ "id": "ListTopicsResponse",
+ "properties": {
+ "nextPageToken": {
+ "description": "If not empty, indicates that there may be more topics that match the\nrequest; this value should be passed in a new `ListTopicsRequest`.",
+ "type": "string"
+ },
+ "topics": {
+ "description": "The resulting topics.",
+ "items": {
+ "$ref": "Topic"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "Binding": {
+ "description": "Associates `members` with a `role`.",
+ "id": "Binding",
+ "properties": {
+ "members": {
+ "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier 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 specific 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:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "role": {
+ "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
+ "type": "string"
}
},
"type": "object"
« no previous file with comments | « discovery/googleapis/plus__v1.json ('k') | discovery/googleapis/runtimeconfig__v1.json » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698