Api-roll 42: 2016-11-08

discovery/googleapis/pubsub__v1.json

 {
     "auth": {
         "oauth2": {
             "scopes": {
                 "https://www.googleapis.com/auth/cloud-platform": {
                     "description": "View and manage your data across Google Cloud Platform services"
                 },
                 "https://www.googleapis.com/auth/pubsub": {
                     "description": "View and manage Pub/Sub topics and subscriptions"
                 }
             }
         }
     },
     "basePath": "",
     "baseUrl": "https://pubsub.googleapis.com/",
     "batchPath": "batch",
     "description": "Provides reliable, many-to-many, asynchronous messaging between applications.",
     "discoveryVersion": "v1",
     "documentationLink": "https://cloud.google.com/pubsub/docs",
-    "etag": "\"C5oy1hgQsABtYOYIOXWcR3BgYqU/liyzgLngirW3xU7Tt2Pd1AnSK1c\"",
+    "etag": "\"C5oy1hgQsABtYOYIOXWcR3BgYqU/HIsdIvCDXEirzqtPtZbE0wV3MKA\"",
     "icons": {
         "x16": "http://www.google.com/images/icons/product/search-16.gif",
         "x32": "http://www.google.com/images/icons/product/search-32.gif"
     },
     "id": "pubsub:v1",
     "kind": "discovery#restDescription",
     "name": "pubsub",
     "ownerDomain": "google.com",
     "ownerName": "Google",
     "parameters": {
@@ skipping 83 matching lines @@
                     "methods": {
                         "setIamPolicy": {
                             "description": "Sets the access control policy on the specified resource. Replaces any existing policy.",
                             "httpMethod": "POST",
                             "id": "pubsub.projects.topics.setIamPolicy",
                             "parameterOrder": [
                                 "resource"
                             ],
                             "parameters": {
                                 "resource": {
-                                    "description": "REQUIRED: The resource for which the policy is being specified. `resource` is usually specified as a path, such as `projects/*project*/zones/*zone*/disks/*disk*`. The format for the path specified in this value is resource specific and is specified in the `setIamPolicy` documentation.",
+                                    "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/[^/]*/topics/[^/]*$",
                                     "required": true,
                                     "type": "string"
                                 }
                             },
                             "path": "v1/{+resource}:setIamPolicy",
                             "request": {
                                 "$ref": "SetIamPolicyRequest"
                             },
                             "response": {
                                 "$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`. Returns an empty policy if the resource exists and does not have a policy set.",
+                            "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.",
                             "httpMethod": "GET",
                             "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, such as `projects/*project*/zones/*zone*/disks/*disk*`. The format for the path specified in this value is resource specific and is specified in the `getIamPolicy` documentation.",
+                                    "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}`.",
                                     "location": "path",
                                     "pattern": "^projects/[^/]*/topics/[^/]*$",
                                     "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"
                             ]
                         },
                         "testIamPermissions": {
                             "description": "Returns permissions that a caller has on the specified resource.",
                             "httpMethod": "POST",
                             "id": "pubsub.projects.topics.testIamPermissions",
                             "parameterOrder": [
                                 "resource"
                             ],
                             "parameters": {
                                 "resource": {
-                                    "description": "REQUIRED: The resource for which the policy detail is being requested. `resource` is usually specified as a path, such as `projects/*project*/zones/*zone*/disks/*disk*`. The format for the path specified in this value is resource specific and is specified in the `testIamPermissions` documentation.",
+                                    "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/[^/]*/topics/[^/]*$",
                                     "required": true,
                                     "type": "string"
                                 }
                             },
                             "path": "v1/{+resource}:testIamPermissions",
                             "request": {
                                 "$ref": "TestIamPermissionsRequest"
                             },
@@ skipping 195 matching lines @@
                     "methods": {
                         "setIamPolicy": {
                             "description": "Sets the access control policy on the specified resource. Replaces any existing policy.",
                             "httpMethod": "POST",
                             "id": "pubsub.projects.subscriptions.setIamPolicy",
                             "parameterOrder": [
                                 "resource"
                             ],
                             "parameters": {
                                 "resource": {
-                                    "description": "REQUIRED: The resource for which the policy is being specified. `resource` is usually specified as a path, such as `projects/*project*/zones/*zone*/disks/*disk*`. The format for the path specified in this value is resource specific and is specified in the `setIamPolicy` documentation.",
+                                    "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/[^/]*/subscriptions/[^/]*$",
                                     "required": true,
                                     "type": "string"
                                 }
                             },
                             "path": "v1/{+resource}:setIamPolicy",
                             "request": {
                                 "$ref": "SetIamPolicyRequest"
                             },
                             "response": {
                                 "$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`. Returns an empty policy if the resource exists and does not have a policy set.",
+                            "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.",
                             "httpMethod": "GET",
                             "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, such as `projects/*project*/zones/*zone*/disks/*disk*`. The format for the path specified in this value is resource specific and is specified in the `getIamPolicy` documentation.",
+                                    "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}`.",
                                     "location": "path",
                                     "pattern": "^projects/[^/]*/subscriptions/[^/]*$",
                                     "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"
                             ]
                         },
                         "testIamPermissions": {
                             "description": "Returns permissions that a caller has on the specified resource.",
                             "httpMethod": "POST",
                             "id": "pubsub.projects.subscriptions.testIamPermissions",
                             "parameterOrder": [
                                 "resource"
                             ],
                             "parameters": {
                                 "resource": {
-                                    "description": "REQUIRED: The resource for which the policy detail is being requested. `resource` is usually specified as a path, such as `projects/*project*/zones/*zone*/disks/*disk*`. The format for the path specified in this value is resource specific and is specified in the `testIamPermissions` documentation.",
+                                    "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/[^/]*/subscriptions/[^/]*$",
                                     "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"
                             ]
                         },
                         "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.",
+                            "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",
                             "parameterOrder": [
                                 "name"
                             ],
                             "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\"`.",
                                     "location": "path",
                                     "pattern": "^projects/[^/]*/subscriptions/[^/]*$",
@@ skipping 68 matching lines @@
                             "path": "v1/{+project}/subscriptions",
                             "response": {
                                 "$ref": "ListSubscriptionsResponse"
                             },
                             "scopes": [
                                 "https://www.googleapis.com/auth/cloud-platform",
                                 "https://www.googleapis.com/auth/pubsub"
                             ]
                         },
                         "delete": {
-                            "description": "Deletes an existing subscription. All pending messages 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.",
+                            "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",
                             "parameterOrder": [
                                 "subscription"
                             ],
                             "parameters": {
                                 "subscription": {
                                     "description": "The subscription to delete.",
                                     "location": "path",
                                     "pattern": "^projects/[^/]*/subscriptions/[^/]*$",
                                     "required": true,
                                     "type": "string"
                                 }
                             },
                             "path": "v1/{+subscription}",
                             "response": {
                                 "$ref": "Empty"
                             },
                             "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.",
+                            "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",
                             "parameterOrder": [
                                 "subscription"
                             ],
                             "parameters": {
                                 "subscription": {
                                     "description": "The name of the subscription.",
                                     "location": "path",
                                     "pattern": "^projects/[^/]*/subscriptions/[^/]*$",
@@ skipping 91 matching lines @@
                             },
                             "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",
+                            "request": {
+                                "$ref": "SetIamPolicyRequest"
+                            },
+                            "response": {
+                                "$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. Returns an empty policy if the resource exists and does not have a policy set.",
+                            "httpMethod": "GET",
+                            "id": "pubsub.projects.snapshots.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}`.",
+                                    "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"
+                            ]
+                        },
+                        "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": "20160317",
+    "revision": "20161003",
     "rootUrl": "https://pubsub.googleapis.com/",
     "schemas": {
         "SetIamPolicyRequest": {
             "description": "Request message for `SetIamPolicy` method.",
             "id": "SetIamPolicyRequest",
             "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."
                 }
@@ skipping 40 matching lines @@
                     "type": "array"
                 }
             },
             "type": "object"
         },
         "TestIamPermissionsRequest": {
             "description": "Request message for `TestIamPermissions` method.",
             "id": "TestIamPermissionsRequest",
             "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.",
+                    "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).",
                     "items": {
                         "type": "string"
                     },
                     "type": "array"
                 }
             },
             "type": "object"
         },
         "TestIamPermissionsResponse": {
             "description": "Response message for `TestIamPermissions` method.",
@@ skipping 32 matching lines @@
                     "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.",
+                    "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"
                 },
@@ skipping 73 matching lines @@
                 },
                 "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.",
                     "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. 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 not set, the default value of 10 seconds is used.",
+                    "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.",
                     "format": "int32",
                     "type": "integer"
                 }
             },
             "type": "object"
         },
         "PushConfig": {
             "description": "Configuration for a push delivery endpoint.",
             "id": "PushConfig",
             "properties": {
@@ skipping 116 matching lines @@
                     "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."
                 }
             },
             "type": "object"
         }
     },
     "servicePath": "",
     "title": "Google Cloud Pub/Sub API",
     "version": "v1"
 }