Index: discovery/googleapis/pubsub__v1.json |
diff --git a/discovery/googleapis/pubsub__v1.json b/discovery/googleapis/pubsub__v1.json |
index 3242eab9df962df6473f5471f75ce3cfd558f440..f83fda25a555c7974358f63f9ba1a1a343a47340 100644 |
--- a/discovery/googleapis/pubsub__v1.json |
+++ b/discovery/googleapis/pubsub__v1.json |
@@ -27,35 +27,31 @@ |
"ownerDomain": "google.com", |
"ownerName": "Google", |
"parameters": { |
- "access_token": { |
- "description": "OAuth access token.", |
+ "fields": { |
+ "description": "Selector specifying which fields to include in a partial response.", |
"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.", |
+ "uploadType": { |
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", |
"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.", |
+ "$.xgafv": { |
+ "description": "V1 error format.", |
+ "enum": [ |
+ "1", |
+ "2" |
+ ], |
+ "enumDescriptions": [ |
+ "v1 error format", |
+ "v2 error format" |
+ ], |
"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.", |
+ "callback": { |
+ "description": "JSONP", |
"location": "query", |
"type": "string" |
}, |
@@ -75,31 +71,29 @@ |
"location": "query", |
"type": "string" |
}, |
- "$.xgafv": { |
- "description": "V1 error format.", |
- "enum": [ |
- "1", |
- "2" |
- ], |
- "enumDescriptions": [ |
- "v1 error format", |
- "v2 error format" |
- ], |
+ "access_token": { |
+ "description": "OAuth access token.", |
"location": "query", |
"type": "string" |
}, |
- "callback": { |
- "description": "JSONP", |
+ "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.", |
+ "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" |
}, |
- "uploadType": { |
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", |
+ "pp": { |
+ "default": "true", |
+ "description": "Pretty-print response.", |
+ "location": "query", |
+ "type": "boolean" |
+ }, |
+ "oauth_token": { |
+ "description": "OAuth 2.0 token for the current user.", |
"location": "query", |
"type": "string" |
}, |
@@ -112,6 +106,12 @@ |
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", |
"location": "query", |
"type": "string" |
+ }, |
+ "prettyPrint": { |
+ "default": "true", |
+ "description": "Returns response with indentations and line breaks.", |
+ "location": "query", |
+ "type": "boolean" |
} |
}, |
"protocol": "rest", |
@@ -120,25 +120,25 @@ |
"resources": { |
"subscriptions": { |
"methods": { |
- "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`.", |
+ "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.modifyPushConfig", |
+ "id": "pubsub.projects.subscriptions.acknowledge", |
"parameterOrder": [ |
"subscription" |
], |
"parameters": { |
"subscription": { |
- "description": "The name of the subscription.\nFormat is `projects/{project}/subscriptions/{sub}`.", |
+ "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/{+subscription}:modifyPushConfig", |
+ "path": "v1/{+subscription}:acknowledge", |
"request": { |
- "$ref": "ModifyPushConfigRequest" |
+ "$ref": "AcknowledgeRequest" |
}, |
"response": { |
"$ref": "Empty" |
@@ -148,89 +148,53 @@ |
"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", |
- "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.", |
+ "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.subscriptions.pull", |
+ "id": "pubsub.projects.subscriptions.modifyAckDeadline", |
"parameterOrder": [ |
"subscription" |
], |
"parameters": { |
"subscription": { |
- "description": "The subscription from which messages should be pulled.\nFormat is `projects/{project}/subscriptions/{sub}`.", |
+ "description": "The name of the subscription.\nFormat is `projects/{project}/subscriptions/{sub}`.", |
"location": "path", |
"pattern": "^projects/[^/]+/subscriptions/[^/]+$", |
"required": true, |
"type": "string" |
} |
}, |
- "path": "v1/{+subscription}:pull", |
+ "path": "v1/{+subscription}:modifyAckDeadline", |
"request": { |
- "$ref": "PullRequest" |
+ "$ref": "ModifyAckDeadlineRequest" |
}, |
"response": { |
- "$ref": "PullResponse" |
+ "$ref": "Empty" |
}, |
"scopes": [ |
"https://www.googleapis.com/auth/cloud-platform", |
"https://www.googleapis.com/auth/pubsub" |
] |
}, |
- "list": { |
- "description": "Lists matching subscriptions.", |
+ "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.list", |
+ "id": "pubsub.projects.subscriptions.getIamPolicy", |
"parameterOrder": [ |
- "project" |
+ "resource" |
], |
"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}`.", |
+ "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/[^/]+$", |
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$", |
"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", |
+ "path": "v1/{+resource}:getIamPolicy", |
"response": { |
- "$ref": "ListSubscriptionsResponse" |
+ "$ref": "Policy" |
}, |
"scopes": [ |
"https://www.googleapis.com/auth/cloud-platform", |
@@ -262,38 +226,38 @@ |
"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", |
+ "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": [ |
- "name" |
+ "resource" |
], |
"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\"`.", |
+ "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/[^/]+$", |
"required": true, |
"type": "string" |
} |
}, |
- "path": "v1/{+name}", |
+ "path": "v1/{+resource}:testIamPermissions", |
"request": { |
- "$ref": "Subscription" |
+ "$ref": "TestIamPermissionsRequest" |
}, |
"response": { |
- "$ref": "Subscription" |
+ "$ref": "TestIamPermissionsResponse" |
}, |
"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\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.", |
+ "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.subscriptions.modifyAckDeadline", |
+ "id": "pubsub.projects.subscriptions.modifyPushConfig", |
"parameterOrder": [ |
"subscription" |
], |
@@ -306,9 +270,9 @@ |
"type": "string" |
} |
}, |
- "path": "v1/{+subscription}:modifyAckDeadline", |
+ "path": "v1/{+subscription}:modifyPushConfig", |
"request": { |
- "$ref": "ModifyAckDeadlineRequest" |
+ "$ref": "ModifyPushConfigRequest" |
}, |
"response": { |
"$ref": "Empty" |
@@ -318,34 +282,6 @@ |
"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", |
- "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}`.", |
- "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" |
- ] |
- }, |
"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", |
@@ -371,56 +307,120 @@ |
"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.", |
+ "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.testIamPermissions", |
+ "id": "pubsub.projects.subscriptions.pull", |
"parameterOrder": [ |
- "resource" |
+ "subscription" |
], |
"parameters": { |
- "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}`.", |
+ "subscription": { |
+ "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/{+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" |
] |
}, |
- "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", |
+ "list": { |
+ "description": "Lists matching subscriptions.", |
+ "httpMethod": "GET", |
+ "id": "pubsub.projects.subscriptions.list", |
"parameterOrder": [ |
- "subscription" |
+ "project" |
], |
"parameters": { |
- "subscription": { |
- "description": "The subscription whose message is being acknowledged.\nFormat is `projects/{project}/subscriptions/{sub}`.", |
+ "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" |
+ }, |
+ "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/[^/]+/subscriptions/[^/]+$", |
+ "pattern": "^projects/[^/]+$", |
"required": true, |
"type": "string" |
} |
}, |
- "path": "v1/{+subscription}:acknowledge", |
+ "path": "v1/{+project}/subscriptions", |
+ "response": { |
+ "$ref": "ListSubscriptionsResponse" |
+ }, |
+ "scopes": [ |
+ "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": "AcknowledgeRequest" |
+ "$ref": "Subscription" |
}, |
"response": { |
- "$ref": "Empty" |
+ "$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", |
+ "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}`.", |
+ "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", |
@@ -429,25 +429,28 @@ |
} |
} |
}, |
- "topics": { |
+ "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.topics.getIamPolicy", |
+ "setIamPolicy": { |
+ "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.", |
+ "httpMethod": "POST", |
+ "id": "pubsub.projects.snapshots.setIamPolicy", |
"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}`.", |
+ "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/[^/]+/snapshots/[^/]+$", |
"required": true, |
"type": "string" |
} |
}, |
- "path": "v1/{+resource}:getIamPolicy", |
+ "path": "v1/{+resource}:setIamPolicy", |
+ "request": { |
+ "$ref": "SetIamPolicyRequest" |
+ }, |
"response": { |
"$ref": "Policy" |
}, |
@@ -456,70 +459,63 @@ |
"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.", |
+ "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.topics.publish", |
+ "id": "pubsub.projects.snapshots.testIamPermissions", |
"parameterOrder": [ |
- "topic" |
+ "resource" |
], |
"parameters": { |
- "topic": { |
- "description": "The messages in the request will be published on this topic.\nFormat is `projects/{project}/topics/{topic}`.", |
+ "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/[^/]+/snapshots/[^/]+$", |
"required": true, |
"type": "string" |
} |
}, |
- "path": "v1/{+topic}:publish", |
+ "path": "v1/{+resource}:testIamPermissions", |
"request": { |
- "$ref": "PublishRequest" |
+ "$ref": "TestIamPermissionsRequest" |
}, |
"response": { |
- "$ref": "PublishResponse" |
+ "$ref": "TestIamPermissionsResponse" |
}, |
"scopes": [ |
"https://www.googleapis.com/auth/cloud-platform", |
"https://www.googleapis.com/auth/pubsub" |
] |
}, |
- "list": { |
- "description": "Lists matching topics.", |
+ "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.topics.list", |
+ "id": "pubsub.projects.snapshots.getIamPolicy", |
"parameterOrder": [ |
- "project" |
+ "resource" |
], |
"parameters": { |
- "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}`.", |
+ "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/[^/]+$", |
+ "pattern": "^projects/[^/]+/snapshots/[^/]+$", |
"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", |
+ "path": "v1/{+resource}:getIamPolicy", |
"response": { |
- "$ref": "ListTopicsResponse" |
+ "$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", |
@@ -545,56 +541,56 @@ |
"https://www.googleapis.com/auth/pubsub" |
] |
}, |
- "create": { |
- "description": "Creates the given topic with the given name.", |
- "httpMethod": "PUT", |
- "id": "pubsub.projects.topics.create", |
+ "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": [ |
- "name" |
+ "topic" |
], |
"parameters": { |
- "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\"`.", |
+ "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/{+name}", |
+ "path": "v1/{+topic}:publish", |
"request": { |
- "$ref": "Topic" |
+ "$ref": "PublishRequest" |
}, |
"response": { |
- "$ref": "Topic" |
+ "$ref": "PublishResponse" |
}, |
"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.", |
+ "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.topics.setIamPolicy", |
+ "id": "pubsub.projects.topics.testIamPermissions", |
"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 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/[^/]+$", |
"required": true, |
"type": "string" |
} |
}, |
- "path": "v1/{+resource}:setIamPolicy", |
+ "path": "v1/{+resource}:testIamPermissions", |
"request": { |
- "$ref": "SetIamPolicyRequest" |
+ "$ref": "TestIamPermissionsRequest" |
}, |
"response": { |
- "$ref": "Policy" |
+ "$ref": "TestIamPermissionsResponse" |
}, |
"scopes": [ |
"https://www.googleapis.com/auth/cloud-platform", |
@@ -626,46 +622,141 @@ |
"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.", |
+ "list": { |
+ "description": "Lists matching topics.", |
+ "httpMethod": "GET", |
+ "id": "pubsub.projects.topics.list", |
+ "parameterOrder": [ |
+ "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", |
+ "location": "query", |
+ "type": "integer" |
+ }, |
+ "project": { |
+ "description": "The name of the cloud project that topics belong to.\nFormat is `projects/{project}`.", |
+ "location": "path", |
+ "pattern": "^projects/[^/]+$", |
+ "required": true, |
+ "type": "string" |
+ } |
+ }, |
+ "path": "v1/{+project}/topics", |
+ "response": { |
+ "$ref": "ListTopicsResponse" |
+ }, |
+ "scopes": [ |
+ "https://www.googleapis.com/auth/cloud-platform", |
+ "https://www.googleapis.com/auth/pubsub" |
+ ] |
+ }, |
+ "create": { |
+ "description": "Creates the given topic with the given name.", |
+ "httpMethod": "PUT", |
+ "id": "pubsub.projects.topics.create", |
+ "parameterOrder": [ |
+ "name" |
+ ], |
+ "parameters": { |
+ "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/[^/]+/topics/[^/]+$", |
+ "required": true, |
+ "type": "string" |
+ } |
+ }, |
+ "path": "v1/{+name}", |
+ "request": { |
+ "$ref": "Topic" |
+ }, |
+ "response": { |
+ "$ref": "Topic" |
+ }, |
+ "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.topics.testIamPermissions", |
+ "id": "pubsub.projects.topics.setIamPolicy", |
"parameterOrder": [ |
"resource" |
], |
"parameters": { |
"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}`.", |
+ "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/[^/]+$", |
"required": true, |
"type": "string" |
} |
}, |
- "path": "v1/{+resource}:testIamPermissions", |
+ "path": "v1/{+resource}:setIamPolicy", |
"request": { |
- "$ref": "TestIamPermissionsRequest" |
+ "$ref": "SetIamPolicyRequest" |
}, |
"response": { |
- "$ref": "TestIamPermissionsResponse" |
+ "$ref": "Policy" |
}, |
"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" |
- ], |
+ }, |
+ "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.topics.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/[^/]+/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" |
+ ] |
+ } |
+ }, |
+ "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": { |
+ "pageSize": { |
+ "description": "Maximum number of subscription names to return.", |
+ "format": "int32", |
+ "location": "query", |
+ "type": "integer" |
+ }, |
"topic": { |
"description": "The name of the topic that subscriptions are attached to.\nFormat is `projects/{project}/topics/{topic}`.", |
"location": "path", |
@@ -673,12 +764,6 @@ |
"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", |
@@ -697,131 +782,43 @@ |
} |
} |
} |
- }, |
- "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.snapshots.testIamPermissions", |
- "parameterOrder": [ |
- "resource" |
- ], |
- "parameters": { |
- "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/[^/]+/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" |
- ] |
- }, |
- "setIamPolicy": { |
- "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.", |
- "httpMethod": "POST", |
- "id": "pubsub.projects.snapshots.setIamPolicy", |
- "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}`.", |
- "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.\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" |
- ] |
- } |
- } |
} |
} |
} |
}, |
- "revision": "20170105", |
+ "revision": "20170124", |
"rootUrl": "https://pubsub.googleapis.com/", |
"schemas": { |
- "Topic": { |
- "description": "A topic resource.", |
- "id": "Topic", |
- "properties": { |
- "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" |
- }, |
- "SetIamPolicyRequest": { |
- "description": "Request message for `SetIamPolicy` method.", |
- "id": "SetIamPolicyRequest", |
+ "PullRequest": { |
+ "description": "Request for the `Pull` method.", |
+ "id": "PullRequest", |
"properties": { |
- "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." |
+ "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" |
} |
}, |
"type": "object" |
}, |
- "ReceivedMessage": { |
- "description": "A message and its corresponding acknowledgment ID.", |
- "id": "ReceivedMessage", |
+ "ListSubscriptionsResponse": { |
+ "description": "Response for the `ListSubscriptions` method.", |
+ "id": "ListSubscriptionsResponse", |
"properties": { |
- "ackId": { |
- "description": "This ID can be used to acknowledge the received message.", |
+ "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" |
}, |
- "message": { |
- "$ref": "PubsubMessage", |
- "description": "The message." |
+ "subscriptions": { |
+ "description": "The subscriptions that match the request.", |
+ "items": { |
+ "$ref": "Subscription" |
+ }, |
+ "type": "array" |
} |
}, |
"type": "object" |
@@ -840,20 +837,6 @@ |
}, |
"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" |
- }, |
"PublishResponse": { |
"description": "Response for the `Publish` method.", |
"id": "PublishResponse", |
@@ -868,153 +851,105 @@ |
}, |
"type": "object" |
}, |
- "ListSubscriptionsResponse": { |
- "description": "Response for the `ListSubscriptions` method.", |
- "id": "ListSubscriptionsResponse", |
+ "Subscription": { |
+ "description": "A subscription resource.", |
+ "id": "Subscription", |
"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\nthe request; this value should be passed in a new\n`ListSubscriptionsRequest` to get more subscriptions.", |
+ "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" |
- } |
- }, |
- "type": "object" |
- }, |
- "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": { |
- "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": "Binding" |
- }, |
- "type": "array" |
}, |
- "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" |
+ "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." |
}, |
- "version": { |
- "description": "Version of the `Policy`. The default version is 0.", |
+ "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", |
"type": "integer" |
+ }, |
+ "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" |
} |
}, |
"type": "object" |
}, |
- "ListTopicSubscriptionsResponse": { |
- "description": "Response for the `ListTopicSubscriptions` method.", |
- "id": "ListTopicSubscriptionsResponse", |
+ "TestIamPermissionsRequest": { |
+ "description": "Request message for `TestIamPermissions` method.", |
+ "id": "TestIamPermissionsRequest", |
"properties": { |
- "subscriptions": { |
- "description": "The names of the subscriptions that match the request.", |
+ "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" |
}, |
"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`ListTopicSubscriptionsRequest` to get more subscriptions.", |
- "type": "string" |
} |
}, |
"type": "object" |
}, |
- "Subscription": { |
- "description": "A subscription resource.", |
- "id": "Subscription", |
+ "Topic": { |
+ "description": "A topic resource.", |
+ "id": "Topic", |
"properties": { |
- "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.\nFormat is `projects/{project}/topics/{topic}`.\nThe value of this field will be `_deleted-topic_` if the topic has been\ndeleted.", |
- "type": "string" |
- }, |
- "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", |
- "type": "integer" |
- }, |
"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\"`.", |
+ "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" |
}, |
- "ModifyAckDeadlineRequest": { |
- "description": "Request for the ModifyAckDeadline method.", |
- "id": "ModifyAckDeadlineRequest", |
+ "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": { |
- "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).", |
+ "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" |
}, |
- "ackIds": { |
- "description": "List of acknowledgment IDs.", |
+ "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": { |
- "type": "string" |
+ "$ref": "Binding" |
}, |
"type": "array" |
} |
}, |
"type": "object" |
}, |
- "TestIamPermissionsRequest": { |
- "description": "Request message for `TestIamPermissions` method.", |
- "id": "TestIamPermissionsRequest", |
+ "ModifyAckDeadlineRequest": { |
+ "description": "Request for the ModifyAckDeadline method.", |
+ "id": "ModifyAckDeadlineRequest", |
"properties": { |
- "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).", |
+ "ackIds": { |
+ "description": "List of acknowledgment IDs.", |
"items": { |
"type": "string" |
}, |
"type": "array" |
- } |
- }, |
- "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" |
+ "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" |
} |
}, |
"type": "object" |
}, |
- "PullRequest": { |
- "description": "Request for the `Pull` method.", |
- "id": "PullRequest", |
+ "SetIamPolicyRequest": { |
+ "description": "Request message for `SetIamPolicy` method.", |
+ "id": "SetIamPolicyRequest", |
"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" |
+ "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" |
@@ -1030,29 +965,10 @@ |
}, |
"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\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" |
- }, |
- "type": "array" |
- } |
- }, |
- "type": "object" |
- }, |
"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": { |
- "data": { |
- "description": "The message payload.", |
- "format": "byte", |
- "type": "string" |
- }, |
"attributes": { |
"additionalProperties": { |
"type": "string" |
@@ -1068,6 +984,47 @@ |
"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" |
+ }, |
+ "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" |
+ }, |
+ "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" |
@@ -1092,38 +1049,81 @@ |
"properties": {}, |
"type": "object" |
}, |
- "ListTopicsResponse": { |
- "description": "Response for the `ListTopics` method.", |
- "id": "ListTopicsResponse", |
+ "ListTopicSubscriptionsResponse": { |
+ "description": "Response for the `ListTopicSubscriptions` method.", |
+ "id": "ListTopicSubscriptionsResponse", |
"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`.", |
+ "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" |
}, |
- "topics": { |
- "description": "The resulting topics.", |
+ "subscriptions": { |
+ "description": "The names of the subscriptions that match the request.", |
"items": { |
- "$ref": "Topic" |
+ "type": "string" |
}, |
"type": "array" |
} |
}, |
"type": "object" |
}, |
- "Binding": { |
- "description": "Associates `members` with a `role`.", |
- "id": "Binding", |
+ "PullResponse": { |
+ "description": "Response for the `Pull` method.", |
+ "id": "PullResponse", |
"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", |
+ "receivedMessages": { |
+ "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": { |
- "type": "string" |
+ "$ref": "ReceivedMessage" |
}, |
"type": "array" |
+ } |
+ }, |
+ "type": "object" |
+ }, |
+ "ReceivedMessage": { |
+ "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" |
}, |
- "role": { |
- "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired", |
+ "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" |
} |
}, |
"type": "object" |