Index: discovery/googleapis/pubsub__v1.json |
diff --git a/discovery/googleapis/pubsub__v1.json b/discovery/googleapis/pubsub__v1.json |
index 6d1f57400d2cc0ee310be4163f3f66f7c7b7318d..bf979dfc638c23bba1a518b495c99f976fb9e7c0 100644 |
--- a/discovery/googleapis/pubsub__v1.json |
+++ b/discovery/googleapis/pubsub__v1.json |
@@ -28,37 +28,8 @@ |
"ownerDomain": "google.com", |
"ownerName": "Google", |
"parameters": { |
- "$.xgafv": { |
- "description": "V1 error format.", |
- "enum": [ |
- "1", |
- "2" |
- ], |
- "enumDescriptions": [ |
- "v1 error format", |
- "v2 error format" |
- ], |
- "location": "query", |
- "type": "string" |
- }, |
- "callback": { |
- "description": "JSONP", |
- "location": "query", |
- "type": "string" |
- }, |
- "alt": { |
- "default": "json", |
- "description": "Data format for response.", |
- "enum": [ |
- "json", |
- "media", |
- "proto" |
- ], |
- "enumDescriptions": [ |
- "Responses with Content-Type of application/json", |
- "Media download with context-dependent Content-Type", |
- "Responses with Content-Type of application/x-protobuf" |
- ], |
+ "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" |
}, |
@@ -67,11 +38,6 @@ |
"location": "query", |
"type": "string" |
}, |
- "key": { |
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", |
- "location": "query", |
- "type": "string" |
- }, |
"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", |
@@ -113,6 +79,40 @@ |
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", |
"location": "query", |
"type": "string" |
+ }, |
+ "$.xgafv": { |
+ "description": "V1 error format.", |
+ "enum": [ |
+ "1", |
+ "2" |
+ ], |
+ "enumDescriptions": [ |
+ "v1 error format", |
+ "v2 error format" |
+ ], |
+ "location": "query", |
+ "type": "string" |
+ }, |
+ "callback": { |
+ "description": "JSONP", |
+ "location": "query", |
+ "type": "string" |
+ }, |
+ "alt": { |
+ "default": "json", |
+ "description": "Data format for response.", |
+ "enum": [ |
+ "json", |
+ "media", |
+ "proto" |
+ ], |
+ "enumDescriptions": [ |
+ "Responses with Content-Type of application/json", |
+ "Media download with context-dependent Content-Type", |
+ "Responses with Content-Type of application/x-protobuf" |
+ ], |
+ "location": "query", |
+ "type": "string" |
} |
}, |
"protocol": "rest", |
@@ -121,6 +121,123 @@ |
"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`.", |
+ "httpMethod": "POST", |
+ "id": "pubsub.projects.subscriptions.modifyPushConfig", |
+ "parameterOrder": [ |
+ "subscription" |
+ ], |
+ "parameters": { |
+ "subscription": { |
+ "description": "The name of the subscription.\nFormat is `projects/{project}/subscriptions/{sub}`.", |
+ "location": "path", |
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$", |
+ "required": true, |
+ "type": "string" |
+ } |
+ }, |
+ "path": "v1/{+subscription}:modifyPushConfig", |
+ "request": { |
+ "$ref": "ModifyPushConfigRequest" |
+ }, |
+ "response": { |
+ "$ref": "Empty" |
+ }, |
+ "scopes": [ |
+ "https://www.googleapis.com/auth/cloud-platform", |
+ "https://www.googleapis.com/auth/pubsub" |
+ ] |
+ }, |
+ "pull": { |
+ "description": "Pulls messages from the server. Returns an empty list if there are no\nmessages available in the backlog. The server may return `UNAVAILABLE` if\nthere are too many concurrent pull requests pending for the given\nsubscription.", |
+ "httpMethod": "POST", |
+ "id": "pubsub.projects.subscriptions.pull", |
+ "parameterOrder": [ |
+ "subscription" |
+ ], |
+ "parameters": { |
+ "subscription": { |
+ "description": "The subscription from which messages should be pulled.\nFormat is `projects/{project}/subscriptions/{sub}`.", |
+ "location": "path", |
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$", |
+ "required": true, |
+ "type": "string" |
+ } |
+ }, |
+ "path": "v1/{+subscription}:pull", |
+ "request": { |
+ "$ref": "PullRequest" |
+ }, |
+ "response": { |
+ "$ref": "PullResponse" |
+ }, |
+ "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", |
+ "id": "pubsub.projects.subscriptions.delete", |
+ "parameterOrder": [ |
+ "subscription" |
+ ], |
+ "parameters": { |
+ "subscription": { |
+ "description": "The subscription to delete.\nFormat is `projects/{project}/subscriptions/{sub}`.", |
+ "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" |
+ ] |
+ }, |
+ "list": { |
+ "description": "Lists matching subscriptions.", |
+ "httpMethod": "GET", |
+ "id": "pubsub.projects.subscriptions.list", |
+ "parameterOrder": [ |
+ "project" |
+ ], |
+ "parameters": { |
+ "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/[^/]+$", |
+ "required": true, |
+ "type": "string" |
+ } |
+ }, |
+ "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", |
@@ -158,7 +275,7 @@ |
], |
"parameters": { |
"resource": { |
- "description": "REQUIRED: The resource for which the policy is being specified.\n`resource` is usually specified as a path. For example, a Project\nresource is specified as `projects/{project}`.", |
+ "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.", |
"location": "path", |
"pattern": "^projects/[^/]+/subscriptions/[^/]+$", |
"required": true, |
@@ -186,7 +303,7 @@ |
], |
"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 requested.\nSee the operation documentation for the appropriate value for this field.", |
"location": "path", |
"pattern": "^projects/[^/]+/subscriptions/[^/]+$", |
"required": true, |
@@ -292,7 +409,7 @@ |
], |
"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 detail is being requested.\nSee the operation documentation for the appropriate value for this field.", |
"location": "path", |
"pattern": "^projects/[^/]+/subscriptions/[^/]+$", |
"required": true, |
@@ -310,118 +427,86 @@ |
"https://www.googleapis.com/auth/cloud-platform", |
"https://www.googleapis.com/auth/pubsub" |
] |
- }, |
- "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.modifyPushConfig", |
+ } |
+ } |
+ }, |
+ "snapshots": { |
+ "methods": { |
+ "getIamPolicy": { |
+ "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.", |
+ "httpMethod": "GET", |
+ "id": "pubsub.projects.snapshots.getIamPolicy", |
"parameterOrder": [ |
- "subscription" |
+ "resource" |
], |
"parameters": { |
- "subscription": { |
- "description": "The name of the subscription.\nFormat is `projects/{project}/subscriptions/{sub}`.", |
+ "resource": { |
+ "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.", |
"location": "path", |
- "pattern": "^projects/[^/]+/subscriptions/[^/]+$", |
+ "pattern": "^projects/[^/]+/snapshots/[^/]+$", |
"required": true, |
"type": "string" |
} |
}, |
- "path": "v1/{+subscription}:modifyPushConfig", |
- "request": { |
- "$ref": "ModifyPushConfigRequest" |
- }, |
+ "path": "v1/{+resource}:getIamPolicy", |
"response": { |
- "$ref": "Empty" |
+ "$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.", |
+ "setIamPolicy": { |
+ "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.", |
"httpMethod": "POST", |
- "id": "pubsub.projects.subscriptions.pull", |
+ "id": "pubsub.projects.snapshots.setIamPolicy", |
"parameterOrder": [ |
- "subscription" |
+ "resource" |
], |
"parameters": { |
- "subscription": { |
- "description": "The subscription from which messages should be pulled.\nFormat is `projects/{project}/subscriptions/{sub}`.", |
+ "resource": { |
+ "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.", |
"location": "path", |
- "pattern": "^projects/[^/]+/subscriptions/[^/]+$", |
+ "pattern": "^projects/[^/]+/snapshots/[^/]+$", |
"required": true, |
"type": "string" |
} |
}, |
- "path": "v1/{+subscription}:pull", |
+ "path": "v1/{+resource}:setIamPolicy", |
"request": { |
- "$ref": "PullRequest" |
+ "$ref": "SetIamPolicyRequest" |
}, |
"response": { |
- "$ref": "PullResponse" |
+ "$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", |
- "id": "pubsub.projects.subscriptions.delete", |
+ "testIamPermissions": { |
+ "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.", |
+ "httpMethod": "POST", |
+ "id": "pubsub.projects.snapshots.testIamPermissions", |
"parameterOrder": [ |
- "subscription" |
+ "resource" |
], |
"parameters": { |
- "subscription": { |
- "description": "The subscription to delete.\nFormat is `projects/{project}/subscriptions/{sub}`.", |
+ "resource": { |
+ "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.", |
"location": "path", |
- "pattern": "^projects/[^/]+/subscriptions/[^/]+$", |
+ "pattern": "^projects/[^/]+/snapshots/[^/]+$", |
"required": true, |
"type": "string" |
} |
}, |
- "path": "v1/{+subscription}", |
+ "path": "v1/{+resource}:testIamPermissions", |
+ "request": { |
+ "$ref": "TestIamPermissionsRequest" |
+ }, |
"response": { |
- "$ref": "Empty" |
- }, |
- "scopes": [ |
- "https://www.googleapis.com/auth/cloud-platform", |
- "https://www.googleapis.com/auth/pubsub" |
- ] |
- }, |
- "list": { |
- "description": "Lists matching subscriptions.", |
- "httpMethod": "GET", |
- "id": "pubsub.projects.subscriptions.list", |
- "parameterOrder": [ |
- "project" |
- ], |
- "parameters": { |
- "project": { |
- "description": "The name of the cloud project that subscriptions belong to.\nFormat is `projects/{project}`.", |
- "location": "path", |
- "pattern": "^projects/[^/]+$", |
- "required": true, |
- "type": "string" |
- }, |
- "pageToken": { |
- "description": "The value returned by the last `ListSubscriptionsResponse`; indicates that\nthis is a continuation of a prior `ListSubscriptions` call, and that the\nsystem should return the next page of data.", |
- "location": "query", |
- "type": "string" |
- }, |
- "pageSize": { |
- "description": "Maximum number of subscriptions to return.", |
- "format": "int32", |
- "location": "query", |
- "type": "integer" |
- } |
- }, |
- "path": "v1/{+project}/subscriptions", |
- "response": { |
- "$ref": "ListSubscriptionsResponse" |
+ "$ref": "TestIamPermissionsResponse" |
}, |
"scopes": [ |
"https://www.googleapis.com/auth/cloud-platform", |
@@ -430,55 +515,30 @@ |
} |
} |
}, |
- "snapshots": { |
+ "topics": { |
"methods": { |
- "getIamPolicy": { |
- "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.", |
- "httpMethod": "GET", |
- "id": "pubsub.projects.snapshots.getIamPolicy", |
- "parameterOrder": [ |
- "resource" |
- ], |
- "parameters": { |
- "resource": { |
- "description": "REQUIRED: The resource for which the policy is being 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" |
- ] |
- }, |
- "setIamPolicy": { |
- "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.", |
+ "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.snapshots.setIamPolicy", |
+ "id": "pubsub.projects.topics.publish", |
"parameterOrder": [ |
- "resource" |
+ "topic" |
], |
"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}`.", |
+ "topic": { |
+ "description": "The messages in the request will be published on this topic.\nFormat is `projects/{project}/topics/{topic}`.", |
"location": "path", |
- "pattern": "^projects/[^/]+/snapshots/[^/]+$", |
+ "pattern": "^projects/[^/]+/topics/[^/]+$", |
"required": true, |
"type": "string" |
} |
}, |
- "path": "v1/{+resource}:setIamPolicy", |
+ "path": "v1/{+topic}:publish", |
"request": { |
- "$ref": "SetIamPolicyRequest" |
+ "$ref": "PublishRequest" |
}, |
"response": { |
- "$ref": "Policy" |
+ "$ref": "PublishResponse" |
}, |
"scopes": [ |
"https://www.googleapis.com/auth/cloud-platform", |
@@ -488,45 +548,13 @@ |
"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.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.", |
"httpMethod": "POST", |
- "id": "pubsub.projects.snapshots.testIamPermissions", |
- "parameterOrder": [ |
- "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" |
- ] |
- } |
- } |
- }, |
- "topics": { |
- "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.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.", |
- "httpMethod": "POST", |
"id": "pubsub.projects.topics.testIamPermissions", |
"parameterOrder": [ |
"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 detail is being requested.\nSee the operation documentation for the appropriate value for this field.", |
"location": "path", |
"pattern": "^projects/[^/]+/topics/[^/]+$", |
"required": true, |
@@ -578,6 +606,11 @@ |
"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", |
@@ -590,11 +623,6 @@ |
"pattern": "^projects/[^/]+$", |
"required": true, |
"type": "string" |
- }, |
- "pageToken": { |
- "description": "The value returned by the last `ListTopicsResponse`; indicates that this is\na continuation of a prior `ListTopics` call, and that the system should\nreturn the next page of data.", |
- "location": "query", |
- "type": "string" |
} |
}, |
"path": "v1/{+project}/topics", |
@@ -643,7 +671,7 @@ |
], |
"parameters": { |
"resource": { |
- "description": "REQUIRED: The resource for which the policy is being specified.\n`resource` is usually specified as a path. For example, a Project\nresource is specified as `projects/{project}`.", |
+ "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.", |
"location": "path", |
"pattern": "^projects/[^/]+/topics/[^/]+$", |
"required": true, |
@@ -671,7 +699,7 @@ |
], |
"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 requested.\nSee the operation documentation for the appropriate value for this field.", |
"location": "path", |
"pattern": "^projects/[^/]+/topics/[^/]+$", |
"required": true, |
@@ -711,34 +739,6 @@ |
"https://www.googleapis.com/auth/cloud-platform", |
"https://www.googleapis.com/auth/pubsub" |
] |
- }, |
- "publish": { |
- "description": "Adds one or more messages to the topic. Returns `NOT_FOUND` if the topic\ndoes not exist. The message payload must not be empty; it must contain\n either a non-empty data field, or at least one attribute.", |
- "httpMethod": "POST", |
- "id": "pubsub.projects.topics.publish", |
- "parameterOrder": [ |
- "topic" |
- ], |
- "parameters": { |
- "topic": { |
- "description": "The messages in the request will be published on this topic.\nFormat is `projects/{project}/topics/{topic}`.", |
- "location": "path", |
- "pattern": "^projects/[^/]+/topics/[^/]+$", |
- "required": true, |
- "type": "string" |
- } |
- }, |
- "path": "v1/{+topic}:publish", |
- "request": { |
- "$ref": "PublishRequest" |
- }, |
- "response": { |
- "$ref": "PublishResponse" |
- }, |
- "scopes": [ |
- "https://www.googleapis.com/auth/cloud-platform", |
- "https://www.googleapis.com/auth/pubsub" |
- ] |
} |
}, |
"resources": { |
@@ -787,107 +787,17 @@ |
} |
} |
}, |
- "revision": "20170214", |
+ "revision": "20170308", |
"rootUrl": "https://pubsub.googleapis.com/", |
"schemas": { |
- "PushConfig": { |
- "description": "Configuration for a push delivery endpoint.", |
- "id": "PushConfig", |
- "properties": { |
- "pushEndpoint": { |
- "description": "A URL locating the endpoint to which messages should be pushed.\nFor example, a Webhook endpoint might use \"https://example.com/push\".", |
- "type": "string" |
- }, |
- "attributes": { |
- "additionalProperties": { |
- "type": "string" |
- }, |
- "description": "Endpoint configuration attributes.\n\nEvery endpoint has a set of API supported attributes that can be used to\ncontrol different aspects of the message delivery.\n\nThe currently supported attribute is `x-goog-version`, which you can\nuse to change the format of the push message. This attribute\nindicates the version of the data expected by the endpoint. This\ncontrols the shape of the envelope (i.e. its fields and metadata).\nThe endpoint version is based on the version of the Pub/Sub\nAPI.\n\nIf not present during the `CreateSubscription` call, it will default to\nthe version of the API used to make such call. If not present during a\n`ModifyPushConfig` call, its value will not be changed. `GetSubscription`\ncalls will always return a valid version, even if the subscription was\ncreated without this attribute.\n\nThe possible values for this attribute are:\n\n* `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API.\n* `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API.", |
- "type": "object" |
- } |
- }, |
- "type": "object" |
- }, |
- "TestIamPermissionsResponse": { |
- "description": "Response message for `TestIamPermissions` method.", |
- "id": "TestIamPermissionsResponse", |
- "properties": { |
- "permissions": { |
- "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.", |
- "items": { |
- "type": "string" |
- }, |
- "type": "array" |
- } |
- }, |
- "type": "object" |
- }, |
- "PullRequest": { |
- "description": "Request for the `Pull` method.", |
- "id": "PullRequest", |
- "properties": { |
- "maxMessages": { |
- "description": "The maximum number of messages returned for this request. The Pub/Sub\nsystem may return fewer than the number specified.", |
- "format": "int32", |
- "type": "integer" |
- }, |
- "returnImmediately": { |
- "description": "If this field set to true, the system will respond immediately even if\nit there are no messages available to return in the `Pull` response.\nOtherwise, the system may wait (for a bounded amount of time) until at\nleast one message is available, rather than returning no messages. The\nclient may cancel the request if it does not wish to wait any longer for\nthe response.", |
- "type": "boolean" |
- } |
- }, |
- "type": "object" |
- }, |
- "ListSubscriptionsResponse": { |
- "description": "Response for the `ListSubscriptions` method.", |
- "id": "ListSubscriptionsResponse", |
- "properties": { |
- "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" |
- }, |
- "subscriptions": { |
- "description": "The subscriptions that match the request.", |
- "items": { |
- "$ref": "Subscription" |
- }, |
- "type": "array" |
- } |
- }, |
- "type": "object" |
- }, |
- "PublishRequest": { |
- "description": "Request for the Publish method.", |
- "id": "PublishRequest", |
- "properties": { |
- "messages": { |
- "description": "The messages to publish.", |
- "items": { |
- "$ref": "PubsubMessage" |
- }, |
- "type": "array" |
- } |
- }, |
- "type": "object" |
- }, |
- "PublishResponse": { |
- "description": "Response for the `Publish` method.", |
- "id": "PublishResponse", |
- "properties": { |
- "messageIds": { |
- "description": "The server-assigned ID of each published message, in the same order as\nthe messages in the request. IDs are guaranteed to be unique within\nthe topic.", |
- "items": { |
- "type": "string" |
- }, |
- "type": "array" |
- } |
- }, |
- "type": "object" |
- }, |
"Subscription": { |
"description": "A subscription resource.", |
"id": "Subscription", |
"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." |
+ }, |
"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", |
@@ -900,10 +810,6 @@ |
"topic": { |
"description": "The name of the topic from which this subscription is receiving messages.\nFormat is `projects/{project}/topics/{topic}`.\nThe value of this field will be `_deleted-topic_` if the topic has been\ndeleted.", |
"type": "string" |
- }, |
- "pushConfig": { |
- "$ref": "PushConfig", |
- "description": "If push delivery is used with this subscription, this field is\nused to configure it. An empty `pushConfig` signifies that the subscriber\nwill pull and ack messages using API methods." |
} |
}, |
"type": "object" |
@@ -922,17 +828,6 @@ |
}, |
"type": "object" |
}, |
- "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" |
- }, |
"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", |
@@ -957,21 +852,32 @@ |
}, |
"type": "object" |
}, |
+ "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" |
+ }, |
"ModifyAckDeadlineRequest": { |
"description": "Request for the ModifyAckDeadline method.", |
"id": "ModifyAckDeadlineRequest", |
"properties": { |
+ "ackDeadlineSeconds": { |
+ "description": "The new ack deadline with respect to the time this request was sent to\nthe Pub/Sub system. For example, if the value is 10, the new\nack deadline will expire 10 seconds after the `ModifyAckDeadline` call\nwas made. Specifying zero may immediately make the message available for\nanother pull request.\nThe minimum deadline you can specify is 0 seconds.\nThe maximum deadline you can specify is 600 seconds (10 minutes).", |
+ "format": "int32", |
+ "type": "integer" |
+ }, |
"ackIds": { |
"description": "List of acknowledgment IDs.", |
"items": { |
"type": "string" |
}, |
"type": "array" |
- }, |
- "ackDeadlineSeconds": { |
- "description": "The new ack deadline with respect to the time this request was sent to\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" |
@@ -987,17 +893,6 @@ |
}, |
"type": "object" |
}, |
- "ModifyPushConfigRequest": { |
- "description": "Request for the ModifyPushConfig method.", |
- "id": "ModifyPushConfigRequest", |
- "properties": { |
- "pushConfig": { |
- "$ref": "PushConfig", |
- "description": "The push configuration for future deliveries.\n\nAn empty `pushConfig` indicates that the Pub/Sub system should\nstop pushing messages from the given subscription and allow\nmessages to be pulled and acknowledged - effectively pausing\nthe subscription if `Pull` is not called." |
- } |
- }, |
- "type": "object" |
- }, |
"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", |
@@ -1026,6 +921,17 @@ |
}, |
"type": "object" |
}, |
+ "ModifyPushConfigRequest": { |
+ "description": "Request for the ModifyPushConfig method.", |
+ "id": "ModifyPushConfigRequest", |
+ "properties": { |
+ "pushConfig": { |
+ "$ref": "PushConfig", |
+ "description": "The push configuration for future deliveries.\n\nAn empty `pushConfig` indicates that the Pub/Sub system should\nstop pushing messages from the given subscription and allow\nmessages to be pulled and acknowledged - effectively pausing\nthe subscription if `Pull` is not called." |
+ } |
+ }, |
+ "type": "object" |
+ }, |
"Binding": { |
"description": "Associates `members` with a `role`.", |
"id": "Binding", |
@@ -1044,14 +950,18 @@ |
}, |
"type": "object" |
}, |
- "AcknowledgeRequest": { |
- "description": "Request for the Acknowledge method.", |
- "id": "AcknowledgeRequest", |
+ "ListTopicsResponse": { |
+ "description": "Response for the `ListTopics` method.", |
+ "id": "ListTopicsResponse", |
"properties": { |
- "ackIds": { |
- "description": "The acknowledgment ID for the messages being acknowledged that was returned\nby the Pub/Sub system in the `Pull` response. Must not be empty.", |
+ "nextPageToken": { |
+ "description": "If not empty, indicates that there may be more topics that match the\nrequest; this value should be passed in a new `ListTopicsRequest`.", |
+ "type": "string" |
+ }, |
+ "topics": { |
+ "description": "The resulting topics.", |
"items": { |
- "type": "string" |
+ "$ref": "Topic" |
}, |
"type": "array" |
} |
@@ -1064,18 +974,14 @@ |
"properties": {}, |
"type": "object" |
}, |
- "ListTopicsResponse": { |
- "description": "Response for the `ListTopics` method.", |
- "id": "ListTopicsResponse", |
+ "AcknowledgeRequest": { |
+ "description": "Request for the Acknowledge method.", |
+ "id": "AcknowledgeRequest", |
"properties": { |
- "nextPageToken": { |
- "description": "If not empty, indicates that there may be more topics that match the\nrequest; this value should be passed in a new `ListTopicsRequest`.", |
- "type": "string" |
- }, |
- "topics": { |
- "description": "The resulting topics.", |
+ "ackIds": { |
+ "description": "The acknowledgment ID for the messages being acknowledged that was returned\nby the Pub/Sub system in the `Pull` response. Must not be empty.", |
"items": { |
- "$ref": "Topic" |
+ "type": "string" |
}, |
"type": "array" |
} |
@@ -1128,6 +1034,100 @@ |
} |
}, |
"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 pushed message. This attribute\nindicates the version of the data expected by the endpoint. This\ncontrols the shape of the pushed message (i.e., its fields and metadata).\nThe endpoint version is based on the version of the Pub/Sub API.\n\nIf not present during the `CreateSubscription` call, it will default to\nthe version of the API used to make such call. If not present during a\n`ModifyPushConfig` call, its value will not be changed. `GetSubscription`\ncalls will always return a valid version, even if the subscription was\ncreated without this attribute.\n\nThe possible values for this attribute are:\n\n* `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API.\n* `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API.", |
+ "type": "object" |
+ } |
+ }, |
+ "type": "object" |
+ }, |
+ "TestIamPermissionsResponse": { |
+ "description": "Response message for `TestIamPermissions` method.", |
+ "id": "TestIamPermissionsResponse", |
+ "properties": { |
+ "permissions": { |
+ "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.", |
+ "items": { |
+ "type": "string" |
+ }, |
+ "type": "array" |
+ } |
+ }, |
+ "type": "object" |
+ }, |
+ "PullRequest": { |
+ "description": "Request for the `Pull` method.", |
+ "id": "PullRequest", |
+ "properties": { |
+ "maxMessages": { |
+ "description": "The maximum number of messages returned for this request. The Pub/Sub\nsystem may return fewer than the number specified.", |
+ "format": "int32", |
+ "type": "integer" |
+ }, |
+ "returnImmediately": { |
+ "description": "If this field set to true, the system will respond immediately even if\nit there are no messages available to return in the `Pull` response.\nOtherwise, the system may wait (for a bounded amount of time) until at\nleast one message is available, rather than returning no messages. The\nclient may cancel the request if it does not wish to wait any longer for\nthe response.", |
+ "type": "boolean" |
+ } |
+ }, |
+ "type": "object" |
+ }, |
+ "ListSubscriptionsResponse": { |
+ "description": "Response for the `ListSubscriptions` method.", |
+ "id": "ListSubscriptionsResponse", |
+ "properties": { |
+ "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" |
+ }, |
+ "subscriptions": { |
+ "description": "The subscriptions that match the request.", |
+ "items": { |
+ "$ref": "Subscription" |
+ }, |
+ "type": "array" |
+ } |
+ }, |
+ "type": "object" |
+ }, |
+ "PublishRequest": { |
+ "description": "Request for the Publish method.", |
+ "id": "PublishRequest", |
+ "properties": { |
+ "messages": { |
+ "description": "The messages to publish.", |
+ "items": { |
+ "$ref": "PubsubMessage" |
+ }, |
+ "type": "array" |
+ } |
+ }, |
+ "type": "object" |
+ }, |
+ "PublishResponse": { |
+ "description": "Response for the `Publish` method.", |
+ "id": "PublishResponse", |
+ "properties": { |
+ "messageIds": { |
+ "description": "The server-assigned ID of each published message, in the same order as\nthe messages in the request. IDs are guaranteed to be unique within\nthe topic.", |
+ "items": { |
+ "type": "string" |
+ }, |
+ "type": "array" |
+ } |
+ }, |
+ "type": "object" |
} |
}, |
"servicePath": "", |