Index: discovery/googleapis/pubsub__v1.json |
diff --git a/discovery/googleapis/pubsub__v1.json b/discovery/googleapis/pubsub__v1.json |
index ccbd0590667f746512b69f30eba0583130cbd3ea..7e0d26d51269c0a5b8e86699c415d7bcbb4f2a30 100644 |
--- a/discovery/googleapis/pubsub__v1.json |
+++ b/discovery/googleapis/pubsub__v1.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" |
} |
} |
} |
@@ -39,13 +39,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" |
}, |
@@ -83,13 +83,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" |
}, |
@@ -119,12 +119,40 @@ |
"resources": { |
"projects": { |
"resources": { |
- "topics": { |
+ "snapshots": { |
"methods": { |
+ "setIamPolicy": { |
+ "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.", |
+ "httpMethod": "POST", |
+ "id": "pubsub.projects.snapshots.setIamPolicy", |
+ "parameterOrder": [ |
+ "resource" |
+ ], |
+ "parameters": { |
+ "resource": { |
+ "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.", |
+ "location": "path", |
+ "pattern": "^projects/[^/]+/snapshots/[^/]+$", |
+ "required": true, |
+ "type": "string" |
+ } |
+ }, |
+ "path": "v1/{+resource}:setIamPolicy", |
+ "request": { |
+ "$ref": "SetIamPolicyRequest" |
+ }, |
+ "response": { |
+ "$ref": "Policy" |
+ }, |
+ "scopes": [ |
+ "https://www.googleapis.com/auth/cloud-platform", |
+ "https://www.googleapis.com/auth/pubsub" |
+ ] |
+ }, |
"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", |
+ "id": "pubsub.projects.snapshots.testIamPermissions", |
"parameterOrder": [ |
"resource" |
], |
@@ -132,7 +160,7 @@ |
"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/[^/]+/topics/[^/]+$", |
+ "pattern": "^projects/[^/]+/snapshots/[^/]+$", |
"required": true, |
"type": "string" |
} |
@@ -149,61 +177,65 @@ |
"https://www.googleapis.com/auth/pubsub" |
] |
}, |
- "delete": { |
- "description": "Deletes the topic with the given name. Returns `NOT_FOUND` if the topic\ndoes not exist. After a topic is deleted, a new topic may be created with\nthe same name; this is an entirely new topic with none of the old\nconfiguration or subscriptions. Existing subscriptions to this topic are\nnot deleted, but their `topic` field is set to `_deleted-topic_`.", |
- "httpMethod": "DELETE", |
- "id": "pubsub.projects.topics.delete", |
+ "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": [ |
- "topic" |
+ "resource" |
], |
"parameters": { |
- "topic": { |
- "description": "Name of the topic to delete.\nFormat is `projects/{project}/topics/{topic}`.", |
+ "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/[^/]+/topics/[^/]+$", |
+ "pattern": "^projects/[^/]+/snapshots/[^/]+$", |
"required": true, |
"type": "string" |
} |
}, |
- "path": "v1/{+topic}", |
+ "path": "v1/{+resource}:getIamPolicy", |
"response": { |
- "$ref": "Empty" |
+ "$ref": "Policy" |
}, |
"scopes": [ |
"https://www.googleapis.com/auth/cloud-platform", |
"https://www.googleapis.com/auth/pubsub" |
] |
- }, |
+ } |
+ } |
+ }, |
+ "subscriptions": { |
+ "methods": { |
"list": { |
- "description": "Lists matching topics.", |
+ "description": "Lists matching subscriptions.", |
"httpMethod": "GET", |
- "id": "pubsub.projects.topics.list", |
+ "id": "pubsub.projects.subscriptions.list", |
"parameterOrder": [ |
"project" |
], |
"parameters": { |
- "pageToken": { |
- "description": "The value returned by the last `ListTopicsResponse`; indicates that this is\na continuation of a prior `ListTopics` call, and that the system should\nreturn the next page of data.", |
- "location": "query", |
- "type": "string" |
- }, |
"pageSize": { |
- "description": "Maximum number of topics to return.", |
+ "description": "Maximum number of subscriptions to return.", |
"format": "int32", |
"location": "query", |
"type": "integer" |
}, |
"project": { |
- "description": "The name of the cloud project that topics belong to.\nFormat is `projects/{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" |
} |
}, |
- "path": "v1/{+project}/topics", |
+ "path": "v1/{+project}/subscriptions", |
"response": { |
- "$ref": "ListTopicsResponse" |
+ "$ref": "ListSubscriptionsResponse" |
}, |
"scopes": [ |
"https://www.googleapis.com/auth/cloud-platform", |
@@ -211,27 +243,27 @@ |
] |
}, |
"create": { |
- "description": "Creates the given topic with the given name.", |
+ "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.topics.create", |
+ "id": "pubsub.projects.subscriptions.create", |
"parameterOrder": [ |
"name" |
], |
"parameters": { |
"name": { |
- "description": "The name of the topic. It must have the format\n`\"projects/{project}/topics/{topic}\"`. `{topic}` must start with a letter,\nand contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`),\nunderscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent\nsigns (`%`). It must be between 3 and 255 characters in length, and it\nmust not start with `\"goog\"`.", |
+ "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/[^/]+/topics/[^/]+$", |
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$", |
"required": true, |
"type": "string" |
} |
}, |
"path": "v1/{+name}", |
"request": { |
- "$ref": "Topic" |
+ "$ref": "Subscription" |
}, |
"response": { |
- "$ref": "Topic" |
+ "$ref": "Subscription" |
}, |
"scopes": [ |
"https://www.googleapis.com/auth/cloud-platform", |
@@ -241,7 +273,7 @@ |
"setIamPolicy": { |
"description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.", |
"httpMethod": "POST", |
- "id": "pubsub.projects.topics.setIamPolicy", |
+ "id": "pubsub.projects.subscriptions.setIamPolicy", |
"parameterOrder": [ |
"resource" |
], |
@@ -249,7 +281,7 @@ |
"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/[^/]+/topics/[^/]+$", |
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$", |
"required": true, |
"type": "string" |
} |
@@ -266,152 +298,106 @@ |
"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.topics.getIamPolicy", |
+ "acknowledge": { |
+ "description": "Acknowledges the messages associated with the `ack_ids` in the\n`AcknowledgeRequest`. The Pub/Sub system can remove the relevant messages\nfrom the subscription.\n\nAcknowledging a message whose ack deadline has expired may succeed,\nbut such a message may be redelivered later. Acknowledging a message more\nthan once will not result in an error.", |
+ "httpMethod": "POST", |
+ "id": "pubsub.projects.subscriptions.acknowledge", |
"parameterOrder": [ |
- "resource" |
+ "subscription" |
], |
"parameters": { |
- "resource": { |
- "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.", |
+ "subscription": { |
+ "description": "The subscription whose message is being acknowledged.\nFormat is `projects/{project}/subscriptions/{sub}`.", |
"location": "path", |
- "pattern": "^projects/[^/]+/topics/[^/]+$", |
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$", |
"required": true, |
"type": "string" |
} |
}, |
- "path": "v1/{+resource}:getIamPolicy", |
+ "path": "v1/{+subscription}:acknowledge", |
+ "request": { |
+ "$ref": "AcknowledgeRequest" |
+ }, |
"response": { |
- "$ref": "Policy" |
+ "$ref": "Empty" |
}, |
"scopes": [ |
"https://www.googleapis.com/auth/cloud-platform", |
"https://www.googleapis.com/auth/pubsub" |
] |
}, |
- "get": { |
- "description": "Gets the configuration of a topic.", |
+ "getIamPolicy": { |
+ "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.", |
"httpMethod": "GET", |
- "id": "pubsub.projects.topics.get", |
+ "id": "pubsub.projects.subscriptions.getIamPolicy", |
"parameterOrder": [ |
- "topic" |
+ "resource" |
], |
"parameters": { |
- "topic": { |
- "description": "The name of the topic to get.\nFormat is `projects/{project}/topics/{topic}`.", |
+ "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/[^/]+/topics/[^/]+$", |
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$", |
"required": true, |
"type": "string" |
} |
}, |
- "path": "v1/{+topic}", |
+ "path": "v1/{+resource}:getIamPolicy", |
"response": { |
- "$ref": "Topic" |
+ "$ref": "Policy" |
}, |
"scopes": [ |
"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.", |
+ "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.topics.publish", |
+ "id": "pubsub.projects.subscriptions.modifyAckDeadline", |
"parameterOrder": [ |
- "topic" |
+ "subscription" |
], |
"parameters": { |
- "topic": { |
- "description": "The messages in the request will be published on this topic.\nFormat is `projects/{project}/topics/{topic}`.", |
+ "subscription": { |
+ "description": "The name of the subscription.\nFormat is `projects/{project}/subscriptions/{sub}`.", |
"location": "path", |
- "pattern": "^projects/[^/]+/topics/[^/]+$", |
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$", |
"required": true, |
"type": "string" |
} |
}, |
- "path": "v1/{+topic}:publish", |
+ "path": "v1/{+subscription}:modifyAckDeadline", |
"request": { |
- "$ref": "PublishRequest" |
+ "$ref": "ModifyAckDeadlineRequest" |
}, |
"response": { |
- "$ref": "PublishResponse" |
+ "$ref": "Empty" |
}, |
"scopes": [ |
"https://www.googleapis.com/auth/cloud-platform", |
"https://www.googleapis.com/auth/pubsub" |
] |
- } |
- }, |
- "resources": { |
- "subscriptions": { |
- "methods": { |
- "list": { |
- "description": "Lists the name of the subscriptions for this topic.", |
- "httpMethod": "GET", |
- "id": "pubsub.projects.topics.subscriptions.list", |
- "parameterOrder": [ |
- "topic" |
- ], |
- "parameters": { |
- "pageSize": { |
- "description": "Maximum number of subscription names to return.", |
- "format": "int32", |
- "location": "query", |
- "type": "integer" |
- }, |
- "topic": { |
- "description": "The name of the topic that subscriptions are attached to.\nFormat is `projects/{project}/topics/{topic}`.", |
- "location": "path", |
- "pattern": "^projects/[^/]+/topics/[^/]+$", |
- "required": true, |
- "type": "string" |
- }, |
- "pageToken": { |
- "description": "The value returned by the last `ListTopicSubscriptionsResponse`; indicates\nthat this is a continuation of a prior `ListTopicSubscriptions` call, and\nthat the system should return the next page of data.", |
- "location": "query", |
- "type": "string" |
- } |
- }, |
- "path": "v1/{+topic}/subscriptions", |
- "response": { |
- "$ref": "ListTopicSubscriptionsResponse" |
- }, |
- "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", |
- "id": "pubsub.projects.snapshots.setIamPolicy", |
+ }, |
+ "get": { |
+ "description": "Gets the configuration details of a subscription.", |
+ "httpMethod": "GET", |
+ "id": "pubsub.projects.subscriptions.get", |
"parameterOrder": [ |
- "resource" |
+ "subscription" |
], |
"parameters": { |
- "resource": { |
- "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.", |
+ "subscription": { |
+ "description": "The name of the subscription to get.\nFormat is `projects/{project}/subscriptions/{sub}`.", |
"location": "path", |
- "pattern": "^projects/[^/]+/snapshots/[^/]+$", |
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$", |
"required": true, |
"type": "string" |
} |
}, |
- "path": "v1/{+resource}:setIamPolicy", |
- "request": { |
- "$ref": "SetIamPolicyRequest" |
- }, |
+ "path": "v1/{+subscription}", |
"response": { |
- "$ref": "Policy" |
+ "$ref": "Subscription" |
}, |
"scopes": [ |
"https://www.googleapis.com/auth/cloud-platform", |
@@ -421,7 +407,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.\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", |
+ "id": "pubsub.projects.subscriptions.testIamPermissions", |
"parameterOrder": [ |
"resource" |
], |
@@ -429,64 +415,7 @@ |
"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/[^/]+/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" |
- ] |
- }, |
- "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" |
- ] |
- } |
- } |
- }, |
- "subscriptions": { |
- "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.subscriptions.testIamPermissions", |
- "parameterOrder": [ |
- "resource" |
- ], |
- "parameters": { |
- "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/[^/]+/subscriptions/[^/]+$", |
"required": true, |
"type": "string" |
} |
@@ -583,119 +512,109 @@ |
"https://www.googleapis.com/auth/cloud-platform", |
"https://www.googleapis.com/auth/pubsub" |
] |
- }, |
- "list": { |
- "description": "Lists matching subscriptions.", |
+ } |
+ } |
+ }, |
+ "topics": { |
+ "methods": { |
+ "get": { |
+ "description": "Gets the configuration of a topic.", |
"httpMethod": "GET", |
- "id": "pubsub.projects.subscriptions.list", |
+ "id": "pubsub.projects.topics.get", |
"parameterOrder": [ |
- "project" |
+ "topic" |
], |
"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}`.", |
+ "topic": { |
+ "description": "The name of the topic to get.\nFormat is `projects/{project}/topics/{topic}`.", |
"location": "path", |
- "pattern": "^projects/[^/]+$", |
+ "pattern": "^projects/[^/]+/topics/[^/]+$", |
"required": true, |
"type": "string" |
} |
}, |
- "path": "v1/{+project}/subscriptions", |
+ "path": "v1/{+topic}", |
"response": { |
- "$ref": "ListSubscriptionsResponse" |
+ "$ref": "Topic" |
}, |
"scopes": [ |
"https://www.googleapis.com/auth/cloud-platform", |
"https://www.googleapis.com/auth/pubsub" |
] |
}, |
- "create": { |
- "description": "Creates a subscription to a given topic.\nIf the subscription already exists, returns `ALREADY_EXISTS`.\nIf the corresponding topic doesn't exist, returns `NOT_FOUND`.\n\nIf the name is not provided in the request, the server will assign a random\nname for this subscription on the same project as the topic, conforming\nto the\n[resource name format](https://cloud.google.com/pubsub/docs/overview#names).\nThe generated name is populated in the returned Subscription object.\nNote that for REST API requests, you must specify a name in the request.", |
- "httpMethod": "PUT", |
- "id": "pubsub.projects.subscriptions.create", |
+ "publish": { |
+ "description": "Adds one or more messages to the topic. Returns `NOT_FOUND` if the topic\ndoes not exist. The message payload must not be empty; it must contain\n either a non-empty data field, or at least one attribute.", |
+ "httpMethod": "POST", |
+ "id": "pubsub.projects.topics.publish", |
"parameterOrder": [ |
- "name" |
+ "topic" |
], |
"parameters": { |
- "name": { |
- "description": "The name of the 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\"`.", |
+ "topic": { |
+ "description": "The messages in the request will be published on this topic.\nFormat is `projects/{project}/topics/{topic}`.", |
"location": "path", |
- "pattern": "^projects/[^/]+/subscriptions/[^/]+$", |
+ "pattern": "^projects/[^/]+/topics/[^/]+$", |
"required": true, |
"type": "string" |
} |
}, |
- "path": "v1/{+name}", |
+ "path": "v1/{+topic}:publish", |
"request": { |
- "$ref": "Subscription" |
+ "$ref": "PublishRequest" |
}, |
"response": { |
- "$ref": "Subscription" |
+ "$ref": "PublishResponse" |
}, |
"scopes": [ |
"https://www.googleapis.com/auth/cloud-platform", |
"https://www.googleapis.com/auth/pubsub" |
] |
}, |
- "setIamPolicy": { |
- "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.", |
+ "testIamPermissions": { |
+ "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\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.setIamPolicy", |
+ "id": "pubsub.projects.topics.testIamPermissions", |
"parameterOrder": [ |
"resource" |
], |
"parameters": { |
"resource": { |
- "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.", |
+ "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/[^/]+/topics/[^/]+$", |
"required": true, |
"type": "string" |
} |
}, |
- "path": "v1/{+resource}:setIamPolicy", |
+ "path": "v1/{+resource}:testIamPermissions", |
"request": { |
- "$ref": "SetIamPolicyRequest" |
+ "$ref": "TestIamPermissionsRequest" |
}, |
"response": { |
- "$ref": "Policy" |
+ "$ref": "TestIamPermissionsResponse" |
}, |
"scopes": [ |
"https://www.googleapis.com/auth/cloud-platform", |
"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", |
+ "delete": { |
+ "description": "Deletes the topic with the given name. Returns `NOT_FOUND` if the topic\ndoes not exist. After a topic is deleted, a new topic may be created with\nthe same name; this is an entirely new topic with none of the old\nconfiguration or subscriptions. Existing subscriptions to this topic are\nnot deleted, but their `topic` field is set to `_deleted-topic_`.", |
+ "httpMethod": "DELETE", |
+ "id": "pubsub.projects.topics.delete", |
"parameterOrder": [ |
- "subscription" |
+ "topic" |
], |
"parameters": { |
- "subscription": { |
- "description": "The name of the subscription.\nFormat is `projects/{project}/subscriptions/{sub}`.", |
+ "topic": { |
+ "description": "Name of the topic to delete.\nFormat is `projects/{project}/topics/{topic}`.", |
"location": "path", |
- "pattern": "^projects/[^/]+/subscriptions/[^/]+$", |
+ "pattern": "^projects/[^/]+/topics/[^/]+$", |
"required": true, |
"type": "string" |
} |
}, |
- "path": "v1/{+subscription}:modifyAckDeadline", |
- "request": { |
- "$ref": "ModifyAckDeadlineRequest" |
- }, |
+ "path": "v1/{+topic}", |
"response": { |
"$ref": "Empty" |
}, |
@@ -704,51 +623,90 @@ |
"https://www.googleapis.com/auth/pubsub" |
] |
}, |
- "acknowledge": { |
- "description": "Acknowledges the messages associated with the `ack_ids` in the\n`AcknowledgeRequest`. The Pub/Sub system can remove the relevant messages\nfrom the subscription.\n\nAcknowledging a message whose ack deadline has expired may succeed,\nbut such a message may be redelivered later. Acknowledging a message more\nthan once will not result in an error.", |
- "httpMethod": "POST", |
- "id": "pubsub.projects.subscriptions.acknowledge", |
+ "list": { |
+ "description": "Lists matching topics.", |
+ "httpMethod": "GET", |
+ "id": "pubsub.projects.topics.list", |
"parameterOrder": [ |
- "subscription" |
+ "project" |
], |
"parameters": { |
- "subscription": { |
- "description": "The subscription whose message is being acknowledged.\nFormat is `projects/{project}/subscriptions/{sub}`.", |
+ "pageToken": { |
+ "description": "The value returned by the last `ListTopicsResponse`; indicates that this is\na continuation of a prior `ListTopics` call, and that the system should\nreturn the next page of data.", |
+ "location": "query", |
+ "type": "string" |
+ }, |
+ "pageSize": { |
+ "description": "Maximum number of topics to return.", |
+ "format": "int32", |
+ "location": "query", |
+ "type": "integer" |
+ }, |
+ "project": { |
+ "description": "The name of the cloud project that topics belong to.\nFormat is `projects/{project}`.", |
"location": "path", |
- "pattern": "^projects/[^/]+/subscriptions/[^/]+$", |
+ "pattern": "^projects/[^/]+$", |
"required": true, |
"type": "string" |
} |
}, |
- "path": "v1/{+subscription}:acknowledge", |
+ "path": "v1/{+project}/topics", |
+ "response": { |
+ "$ref": "ListTopicsResponse" |
+ }, |
+ "scopes": [ |
+ "https://www.googleapis.com/auth/cloud-platform", |
+ "https://www.googleapis.com/auth/pubsub" |
+ ] |
+ }, |
+ "create": { |
+ "description": "Creates the given topic with the given name.", |
+ "httpMethod": "PUT", |
+ "id": "pubsub.projects.topics.create", |
+ "parameterOrder": [ |
+ "name" |
+ ], |
+ "parameters": { |
+ "name": { |
+ "description": "The name of the topic. It must have the format\n`\"projects/{project}/topics/{topic}\"`. `{topic}` must start with a letter,\nand contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`),\nunderscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent\nsigns (`%`). It must be between 3 and 255 characters in length, and it\nmust not start with `\"goog\"`.", |
+ "location": "path", |
+ "pattern": "^projects/[^/]+/topics/[^/]+$", |
+ "required": true, |
+ "type": "string" |
+ } |
+ }, |
+ "path": "v1/{+name}", |
"request": { |
- "$ref": "AcknowledgeRequest" |
+ "$ref": "Topic" |
}, |
"response": { |
- "$ref": "Empty" |
+ "$ref": "Topic" |
}, |
"scopes": [ |
"https://www.googleapis.com/auth/cloud-platform", |
"https://www.googleapis.com/auth/pubsub" |
] |
}, |
- "getIamPolicy": { |
- "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.", |
- "httpMethod": "GET", |
- "id": "pubsub.projects.subscriptions.getIamPolicy", |
+ "setIamPolicy": { |
+ "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.", |
+ "httpMethod": "POST", |
+ "id": "pubsub.projects.topics.setIamPolicy", |
"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.", |
+ "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/[^/]+/topics/[^/]+$", |
"required": true, |
"type": "string" |
} |
}, |
- "path": "v1/{+resource}:getIamPolicy", |
+ "path": "v1/{+resource}:setIamPolicy", |
+ "request": { |
+ "$ref": "SetIamPolicyRequest" |
+ }, |
"response": { |
"$ref": "Policy" |
}, |
@@ -757,39 +715,216 @@ |
"https://www.googleapis.com/auth/pubsub" |
] |
}, |
- "get": { |
- "description": "Gets the configuration details of a subscription.", |
+ "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.get", |
+ "id": "pubsub.projects.topics.getIamPolicy", |
"parameterOrder": [ |
- "subscription" |
+ "resource" |
], |
"parameters": { |
- "subscription": { |
- "description": "The name of the subscription to get.\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/[^/]+/topics/[^/]+$", |
"required": true, |
"type": "string" |
} |
}, |
- "path": "v1/{+subscription}", |
+ "path": "v1/{+resource}:getIamPolicy", |
"response": { |
- "$ref": "Subscription" |
+ "$ref": "Policy" |
}, |
"scopes": [ |
"https://www.googleapis.com/auth/cloud-platform", |
"https://www.googleapis.com/auth/pubsub" |
] |
} |
+ }, |
+ "resources": { |
+ "subscriptions": { |
+ "methods": { |
+ "list": { |
+ "description": "Lists the name of the subscriptions for this topic.", |
+ "httpMethod": "GET", |
+ "id": "pubsub.projects.topics.subscriptions.list", |
+ "parameterOrder": [ |
+ "topic" |
+ ], |
+ "parameters": { |
+ "pageToken": { |
+ "description": "The value returned by the last `ListTopicSubscriptionsResponse`; indicates\nthat this is a continuation of a prior `ListTopicSubscriptions` call, and\nthat the system should return the next page of data.", |
+ "location": "query", |
+ "type": "string" |
+ }, |
+ "pageSize": { |
+ "description": "Maximum number of subscription names to return.", |
+ "format": "int32", |
+ "location": "query", |
+ "type": "integer" |
+ }, |
+ "topic": { |
+ "description": "The name of the topic that subscriptions are attached to.\nFormat is `projects/{project}/topics/{topic}`.", |
+ "location": "path", |
+ "pattern": "^projects/[^/]+/topics/[^/]+$", |
+ "required": true, |
+ "type": "string" |
+ } |
+ }, |
+ "path": "v1/{+topic}/subscriptions", |
+ "response": { |
+ "$ref": "ListTopicSubscriptionsResponse" |
+ }, |
+ "scopes": [ |
+ "https://www.googleapis.com/auth/cloud-platform", |
+ "https://www.googleapis.com/auth/pubsub" |
+ ] |
+ } |
+ } |
+ } |
} |
} |
- } |
- } |
- }, |
- "revision": "20170731", |
- "rootUrl": "https://pubsub.googleapis.com/", |
- "schemas": { |
+ } |
+ } |
+ }, |
+ "revision": "20170829", |
+ "rootUrl": "https://pubsub.googleapis.com/", |
+ "schemas": { |
+ "PullRequest": { |
+ "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" |
+ } |
+ }, |
+ "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": { |
+ "ackDeadlineSeconds": { |
+ "description": "This value is the maximum time after a subscriber receives a message\nbefore the subscriber should acknowledge the message. After message\ndelivery but before the ack deadline expires and before the message is\nacknowledged, it is an outstanding message and will not be delivered\nagain during that time (on a best-effort basis).\n\nFor pull subscriptions, this value is used as the initial value for the ack\ndeadline. To override this value for a given message, call\n`ModifyAckDeadline` with the corresponding `ack_id` if using\npull.\nThe minimum custom deadline you can specify is 10 seconds.\nThe maximum custom deadline you can specify is 600 seconds (10 minutes).\nIf this parameter is 0, a default value of 10 seconds is used.\n\nFor push delivery, this value is also used to set the request timeout for\nthe call to the push endpoint.\n\nIf the subscriber never acknowledges the message, the Pub/Sub\nsystem will eventually redeliver the message.", |
+ "format": "int32", |
+ "type": "integer" |
+ }, |
+ "name": { |
+ "description": "The name of the subscription. It must have the format\n`\"projects/{project}/subscriptions/{subscription}\"`. `{subscription}` must\nstart with a letter, and contain only letters (`[A-Za-z]`), numbers\n(`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),\nplus (`+`) or percent signs (`%`). It must be between 3 and 255 characters\nin length, and it must not start with `\"goog\"`.", |
+ "type": "string" |
+ }, |
+ "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" |
+ }, |
+ "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", |
+ "properties": { |
+ "bindings": { |
+ "description": "Associates a list of `members` to a `role`.\n`bindings` with no members will result in an error.", |
+ "items": { |
+ "$ref": "Binding" |
+ }, |
+ "type": "array" |
+ }, |
+ "etag": { |
+ "description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.", |
+ "format": "byte", |
+ "type": "string" |
+ }, |
+ "version": { |
+ "description": "Version of the `Policy`. The default version is 0.", |
+ "format": "int32", |
+ "type": "integer" |
+ } |
+ }, |
+ "type": "object" |
+ }, |
"ModifyAckDeadlineRequest": { |
"description": "Request for the ModifyAckDeadline method.", |
"id": "ModifyAckDeadlineRequest", |
@@ -993,141 +1128,6 @@ |
} |
}, |
"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": { |
- "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." |
- }, |
- "ackDeadlineSeconds": { |
- "description": "This value is the maximum time after a subscriber receives a message\nbefore the subscriber should acknowledge the message. After message\ndelivery but before the ack deadline expires and before the message is\nacknowledged, it is an outstanding message and will not be delivered\nagain during that time (on a best-effort basis).\n\nFor pull subscriptions, this value is used as the initial value for the ack\ndeadline. To override this value for a given message, call\n`ModifyAckDeadline` with the corresponding `ack_id` if using\npull.\nThe minimum custom deadline you can specify is 10 seconds.\nThe maximum custom deadline you can specify is 600 seconds (10 minutes).\nIf this parameter is 0, a default value of 10 seconds is used.\n\nFor push delivery, this value is also used to set the request timeout for\nthe call to the push endpoint.\n\nIf the subscriber never acknowledges the message, the Pub/Sub\nsystem will eventually redeliver the message.", |
- "format": "int32", |
- "type": "integer" |
- }, |
- "name": { |
- "description": "The name of the subscription. It must have the format\n`\"projects/{project}/subscriptions/{subscription}\"`. `{subscription}` must\nstart with a letter, and contain only letters (`[A-Za-z]`), numbers\n(`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),\nplus (`+`) or percent signs (`%`). It must be between 3 and 255 characters\nin length, and it must not start with `\"goog\"`.", |
- "type": "string" |
- } |
- }, |
- "type": "object" |
- }, |
- "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" |
- }, |
- "Policy": { |
- "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam).", |
- "id": "Policy", |
- "properties": { |
- "bindings": { |
- "description": "Associates a list of `members` to a `role`.\n`bindings` with no members will result in an error.", |
- "items": { |
- "$ref": "Binding" |
- }, |
- "type": "array" |
- }, |
- "etag": { |
- "description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.", |
- "format": "byte", |
- "type": "string" |
- }, |
- "version": { |
- "description": "Version of the `Policy`. The default version is 0.", |
- "format": "int32", |
- "type": "integer" |
- } |
- }, |
- "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" |
} |
}, |
"servicePath": "", |