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

Unified Diff: discovery/googleapis/pubsub__v1.json

Issue 2734843002: Api-roll 46: 2017-03-06 (Closed)
Patch Set: Created 3 years, 9 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/reseller__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 f83fda25a555c7974358f63f9ba1a1a343a47340..6d1f57400d2cc0ee310be4163f3f66f7c7b7318d 100644
--- a/discovery/googleapis/pubsub__v1.json
+++ b/discovery/googleapis/pubsub__v1.json
@@ -14,6 +14,7 @@
"basePath": "",
"baseUrl": "https://pubsub.googleapis.com/",
"batchPath": "batch",
+ "canonicalName": "Pubsub",
"description": "Provides reliable, many-to-many, asynchronous messaging between applications.\n",
"discoveryVersion": "v1",
"documentationLink": "https://cloud.google.com/pubsub/docs",
@@ -27,16 +28,6 @@
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query",
- "type": "string"
- },
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "location": "query",
- "type": "string"
- },
"$.xgafv": {
"description": "V1 error format.",
"enum": [
@@ -112,6 +103,16 @@
"description": "Returns response with indentations and line breaks.",
"location": "query",
"type": "boolean"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "location": "query",
+ "type": "string"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "location": "query",
+ "type": "string"
}
},
"protocol": "rest",
@@ -120,28 +121,81 @@
"resources": {
"subscriptions": {
"methods": {
- "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.",
+ "create": {
+ "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.subscriptions.create",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "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\"`.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+name}",
+ "request": {
+ "$ref": "Subscription"
+ },
+ "response": {
+ "$ref": "Subscription"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ]
+ },
+ "setIamPolicy": {
+ "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
"httpMethod": "POST",
- "id": "pubsub.projects.subscriptions.acknowledge",
+ "id": "pubsub.projects.subscriptions.setIamPolicy",
"parameterOrder": [
- "subscription"
+ "resource"
],
"parameters": {
- "subscription": {
- "description": "The subscription whose message is being acknowledged.\nFormat is `projects/{project}/subscriptions/{sub}`.",
+ "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/[^/]+$",
"required": true,
"type": "string"
}
},
- "path": "v1/{+subscription}:acknowledge",
+ "path": "v1/{+resource}:setIamPolicy",
"request": {
- "$ref": "AcknowledgeRequest"
+ "$ref": "SetIamPolicyRequest"
},
"response": {
- "$ref": "Empty"
+ "$ref": "Policy"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ]
+ },
+ "getIamPolicy": {
+ "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",
+ "parameterOrder": [
+ "resource"
+ ],
+ "parameters": {
+ "resource": {
+ "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/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+resource}:getIamPolicy",
+ "response": {
+ "$ref": "Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
@@ -176,25 +230,28 @@
"https://www.googleapis.com/auth/pubsub"
]
},
- "getIamPolicy": {
- "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",
+ "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.acknowledge",
"parameterOrder": [
- "resource"
+ "subscription"
],
"parameters": {
- "resource": {
- "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}`.",
+ "subscription": {
+ "description": "The subscription whose message is being acknowledged.\nFormat is `projects/{project}/subscriptions/{sub}`.",
"location": "path",
"pattern": "^projects/[^/]+/subscriptions/[^/]+$",
"required": true,
"type": "string"
}
},
- "path": "v1/{+resource}:getIamPolicy",
+ "path": "v1/{+subscription}:acknowledge",
+ "request": {
+ "$ref": "AcknowledgeRequest"
+ },
"response": {
- "$ref": "Policy"
+ "$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
@@ -227,7 +284,7 @@
]
},
"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.",
+ "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.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
"httpMethod": "POST",
"id": "pubsub.projects.subscriptions.testIamPermissions",
"parameterOrder": [
@@ -282,53 +339,53 @@
"https://www.googleapis.com/auth/pubsub"
]
},
- "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",
+ "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.subscriptions.pull",
"parameterOrder": [
"subscription"
],
"parameters": {
"subscription": {
- "description": "The subscription to delete.\nFormat is `projects/{project}/subscriptions/{sub}`.",
+ "description": "The subscription from which messages should be pulled.\nFormat is `projects/{project}/subscriptions/{sub}`.",
"location": "path",
"pattern": "^projects/[^/]+/subscriptions/[^/]+$",
"required": true,
"type": "string"
}
},
- "path": "v1/{+subscription}",
+ "path": "v1/{+subscription}:pull",
+ "request": {
+ "$ref": "PullRequest"
+ },
"response": {
- "$ref": "Empty"
+ "$ref": "PullResponse"
},
"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\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.subscriptions.pull",
+ "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": [
"subscription"
],
"parameters": {
"subscription": {
- "description": "The subscription from which messages should be pulled.\nFormat is `projects/{project}/subscriptions/{sub}`.",
+ "description": "The subscription to delete.\nFormat is `projects/{project}/subscriptions/{sub}`.",
"location": "path",
"pattern": "^projects/[^/]+/subscriptions/[^/]+$",
"required": true,
"type": "string"
}
},
- "path": "v1/{+subscription}:pull",
- "request": {
- "$ref": "PullRequest"
- },
+ "path": "v1/{+subscription}",
"response": {
- "$ref": "PullResponse"
+ "$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
@@ -343,6 +400,13 @@
"project"
],
"parameters": {
+ "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",
@@ -353,13 +417,6 @@
"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"
}
},
"path": "v1/{+project}/subscriptions",
@@ -370,55 +427,28 @@
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/pubsub"
]
- },
- "create": {
- "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.subscriptions.create",
- "parameterOrder": [
- "name"
- ],
- "parameters": {
- "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\"`.",
- "location": "path",
- "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
- "required": true,
- "type": "string"
- }
- },
- "path": "v1/{+name}",
- "request": {
- "$ref": "Subscription"
- },
- "response": {
- "$ref": "Subscription"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ]
- },
- "setIamPolicy": {
- "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
- "httpMethod": "POST",
- "id": "pubsub.projects.subscriptions.setIamPolicy",
+ }
+ }
+ },
+ "snapshots": {
+ "methods": {
+ "getIamPolicy": {
+ "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": [
"resource"
],
"parameters": {
"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}`.",
+ "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/[^/]+/snapshots/[^/]+$",
"required": true,
"type": "string"
}
},
- "path": "v1/{+resource}:setIamPolicy",
- "request": {
- "$ref": "SetIamPolicyRequest"
- },
+ "path": "v1/{+resource}:getIamPolicy",
"response": {
"$ref": "Policy"
},
@@ -426,11 +456,7 @@
"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\nexisting policy.",
"httpMethod": "POST",
@@ -460,7 +486,7 @@
]
},
"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.",
+ "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.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
"httpMethod": "POST",
"id": "pubsub.projects.snapshots.testIamPermissions",
"parameterOrder": [
@@ -486,91 +512,13 @@
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/pubsub"
]
- },
- "getIamPolicy": {
- "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": [
- "resource"
- ],
- "parameters": {
- "resource": {
- "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/[^/]+$",
- "required": true,
- "type": "string"
- }
- },
- "path": "v1/{+resource}:getIamPolicy",
- "response": {
- "$ref": "Policy"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ]
}
}
},
"topics": {
"methods": {
- "get": {
- "description": "Gets the configuration of a topic.",
- "httpMethod": "GET",
- "id": "pubsub.projects.topics.get",
- "parameterOrder": [
- "topic"
- ],
- "parameters": {
- "topic": {
- "description": "The name of the topic to get.\nFormat is `projects/{project}/topics/{topic}`.",
- "location": "path",
- "pattern": "^projects/[^/]+/topics/[^/]+$",
- "required": true,
- "type": "string"
- }
- },
- "path": "v1/{+topic}",
- "response": {
- "$ref": "Topic"
- },
- "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\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.topics.publish",
- "parameterOrder": [
- "topic"
- ],
- "parameters": {
- "topic": {
- "description": "The messages in the request will be published on this topic.\nFormat is `projects/{project}/topics/{topic}`.",
- "location": "path",
- "pattern": "^projects/[^/]+/topics/[^/]+$",
- "required": true,
- "type": "string"
- }
- },
- "path": "v1/{+topic}:publish",
- "request": {
- "$ref": "PublishRequest"
- },
- "response": {
- "$ref": "PublishResponse"
- },
- "scopes": [
- "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.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.",
+ "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.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
"httpMethod": "POST",
"id": "pubsub.projects.topics.testIamPermissions",
"parameterOrder": [
@@ -630,11 +578,6 @@
"project"
],
"parameters": {
- "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"
- },
"pageSize": {
"description": "Maximum number of topics to return.",
"format": "int32",
@@ -647,6 +590,11 @@
"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/{+project}/topics",
@@ -738,6 +686,59 @@
"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",
+ "parameterOrder": [
+ "topic"
+ ],
+ "parameters": {
+ "topic": {
+ "description": "The name of the topic to get.\nFormat is `projects/{project}/topics/{topic}`.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/topics/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+topic}",
+ "response": {
+ "$ref": "Topic"
+ },
+ "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\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.topics.publish",
+ "parameterOrder": [
+ "topic"
+ ],
+ "parameters": {
+ "topic": {
+ "description": "The messages in the request will be published on this topic.\nFormat is `projects/{project}/topics/{topic}`.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/topics/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+topic}:publish",
+ "request": {
+ "$ref": "PublishRequest"
+ },
+ "response": {
+ "$ref": "PublishResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ]
}
},
"resources": {
@@ -751,6 +752,11 @@
"topic"
],
"parameters": {
+ "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"
+ },
"pageSize": {
"description": "Maximum number of subscription names to return.",
"format": "int32",
@@ -763,11 +769,6 @@
"pattern": "^projects/[^/]+/topics/[^/]+$",
"required": true,
"type": "string"
- },
- "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",
@@ -786,21 +787,53 @@
}
}
},
- "revision": "20170124",
+ "revision": "20170214",
"rootUrl": "https://pubsub.googleapis.com/",
"schemas": {
+ "PushConfig": {
+ "description": "Configuration for a push delivery endpoint.",
+ "id": "PushConfig",
+ "properties": {
+ "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"
+ },
+ "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"
+ }
+ },
+ "type": "object"
+ },
+ "TestIamPermissionsResponse": {
+ "description": "Response message for `TestIamPermissions` method.",
+ "id": "TestIamPermissionsResponse",
+ "properties": {
+ "permissions": {
+ "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
"PullRequest": {
"description": "Request for the `Pull` method.",
"id": "PullRequest",
"properties": {
- "returnImmediately": {
- "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\nsystem may return fewer than the number specified.",
"format": "int32",
"type": "integer"
+ },
+ "returnImmediately": {
+ "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"
}
},
"type": "object"
@@ -855,14 +888,6 @@
"description": "A subscription resource.",
"id": "Subscription",
"properties": {
- "topic": {
- "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\nused to configure it. An empty `pushConfig` signifies that the subscriber\nwill pull and ack messages using API methods."
- },
"ackDeadlineSeconds": {
"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",
@@ -871,6 +896,14 @@
"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"
+ },
+ "topic": {
+ "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\nused to configure it. An empty `pushConfig` signifies that the subscriber\nwill pull and ack messages using API methods."
}
},
"type": "object"
@@ -969,6 +1002,11 @@
"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": {
+ "data": {
+ "description": "The message payload.",
+ "format": "byte",
+ "type": "string"
+ },
"attributes": {
"additionalProperties": {
"type": "string"
@@ -984,11 +1022,6 @@
"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"
- },
- "data": {
- "description": "The message payload.",
- "format": "byte",
- "type": "string"
}
},
"type": "object"
@@ -1011,24 +1044,6 @@
},
"type": "object"
},
- "ListTopicsResponse": {
- "description": "Response for the `ListTopics` method.",
- "id": "ListTopicsResponse",
- "properties": {
- "topics": {
- "description": "The resulting topics.",
- "items": {
- "$ref": "Topic"
- },
- "type": "array"
- },
- "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"
- }
- },
- "type": "object"
- },
"AcknowledgeRequest": {
"description": "Request for the Acknowledge method.",
"id": "AcknowledgeRequest",
@@ -1049,6 +1064,24 @@
"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"
+ },
"ListTopicSubscriptionsResponse": {
"description": "Response for the `ListTopicSubscriptions` method.",
"id": "ListTopicSubscriptionsResponse",
@@ -1085,45 +1118,13 @@
"description": "A message and its corresponding acknowledgment ID.",
"id": "ReceivedMessage",
"properties": {
- "ackId": {
- "description": "This ID can be used to acknowledge the received message.",
- "type": "string"
- },
"message": {
"$ref": "PubsubMessage",
"description": "The message."
- }
- },
- "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.\nFor example, a Webhook endpoint might use \"https://example.com/push\".",
- "type": "string"
},
- "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"
- }
- },
- "type": "object"
- },
- "TestIamPermissionsResponse": {
- "description": "Response message for `TestIamPermissions` method.",
- "id": "TestIamPermissionsResponse",
- "properties": {
- "permissions": {
- "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
- "items": {
- "type": "string"
- },
- "type": "array"
+ "ackId": {
+ "description": "This ID can be used to acknowledge the received message.",
+ "type": "string"
}
},
"type": "object"
« no previous file with comments | « discovery/googleapis/plus__v1.json ('k') | discovery/googleapis/reseller__v1.json » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698