Index: discovery/googleapis_beta/pubsub__v1beta2.json |
diff --git a/discovery/googleapis_beta/pubsub__v1beta2.json b/discovery/googleapis_beta/pubsub__v1beta2.json |
index 933e9da6bd5527b3bdf93da7486a28f5fd2c301d..dea711fdd2e07922fde397616e5321247a97ee9b 100644 |
--- a/discovery/googleapis_beta/pubsub__v1beta2.json |
+++ b/discovery/googleapis_beta/pubsub__v1beta2.json |
@@ -2,11 +2,11 @@ |
"auth": { |
"oauth2": { |
"scopes": { |
- "https://www.googleapis.com/auth/pubsub": { |
- "description": "View and manage Pub/Sub topics and subscriptions" |
- }, |
"https://www.googleapis.com/auth/cloud-platform": { |
"description": "View and manage your data across Google Cloud Platform services" |
+ }, |
+ "https://www.googleapis.com/auth/pubsub": { |
+ "description": "View and manage Pub/Sub topics and subscriptions" |
} |
} |
} |
@@ -14,6 +14,7 @@ |
"basePath": "", |
"baseUrl": "https://pubsub.googleapis.com/", |
"batchPath": "batch", |
+ "canonicalName": "Pubsub", |
"description": "Provides reliable, many-to-many, asynchronous messaging between applications.\n", |
"discoveryVersion": "v1", |
"documentationLink": "https://cloud.google.com/pubsub/docs", |
@@ -27,6 +28,16 @@ |
"ownerDomain": "google.com", |
"ownerName": "Google", |
"parameters": { |
+ "bearer_token": { |
+ "description": "OAuth bearer token.", |
+ "location": "query", |
+ "type": "string" |
+ }, |
+ "oauth_token": { |
+ "description": "OAuth 2.0 token for the current user.", |
+ "location": "query", |
+ "type": "string" |
+ }, |
"upload_protocol": { |
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", |
"location": "query", |
@@ -38,13 +49,13 @@ |
"location": "query", |
"type": "boolean" |
}, |
- "uploadType": { |
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", |
+ "fields": { |
+ "description": "Selector specifying which fields to include in a partial response.", |
"location": "query", |
"type": "string" |
}, |
- "fields": { |
- "description": "Selector specifying which fields to include in a partial response.", |
+ "uploadType": { |
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", |
"location": "query", |
"type": "string" |
}, |
@@ -82,13 +93,13 @@ |
"location": "query", |
"type": "string" |
}, |
- "access_token": { |
- "description": "OAuth access token.", |
+ "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" |
}, |
- "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.", |
+ "access_token": { |
+ "description": "OAuth access token.", |
"location": "query", |
"type": "string" |
}, |
@@ -102,16 +113,6 @@ |
"description": "Pretty-print response.", |
"location": "query", |
"type": "boolean" |
- }, |
- "oauth_token": { |
- "description": "OAuth 2.0 token for the current user.", |
- "location": "query", |
- "type": "string" |
- }, |
- "bearer_token": { |
- "description": "OAuth bearer token.", |
- "location": "query", |
- "type": "string" |
} |
}, |
"protocol": "rest", |
@@ -120,31 +121,6 @@ |
"resources": { |
"subscriptions": { |
"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.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": "v1beta2/{+resource}:getIamPolicy", |
- "response": { |
- "$ref": "Policy" |
- }, |
- "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", |
@@ -201,6 +177,31 @@ |
"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": "v1beta2/{+resource}:getIamPolicy", |
+ "response": { |
+ "$ref": "Policy" |
+ }, |
+ "scopes": [ |
+ "https://www.googleapis.com/auth/cloud-platform", |
+ "https://www.googleapis.com/auth/pubsub" |
+ ] |
+ }, |
"get": { |
"description": "Gets the configuration details of a subscription.", |
"httpMethod": "GET", |
@@ -227,7 +228,7 @@ |
] |
}, |
"testIamPermissions": { |
- "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.", |
+ "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.", |
"httpMethod": "POST", |
"id": "pubsub.projects.subscriptions.testIamPermissions", |
"parameterOrder": [ |
@@ -460,7 +461,7 @@ |
] |
}, |
"testIamPermissions": { |
- "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.", |
+ "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.", |
"httpMethod": "POST", |
"id": "pubsub.projects.topics.testIamPermissions", |
"parameterOrder": [ |
@@ -520,11 +521,6 @@ |
"project" |
], |
"parameters": { |
- "pageToken": { |
- "description": "The value returned by the last `ListTopicsResponse`; indicates that this is\na continuation of a prior `ListTopics` call, and that the system should\nreturn the next page of data.", |
- "location": "query", |
- "type": "string" |
- }, |
"pageSize": { |
"description": "Maximum number of topics to return.", |
"format": "int32", |
@@ -537,6 +533,11 @@ |
"pattern": "^projects/[^/]+$", |
"required": true, |
"type": "string" |
+ }, |
+ "pageToken": { |
+ "description": "The value returned by the last `ListTopicsResponse`; indicates that this is\na continuation of a prior `ListTopics` call, and that the system should\nreturn the next page of data.", |
+ "location": "query", |
+ "type": "string" |
} |
}, |
"path": "v1beta2/{+project}/topics", |
@@ -548,56 +549,56 @@ |
"https://www.googleapis.com/auth/pubsub" |
] |
}, |
- "create": { |
- "description": "Creates the given topic with the given name.", |
- "httpMethod": "PUT", |
- "id": "pubsub.projects.topics.create", |
+ "setIamPolicy": { |
+ "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.", |
+ "httpMethod": "POST", |
+ "id": "pubsub.projects.topics.setIamPolicy", |
"parameterOrder": [ |
- "name" |
+ "resource" |
], |
"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\"`.", |
+ "resource": { |
+ "description": "REQUIRED: The resource for which the policy is being specified.\n`resource` is usually specified as a path. For example, a Project\nresource is specified as `projects/{project}`.", |
"location": "path", |
"pattern": "^projects/[^/]+/topics/[^/]+$", |
"required": true, |
"type": "string" |
} |
}, |
- "path": "v1beta2/{+name}", |
+ "path": "v1beta2/{+resource}:setIamPolicy", |
"request": { |
- "$ref": "Topic" |
+ "$ref": "SetIamPolicyRequest" |
}, |
"response": { |
- "$ref": "Topic" |
+ "$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.", |
- "httpMethod": "POST", |
- "id": "pubsub.projects.topics.setIamPolicy", |
+ "create": { |
+ "description": "Creates the given topic with the given name.", |
+ "httpMethod": "PUT", |
+ "id": "pubsub.projects.topics.create", |
"parameterOrder": [ |
- "resource" |
+ "name" |
], |
"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}`.", |
+ "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": "v1beta2/{+resource}:setIamPolicy", |
+ "path": "v1beta2/{+name}", |
"request": { |
- "$ref": "SetIamPolicyRequest" |
+ "$ref": "Topic" |
}, |
"response": { |
- "$ref": "Policy" |
+ "$ref": "Topic" |
}, |
"scopes": [ |
"https://www.googleapis.com/auth/cloud-platform", |
@@ -701,132 +702,9 @@ |
} |
} |
}, |
- "revision": "20170124", |
+ "revision": "20170214", |
"rootUrl": "https://pubsub.googleapis.com/", |
"schemas": { |
- "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" |
- }, |
- "ReceivedMessage": { |
- "description": "A message and its corresponding acknowledgment ID.", |
- "id": "ReceivedMessage", |
- "properties": { |
- "message": { |
- "$ref": "PubsubMessage", |
- "description": "The message." |
- }, |
- "ackId": { |
- "description": "This ID can be used to acknowledge the received message.", |
- "type": "string" |
- } |
- }, |
- "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" |
- }, |
- "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 is specified as true the system will respond immediately even if\nit is not able to return a message in the `Pull` response. Otherwise the\nsystem is allowed to wait until at least one message is available rather\nthan returning no messages. The client may cancel the request if it does\nnot wish to wait any longer for the response.", |
- "type": "boolean" |
- } |
- }, |
- "type": "object" |
- }, |
- "ListSubscriptionsResponse": { |
- "description": "Response for the `ListSubscriptions` method.", |
- "id": "ListSubscriptionsResponse", |
- "properties": { |
- "subscriptions": { |
- "description": "The subscriptions that match the request.", |
- "items": { |
- "$ref": "Subscription" |
- }, |
- "type": "array" |
- }, |
- "nextPageToken": { |
- "description": "If not empty, indicates that there may be more subscriptions that match\nthe request; this value should be passed in a new\n`ListSubscriptionsRequest` to get more subscriptions.", |
- "type": "string" |
- } |
- }, |
- "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", |
@@ -865,6 +743,17 @@ |
}, |
"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", |
@@ -889,28 +778,10 @@ |
}, |
"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": { |
- "ackIds": { |
- "description": "List of acknowledgment IDs.", |
- "items": { |
- "type": "string" |
- }, |
- "type": "array" |
- }, |
"ackId": { |
"description": "The acknowledgment ID. Either this or ack_ids must be populated, but not\nboth.", |
"type": "string" |
@@ -919,6 +790,13 @@ |
"description": "The new ack deadline with respect to the time this request was sent to\nthe Pub/Sub system. Must be >= 0. 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.", |
"format": "int32", |
"type": "integer" |
+ }, |
+ "ackIds": { |
+ "description": "List of acknowledgment IDs.", |
+ "items": { |
+ "type": "string" |
+ }, |
+ "type": "array" |
} |
}, |
"type": "object" |
@@ -934,17 +812,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", |
@@ -973,6 +840,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", |
@@ -991,20 +869,16 @@ |
}, |
"type": "object" |
}, |
- "ListTopicsResponse": { |
- "description": "Response for the `ListTopics` method.", |
- "id": "ListTopicsResponse", |
+ "AcknowledgeRequest": { |
+ "description": "Request for the Acknowledge method.", |
+ "id": "AcknowledgeRequest", |
"properties": { |
- "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" |
- }, |
- "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" |
@@ -1015,14 +889,18 @@ |
"properties": {}, |
"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" |
} |
@@ -1033,16 +911,139 @@ |
"description": "Response for the `ListTopicSubscriptions` method.", |
"id": "ListTopicSubscriptionsResponse", |
"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`ListTopicSubscriptionsRequest` to get more subscriptions.", |
+ "type": "string" |
+ }, |
"subscriptions": { |
"description": "The names of the subscriptions that match the request.", |
"items": { |
"type": "string" |
}, |
"type": "array" |
+ } |
+ }, |
+ "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" |
+ }, |
+ "ReceivedMessage": { |
+ "description": "A message and its corresponding acknowledgment ID.", |
+ "id": "ReceivedMessage", |
+ "properties": { |
+ "message": { |
+ "$ref": "PubsubMessage", |
+ "description": "The message." |
+ }, |
+ "ackId": { |
+ "description": "This ID can be used to acknowledge the received message.", |
+ "type": "string" |
+ } |
+ }, |
+ "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" |
+ }, |
+ "PullRequest": { |
+ "description": "Request for the `Pull` method.", |
+ "id": "PullRequest", |
+ "properties": { |
+ "returnImmediately": { |
+ "description": "If this is specified as true the system will respond immediately even if\nit is not able to return a message in the `Pull` response. Otherwise the\nsystem is allowed to wait until at least one message is available rather\nthan returning no messages. The client may cancel the request if it does\nnot wish to wait any longer for the 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" |
+ }, |
+ "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`ListTopicSubscriptionsRequest` to get more subscriptions.", |
+ "description": "If not empty, indicates that there may be more subscriptions that match\nthe request; this value should be passed in a new\n`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" |