discovery/googleapis/pubsub__v1.json - Issue 2936613002: Api-Roll 50: 2017-06-12

Unified Diff: discovery/googleapis/pubsub__v1.json

Issue 2936613002: Api-Roll 50: 2017-06-12 (Closed)

Patch Set: Created 3 years, 6 months ago

Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.

Jump to:

View side-by-side diff with in-line comments

Index: discovery/googleapis/pubsub__v1.json

diff --git a/discovery/googleapis/pubsub__v1.json b/discovery/googleapis/pubsub__v1.json

index f59762ea7ee4c58b284f448870c5efd54e37eb1d..f30f740750c674a8a4e66088a13c190ddab61a36 100644

--- a/discovery/googleapis/pubsub__v1.json

+++ b/discovery/googleapis/pubsub__v1.json

@@ -28,6 +28,50 @@

"ownerDomain": "google.com",

"ownerName": "Google",

"parameters": {

+ "fields": {

+ "description": "Selector specifying which fields to include in a partial response.",

+ "location": "query",

+ "type": "string"

+ },

+ "uploadType": {

+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",

+ "location": "query",

+ "type": "string"

+ },

+ "$.xgafv": {

+ "description": "V1 error format.",

+ "enum": [

+ "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"

+ },

"access_token": {

"description": "OAuth access token.",

"location": "query",

@@ -69,50 +113,6 @@

"description": "Returns response with indentations and line breaks.",

"location": "query",

"type": "boolean"

- },

- "uploadType": {

- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",

- "location": "query",

- "type": "string"

- },

- "fields": {

- "description": "Selector specifying which fields to include in a partial response.",

- "location": "query",

- "type": "string"

- },

- "callback": {

- "description": "JSONP",

- "location": "query",

- "type": "string"

- },

- "$.xgafv": {

- "description": "V1 error format.",

- "enum": [

- "1",

- "2"

- ],

- "enumDescriptions": [

- "v1 error format",

- "v2 error format"

- ],

- "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,89 +121,28 @@

"resources": {

"subscriptions": {

"methods": {

- "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"

- ]

- },

- "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",

+ "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": [

- "subscription"

+ "name"

"parameters": {

- "subscription": {

- "description": "The subscription from which messages should be pulled.\nFormat is `projects/{project}/subscriptions/{sub}`.",

+ "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/{+subscription}:pull",

+ "path": "v1/{+name}",

"request": {

- "$ref": "PullRequest"

- },

- "response": {

- "$ref": "PullResponse"

- },

- "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"

- }

+ "$ref": "Subscription"

- "path": "v1/{+project}/subscriptions",

"response": {

- "$ref": "ListSubscriptionsResponse"

+ "$ref": "Subscription"

"scopes": [

"https://www.googleapis.com/auth/cloud-platform",

@@ -238,28 +177,28 @@

"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",

+ "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.modifyAckDeadline",

"parameterOrder": [

- "name"

+ "subscription"

"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\"`.",

+ "subscription": {

+ "description": "The name of the subscription.\nFormat is `projects/{project}/subscriptions/{sub}`.",

"location": "path",

"pattern": "^projects/[^/]+/subscriptions/[^/]+$",

"required": true,

"type": "string"

}

- "path": "v1/{+name}",

+ "path": "v1/{+subscription}:modifyAckDeadline",

"request": {

- "$ref": "Subscription"

+ "$ref": "ModifyAckDeadlineRequest"

"response": {

- "$ref": "Subscription"

+ "$ref": "Empty"

"scopes": [

"https://www.googleapis.com/auth/cloud-platform",

@@ -294,34 +233,6 @@

"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.",

- "httpMethod": "POST",

- "id": "pubsub.projects.subscriptions.modifyAckDeadline",

- "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}:modifyAckDeadline",

- "request": {

- "$ref": "ModifyAckDeadlineRequest"

- },

- "response": {

- "$ref": "Empty"

- },

- "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",

@@ -427,36 +338,100 @@

"https://www.googleapis.com/auth/cloud-platform",

"https://www.googleapis.com/auth/pubsub"

]

- }

- },

- "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.",

+ },

+ "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.snapshots.getIamPolicy",

+ "id": "pubsub.projects.subscriptions.list",

"parameterOrder": [

- "resource"

+ "project"

"parameters": {

- "resource": {

- "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",

+ "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/[^/]+/snapshots/[^/]+$",

+ "pattern": "^projects/[^/]+$",

"required": true,

"type": "string"

}

- "path": "v1/{+resource}:getIamPolicy",

+ "path": "v1/{+project}/subscriptions",

"response": {

- "$ref": "Policy"

+ "$ref": "ListSubscriptionsResponse"

"scopes": [

"https://www.googleapis.com/auth/cloud-platform",

"https://www.googleapis.com/auth/pubsub"

]

- },

+ }

+ },

+ "snapshots": {

+ "methods": {

"setIamPolicy": {

"description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",

"httpMethod": "POST",

@@ -512,6 +487,31 @@

"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.\nSee the operation documentation for the appropriate value for this field.",

+ "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"

+ ]

}

@@ -790,12 +790,26 @@

"revision": "20170502",

"rootUrl": "https://pubsub.googleapis.com/",

"schemas": {

- "TestIamPermissionsRequest": {

- "description": "Request message for `TestIamPermissions` method.",

- "id": "TestIamPermissionsRequest",

+ "PublishRequest": {

+ "description": "Request for the Publish method.",

+ "id": "PublishRequest",

"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).",

+ "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"

@@ -804,13 +818,40 @@

"type": "object"

- "Topic": {

- "description": "A topic resource.",

- "id": "Topic",

+ "Subscription": {

+ "description": "A subscription resource.",

+ "id": "Subscription",

"properties": {

+ "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 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"

+ },

+ "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"

+ },

+ "TestIamPermissionsRequest": {

+ "description": "Request message for `TestIamPermissions` method.",

+ "id": "TestIamPermissionsRequest",

+ "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).",

+ "items": {

+ "type": "string"

+ },

+ "type": "array"

}

"type": "object"

@@ -839,6 +880,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"

+ },

"ModifyAckDeadlineRequest": {

"description": "Request for the ModifyAckDeadline method.",

"id": "ModifyAckDeadlineRequest",

@@ -869,20 +921,21 @@

"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",

"properties": {

- "publishTime": {

- "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"

- },

"attributes": {

"additionalProperties": {

"type": "string"

@@ -893,17 +946,16 @@

"messageId": {

"description": "ID of this message, assigned by the server when the message is published.\nGuaranteed to be unique within the topic. This value may be read by a\nsubscriber that receives a `PubsubMessage` via a `Pull` call or a push\ndelivery. It must not be populated by the publisher in a `Publish` call.",

"type": "string"

- }

- },

- "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."

+ },

+ "publishTime": {

+ "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"

@@ -926,14 +978,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"

}

@@ -946,20 +1002,16 @@

"properties": {},

"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"

@@ -1047,14 +1099,14 @@

"description": "Request for the `Pull` method.",

"id": "PullRequest",

"properties": {

- "returnImmediately": {

- "description": "If this field set to true, the system will respond immediately even if\nit there are no messages available to return in the `Pull` response.\nOtherwise, the system may wait (for a bounded amount of time) until at\nleast one message is available, rather than returning no messages. The\nclient may cancel the request if it does not wish to wait any longer for\nthe response.",

- "type": "boolean"

- },

"maxMessages": {

"description": "The maximum number of messages returned for this request. The Pub/Sub\nsystem may return fewer than the number specified.",

"format": "int32",

"type": "integer"

+ },

+ "returnImmediately": {

+ "description": "If this field set to true, the system will respond immediately even if\nit there are no messages available to return in the `Pull` response.\nOtherwise, the system may wait (for a bounded amount of time) until at\nleast one message is available, rather than returning no messages. The\nclient may cancel the request if it does not wish to wait any longer for\nthe response.",

+ "type": "boolean"

}

"type": "object"

@@ -1063,71 +1115,19 @@

"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.",

+ },

+ "subscriptions": {

+ "description": "The subscriptions that match the request.",

"items": {

- "type": "string"

+ "$ref": "Subscription"

"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",

- "type": "integer"

- },

- "name": {

- "type": "string"

- },

- "topic": {

- "description": "The name of the topic from which this subscription is receiving messages.\nFormat is `projects/{project}/topics/{topic}`.\nThe value of this field will be `_deleted-topic_` if the topic has been\ndeleted.",

- "type": "string"

- }

- },

- "type": "object"

}

"servicePath": "",

« no previous file with comments | « discovery/googleapis/plus__v1.json ('k') | discovery/googleapis/runtimeconfig__v1.json » ('j') | no next file with comments »