Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(231)

Issues Search
    My Issues | Starred     Open | Closed | All

Side by Side Diff: discovery/googleapis/spanner__v1.json

Issue 3003493002: Api-Roll 53: 2017-08-21 (Closed)
Patch Set: Created 3 years, 4 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 unified diff | Download patch
« no previous file with comments | « discovery/googleapis/sourcerepo__v1.json ('k') | discovery/googleapis/speech__v1.json » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
1 { 1 {
2 "auth": { 2 "auth": {
3 "oauth2": { 3 "oauth2": {
4 "scopes": { 4 "scopes": {
5 "https://www.googleapis.com/auth/spanner.admin": { 5 "https://www.googleapis.com/auth/spanner.admin": {
6 "description": "Administer your Spanner databases" 6 "description": "Administer your Spanner databases"
7 }, 7 },
8 "https://www.googleapis.com/auth/cloud-platform": { 8 "https://www.googleapis.com/auth/cloud-platform": {
9 "description": "View and manage your data across Google Clou d Platform services" 9 "description": "View and manage your data across Google Clou d Platform services"
10 }, 10 },
(...skipping 13 matching lines...) Expand all
24 "icons": { 24 "icons": {
25 "x16": "http://www.google.com/images/icons/product/search-16.gif", 25 "x16": "http://www.google.com/images/icons/product/search-16.gif",
26 "x32": "http://www.google.com/images/icons/product/search-32.gif" 26 "x32": "http://www.google.com/images/icons/product/search-32.gif"
27 }, 27 },
28 "id": "spanner:v1", 28 "id": "spanner:v1",
29 "kind": "discovery#restDescription", 29 "kind": "discovery#restDescription",
30 "name": "spanner", 30 "name": "spanner",
31 "ownerDomain": "google.com", 31 "ownerDomain": "google.com",
32 "ownerName": "Google", 32 "ownerName": "Google",
33 "parameters": { 33 "parameters": {
34 "access_token": {
35 "description": "OAuth access token.",
36 "location": "query",
37 "type": "string"
38 },
39 "key": {
40 "description": "API key. Your API key identifies your project and pr ovides you with API access, quota, and reports. Required unless you provide an O Auth 2.0 token.",
41 "location": "query",
42 "type": "string"
43 },
44 "quotaUser": {
45 "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exc eed 40 characters.",
46 "location": "query",
47 "type": "string"
48 },
49 "pp": {
50 "default": "true",
51 "description": "Pretty-print response.",
52 "location": "query",
53 "type": "boolean"
54 },
55 "bearer_token": {
56 "description": "OAuth bearer token.",
57 "location": "query",
58 "type": "string"
59 },
60 "oauth_token": {
61 "description": "OAuth 2.0 token for the current user.",
62 "location": "query",
63 "type": "string"
64 },
34 "upload_protocol": { 65 "upload_protocol": {
35 "description": "Upload protocol for media (e.g. \"raw\", \"multipart \").", 66 "description": "Upload protocol for media (e.g. \"raw\", \"multipart \").",
36 "location": "query", 67 "location": "query",
37 "type": "string" 68 "type": "string"
38 }, 69 },
39 "prettyPrint": { 70 "prettyPrint": {
40 "default": "true", 71 "default": "true",
41 "description": "Returns response with indentations and line breaks." , 72 "description": "Returns response with indentations and line breaks." ,
42 "location": "query", 73 "location": "query",
43 "type": "boolean" 74 "type": "boolean"
44 }, 75 },
76 "uploadType": {
77 "description": "Legacy upload protocol for media (e.g. \"media\", \" multipart\").",
78 "location": "query",
79 "type": "string"
80 },
45 "fields": { 81 "fields": {
46 "description": "Selector specifying which fields to include in a par tial response.", 82 "description": "Selector specifying which fields to include in a par tial response.",
47 "location": "query", 83 "location": "query",
48 "type": "string" 84 "type": "string"
49 }, 85 },
50 "uploadType": {
51 "description": "Legacy upload protocol for media (e.g. \"media\", \" multipart\").",
52 "location": "query",
53 "type": "string"
54 },
55 "$.xgafv": { 86 "$.xgafv": {
56 "description": "V1 error format.", 87 "description": "V1 error format.",
57 "enum": [ 88 "enum": [
58 "1", 89 "1",
59 "2" 90 "2"
60 ], 91 ],
61 "enumDescriptions": [ 92 "enumDescriptions": [
62 "v1 error format", 93 "v1 error format",
63 "v2 error format" 94 "v2 error format"
64 ], 95 ],
(...skipping 13 matching lines...) Expand all
78 "media", 109 "media",
79 "proto" 110 "proto"
80 ], 111 ],
81 "enumDescriptions": [ 112 "enumDescriptions": [
82 "Responses with Content-Type of application/json", 113 "Responses with Content-Type of application/json",
83 "Media download with context-dependent Content-Type", 114 "Media download with context-dependent Content-Type",
84 "Responses with Content-Type of application/x-protobuf" 115 "Responses with Content-Type of application/x-protobuf"
85 ], 116 ],
86 "location": "query", 117 "location": "query",
87 "type": "string" 118 "type": "string"
88 },
89 "access_token": {
90 "description": "OAuth access token.",
91 "location": "query",
92 "type": "string"
93 },
94 "key": {
95 "description": "API key. Your API key identifies your project and pr ovides you with API access, quota, and reports. Required unless you provide an O Auth 2.0 token.",
96 "location": "query",
97 "type": "string"
98 },
99 "quotaUser": {
100 "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exc eed 40 characters.",
101 "location": "query",
102 "type": "string"
103 },
104 "pp": {
105 "default": "true",
106 "description": "Pretty-print response.",
107 "location": "query",
108 "type": "boolean"
109 },
110 "bearer_token": {
111 "description": "OAuth bearer token.",
112 "location": "query",
113 "type": "string"
114 },
115 "oauth_token": {
116 "description": "OAuth 2.0 token for the current user.",
117 "location": "query",
118 "type": "string"
119 } 119 }
120 }, 120 },
121 "protocol": "rest", 121 "protocol": "rest",
122 "resources": { 122 "resources": {
123 "projects": { 123 "projects": {
124 "resources": { 124 "resources": {
125 "instanceConfigs": { 125 "instances": {
126 "methods": { 126 "methods": {
127 "get": { 127 "get": {
128 "description": "Gets information about a particular instance configuration.", 128 "description": "Gets information about a particular instance.",
129 "httpMethod": "GET", 129 "httpMethod": "GET",
130 "id": "spanner.projects.instanceConfigs.get", 130 "id": "spanner.projects.instances.get",
131 "parameterOrder": [ 131 "parameterOrder": [
132 "name" 132 "name"
133 ], 133 ],
134 "parameters": { 134 "parameters": {
135 "name": { 135 "name": {
136 "description": "Required. The name of the re quested instance configuration. Values are of\nthe form `projects/<project>/inst anceConfigs/<config>`.", 136 "description": "Required. The name of the re quested instance. Values are of the form\n`projects/<project>/instances/<instanc e>`.",
137 "location": "path", 137 "location": "path",
138 "pattern": "^projects/[^/]+/instanceConfigs/ [^/]+$", 138 "pattern": "^projects/[^/]+/instances/[^/]+$ ",
139 "required": true, 139 "required": true,
140 "type": "string" 140 "type": "string"
141 } 141 }
142 }, 142 },
143 "path": "v1/{+name}", 143 "path": "v1/{+name}",
144 "response": { 144 "response": {
145 "$ref": "InstanceConfig" 145 "$ref": "Instance"
146 }, 146 },
147 "scopes": [ 147 "scopes": [
148 "https://www.googleapis.com/auth/cloud-platform" , 148 "https://www.googleapis.com/auth/cloud-platform" ,
149 "https://www.googleapis.com/auth/spanner.admin" 149 "https://www.googleapis.com/auth/spanner.admin"
150 ] 150 ]
151 }, 151 },
152 "list": { 152 "patch": {
153 "description": "Lists the supported instance configu rations for a given project.", 153 "description": "Updates an instance, and begins allo cating or releasing resources\nas requested. The returned long-running\noperatio n can be used to track the\nprogress of updating the instance. If the named inst ance does not\nexist, returns `NOT_FOUND`.\n\nImmediately upon completion of thi s request:\n\n * For resource types for which a decrease in the instance's allo cation\n has been requested, billing is based on the newly-requested level.\n \nUntil completion of the returned operation:\n\n * Cancelling the operation se ts its metadata's\n cancel_time, and begins\n restoring resources to their pre-request values. The operation\n is guaranteed to succeed at undoing all resource changes,\n after which point it terminates with a `CANCELLED` status .\n * All other attempts to modify the instance are rejected.\n * Reading the instance via the API continues to give the pre-request\n resource levels.\n\n Upon completion of the returned operation:\n\n * Billing begins for all success fully-allocated resources (some types\n may have lower than the requested lev els).\n * All newly-reserved resources are available for serving the instance's \n tables.\n * The instance's new resource levels are readable via the API.\ n\nThe returned long-running operation will\nhave a name of the format `<instanc e_name>/operations/<operation_id>` and\ncan be used to track the instance modifi cation. The\nmetadata field type is\nUpdateInstanceMetadata.\nThe response fiel d type is\nInstance, if successful.\n\nAuthorization requires `spanner.instances .update` permission on\nresource name.",
154 "httpMethod": "GET", 154 "httpMethod": "PATCH",
155 "id": "spanner.projects.instanceConfigs.list", 155 "id": "spanner.projects.instances.patch",
156 "parameterOrder": [ 156 "parameterOrder": [
157 "parent" 157 "name"
158 ], 158 ],
159 "parameters": { 159 "parameters": {
160 "parent": { 160 "name": {
161 "description": "Required. The name of the pr oject for which a list of supported instance\nconfigurations is requested. Value s are of the form\n`projects/<project>`.", 161 "description": "Required. A unique identifie r for the instance, which cannot be changed\nafter the instance is created. Valu es are of the form\n`projects/<project>/instances/a-z*[a-z0-9]`. The final\nsegm ent of the name must be between 6 and 30 characters in length.",
162 "location": "path", 162 "location": "path",
163 "pattern": "^projects/[^/]+$", 163 "pattern": "^projects/[^/]+/instances/[^/]+$ ",
164 "required": true, 164 "required": true,
165 "type": "string" 165 "type": "string"
166 },
167 "pageToken": {
168 "description": "If non-empty, `page_token` s hould contain a\nnext_page_token\nfrom a previous ListInstanceConfigsResponse.",
169 "location": "query",
170 "type": "string"
171 },
172 "pageSize": {
173 "description": "Number of instance configura tions to be returned in the response. If 0 or\nless, defaults to the server's ma ximum allowed page size.",
174 "format": "int32",
175 "location": "query",
176 "type": "integer"
177 } 166 }
178 }, 167 },
179 "path": "v1/{+parent}/instanceConfigs", 168 "path": "v1/{+name}",
169 "request": {
170 "$ref": "UpdateInstanceRequest"
171 },
180 "response": { 172 "response": {
181 "$ref": "ListInstanceConfigsResponse" 173 "$ref": "Operation"
182 }, 174 },
183 "scopes": [ 175 "scopes": [
184 "https://www.googleapis.com/auth/cloud-platform" , 176 "https://www.googleapis.com/auth/cloud-platform" ,
185 "https://www.googleapis.com/auth/spanner.admin" 177 "https://www.googleapis.com/auth/spanner.admin"
186 ] 178 ]
187 } 179 },
188 } 180 "testIamPermissions": {
189 }, 181 "description": "Returns permissions that the caller has on the specified instance resource.\n\nAttempting this RPC on a non-existent Cloud Spanner instance resource will\nresult in a NOT_FOUND error if the user h as `spanner.instances.list`\npermission on the containing Google Cloud Project. Otherwise returns an\nempty set of permissions.",
190 "instances": { 182 "httpMethod": "POST",
191 "methods": { 183 "id": "spanner.projects.instances.testIamPermissions ",
184 "parameterOrder": [
185 "resource"
186 ],
187 "parameters": {
188 "resource": {
189 "description": "REQUIRED: The Cloud Spanner resource for which permissions are being tested. The format is `projects/<projec t ID>/instances/<instance ID>` for instance resources and `projects/<project ID> /instances/<instance ID>/databases/<database ID>` for database resources.",
190 "location": "path",
191 "pattern": "^projects/[^/]+/instances/[^/]+$ ",
192 "required": true,
193 "type": "string"
194 }
195 },
196 "path": "v1/{+resource}:testIamPermissions",
197 "request": {
198 "$ref": "TestIamPermissionsRequest"
199 },
200 "response": {
201 "$ref": "TestIamPermissionsResponse"
202 },
203 "scopes": [
204 "https://www.googleapis.com/auth/cloud-platform" ,
205 "https://www.googleapis.com/auth/spanner.admin"
206 ]
207 },
192 "delete": { 208 "delete": {
193 "description": "Deletes an instance.\n\nImmediately upon completion of the request:\n\n * Billing ceases for all of the instance's reserved resources.\n\nSoon afterward:\n\n * The instance and *all of its datab ases* immediately and\n irrevocably disappear from the API. All data in the d atabases\n is permanently deleted.", 209 "description": "Deletes an instance.\n\nImmediately upon completion of the request:\n\n * Billing ceases for all of the instance's reserved resources.\n\nSoon afterward:\n\n * The instance and *all of its datab ases* immediately and\n irrevocably disappear from the API. All data in the d atabases\n is permanently deleted.",
194 "httpMethod": "DELETE", 210 "httpMethod": "DELETE",
195 "id": "spanner.projects.instances.delete", 211 "id": "spanner.projects.instances.delete",
196 "parameterOrder": [ 212 "parameterOrder": [
197 "name" 213 "name"
198 ], 214 ],
199 "parameters": { 215 "parameters": {
200 "name": { 216 "name": {
201 "description": "Required. The name of the in stance to be deleted. Values are of the form\n`projects/<project>/instances/<ins tance>`", 217 "description": "Required. The name of the in stance to be deleted. Values are of the form\n`projects/<project>/instances/<ins tance>`",
(...skipping 13 matching lines...) Expand all
215 ] 231 ]
216 }, 232 },
217 "list": { 233 "list": {
218 "description": "Lists all instances in the given pro ject.", 234 "description": "Lists all instances in the given pro ject.",
219 "httpMethod": "GET", 235 "httpMethod": "GET",
220 "id": "spanner.projects.instances.list", 236 "id": "spanner.projects.instances.list",
221 "parameterOrder": [ 237 "parameterOrder": [
222 "parent" 238 "parent"
223 ], 239 ],
224 "parameters": { 240 "parameters": {
225 "parent": {
226 "description": "Required. The name of the pr oject for which a list of instances is\nrequested. Values are of the form `proje cts/<project>`.",
227 "location": "path",
228 "pattern": "^projects/[^/]+$",
229 "required": true,
230 "type": "string"
231 },
232 "filter": {
233 "description": "An expression for filtering the results of the request. Filter rules are\ncase insensitive. The fields eligi ble for filtering are:\n\n * name\n * display_name\n * labels.key where key i s the name of a label\n\nSome examples of using filters are:\n\n * name:* --> T he instance has a name.\n * name:Howl --> The instance's name contains the stri ng \"howl\".\n * name:HOWL --> Equivalent to above.\n * NAME:howl --> Equivale nt to above.\n * labels.env:* --> The instance has the label \"env\".\n * labe ls.env:dev --> The instance has the label \"env\" and the value of\n the label contains the string \"dev\".\n * name:howl labels.env:dev --> The instance's name contains \"howl\" and\n it has the label \"env\" with its value\n contai ning \"dev\".",
234 "location": "query",
235 "type": "string"
236 },
237 "pageToken": { 241 "pageToken": {
238 "description": "If non-empty, `page_token` s hould contain a\nnext_page_token from a\nprevious ListInstancesResponse.", 242 "description": "If non-empty, `page_token` s hould contain a\nnext_page_token from a\nprevious ListInstancesResponse.",
239 "location": "query", 243 "location": "query",
240 "type": "string" 244 "type": "string"
241 }, 245 },
242 "pageSize": { 246 "pageSize": {
243 "description": "Number of instances to be re turned in the response. If 0 or less, defaults\nto the server's maximum allowed page size.", 247 "description": "Number of instances to be re turned in the response. If 0 or less, defaults\nto the server's maximum allowed page size.",
244 "format": "int32", 248 "format": "int32",
245 "location": "query", 249 "location": "query",
246 "type": "integer" 250 "type": "integer"
251 },
252 "parent": {
253 "description": "Required. The name of the pr oject for which a list of instances is\nrequested. Values are of the form `proje cts/<project>`.",
254 "location": "path",
255 "pattern": "^projects/[^/]+$",
256 "required": true,
257 "type": "string"
258 },
259 "filter": {
260 "description": "An expression for filtering the results of the request. Filter rules are\ncase insensitive. The fields eligi ble for filtering are:\n\n * name\n * display_name\n * labels.key where key i s the name of a label\n\nSome examples of using filters are:\n\n * name:* --> T he instance has a name.\n * name:Howl --> The instance's name contains the stri ng \"howl\".\n * name:HOWL --> Equivalent to above.\n * NAME:howl --> Equivale nt to above.\n * labels.env:* --> The instance has the label \"env\".\n * labe ls.env:dev --> The instance has the label \"env\" and the value of\n the label contains the string \"dev\".\n * name:howl labels.env:dev --> The instance's name contains \"howl\" and\n it has the label \"env\" with its value\n contai ning \"dev\".",
261 "location": "query",
262 "type": "string"
247 } 263 }
248 }, 264 },
249 "path": "v1/{+parent}/instances", 265 "path": "v1/{+parent}/instances",
250 "response": { 266 "response": {
251 "$ref": "ListInstancesResponse" 267 "$ref": "ListInstancesResponse"
252 }, 268 },
253 "scopes": [ 269 "scopes": [
254 "https://www.googleapis.com/auth/cloud-platform" , 270 "https://www.googleapis.com/auth/cloud-platform" ,
255 "https://www.googleapis.com/auth/spanner.admin"
256 ]
257 },
258 "setIamPolicy": {
259 "description": "Sets the access control policy on an instance resource. Replaces any\nexisting policy.\n\nAuthorization requires `sp anner.instances.setIamPolicy` on\nresource.",
260 "httpMethod": "POST",
261 "id": "spanner.projects.instances.setIamPolicy",
262 "parameterOrder": [
263 "resource"
264 ],
265 "parameters": {
266 "resource": {
267 "description": "REQUIRED: The Cloud Spanner resource for which the policy is being set. The format is `projects/<project ID> /instances/<instance ID>` for instance resources and `projects/<project ID>/inst ances/<instance ID>/databases/<database ID>` for databases resources.",
268 "location": "path",
269 "pattern": "^projects/[^/]+/instances/[^/]+$ ",
270 "required": true,
271 "type": "string"
272 }
273 },
274 "path": "v1/{+resource}:setIamPolicy",
275 "request": {
276 "$ref": "SetIamPolicyRequest"
277 },
278 "response": {
279 "$ref": "Policy"
280 },
281 "scopes": [
282 "https://www.googleapis.com/auth/cloud-platform" ,
283 "https://www.googleapis.com/auth/spanner.admin" 271 "https://www.googleapis.com/auth/spanner.admin"
284 ] 272 ]
285 }, 273 },
286 "create": { 274 "create": {
287 "description": "Creates an instance and begins prepa ring it to begin serving. The\nreturned long-running operation\ncan be used to t rack the progress of preparing the new\ninstance. The instance name is assigned by the caller. If the\nnamed instance already exists, `CreateInstance` returns\n `ALREADY_EXISTS`.\n\nImmediately upon completion of this request:\n\n * The ins tance is readable via the API, with all requested attributes\n but no allocat ed resources. Its state is `CREATING`.\n\nUntil completion of the returned opera tion:\n\n * Cancelling the operation renders the instance immediately unreadabl e\n via the API.\n * The instance can be deleted.\n * All other attempts to modify the instance are rejected.\n\nUpon completion of the returned operation: \n\n * Billing for all successfully-allocated resources begins (some types\n may have lower than the requested levels).\n * Databases can be created in the instance.\n * The instance's allocated resource levels are readable via the AP I.\n * The instance's state becomes `READY`.\n\nThe returned long-running opera tion will\nhave a name of the format `<instance_name>/operations/<operation_id>` and\ncan be used to track creation of the instance. The\nmetadata field type i s\nCreateInstanceMetadata.\nThe response field type is\nInstance, if successful. ", 275 "description": "Creates an instance and begins prepa ring it to begin serving. The\nreturned long-running operation\ncan be used to t rack the progress of preparing the new\ninstance. The instance name is assigned by the caller. If the\nnamed instance already exists, `CreateInstance` returns\n `ALREADY_EXISTS`.\n\nImmediately upon completion of this request:\n\n * The ins tance is readable via the API, with all requested attributes\n but no allocat ed resources. Its state is `CREATING`.\n\nUntil completion of the returned opera tion:\n\n * Cancelling the operation renders the instance immediately unreadabl e\n via the API.\n * The instance can be deleted.\n * All other attempts to modify the instance are rejected.\n\nUpon completion of the returned operation: \n\n * Billing for all successfully-allocated resources begins (some types\n may have lower than the requested levels).\n * Databases can be created in the instance.\n * The instance's allocated resource levels are readable via the AP I.\n * The instance's state becomes `READY`.\n\nThe returned long-running opera tion will\nhave a name of the format `<instance_name>/operations/<operation_id>` and\ncan be used to track creation of the instance. The\nmetadata field type i s\nCreateInstanceMetadata.\nThe response field type is\nInstance, if successful. ",
288 "httpMethod": "POST", 276 "httpMethod": "POST",
289 "id": "spanner.projects.instances.create", 277 "id": "spanner.projects.instances.create",
290 "parameterOrder": [ 278 "parameterOrder": [
291 "parent" 279 "parent"
292 ], 280 ],
(...skipping 11 matching lines...) Expand all
304 "$ref": "CreateInstanceRequest" 292 "$ref": "CreateInstanceRequest"
305 }, 293 },
306 "response": { 294 "response": {
307 "$ref": "Operation" 295 "$ref": "Operation"
308 }, 296 },
309 "scopes": [ 297 "scopes": [
310 "https://www.googleapis.com/auth/cloud-platform" , 298 "https://www.googleapis.com/auth/cloud-platform" ,
311 "https://www.googleapis.com/auth/spanner.admin" 299 "https://www.googleapis.com/auth/spanner.admin"
312 ] 300 ]
313 }, 301 },
314 "getIamPolicy": { 302 "setIamPolicy": {
315 "description": "Gets the access control policy for a n instance resource. Returns an empty\npolicy if an instance exists but does not have a policy set.\n\nAuthorization requires `spanner.instances.getIamPolicy` o n\nresource.", 303 "description": "Sets the access control policy on an instance resource. Replaces any\nexisting policy.\n\nAuthorization requires `sp anner.instances.setIamPolicy` on\nresource.",
316 "httpMethod": "POST", 304 "httpMethod": "POST",
317 "id": "spanner.projects.instances.getIamPolicy", 305 "id": "spanner.projects.instances.setIamPolicy",
318 "parameterOrder": [ 306 "parameterOrder": [
319 "resource" 307 "resource"
320 ], 308 ],
321 "parameters": { 309 "parameters": {
322 "resource": { 310 "resource": {
323 "description": "REQUIRED: The Cloud Spanner resource for which the policy is being retrieved. The format is `projects/<proje ct ID>/instances/<instance ID>` for instance resources and `projects/<project ID >/instances/<instance ID>/databases/<database ID>` for database resources.", 311 "description": "REQUIRED: The Cloud Spanner resource for which the policy is being set. The format is `projects/<project ID> /instances/<instance ID>` for instance resources and `projects/<project ID>/inst ances/<instance ID>/databases/<database ID>` for databases resources.",
324 "location": "path", 312 "location": "path",
325 "pattern": "^projects/[^/]+/instances/[^/]+$ ", 313 "pattern": "^projects/[^/]+/instances/[^/]+$ ",
326 "required": true, 314 "required": true,
327 "type": "string" 315 "type": "string"
328 } 316 }
329 }, 317 },
330 "path": "v1/{+resource}:getIamPolicy", 318 "path": "v1/{+resource}:setIamPolicy",
331 "request": { 319 "request": {
332 "$ref": "GetIamPolicyRequest" 320 "$ref": "SetIamPolicyRequest"
333 }, 321 },
334 "response": { 322 "response": {
335 "$ref": "Policy" 323 "$ref": "Policy"
336 }, 324 },
337 "scopes": [ 325 "scopes": [
338 "https://www.googleapis.com/auth/cloud-platform" , 326 "https://www.googleapis.com/auth/cloud-platform" ,
339 "https://www.googleapis.com/auth/spanner.admin" 327 "https://www.googleapis.com/auth/spanner.admin"
340 ] 328 ]
341 }, 329 },
342 "patch": { 330 "getIamPolicy": {
343 "description": "Updates an instance, and begins allo cating or releasing resources\nas requested. The returned long-running\noperatio n can be used to track the\nprogress of updating the instance. If the named inst ance does not\nexist, returns `NOT_FOUND`.\n\nImmediately upon completion of thi s request:\n\n * For resource types for which a decrease in the instance's allo cation\n has been requested, billing is based on the newly-requested level.\n \nUntil completion of the returned operation:\n\n * Cancelling the operation se ts its metadata's\n cancel_time, and begins\n restoring resources to their pre-request values. The operation\n is guaranteed to succeed at undoing all resource changes,\n after which point it terminates with a `CANCELLED` status .\n * All other attempts to modify the instance are rejected.\n * Reading the instance via the API continues to give the pre-request\n resource levels.\n\n Upon completion of the returned operation:\n\n * Billing begins for all success fully-allocated resources (some types\n may have lower than the requested lev els).\n * All newly-reserved resources are available for serving the instance's \n tables.\n * The instance's new resource levels are readable via the API.\ n\nThe returned long-running operation will\nhave a name of the format `<instanc e_name>/operations/<operation_id>` and\ncan be used to track the instance modifi cation. The\nmetadata field type is\nUpdateInstanceMetadata.\nThe response fiel d type is\nInstance, if successful.\n\nAuthorization requires `spanner.instances .update` permission on\nresource name.", 331 "description": "Gets the access control policy for a n instance resource. Returns an empty\npolicy if an instance exists but does not have a policy set.\n\nAuthorization requires `spanner.instances.getIamPolicy` o n\nresource.",
344 "httpMethod": "PATCH", 332 "httpMethod": "POST",
345 "id": "spanner.projects.instances.patch", 333 "id": "spanner.projects.instances.getIamPolicy",
346 "parameterOrder": [ 334 "parameterOrder": [
347 "name" 335 "resource"
348 ], 336 ],
349 "parameters": { 337 "parameters": {
350 "name": { 338 "resource": {
351 "description": "Required. A unique identifie r for the instance, which cannot be changed\nafter the instance is created. Valu es are of the form\n`projects/<project>/instances/a-z*[a-z0-9]`. The final\nsegm ent of the name must be between 6 and 30 characters in length.", 339 "description": "REQUIRED: The Cloud Spanner resource for which the policy is being retrieved. The format is `projects/<proje ct ID>/instances/<instance ID>` for instance resources and `projects/<project ID >/instances/<instance ID>/databases/<database ID>` for database resources.",
352 "location": "path", 340 "location": "path",
353 "pattern": "^projects/[^/]+/instances/[^/]+$ ", 341 "pattern": "^projects/[^/]+/instances/[^/]+$ ",
354 "required": true, 342 "required": true,
355 "type": "string" 343 "type": "string"
356 } 344 }
357 }, 345 },
358 "path": "v1/{+name}", 346 "path": "v1/{+resource}:getIamPolicy",
359 "request": { 347 "request": {
360 "$ref": "UpdateInstanceRequest" 348 "$ref": "GetIamPolicyRequest"
361 }, 349 },
362 "response": { 350 "response": {
363 "$ref": "Operation" 351 "$ref": "Policy"
364 }, 352 },
365 "scopes": [ 353 "scopes": [
366 "https://www.googleapis.com/auth/cloud-platform" , 354 "https://www.googleapis.com/auth/cloud-platform" ,
367 "https://www.googleapis.com/auth/spanner.admin"
368 ]
369 },
370 "get": {
371 "description": "Gets information about a particular instance.",
372 "httpMethod": "GET",
373 "id": "spanner.projects.instances.get",
374 "parameterOrder": [
375 "name"
376 ],
377 "parameters": {
378 "name": {
379 "description": "Required. The name of the re quested instance. Values are of the form\n`projects/<project>/instances/<instanc e>`.",
380 "location": "path",
381 "pattern": "^projects/[^/]+/instances/[^/]+$ ",
382 "required": true,
383 "type": "string"
384 }
385 },
386 "path": "v1/{+name}",
387 "response": {
388 "$ref": "Instance"
389 },
390 "scopes": [
391 "https://www.googleapis.com/auth/cloud-platform" ,
392 "https://www.googleapis.com/auth/spanner.admin"
393 ]
394 },
395 "testIamPermissions": {
396 "description": "Returns permissions that the caller has on the specified instance resource.\n\nAttempting this RPC on a non-existent Cloud Spanner instance resource will\nresult in a NOT_FOUND error if the user h as `spanner.instances.list`\npermission on the containing Google Cloud Project. Otherwise returns an\nempty set of permissions.",
397 "httpMethod": "POST",
398 "id": "spanner.projects.instances.testIamPermissions ",
399 "parameterOrder": [
400 "resource"
401 ],
402 "parameters": {
403 "resource": {
404 "description": "REQUIRED: The Cloud Spanner resource for which permissions are being tested. The format is `projects/<projec t ID>/instances/<instance ID>` for instance resources and `projects/<project ID> /instances/<instance ID>/databases/<database ID>` for database resources.",
405 "location": "path",
406 "pattern": "^projects/[^/]+/instances/[^/]+$ ",
407 "required": true,
408 "type": "string"
409 }
410 },
411 "path": "v1/{+resource}:testIamPermissions",
412 "request": {
413 "$ref": "TestIamPermissionsRequest"
414 },
415 "response": {
416 "$ref": "TestIamPermissionsResponse"
417 },
418 "scopes": [
419 "https://www.googleapis.com/auth/cloud-platform" ,
420 "https://www.googleapis.com/auth/spanner.admin" 355 "https://www.googleapis.com/auth/spanner.admin"
421 ] 356 ]
422 } 357 }
423 }, 358 },
424 "resources": { 359 "resources": {
425 "databases": { 360 "operations": {
426 "methods": { 361 "methods": {
427 "setIamPolicy": { 362 "get": {
428 "description": "Sets the access control poli cy on a database resource. Replaces any\nexisting policy.\n\nAuthorization requi res `spanner.databases.setIamPolicy` permission on\nresource.", 363 "description": "Gets the latest state of a l ong-running operation. Clients can use this\nmethod to poll the operation resul t at intervals as recommended by the API\nservice.",
429 "httpMethod": "POST", 364 "httpMethod": "GET",
430 "id": "spanner.projects.instances.databases. setIamPolicy", 365 "id": "spanner.projects.instances.operations .get",
431 "parameterOrder": [ 366 "parameterOrder": [
432 "resource" 367 "name"
433 ], 368 ],
434 "parameters": { 369 "parameters": {
435 "resource": { 370 "name": {
436 "description": "REQUIRED: The Cloud Spanner resource for which the policy is being set. The format is `projects/<pro ject ID>/instances/<instance ID>` for instance resources and `projects/<project ID>/instances/<instance ID>/databases/<database ID>` for databases resources.", 371 "description": "The name of the oper ation resource.",
437 "location": "path", 372 "location": "path",
438 "pattern": "^projects/[^/]+/instance s/[^/]+/databases/[^/]+$", 373 "pattern": "^projects/[^/]+/instance s/[^/]+/operations/[^/]+$",
439 "required": true, 374 "required": true,
440 "type": "string" 375 "type": "string"
441 } 376 }
442 }, 377 },
443 "path": "v1/{+resource}:setIamPolicy", 378 "path": "v1/{+name}",
444 "request": {
445 "$ref": "SetIamPolicyRequest"
446 },
447 "response": {
448 "$ref": "Policy"
449 },
450 "scopes": [
451 "https://www.googleapis.com/auth/cloud-p latform",
452 "https://www.googleapis.com/auth/spanner .admin"
453 ]
454 },
455 "create": {
456 "description": "Creates a new Cloud Spanner database and starts to prepare it for serving.\nThe returned long-running operat ion will\nhave a name of the format `<database_name>/operations/<operation_id>` and\ncan be used to track preparation of the database. The\nmetadata field type is\nCreateDatabaseMetadata. The\nresponse field type is\nDatabase, if successful .",
457 "httpMethod": "POST",
458 "id": "spanner.projects.instances.databases. create",
459 "parameterOrder": [
460 "parent"
461 ],
462 "parameters": {
463 "parent": {
464 "description": "Required. The name o f the instance that will serve the new database.\nValues are of the form `projec ts/<project>/instances/<instance>`.",
465 "location": "path",
466 "pattern": "^projects/[^/]+/instance s/[^/]+$",
467 "required": true,
468 "type": "string"
469 }
470 },
471 "path": "v1/{+parent}/databases",
472 "request": {
473 "$ref": "CreateDatabaseRequest"
474 },
475 "response": { 379 "response": {
476 "$ref": "Operation" 380 "$ref": "Operation"
477 }, 381 },
478 "scopes": [ 382 "scopes": [
479 "https://www.googleapis.com/auth/cloud-p latform", 383 "https://www.googleapis.com/auth/cloud-p latform",
480 "https://www.googleapis.com/auth/spanner .admin" 384 "https://www.googleapis.com/auth/spanner .admin"
481 ] 385 ]
482 }, 386 },
483 "getIamPolicy": { 387 "list": {
484 "description": "Gets the access control poli cy for a database resource. Returns an empty\npolicy if a database exists but do es not have a policy set.\n\nAuthorization requires `spanner.databases.getIamPol icy` permission on\nresource.", 388 "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/o perations`. To\noverride the binding, API services can add a binding such as\n`\ "/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id.",
485 "httpMethod": "POST", 389 "httpMethod": "GET",
486 "id": "spanner.projects.instances.databases. getIamPolicy", 390 "id": "spanner.projects.instances.operations .list",
487 "parameterOrder": [ 391 "parameterOrder": [
488 "resource" 392 "name"
489 ], 393 ],
490 "parameters": { 394 "parameters": {
491 "resource": { 395 "filter": {
492 "description": "REQUIRED: The Cloud Spanner resource for which the policy is being retrieved. The format is `project s/<project ID>/instances/<instance ID>` for instance resources and `projects/<pr oject ID>/instances/<instance ID>/databases/<database ID>` for database resource s.", 396 "description": "The standard list fi lter.",
397 "location": "query",
398 "type": "string"
399 },
400 "pageToken": {
401 "description": "The standard list pa ge token.",
402 "location": "query",
403 "type": "string"
404 },
405 "name": {
406 "description": "The name of the oper ation's parent resource.",
493 "location": "path", 407 "location": "path",
494 "pattern": "^projects/[^/]+/instance s/[^/]+/databases/[^/]+$", 408 "pattern": "^projects/[^/]+/instance s/[^/]+/operations$",
495 "required": true, 409 "required": true,
496 "type": "string" 410 "type": "string"
411 },
412 "pageSize": {
413 "description": "The standard list pa ge size.",
414 "format": "int32",
415 "location": "query",
416 "type": "integer"
497 } 417 }
498 }, 418 },
499 "path": "v1/{+resource}:getIamPolicy", 419 "path": "v1/{+name}",
500 "request": {
501 "$ref": "GetIamPolicyRequest"
502 },
503 "response": { 420 "response": {
504 "$ref": "Policy" 421 "$ref": "ListOperationsResponse"
505 }, 422 },
506 "scopes": [ 423 "scopes": [
507 "https://www.googleapis.com/auth/cloud-p latform", 424 "https://www.googleapis.com/auth/cloud-p latform",
508 "https://www.googleapis.com/auth/spanner .admin" 425 "https://www.googleapis.com/auth/spanner .admin"
509 ] 426 ]
510 }, 427 },
428 "cancel": {
429 "description": "Starts asynchronous cancella tion on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperation s.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellatio n,\nthe operation is not deleted; instead, it becomes an operation with\nan Oper ation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CA NCELLED`.",
430 "httpMethod": "POST",
431 "id": "spanner.projects.instances.operations .cancel",
432 "parameterOrder": [
433 "name"
434 ],
435 "parameters": {
436 "name": {
437 "description": "The name of the oper ation resource to be cancelled.",
438 "location": "path",
439 "pattern": "^projects/[^/]+/instance s/[^/]+/operations/[^/]+$",
440 "required": true,
441 "type": "string"
442 }
443 },
444 "path": "v1/{+name}:cancel",
445 "response": {
446 "$ref": "Empty"
447 },
448 "scopes": [
449 "https://www.googleapis.com/auth/cloud-p latform",
450 "https://www.googleapis.com/auth/spanner .admin"
451 ]
452 },
453 "delete": {
454 "description": "Deletes a long-running opera tion. This method indicates that the client is\nno longer interested in the oper ation result. It does not cancel the\noperation. If the server doesn't support t his method, it returns\n`google.rpc.Code.UNIMPLEMENTED`.",
455 "httpMethod": "DELETE",
456 "id": "spanner.projects.instances.operations .delete",
457 "parameterOrder": [
458 "name"
459 ],
460 "parameters": {
461 "name": {
462 "description": "The name of the oper ation resource to be deleted.",
463 "location": "path",
464 "pattern": "^projects/[^/]+/instance s/[^/]+/operations/[^/]+$",
465 "required": true,
466 "type": "string"
467 }
468 },
469 "path": "v1/{+name}",
470 "response": {
471 "$ref": "Empty"
472 },
473 "scopes": [
474 "https://www.googleapis.com/auth/cloud-p latform",
475 "https://www.googleapis.com/auth/spanner .admin"
476 ]
477 }
478 }
479 },
480 "databases": {
481 "methods": {
511 "get": { 482 "get": {
512 "description": "Gets the state of a Cloud Sp anner database.", 483 "description": "Gets the state of a Cloud Sp anner database.",
513 "httpMethod": "GET", 484 "httpMethod": "GET",
514 "id": "spanner.projects.instances.databases. get", 485 "id": "spanner.projects.instances.databases. get",
515 "parameterOrder": [ 486 "parameterOrder": [
516 "name" 487 "name"
517 ], 488 ],
518 "parameters": { 489 "parameters": {
519 "name": { 490 "name": {
520 "description": "Required. The name o f the requested database. Values are of the form\n`projects/<project>/instances/ <instance>/databases/<database>`.", 491 "description": "Required. The name o f the requested database. Values are of the form\n`projects/<project>/instances/ <instance>/databases/<database>`.",
(...skipping 146 matching lines...) Expand 10 before | Expand all | Expand 10 after
667 } 638 }
668 }, 639 },
669 "path": "v1/{+parent}/databases", 640 "path": "v1/{+parent}/databases",
670 "response": { 641 "response": {
671 "$ref": "ListDatabasesResponse" 642 "$ref": "ListDatabasesResponse"
672 }, 643 },
673 "scopes": [ 644 "scopes": [
674 "https://www.googleapis.com/auth/cloud-p latform", 645 "https://www.googleapis.com/auth/cloud-p latform",
675 "https://www.googleapis.com/auth/spanner .admin" 646 "https://www.googleapis.com/auth/spanner .admin"
676 ] 647 ]
648 },
649 "create": {
650 "description": "Creates a new Cloud Spanner database and starts to prepare it for serving.\nThe returned long-running operat ion will\nhave a name of the format `<database_name>/operations/<operation_id>` and\ncan be used to track preparation of the database. The\nmetadata field type is\nCreateDatabaseMetadata. The\nresponse field type is\nDatabase, if successful .",
651 "httpMethod": "POST",
652 "id": "spanner.projects.instances.databases. create",
653 "parameterOrder": [
654 "parent"
655 ],
656 "parameters": {
657 "parent": {
658 "description": "Required. The name o f the instance that will serve the new database.\nValues are of the form `projec ts/<project>/instances/<instance>`.",
659 "location": "path",
660 "pattern": "^projects/[^/]+/instance s/[^/]+$",
661 "required": true,
662 "type": "string"
663 }
664 },
665 "path": "v1/{+parent}/databases",
666 "request": {
667 "$ref": "CreateDatabaseRequest"
668 },
669 "response": {
670 "$ref": "Operation"
671 },
672 "scopes": [
673 "https://www.googleapis.com/auth/cloud-p latform",
674 "https://www.googleapis.com/auth/spanner .admin"
675 ]
676 },
677 "setIamPolicy": {
678 "description": "Sets the access control poli cy on a database resource. Replaces any\nexisting policy.\n\nAuthorization requi res `spanner.databases.setIamPolicy` permission on\nresource.",
679 "httpMethod": "POST",
680 "id": "spanner.projects.instances.databases. setIamPolicy",
681 "parameterOrder": [
682 "resource"
683 ],
684 "parameters": {
685 "resource": {
686 "description": "REQUIRED: The Cloud Spanner resource for which the policy is being set. The format is `projects/<pro ject ID>/instances/<instance ID>` for instance resources and `projects/<project ID>/instances/<instance ID>/databases/<database ID>` for databases resources.",
687 "location": "path",
688 "pattern": "^projects/[^/]+/instance s/[^/]+/databases/[^/]+$",
689 "required": true,
690 "type": "string"
691 }
692 },
693 "path": "v1/{+resource}:setIamPolicy",
694 "request": {
695 "$ref": "SetIamPolicyRequest"
696 },
697 "response": {
698 "$ref": "Policy"
699 },
700 "scopes": [
701 "https://www.googleapis.com/auth/cloud-p latform",
702 "https://www.googleapis.com/auth/spanner .admin"
703 ]
704 },
705 "getIamPolicy": {
706 "description": "Gets the access control poli cy for a database resource. Returns an empty\npolicy if a database exists but do es not have a policy set.\n\nAuthorization requires `spanner.databases.getIamPol icy` permission on\nresource.",
707 "httpMethod": "POST",
708 "id": "spanner.projects.instances.databases. getIamPolicy",
709 "parameterOrder": [
710 "resource"
711 ],
712 "parameters": {
713 "resource": {
714 "description": "REQUIRED: The Cloud Spanner resource for which the policy is being retrieved. The format is `project s/<project ID>/instances/<instance ID>` for instance resources and `projects/<pr oject ID>/instances/<instance ID>/databases/<database ID>` for database resource s.",
715 "location": "path",
716 "pattern": "^projects/[^/]+/instance s/[^/]+/databases/[^/]+$",
717 "required": true,
718 "type": "string"
719 }
720 },
721 "path": "v1/{+resource}:getIamPolicy",
722 "request": {
723 "$ref": "GetIamPolicyRequest"
724 },
725 "response": {
726 "$ref": "Policy"
727 },
728 "scopes": [
729 "https://www.googleapis.com/auth/cloud-p latform",
730 "https://www.googleapis.com/auth/spanner .admin"
731 ]
677 } 732 }
678 }, 733 },
679 "resources": { 734 "resources": {
680 "sessions": { 735 "sessions": {
681 "methods": { 736 "methods": {
682 "executeStreamingSql": { 737 "get": {
683 "description": "Like ExecuteSql, exc ept returns the result\nset as a stream. Unlike ExecuteSql, there\nis no limit o n the size of the returned result set. However, no\nindividual row in the result set can exceed 100 MiB, and no\ncolumn value can exceed 10 MiB.", 738 "description": "Gets a session. Retu rns `NOT_FOUND` if the session does not exist.\nThis is mainly useful for determ ining whether a session is still\nalive.",
684 "httpMethod": "POST", 739 "httpMethod": "GET",
685 "id": "spanner.projects.instances.da tabases.sessions.executeStreamingSql", 740 "id": "spanner.projects.instances.da tabases.sessions.get",
686 "parameterOrder": [ 741 "parameterOrder": [
687 "session" 742 "name"
688 ], 743 ],
689 "parameters": { 744 "parameters": {
690 "session": { 745 "name": {
691 "description": "Required. Th e session in which the SQL query should be performed.", 746 "description": "Required. Th e name of the session to retrieve.",
692 "location": "path", 747 "location": "path",
693 "pattern": "^projects/[^/]+/ instances/[^/]+/databases/[^/]+/sessions/[^/]+$", 748 "pattern": "^projects/[^/]+/ instances/[^/]+/databases/[^/]+/sessions/[^/]+$",
694 "required": true, 749 "required": true,
695 "type": "string" 750 "type": "string"
696 } 751 }
697 }, 752 },
698 "path": "v1/{+session}:executeStream ingSql", 753 "path": "v1/{+name}",
699 "request": {
700 "$ref": "ExecuteSqlRequest"
701 },
702 "response": { 754 "response": {
703 "$ref": "PartialResultSet" 755 "$ref": "Session"
704 }, 756 },
705 "scopes": [ 757 "scopes": [
706 "https://www.googleapis.com/auth /cloud-platform", 758 "https://www.googleapis.com/auth /cloud-platform",
707 "https://www.googleapis.com/auth /spanner.data" 759 "https://www.googleapis.com/auth /spanner.data"
708 ] 760 ]
709 }, 761 },
710 "commit": { 762 "commit": {
711 "description": "Commits a transactio n. The request includes the mutations to be\napplied to rows in the database.\n\ n`Commit` might return an `ABORTED` error. This can occur at any time;\ncommonly , the cause is conflicts with concurrent\ntransactions. However, it can also hap pen for a variety of other\nreasons. If `Commit` returns `ABORTED`, the caller s hould re-attempt\nthe transaction from the beginning, re-using the same session. ", 763 "description": "Commits a transactio n. The request includes the mutations to be\napplied to rows in the database.\n\ n`Commit` might return an `ABORTED` error. This can occur at any time;\ncommonly , the cause is conflicts with concurrent\ntransactions. However, it can also hap pen for a variety of other\nreasons. If `Commit` returns `ABORTED`, the caller s hould re-attempt\nthe transaction from the beginning, re-using the same session. ",
712 "httpMethod": "POST", 764 "httpMethod": "POST",
713 "id": "spanner.projects.instances.da tabases.sessions.commit", 765 "id": "spanner.projects.instances.da tabases.sessions.commit",
(...skipping 67 matching lines...) Expand 10 before | Expand all | Expand 10 after
781 }, 833 },
782 "path": "v1/{+name}", 834 "path": "v1/{+name}",
783 "response": { 835 "response": {
784 "$ref": "Empty" 836 "$ref": "Empty"
785 }, 837 },
786 "scopes": [ 838 "scopes": [
787 "https://www.googleapis.com/auth /cloud-platform", 839 "https://www.googleapis.com/auth /cloud-platform",
788 "https://www.googleapis.com/auth /spanner.data" 840 "https://www.googleapis.com/auth /spanner.data"
789 ] 841 ]
790 }, 842 },
791 "executeSql": { 843 "executeStreamingSql": {
792 "description": "Executes an SQL quer y, returning all rows in a single reply. This\nmethod cannot be used to return a result set larger than 10 MiB;\nif the query yields more data than that, the qu ery fails with\na `FAILED_PRECONDITION` error.\n\nQueries inside read-write tran sactions might return `ABORTED`. If\nthis occurs, the application should restart the transaction from\nthe beginning. See Transaction for more details.\n\nLarge r result sets can be fetched in streaming fashion by calling\nExecuteStreamingSq l instead.", 844 "description": "Like ExecuteSql, exc ept returns the result\nset as a stream. Unlike ExecuteSql, there\nis no limit o n the size of the returned result set. However, no\nindividual row in the result set can exceed 100 MiB, and no\ncolumn value can exceed 10 MiB.",
793 "httpMethod": "POST", 845 "httpMethod": "POST",
794 "id": "spanner.projects.instances.da tabases.sessions.executeSql", 846 "id": "spanner.projects.instances.da tabases.sessions.executeStreamingSql",
795 "parameterOrder": [ 847 "parameterOrder": [
796 "session" 848 "session"
797 ], 849 ],
798 "parameters": { 850 "parameters": {
799 "session": { 851 "session": {
800 "description": "Required. Th e session in which the SQL query should be performed.", 852 "description": "Required. Th e session in which the SQL query should be performed.",
801 "location": "path", 853 "location": "path",
802 "pattern": "^projects/[^/]+/ instances/[^/]+/databases/[^/]+/sessions/[^/]+$", 854 "pattern": "^projects/[^/]+/ instances/[^/]+/databases/[^/]+/sessions/[^/]+$",
803 "required": true, 855 "required": true,
804 "type": "string" 856 "type": "string"
805 } 857 }
806 }, 858 },
859 "path": "v1/{+session}:executeStream ingSql",
860 "request": {
861 "$ref": "ExecuteSqlRequest"
862 },
863 "response": {
864 "$ref": "PartialResultSet"
865 },
866 "scopes": [
867 "https://www.googleapis.com/auth /cloud-platform",
868 "https://www.googleapis.com/auth /spanner.data"
869 ]
870 },
871 "executeSql": {
872 "description": "Executes an SQL quer y, returning all rows in a single reply. This\nmethod cannot be used to return a result set larger than 10 MiB;\nif the query yields more data than that, the qu ery fails with\na `FAILED_PRECONDITION` error.\n\nQueries inside read-write tran sactions might return `ABORTED`. If\nthis occurs, the application should restart the transaction from\nthe beginning. See Transaction for more details.\n\nLarge r result sets can be fetched in streaming fashion by calling\nExecuteStreamingSq l instead.",
873 "httpMethod": "POST",
874 "id": "spanner.projects.instances.da tabases.sessions.executeSql",
875 "parameterOrder": [
876 "session"
877 ],
878 "parameters": {
879 "session": {
880 "description": "Required. Th e session in which the SQL query should be performed.",
881 "location": "path",
882 "pattern": "^projects/[^/]+/ instances/[^/]+/databases/[^/]+/sessions/[^/]+$",
883 "required": true,
884 "type": "string"
885 }
886 },
807 "path": "v1/{+session}:executeSql", 887 "path": "v1/{+session}:executeSql",
808 "request": { 888 "request": {
809 "$ref": "ExecuteSqlRequest" 889 "$ref": "ExecuteSqlRequest"
810 }, 890 },
811 "response": { 891 "response": {
812 "$ref": "ResultSet" 892 "$ref": "ResultSet"
813 }, 893 },
814 "scopes": [ 894 "scopes": [
815 "https://www.googleapis.com/auth /cloud-platform", 895 "https://www.googleapis.com/auth /cloud-platform",
816 "https://www.googleapis.com/auth /spanner.data" 896 "https://www.googleapis.com/auth /spanner.data"
(...skipping 100 matching lines...) Expand 10 before | Expand all | Expand 10 after
917 "request": { 997 "request": {
918 "$ref": "ReadRequest" 998 "$ref": "ReadRequest"
919 }, 999 },
920 "response": { 1000 "response": {
921 "$ref": "ResultSet" 1001 "$ref": "ResultSet"
922 }, 1002 },
923 "scopes": [ 1003 "scopes": [
924 "https://www.googleapis.com/auth /cloud-platform", 1004 "https://www.googleapis.com/auth /cloud-platform",
925 "https://www.googleapis.com/auth /spanner.data" 1005 "https://www.googleapis.com/auth /spanner.data"
926 ] 1006 ]
927 },
928 "get": {
929 "description": "Gets a session. Retu rns `NOT_FOUND` if the session does not exist.\nThis is mainly useful for determ ining whether a session is still\nalive.",
930 "httpMethod": "GET",
931 "id": "spanner.projects.instances.da tabases.sessions.get",
932 "parameterOrder": [
933 "name"
934 ],
935 "parameters": {
936 "name": {
937 "description": "Required. Th e name of the session to retrieve.",
938 "location": "path",
939 "pattern": "^projects/[^/]+/ instances/[^/]+/databases/[^/]+/sessions/[^/]+$",
940 "required": true,
941 "type": "string"
942 }
943 },
944 "path": "v1/{+name}",
945 "response": {
946 "$ref": "Session"
947 },
948 "scopes": [
949 "https://www.googleapis.com/auth /cloud-platform",
950 "https://www.googleapis.com/auth /spanner.data"
951 ]
952 } 1007 }
953 } 1008 }
954 }, 1009 },
955 "operations": { 1010 "operations": {
956 "methods": { 1011 "methods": {
957 "cancel": { 1012 "cancel": {
958 "description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to ca ncel the operation, but success is not\nguaranteed. If the server doesn't suppo rt this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nO perations.GetOperation or\nother methods to check whether the cancellation succe eded or whether the\noperation completed despite cancellation. On successful can cellation,\nthe operation is not deleted; instead, it becomes an operation with\ nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`.", 1013 "description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to ca ncel the operation, but success is not\nguaranteed. If the server doesn't suppo rt this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nO perations.GetOperation or\nother methods to check whether the cancellation succe eded or whether the\noperation completed despite cancellation. On successful can cellation,\nthe operation is not deleted; instead, it becomes an operation with\ nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`.",
959 "httpMethod": "POST", 1014 "httpMethod": "POST",
960 "id": "spanner.projects.instances.da tabases.operations.cancel", 1015 "id": "spanner.projects.instances.da tabases.operations.cancel",
961 "parameterOrder": [ 1016 "parameterOrder": [
(...skipping 104 matching lines...) Expand 10 before | Expand all | Expand 10 after
1066 "$ref": "ListOperationsResponse" 1121 "$ref": "ListOperationsResponse"
1067 }, 1122 },
1068 "scopes": [ 1123 "scopes": [
1069 "https://www.googleapis.com/auth /cloud-platform", 1124 "https://www.googleapis.com/auth /cloud-platform",
1070 "https://www.googleapis.com/auth /spanner.admin" 1125 "https://www.googleapis.com/auth /spanner.admin"
1071 ] 1126 ]
1072 } 1127 }
1073 } 1128 }
1074 } 1129 }
1075 } 1130 }
1076 },
1077 "operations": {
1078 "methods": {
1079 "cancel": {
1080 "description": "Starts asynchronous cancella tion on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperation s.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellatio n,\nthe operation is not deleted; instead, it becomes an operation with\nan Oper ation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CA NCELLED`.",
1081 "httpMethod": "POST",
1082 "id": "spanner.projects.instances.operations .cancel",
1083 "parameterOrder": [
1084 "name"
1085 ],
1086 "parameters": {
1087 "name": {
1088 "description": "The name of the oper ation resource to be cancelled.",
1089 "location": "path",
1090 "pattern": "^projects/[^/]+/instance s/[^/]+/operations/[^/]+$",
1091 "required": true,
1092 "type": "string"
1093 }
1094 },
1095 "path": "v1/{+name}:cancel",
1096 "response": {
1097 "$ref": "Empty"
1098 },
1099 "scopes": [
1100 "https://www.googleapis.com/auth/cloud-p latform",
1101 "https://www.googleapis.com/auth/spanner .admin"
1102 ]
1103 },
1104 "delete": {
1105 "description": "Deletes a long-running opera tion. This method indicates that the client is\nno longer interested in the oper ation result. It does not cancel the\noperation. If the server doesn't support t his method, it returns\n`google.rpc.Code.UNIMPLEMENTED`.",
1106 "httpMethod": "DELETE",
1107 "id": "spanner.projects.instances.operations .delete",
1108 "parameterOrder": [
1109 "name"
1110 ],
1111 "parameters": {
1112 "name": {
1113 "description": "The name of the oper ation resource to be deleted.",
1114 "location": "path",
1115 "pattern": "^projects/[^/]+/instance s/[^/]+/operations/[^/]+$",
1116 "required": true,
1117 "type": "string"
1118 }
1119 },
1120 "path": "v1/{+name}",
1121 "response": {
1122 "$ref": "Empty"
1123 },
1124 "scopes": [
1125 "https://www.googleapis.com/auth/cloud-p latform",
1126 "https://www.googleapis.com/auth/spanner .admin"
1127 ]
1128 },
1129 "get": {
1130 "description": "Gets the latest state of a l ong-running operation. Clients can use this\nmethod to poll the operation resul t at intervals as recommended by the API\nservice.",
1131 "httpMethod": "GET",
1132 "id": "spanner.projects.instances.operations .get",
1133 "parameterOrder": [
1134 "name"
1135 ],
1136 "parameters": {
1137 "name": {
1138 "description": "The name of the oper ation resource.",
1139 "location": "path",
1140 "pattern": "^projects/[^/]+/instance s/[^/]+/operations/[^/]+$",
1141 "required": true,
1142 "type": "string"
1143 }
1144 },
1145 "path": "v1/{+name}",
1146 "response": {
1147 "$ref": "Operation"
1148 },
1149 "scopes": [
1150 "https://www.googleapis.com/auth/cloud-p latform",
1151 "https://www.googleapis.com/auth/spanner .admin"
1152 ]
1153 },
1154 "list": {
1155 "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/o perations`. To\noverride the binding, API services can add a binding such as\n`\ "/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id.",
1156 "httpMethod": "GET",
1157 "id": "spanner.projects.instances.operations .list",
1158 "parameterOrder": [
1159 "name"
1160 ],
1161 "parameters": {
1162 "filter": {
1163 "description": "The standard list fi lter.",
1164 "location": "query",
1165 "type": "string"
1166 },
1167 "pageToken": {
1168 "description": "The standard list pa ge token.",
1169 "location": "query",
1170 "type": "string"
1171 },
1172 "name": {
1173 "description": "The name of the oper ation's parent resource.",
1174 "location": "path",
1175 "pattern": "^projects/[^/]+/instance s/[^/]+/operations$",
1176 "required": true,
1177 "type": "string"
1178 },
1179 "pageSize": {
1180 "description": "The standard list pa ge size.",
1181 "format": "int32",
1182 "location": "query",
1183 "type": "integer"
1184 }
1185 },
1186 "path": "v1/{+name}",
1187 "response": {
1188 "$ref": "ListOperationsResponse"
1189 },
1190 "scopes": [
1191 "https://www.googleapis.com/auth/cloud-p latform",
1192 "https://www.googleapis.com/auth/spanner .admin"
1193 ]
1194 }
1195 }
1196 } 1131 }
1197 } 1132 }
1133 },
1134 "instanceConfigs": {
1135 "methods": {
1136 "get": {
1137 "description": "Gets information about a particular instance configuration.",
1138 "httpMethod": "GET",
1139 "id": "spanner.projects.instanceConfigs.get",
1140 "parameterOrder": [
1141 "name"
1142 ],
1143 "parameters": {
1144 "name": {
1145 "description": "Required. The name of the re quested instance configuration. Values are of\nthe form `projects/<project>/inst anceConfigs/<config>`.",
1146 "location": "path",
1147 "pattern": "^projects/[^/]+/instanceConfigs/ [^/]+$",
1148 "required": true,
1149 "type": "string"
1150 }
1151 },
1152 "path": "v1/{+name}",
1153 "response": {
1154 "$ref": "InstanceConfig"
1155 },
1156 "scopes": [
1157 "https://www.googleapis.com/auth/cloud-platform" ,
1158 "https://www.googleapis.com/auth/spanner.admin"
1159 ]
1160 },
1161 "list": {
1162 "description": "Lists the supported instance configu rations for a given project.",
1163 "httpMethod": "GET",
1164 "id": "spanner.projects.instanceConfigs.list",
1165 "parameterOrder": [
1166 "parent"
1167 ],
1168 "parameters": {
1169 "parent": {
1170 "description": "Required. The name of the pr oject for which a list of supported instance\nconfigurations is requested. Value s are of the form\n`projects/<project>`.",
1171 "location": "path",
1172 "pattern": "^projects/[^/]+$",
1173 "required": true,
1174 "type": "string"
1175 },
1176 "pageToken": {
1177 "description": "If non-empty, `page_token` s hould contain a\nnext_page_token\nfrom a previous ListInstanceConfigsResponse.",
1178 "location": "query",
1179 "type": "string"
1180 },
1181 "pageSize": {
1182 "description": "Number of instance configura tions to be returned in the response. If 0 or\nless, defaults to the server's ma ximum allowed page size.",
1183 "format": "int32",
1184 "location": "query",
1185 "type": "integer"
1186 }
1187 },
1188 "path": "v1/{+parent}/instanceConfigs",
1189 "response": {
1190 "$ref": "ListInstanceConfigsResponse"
1191 },
1192 "scopes": [
1193 "https://www.googleapis.com/auth/cloud-platform" ,
1194 "https://www.googleapis.com/auth/spanner.admin"
1195 ]
1196 }
1197 }
1198 } 1198 }
1199 } 1199 }
1200 } 1200 }
1201 }, 1201 },
1202 "revision": "20170701", 1202 "revision": "20170726",
1203 "rootUrl": "https://spanner.googleapis.com/", 1203 "rootUrl": "https://spanner.googleapis.com/",
1204 "schemas": { 1204 "schemas": {
1205 "Policy": { 1205 "UpdateInstanceMetadata": {
1206 "description": "Defines an Identity and Access Management (IAM) poli cy. 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,\nG oogle domains, and service accounts. A `role` is a named list of permissions\nde fined 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.gserviceaccoun t.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).", 1206 "description": "Metadata type for the operation returned by\nUpdateI nstance.",
1207 "id": "Policy", 1207 "id": "UpdateInstanceMetadata",
1208 "properties": { 1208 "properties": {
1209 "iamOwned": { 1209 "endTime": {
1210 "type": "boolean" 1210 "description": "The time at which this operation failed or w as completed successfully.",
1211 }, 1211 "format": "google-datetime",
1212 "rules": { 1212 "type": "string"
1213 "description": "If more than one rule is specified, the rule s are applied in the following\nmanner:\n- All matching LOG rules are always app lied.\n- If any DENY/DENY_WITH_LOG rule matches, permission is denied.\n Loggin g will be applied if one or more matching rule requires logging.\n- Otherwise, i f any ALLOW/ALLOW_WITH_LOG rule matches, permission is\n granted.\n Logging wi ll be applied if one or more matching rule requires logging.\n- Otherwise, if no rule applies, permission is denied.", 1213 },
1214 "items": { 1214 "cancelTime": {
1215 "$ref": "Rule" 1215 "description": "The time at which this operation was cancell ed. If set, this operation is\nin the process of undoing itself (which is guaran teed to succeed) and\ncannot be cancelled again.",
1216 }, 1216 "format": "google-datetime",
1217 "type": "array" 1217 "type": "string"
1218 }, 1218 },
1219 "version": { 1219 "startTime": {
1220 "description": "Version of the `Policy`. The default version is 0.", 1220 "description": "The time at which UpdateInstance\nrequest wa s received.",
1221 "format": "int32", 1221 "format": "google-datetime",
1222 "type": "integer" 1222 "type": "string"
1223 }, 1223 },
1224 "auditConfigs": { 1224 "instance": {
1225 "description": "Specifies cloud audit logging configuration for this policy.", 1225 "$ref": "Instance",
1226 "items": { 1226 "description": "The desired end state of the update."
1227 "$ref": "AuditConfig"
1228 },
1229 "type": "array"
1230 },
1231 "bindings": {
1232 "description": "Associates a list of `members` to a `role`.\ n`bindings` with no members will result in an error.",
1233 "items": {
1234 "$ref": "Binding"
1235 },
1236 "type": "array"
1237 },
1238 "etag": {
1239 "description": "`etag` is used for optimistic concurrency co ntrol as a way to help\nprevent simultaneous updates of a policy from overwritin g each other.\nIt is strongly suggested that systems make use of the `etag` in t he\nread-modify-write cycle to perform policy updates in order to avoid race\nco nditions: 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 t heir change will be applied to the same version of the policy.\n\nIf no `etag` i s provided in the call to `setIamPolicy`, then the existing\npolicy is overwritt en blindly.",
1240 "format": "byte",
1241 "type": "string"
1242 }
1243 },
1244 "type": "object"
1245 },
1246 "ReadRequest": {
1247 "description": "The request for Read and\nStreamingRead.",
1248 "id": "ReadRequest",
1249 "properties": {
1250 "limit": {
1251 "description": "If greater than zero, only the first `limit` rows are yielded. If `limit`\nis zero, the default is no limit.",
1252 "format": "int64",
1253 "type": "string"
1254 },
1255 "index": {
1256 "description": "If non-empty, the name of an index on table. This index is\nused instead of the table primary key when interpreting key_set\ nand sorting result rows. See key_set for further information.",
1257 "type": "string"
1258 },
1259 "keySet": {
1260 "$ref": "KeySet",
1261 "description": "Required. `key_set` identifies the rows to b e yielded. `key_set` names the\nprimary keys of the rows in table to be yielded, unless index\nis present. If index is present, then key_set instead names\ninde x keys in index.\n\nRows are yielded in table primary key order (if index is emp ty)\nor index key order (if index is non-empty).\n\nIt is not an error for the ` key_set` to name rows that do not\nexist in the database. Read yields nothing fo r nonexistent rows."
1262 },
1263 "columns": {
1264 "description": "The columns of table to be returned for each row matching\nthis request.",
1265 "items": {
1266 "type": "string"
1267 },
1268 "type": "array"
1269 },
1270 "transaction": {
1271 "$ref": "TransactionSelector",
1272 "description": "The transaction to use. If none is provided, the default is a\ntemporary read-only transaction with strong concurrency."
1273 },
1274 "resumeToken": {
1275 "description": "If this request is resuming a previously int errupted read,\n`resume_token` should be copied from the last\nPartialResultSet yielded before the interruption. Doing this\nenables the new read to resume wher e the last read left off. The\nrest of the request parameters must exactly match the request\nthat yielded this token.",
1276 "format": "byte",
1277 "type": "string"
1278 },
1279 "table": {
1280 "description": "Required. The name of the table in the datab ase to be read.",
1281 "type": "string"
1282 }
1283 },
1284 "type": "object"
1285 },
1286 "Write": {
1287 "description": "Arguments to insert, update, insert_or_update, and\n replace operations.",
1288 "id": "Write",
1289 "properties": {
1290 "table": {
1291 "description": "Required. The table whose rows will be writt en.",
1292 "type": "string"
1293 },
1294 "values": {
1295 "description": "The values to be written. `values` can conta in more than one\nlist of values. If it does, then multiple rows are written, on e\nfor each entry in `values`. Each list in `values` must have\nexactly as many entries as there are entries in columns\nabove. Sending multiple lists is equiva lent to sending multiple\n`Mutation`s, each containing one `values` entry and re peating\ntable and columns. Individual values in each list are\nencoded as descr ibed here.",
1296 "items": {
1297 "items": {
1298 "type": "any"
1299 },
1300 "type": "array"
1301 },
1302 "type": "array"
1303 },
1304 "columns": {
1305 "description": "The names of the columns in table to be writ ten.\n\nThe list of columns must contain enough columns to allow\nCloud Spanner to derive values for all primary key columns in the\nrow(s) to be modified.",
1306 "items": {
1307 "type": "string"
1308 },
1309 "type": "array"
1310 }
1311 },
1312 "type": "object"
1313 },
1314 "ReadWrite": {
1315 "description": "Message type to initiate a read-write transaction. C urrently this\ntransaction type has no options.",
1316 "id": "ReadWrite",
1317 "properties": {},
1318 "type": "object"
1319 },
1320 "DataAccessOptions": {
1321 "description": "Write a Data Access (Gin) log",
1322 "id": "DataAccessOptions",
1323 "properties": {},
1324 "type": "object"
1325 },
1326 "Operation": {
1327 "description": "This resource represents a long-running operation th at is the result of a\nnetwork API call.",
1328 "id": "Operation",
1329 "properties": {
1330 "response": {
1331 "additionalProperties": {
1332 "description": "Properties of the object. Contains field @type with type URL.",
1333 "type": "any"
1334 },
1335 "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delet e`, the response is\n`google.protobuf.Empty`. If the original method is standar d\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmet hods, the response should have the type `XxxResponse`, where `Xxx`\nis the origi nal method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
1336 "type": "object"
1337 },
1338 "name": {
1339 "description": "The server-assigned name, which is only uniq ue within the same service that\noriginally returns it. If you use the default H TTP mapping, the\n`name` should have the format of `operations/some/unique/name` .",
1340 "type": "string"
1341 },
1342 "error": {
1343 "$ref": "Status",
1344 "description": "The error result of the operation in case of failure or cancellation."
1345 },
1346 "metadata": {
1347 "additionalProperties": {
1348 "description": "Properties of the object. Contains field @type with type URL.",
1349 "type": "any"
1350 },
1351 "description": "Service-specific metadata associated with th e operation. It typically\ncontains progress information and common metadata su ch as create time.\nSome services might not provide such metadata. Any method t hat returns a\nlong-running operation should document the metadata type, if any. ",
1352 "type": "object"
1353 },
1354 "done": {
1355 "description": "If the value is `false`, it means the operat ion is still in progress.\nIf true, the operation is completed, and either `erro r` or `response` is\navailable.",
1356 "type": "boolean"
1357 }
1358 },
1359 "type": "object"
1360 },
1361 "ResultSet": {
1362 "description": "Results from Read or\nExecuteSql.",
1363 "id": "ResultSet",
1364 "properties": {
1365 "rows": {
1366 "description": "Each element in `rows` is a row whose format is defined by\nmetadata.row_type. The ith element\nin each row matches the ith field in\nmetadata.row_type. Elements are\nencoded based on type as described\nh ere.",
1367 "items": {
1368 "items": {
1369 "type": "any"
1370 },
1371 "type": "array"
1372 },
1373 "type": "array"
1374 },
1375 "metadata": {
1376 "$ref": "ResultSetMetadata",
1377 "description": "Metadata about the result set, such as row t ype information."
1378 },
1379 "stats": {
1380 "$ref": "ResultSetStats",
1381 "description": "Query plan and execution statistics for the query that produced this\nresult set. These can be requested by setting\nExecute SqlRequest.query_mode."
1382 }
1383 },
1384 "type": "object"
1385 },
1386 "Status": {
1387 "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RP C APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is desig ned to be:\n\n- Simple to use and understand for most users\n- Flexible enough t o meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pie ces of data: error code, error message,\nand error details. The error code shoul d be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message tha t helps\ndevelopers *understand* and *resolve* the error. If a localized user-fa cing\nerror message is needed, put the localized message in the error details or \nlocalize it in the client. The optional error details may contain arbitrary\ni nformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Lang uage mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` mess age is\nexposed in different client libraries and different wire protocols, it c an be\nmapped differently. For example, it will likely be mapped to some excepti ons\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n \nThe error model and the `Status` message can be used in a variety of\nenvironm ents, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n - Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step m ay\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\ n- Asynchronous operations. If an API call embeds asynchronous operation\n re sults in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are store d in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
1388 "id": "Status",
1389 "properties": {
1390 "details": {
1391 "description": "A list of messages that carry the error deta ils. There will be a\ncommon set of message types for APIs to use.",
1392 "items": {
1393 "additionalProperties": {
1394 "description": "Properties of the object. Contains f ield @type with type URL.",
1395 "type": "any"
1396 },
1397 "type": "object"
1398 },
1399 "type": "array"
1400 },
1401 "code": {
1402 "description": "The status code, which should be an enum val ue of google.rpc.Code.",
1403 "format": "int32",
1404 "type": "integer"
1405 },
1406 "message": {
1407 "description": "A developer-facing error message, which shou ld be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
1408 "type": "string"
1409 }
1410 },
1411 "type": "object"
1412 },
1413 "UpdateDatabaseDdlRequest": {
1414 "description": "Enqueues the given DDL statements to be applied, in order but not\nnecessarily all at once, to the database schema at some point (or \npoints) in the future. The server checks that the statements\nare executable ( syntactically valid, name tables that exist, etc.)\nbefore enqueueing them, but they may still fail upon\nlater execution (e.g., if a statement from another bat ch of\nstatements is applied first and it conflicts in some way, or if\nthere is some data-related problem like a `NULL` value in a column to\nwhich `NOT NULL` would be added). If a statement fails, all\nsubsequent statements in the batch a re automatically cancelled.\n\nEach batch of statements is assigned a name which can be used with\nthe Operations API to monitor\nprogress. See the\noperation_i d field for more\ndetails.",
1415 "id": "UpdateDatabaseDdlRequest",
1416 "properties": {
1417 "statements": {
1418 "description": "DDL statements to be applied to the database .",
1419 "items": {
1420 "type": "string"
1421 },
1422 "type": "array"
1423 },
1424 "operationId": {
1425 "description": "If empty, the new update request is assigned an\nautomatically-generated operation ID. Otherwise, `operation_id`\nis used to construct the name of the resulting\nOperation.\n\nSpecifying an explicit opera tion ID simplifies determining\nwhether the statements were executed in the even t that the\nUpdateDatabaseDdl call is replayed,\nor the return value is otherwis e lost: the database and\n`operation_id` fields can be combined to form the\nnam e of the resulting\nlongrunning.Operation: `<database>/operations/<operation_id> `.\n\n`operation_id` should be unique within the database, and must be\na valid identifier: `a-z*`. Note that\nautomatically-generated operation IDs always begi n with an\nunderscore. If the named operation already exists,\nUpdateDatabaseDdl returns\n`ALREADY_EXISTS`.",
1426 "type": "string"
1427 }
1428 },
1429 "type": "object"
1430 },
1431 "Binding": {
1432 "description": "Associates `members` with a `role`.",
1433 "id": "Binding",
1434 "properties": {
1435 "condition": {
1436 "$ref": "Expr",
1437 "description": "The condition that is associated with this b inding.\nNOTE: an unsatisfied condition will not allow user access via current\n binding. Different bindings, including their conditions, are examined\nindepende ntly.\nThis field is GOOGLE_INTERNAL."
1438 },
1439 "members": {
1440 "description": "Specifies the identities requesting access f or a Cloud Platform resource.\n`members` can have the following values:\n\n* `al lUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special ident ifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a spec ific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\ n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{e mailid}`: An email address that represents a Google group.\n For example, `adm ins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that repre sents all the\n users of that domain. For example, `google.com` or `example.co m`.\n\n",
1441 "items": {
1442 "type": "string"
1443 },
1444 "type": "array"
1445 },
1446 "role": {
1447 "description": "Role that is assigned to `members`.\nFor exa mple, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
1448 "type": "string"
1449 }
1450 },
1451 "type": "object"
1452 },
1453 "PartialResultSet": {
1454 "description": "Partial results from a streaming read or SQL query. Streaming reads and\nSQL queries better tolerate large result sets, large rows, and large\nvalues, but are a little trickier to consume.",
1455 "id": "PartialResultSet",
1456 "properties": {
1457 "chunkedValue": {
1458 "description": "If true, then the final value in values is c hunked, and must\nbe combined with more values from subsequent `PartialResultSet `s\nto obtain a complete field value.",
1459 "type": "boolean"
1460 },
1461 "values": {
1462 "description": "A streamed result set consists of a stream o f values, which might\nbe split into many `PartialResultSet` messages to accommo date\nlarge rows and/or large values. Every N complete values defines a\nrow, wh ere N is equal to the number of entries in\nmetadata.row_type.fields.\n\nMost va lues are encoded based on type as described\nhere.\n\nIt is possible that the la st value in values is \"chunked\",\nmeaning that the rest of the value is sent i n subsequent\n`PartialResultSet`(s). This is denoted by the chunked_value\nfield . Two or more chunked values can be merged to form a\ncomplete value as follows: \n\n * `bool/number/null`: cannot be chunked\n * `string`: concatenate the str ings\n * `list`: concatenate the lists. If the last element in a list is a\n `string`, `list`, or `object`, merge it with the first element in\n the next list by applying these rules recursively.\n * `object`: concatenate the (field name, field value) pairs. If a\n field name is duplicated, then apply these rules recursively\n to merge the field values.\n\nSome examples of merging:\n \n # Strings are concatenated.\n \"foo\", \"bar\" => \"foobar\"\n\n # L ists of non-strings are concatenated.\n [2, 3], [4] => [2, 3, 4]\n\n # Lis ts are concatenated, but the last and first elements are merged\n # because t hey are strings.\n [\"a\", \"b\"], [\"c\", \"d\"] => [\"a\", \"bc\", \"d\"]\n \n # Lists are concatenated, but the last and first elements are merged\n # because they are lists. Recursively, the last and first elements\n # of the inner lists are merged because they are strings.\n [\"a\", [\"b\", \"c\"]], [[\"d\"], \"e\"] => [\"a\", [\"b\", \"cd\"], \"e\"]\n\n # Non-overlapping obj ect fields are combined.\n {\"a\": \"1\"}, {\"b\": \"2\"} => {\"a\": \"1\", \ "b\": 2\"}\n\n # Overlapping object fields are merged.\n {\"a\": \"1\"}, { \"a\": \"2\"} => {\"a\": \"12\"}\n\n # Examples of merging objects containing lists of strings.\n {\"a\": [\"1\"]}, {\"a\": [\"2\"]} => {\"a\": [\"12\"]}\ n\nFor a more complete example, suppose a streaming SQL query is\nyielding a res ult set whose rows contain a single string\nfield. The following `PartialResultS et`s might be yielded:\n\n {\n \"metadata\": { ... }\n \"values\": [\"Hello\", \"W\"]\n \"chunked_value\": true\n \"resume_token\": \"Af6 5...\"\n }\n {\n \"values\": [\"orl\"]\n \"chunked_value\": true \n \"resume_token\": \"Bqp2...\"\n }\n {\n \"values\": [\"d\"]\n \"resume_token\": \"Zx1B...\"\n }\n\nThis sequence of `PartialResultSet `s encodes two rows, one\ncontaining the field value `\"Hello\"`, and a second c ontaining the\nfield value `\"World\" = \"W\" + \"orl\" + \"d\"`.",
1463 "items": {
1464 "type": "any"
1465 },
1466 "type": "array"
1467 },
1468 "metadata": {
1469 "$ref": "ResultSetMetadata",
1470 "description": "Metadata about the result set, such as row t ype information.\nOnly present in the first response."
1471 },
1472 "resumeToken": {
1473 "description": "Streaming calls might be interrupted for a v ariety of reasons, such\nas TCP connection loss. If this occurs, the stream of r esults can\nbe resumed by re-sending the original request and including\n`resume _token`. Note that executing any other transaction in the\nsame session invalida tes the token.",
1474 "format": "byte",
1475 "type": "string"
1476 },
1477 "stats": {
1478 "$ref": "ResultSetStats",
1479 "description": "Query plan and execution statistics for the query that produced this\nstreaming result set. These can be requested by settin g\nExecuteSqlRequest.query_mode and are sent\nonly once with the last response i n the stream."
1480 } 1227 }
1481 }, 1228 },
1482 "type": "object" 1229 "type": "object"
1483 }, 1230 },
1484 "ListOperationsResponse": { 1231 "ListOperationsResponse": {
1485 "description": "The response message for Operations.ListOperations." , 1232 "description": "The response message for Operations.ListOperations." ,
1486 "id": "ListOperationsResponse", 1233 "id": "ListOperationsResponse",
1487 "properties": { 1234 "properties": {
1488 "nextPageToken": { 1235 "nextPageToken": {
1489 "description": "The standard List next-page token.", 1236 "description": "The standard List next-page token.",
1490 "type": "string" 1237 "type": "string"
1491 }, 1238 },
1492 "operations": { 1239 "operations": {
1493 "description": "A list of operations that matches the specif ied filter in the request.", 1240 "description": "A list of operations that matches the specif ied filter in the request.",
1494 "items": { 1241 "items": {
1495 "$ref": "Operation" 1242 "$ref": "Operation"
1496 }, 1243 },
1497 "type": "array" 1244 "type": "array"
1498 } 1245 }
1499 }, 1246 },
1500 "type": "object" 1247 "type": "object"
1501 }, 1248 },
1502 "UpdateInstanceMetadata": {
1503 "description": "Metadata type for the operation returned by\nUpdateI nstance.",
1504 "id": "UpdateInstanceMetadata",
1505 "properties": {
1506 "startTime": {
1507 "description": "The time at which UpdateInstance\nrequest wa s received.",
1508 "format": "google-datetime",
1509 "type": "string"
1510 },
1511 "instance": {
1512 "$ref": "Instance",
1513 "description": "The desired end state of the update."
1514 },
1515 "endTime": {
1516 "description": "The time at which this operation failed or w as completed successfully.",
1517 "format": "google-datetime",
1518 "type": "string"
1519 },
1520 "cancelTime": {
1521 "description": "The time at which this operation was cancell ed. If set, this operation is\nin the process of undoing itself (which is guaran teed to succeed) and\ncannot be cancelled again.",
1522 "format": "google-datetime",
1523 "type": "string"
1524 }
1525 },
1526 "type": "object"
1527 },
1528 "ResultSetMetadata": { 1249 "ResultSetMetadata": {
1529 "description": "Metadata about a ResultSet or PartialResultSet.", 1250 "description": "Metadata about a ResultSet or PartialResultSet.",
1530 "id": "ResultSetMetadata", 1251 "id": "ResultSetMetadata",
1531 "properties": { 1252 "properties": {
1253 "rowType": {
1254 "$ref": "StructType",
1255 "description": "Indicates the field names and types for the rows in the result\nset. For example, a SQL query like `\"SELECT UserId, UserNa me FROM\nUsers\"` could return a `row_type` value like:\n\n \"fields\": [\n { \"name\": \"UserId\", \"type\": { \"code\": \"INT64\" } },\n { \"name \": \"UserName\", \"type\": { \"code\": \"STRING\" } },\n ]"
1256 },
1532 "transaction": { 1257 "transaction": {
1533 "$ref": "Transaction", 1258 "$ref": "Transaction",
1534 "description": "If the read or SQL query began a transaction as a side-effect, the\ninformation about the new transaction is yielded here." 1259 "description": "If the read or SQL query began a transaction as a side-effect, the\ninformation about the new transaction is yielded here."
1535 },
1536 "rowType": {
1537 "$ref": "StructType",
1538 "description": "Indicates the field names and types for the rows in the result\nset. For example, a SQL query like `\"SELECT UserId, UserNa me FROM\nUsers\"` could return a `row_type` value like:\n\n \"fields\": [\n { \"name\": \"UserId\", \"type\": { \"code\": \"INT64\" } },\n { \"name \": \"UserName\", \"type\": { \"code\": \"STRING\" } },\n ]"
1539 } 1260 }
1540 }, 1261 },
1541 "type": "object" 1262 "type": "object"
1542 }, 1263 },
1543 "TransactionSelector": { 1264 "TransactionSelector": {
1544 "description": "This message is used to select the transaction in wh ich a\nRead or\nExecuteSql call runs.\n\nSee TransactionOptions for more informa tion about transactions.", 1265 "description": "This message is used to select the transaction in wh ich a\nRead or\nExecuteSql call runs.\n\nSee TransactionOptions for more informa tion about transactions.",
1545 "id": "TransactionSelector", 1266 "id": "TransactionSelector",
1546 "properties": { 1267 "properties": {
1268 "begin": {
1269 "$ref": "TransactionOptions",
1270 "description": "Begin a new transaction and execute this rea d or SQL query in\nit. The transaction ID of the new transaction is returned in\ nResultSetMetadata.transaction, which is a Transaction."
1271 },
1547 "id": { 1272 "id": {
1548 "description": "Execute the read or SQL query in a previousl y-started transaction.", 1273 "description": "Execute the read or SQL query in a previousl y-started transaction.",
1549 "format": "byte", 1274 "format": "byte",
1550 "type": "string" 1275 "type": "string"
1551 }, 1276 },
1552 "singleUse": { 1277 "singleUse": {
1553 "$ref": "TransactionOptions", 1278 "$ref": "TransactionOptions",
1554 "description": "Execute the read or SQL query in a temporary transaction.\nThis is the most efficient way to execute a transaction that\ncon sists of a single SQL query." 1279 "description": "Execute the read or SQL query in a temporary transaction.\nThis is the most efficient way to execute a transaction that\ncon sists of a single SQL query."
1555 },
1556 "begin": {
1557 "$ref": "TransactionOptions",
1558 "description": "Begin a new transaction and execute this rea d or SQL query in\nit. The transaction ID of the new transaction is returned in\ nResultSetMetadata.transaction, which is a Transaction."
1559 } 1280 }
1560 }, 1281 },
1561 "type": "object" 1282 "type": "object"
1562 }, 1283 },
1563 "Mutation": { 1284 "Mutation": {
1564 "description": "A modification to one or more Cloud Spanner rows. M utations can be\napplied to a Cloud Spanner database by sending them in a\nCommi t call.", 1285 "description": "A modification to one or more Cloud Spanner rows. M utations can be\napplied to a Cloud Spanner database by sending them in a\nCommi t call.",
1565 "id": "Mutation", 1286 "id": "Mutation",
1566 "properties": { 1287 "properties": {
1567 "update": {
1568 "$ref": "Write",
1569 "description": "Update existing rows in a table. If any of t he rows does not\nalready exist, the transaction fails with error `NOT_FOUND`."
1570 },
1571 "replace": {
1572 "$ref": "Write",
1573 "description": "Like insert, except that if the row already exists, it is\ndeleted, and the column values provided are inserted\ninstead. Un like insert_or_update, this means any values not\nexplicitly written become `NUL L`."
1574 },
1575 "delete": { 1288 "delete": {
1576 "$ref": "Delete", 1289 "$ref": "Delete",
1577 "description": "Delete rows from a table. Succeeds whether o r not the named\nrows were present." 1290 "description": "Delete rows from a table. Succeeds whether o r not the named\nrows were present."
1578 }, 1291 },
1579 "insertOrUpdate": { 1292 "insertOrUpdate": {
1580 "$ref": "Write", 1293 "$ref": "Write",
1581 "description": "Like insert, except that if the row already exists, then\nits column values are overwritten with the ones provided. Any\ncol umn values not explicitly written are preserved." 1294 "description": "Like insert, except that if the row already exists, then\nits column values are overwritten with the ones provided. Any\ncol umn values not explicitly written are preserved."
1582 }, 1295 },
1583 "insert": { 1296 "insert": {
1584 "$ref": "Write", 1297 "$ref": "Write",
1585 "description": "Insert new rows in a table. If any of the ro ws already exist,\nthe write or transaction fails with error `ALREADY_EXISTS`." 1298 "description": "Insert new rows in a table. If any of the ro ws already exist,\nthe write or transaction fails with error `ALREADY_EXISTS`."
1299 },
1300 "update": {
1301 "$ref": "Write",
1302 "description": "Update existing rows in a table. If any of t he rows does not\nalready exist, the transaction fails with error `NOT_FOUND`."
1303 },
1304 "replace": {
1305 "$ref": "Write",
1306 "description": "Like insert, except that if the row already exists, it is\ndeleted, and the column values provided are inserted\ninstead. Un like insert_or_update, this means any values not\nexplicitly written become `NUL L`."
1586 } 1307 }
1587 }, 1308 },
1588 "type": "object" 1309 "type": "object"
1589 }, 1310 },
1590 "KeySet": { 1311 "KeySet": {
1591 "description": "`KeySet` defines a collection of Cloud Spanner keys and/or key ranges. All\nthe keys are expected to be in the same table or index. The keys need\nnot be sorted in any particular way.\n\nIf the same key is specif ied multiple times in the set (for example\nif two ranges, two keys, or a key an d a range overlap), Cloud Spanner\nbehaves as if the key were only specified onc e.", 1312 "description": "`KeySet` defines a collection of Cloud Spanner keys and/or key ranges. All\nthe keys are expected to be in the same table or index. The keys need\nnot be sorted in any particular way.\n\nIf the same key is specif ied multiple times in the set (for example\nif two ranges, two keys, or a key an d a range overlap), Cloud Spanner\nbehaves as if the key were only specified onc e.",
1592 "id": "KeySet", 1313 "id": "KeySet",
1593 "properties": { 1314 "properties": {
1594 "ranges": { 1315 "ranges": {
1595 "description": "A list of key ranges. See KeyRange for more information about\nkey range specifications.", 1316 "description": "A list of key ranges. See KeyRange for more information about\nkey range specifications.",
(...skipping 60 matching lines...) Expand 10 before | Expand all | Expand 10 after
1656 }, 1377 },
1657 "Instance": { 1378 "Instance": {
1658 "description": "An isolated set of Cloud Spanner resources on which databases can be hosted.", 1379 "description": "An isolated set of Cloud Spanner resources on which databases can be hosted.",
1659 "id": "Instance", 1380 "id": "Instance",
1660 "properties": { 1381 "properties": {
1661 "displayName": { 1382 "displayName": {
1662 "description": "Required. The descriptive name for this inst ance as it appears in UIs.\nMust be unique per project and between 4 and 30 char acters in length.", 1383 "description": "Required. The descriptive name for this inst ance as it appears in UIs.\nMust be unique per project and between 4 and 30 char acters in length.",
1663 "type": "string" 1384 "type": "string"
1664 }, 1385 },
1665 "nodeCount": { 1386 "nodeCount": {
1666 "description": "Required. The number of nodes allocated to t his instance. This may be zero\nin API responses for instances that are not yet in state `READY`.", 1387 "description": "Required. The number of nodes allocated to t his instance. This may be zero\nin API responses for instances that are not yet in state `READY`.\n\nEach Spanner node can provide up to 10,000 QPS of reads or 2000 QPS of\nwrites (writing single rows at 1KB data per row), and 2 TiB storage .\n\nFor optimal performance, we recommend provisioning enough nodes to keep\nov erall CPU utilization under 75%.\n\nA minimum of 3 nodes is recommended for prod uction environments. This\nminimum is required for SLAs to apply to your instan ce.\n\nNote that Cloud Spanner performance is highly dependent on workload, sche ma\ndesign, and dataset characteristics. The performance numbers above are\nesti mates, and assume [best practices](https://cloud.google.com/spanner/docs/bulk-lo ading)\nare followed.",
1667 "format": "int32", 1388 "format": "int32",
1668 "type": "integer" 1389 "type": "integer"
1669 }, 1390 },
1670 "labels": { 1391 "labels": {
1671 "additionalProperties": { 1392 "additionalProperties": {
1672 "type": "string" 1393 "type": "string"
1673 }, 1394 },
1674 "description": "Cloud Labels are a flexible and lightweight mechanism for organizing cloud\nresources into groups that reflect a customer's organizational needs and\ndeployment strategies. Cloud Labels can be used to fil ter collections of\nresources. They can be used to control how resource metrics are aggregated.\nAnd they can be used as arguments to policy management rules (e .g. route,\nfirewall, load balancing, etc.).\n\n * Label keys must be between 1 and 63 characters long and must conform to\n the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`.\n * Label values must be between 0 and 63 charact ers long and must conform\n to the regular expression `([a-z]([-a-z0-9]*[a-z0- 9])?)?`.\n * No more than 64 labels can be associated with a given resource.\n\n See https://goo.gl/xmQnxf for more information on and examples of labels.\n\nIf you plan to use labels in your own code, please note that additional\ncharacters may be allowed in the future. And so you are advised to use an\ninternal label representation, such as JSON, which doesn't rely upon\nspecific characters being disallowed. For example, representing labels\nas the string: name + \"_\" + v alue would prove problematic if we were to\nallow \"_\" in a future release.", 1395 "description": "Cloud Labels are a flexible and lightweight mechanism for organizing cloud\nresources into groups that reflect a customer's organizational needs and\ndeployment strategies. Cloud Labels can be used to fil ter collections of\nresources. They can be used to control how resource metrics are aggregated.\nAnd they can be used as arguments to policy management rules (e .g. route,\nfirewall, load balancing, etc.).\n\n * Label keys must be between 1 and 63 characters long and must conform to\n the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`.\n * Label values must be between 0 and 63 charact ers long and must conform\n to the regular expression `([a-z]([-a-z0-9]*[a-z0- 9])?)?`.\n * No more than 64 labels can be associated with a given resource.\n\n See https://goo.gl/xmQnxf for more information on and examples of labels.\n\nIf you plan to use labels in your own code, please note that additional\ncharacters may be allowed in the future. And so you are advised to use an\ninternal label representation, such as JSON, which doesn't rely upon\nspecific characters being disallowed. For example, representing labels\nas the string: name + \"_\" + v alue would prove problematic if we were to\nallow \"_\" in a future release.",
1675 "type": "object" 1396 "type": "object"
1676 }, 1397 },
(...skipping 15 matching lines...) Expand all
1692 ], 1413 ],
1693 "type": "string" 1414 "type": "string"
1694 }, 1415 },
1695 "name": { 1416 "name": {
1696 "description": "Required. A unique identifier for the instan ce, which cannot be changed\nafter the instance is created. Values are of the fo rm\n`projects/<project>/instances/a-z*[a-z0-9]`. The final\nsegment of the name must be between 6 and 30 characters in length.", 1417 "description": "Required. A unique identifier for the instan ce, which cannot be changed\nafter the instance is created. Values are of the fo rm\n`projects/<project>/instances/a-z*[a-z0-9]`. The final\nsegment of the name must be between 6 and 30 characters in length.",
1697 "type": "string" 1418 "type": "string"
1698 } 1419 }
1699 }, 1420 },
1700 "type": "object" 1421 "type": "object"
1701 }, 1422 },
1702 "SetIamPolicyRequest": {
1703 "description": "Request message for `SetIamPolicy` method.",
1704 "id": "SetIamPolicyRequest",
1705 "properties": {
1706 "updateMask": {
1707 "description": "OPTIONAL: A FieldMask specifying which field s of the policy to modify. Only\nthe fields in the mask will be modified. If no mask is provided, the\nfollowing default mask is used:\npaths: \"bindings, etag\ "\nThis field is only used by Cloud IAM.",
1708 "format": "google-fieldmask",
1709 "type": "string"
1710 },
1711 "policy": {
1712 "$ref": "Policy",
1713 "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An emp ty policy is a\nvalid policy but certain Cloud Platform services (such as Projec ts)\nmight reject them."
1714 }
1715 },
1716 "type": "object"
1717 },
1718 "ListDatabasesResponse": { 1423 "ListDatabasesResponse": {
1719 "description": "The response for ListDatabases.", 1424 "description": "The response for ListDatabases.",
1720 "id": "ListDatabasesResponse", 1425 "id": "ListDatabasesResponse",
1721 "properties": { 1426 "properties": {
1722 "nextPageToken": { 1427 "nextPageToken": {
1723 "description": "`next_page_token` can be sent in a subsequen t\nListDatabases call to fetch more\nof the matching databases.", 1428 "description": "`next_page_token` can be sent in a subsequen t\nListDatabases call to fetch more\nof the matching databases.",
1724 "type": "string" 1429 "type": "string"
1725 }, 1430 },
1726 "databases": { 1431 "databases": {
1727 "description": "Databases that matched the request.", 1432 "description": "Databases that matched the request.",
1728 "items": { 1433 "items": {
1729 "$ref": "Database" 1434 "$ref": "Database"
1730 }, 1435 },
1731 "type": "array" 1436 "type": "array"
1732 } 1437 }
1733 }, 1438 },
1734 "type": "object" 1439 "type": "object"
1735 }, 1440 },
1441 "SetIamPolicyRequest": {
1442 "description": "Request message for `SetIamPolicy` method.",
1443 "id": "SetIamPolicyRequest",
1444 "properties": {
1445 "policy": {
1446 "$ref": "Policy",
1447 "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An emp ty policy is a\nvalid policy but certain Cloud Platform services (such as Projec ts)\nmight reject them."
1448 },
1449 "updateMask": {
1450 "description": "OPTIONAL: A FieldMask specifying which field s of the policy to modify. Only\nthe fields in the mask will be modified. If no mask is provided, the\nfollowing default mask is used:\npaths: \"bindings, etag\ "\nThis field is only used by Cloud IAM.",
1451 "format": "google-fieldmask",
1452 "type": "string"
1453 }
1454 },
1455 "type": "object"
1456 },
1736 "RollbackRequest": { 1457 "RollbackRequest": {
1737 "description": "The request for Rollback.", 1458 "description": "The request for Rollback.",
1738 "id": "RollbackRequest", 1459 "id": "RollbackRequest",
1739 "properties": { 1460 "properties": {
1740 "transactionId": { 1461 "transactionId": {
1741 "description": "Required. The transaction to roll back.", 1462 "description": "Required. The transaction to roll back.",
1742 "format": "byte", 1463 "format": "byte",
1743 "type": "string" 1464 "type": "string"
1744 } 1465 }
1745 }, 1466 },
(...skipping 13 matching lines...) Expand all
1759 "format": "google-datetime", 1480 "format": "google-datetime",
1760 "type": "string" 1481 "type": "string"
1761 } 1482 }
1762 }, 1483 },
1763 "type": "object" 1484 "type": "object"
1764 }, 1485 },
1765 "UpdateDatabaseDdlMetadata": { 1486 "UpdateDatabaseDdlMetadata": {
1766 "description": "Metadata type for the operation returned by\nUpdateD atabaseDdl.", 1487 "description": "Metadata type for the operation returned by\nUpdateD atabaseDdl.",
1767 "id": "UpdateDatabaseDdlMetadata", 1488 "id": "UpdateDatabaseDdlMetadata",
1768 "properties": { 1489 "properties": {
1769 "database": {
1770 "description": "The database being modified.",
1771 "type": "string"
1772 },
1773 "statements": { 1490 "statements": {
1774 "description": "For an update this list contains all the sta tements. For an\nindividual statement, this list contains only that statement.", 1491 "description": "For an update this list contains all the sta tements. For an\nindividual statement, this list contains only that statement.",
1775 "items": { 1492 "items": {
1776 "type": "string" 1493 "type": "string"
1777 }, 1494 },
1778 "type": "array" 1495 "type": "array"
1779 }, 1496 },
1780 "commitTimestamps": { 1497 "commitTimestamps": {
1781 "description": "Reports the commit timestamps of all stateme nts that have\nsucceeded so far, where `commit_timestamps[i]` is the commit\ntim estamp for the statement `statements[i]`.", 1498 "description": "Reports the commit timestamps of all stateme nts that have\nsucceeded so far, where `commit_timestamps[i]` is the commit\ntim estamp for the statement `statements[i]`.",
1782 "items": { 1499 "items": {
1783 "format": "google-datetime", 1500 "format": "google-datetime",
1784 "type": "string" 1501 "type": "string"
1785 }, 1502 },
1786 "type": "array" 1503 "type": "array"
1504 },
1505 "database": {
1506 "description": "The database being modified.",
1507 "type": "string"
1787 } 1508 }
1788 }, 1509 },
1789 "type": "object" 1510 "type": "object"
1790 }, 1511 },
1791 "CounterOptions": { 1512 "CounterOptions": {
1792 "description": "Options for counters", 1513 "description": "Options for counters",
1793 "id": "CounterOptions", 1514 "id": "CounterOptions",
1794 "properties": { 1515 "properties": {
1795 "field": { 1516 "field": {
1796 "description": "The field value to attribute.", 1517 "description": "The field value to attribute.",
(...skipping 31 matching lines...) Expand 10 before | Expand all | Expand 10 after
1828 }, 1549 },
1829 "type": "array" 1550 "type": "array"
1830 } 1551 }
1831 }, 1552 },
1832 "type": "object" 1553 "type": "object"
1833 }, 1554 },
1834 "Field": { 1555 "Field": {
1835 "description": "Message representing a single field of a struct.", 1556 "description": "Message representing a single field of a struct.",
1836 "id": "Field", 1557 "id": "Field",
1837 "properties": { 1558 "properties": {
1559 "type": {
1560 "$ref": "Type",
1561 "description": "The type of the field."
1562 },
1838 "name": { 1563 "name": {
1839 "description": "The name of the field. For reads, this is th e column name. For\nSQL queries, it is the column alias (e.g., `\"Word\"` in the \nquery `\"SELECT 'hello' AS Word\"`), or the column name (e.g.,\n`\"ColName\"` in the query `\"SELECT ColName FROM Table\"`). Some\ncolumns might have an empty name (e.g., !\"SELECT\nUPPER(ColName)\"`). Note that a query result can contain \nmultiple fields with the same name.", 1564 "description": "The name of the field. For reads, this is th e column name. For\nSQL queries, it is the column alias (e.g., `\"Word\"` in the \nquery `\"SELECT 'hello' AS Word\"`), or the column name (e.g.,\n`\"ColName\"` in the query `\"SELECT ColName FROM Table\"`). Some\ncolumns might have an empty name (e.g., !\"SELECT\nUPPER(ColName)\"`). Note that a query result can contain \nmultiple fields with the same name.",
1840 "type": "string" 1565 "type": "string"
1841 },
1842 "type": {
1843 "$ref": "Type",
1844 "description": "The type of the field."
1845 } 1566 }
1846 }, 1567 },
1847 "type": "object" 1568 "type": "object"
1848 }, 1569 },
1849 "ResultSetStats": { 1570 "ResultSetStats": {
1850 "description": "Additional statistics about a ResultSet or PartialRe sultSet.", 1571 "description": "Additional statistics about a ResultSet or PartialRe sultSet.",
1851 "id": "ResultSetStats", 1572 "id": "ResultSetStats",
1852 "properties": { 1573 "properties": {
1853 "queryStats": { 1574 "queryStats": {
1854 "additionalProperties": { 1575 "additionalProperties": {
(...skipping 17 matching lines...) Expand all
1872 "permissions": { 1593 "permissions": {
1873 "description": "REQUIRED: The set of permissions to check fo r 'resource'.\nPermissions with wildcards (such as '*', 'spanner.*', 'spanner.in stances.*') are not allowed.", 1594 "description": "REQUIRED: The set of permissions to check fo r 'resource'.\nPermissions with wildcards (such as '*', 'spanner.*', 'spanner.in stances.*') are not allowed.",
1874 "items": { 1595 "items": {
1875 "type": "string" 1596 "type": "string"
1876 }, 1597 },
1877 "type": "array" 1598 "type": "array"
1878 } 1599 }
1879 }, 1600 },
1880 "type": "object" 1601 "type": "object"
1881 }, 1602 },
1603 "AuthorizationLoggingOptions": {
1604 "description": "Authorization-related information used by Cloud Audi t Logging.",
1605 "id": "AuthorizationLoggingOptions",
1606 "properties": {
1607 "permissionType": {
1608 "description": "The type of the permission that was checked. ",
1609 "enum": [
1610 "PERMISSION_TYPE_UNSPECIFIED",
1611 "ADMIN_READ",
1612 "ADMIN_WRITE",
1613 "DATA_READ",
1614 "DATA_WRITE"
1615 ],
1616 "enumDescriptions": [
1617 "Default. Should not be used.",
1618 "A read of admin (meta) data.",
1619 "A write of admin (meta) data.",
1620 "A read of standard data.",
1621 "A write of standard data."
1622 ],
1623 "type": "string"
1624 }
1625 },
1626 "type": "object"
1627 },
1882 "CommitResponse": { 1628 "CommitResponse": {
1883 "description": "The response for Commit.", 1629 "description": "The response for Commit.",
1884 "id": "CommitResponse", 1630 "id": "CommitResponse",
1885 "properties": { 1631 "properties": {
1886 "commitTimestamp": { 1632 "commitTimestamp": {
1887 "description": "The Cloud Spanner timestamp at which the tra nsaction committed.", 1633 "description": "The Cloud Spanner timestamp at which the tra nsaction committed.",
1888 "format": "google-datetime", 1634 "format": "google-datetime",
1889 "type": "string" 1635 "type": "string"
1890 } 1636 }
1891 }, 1637 },
1892 "type": "object" 1638 "type": "object"
1893 }, 1639 },
1894 "Type": { 1640 "Type": {
1895 "description": "`Type` indicates the type of a Cloud Spanner value, as might be stored in a\ntable cell or returned from an SQL query.", 1641 "description": "`Type` indicates the type of a Cloud Spanner value, as might be stored in a\ntable cell or returned from an SQL query.",
1896 "id": "Type", 1642 "id": "Type",
1897 "properties": { 1643 "properties": {
1898 "structType": {
1899 "$ref": "StructType",
1900 "description": "If code == STRUCT, then `struct_type`\nprovi des type information for the struct's fields."
1901 },
1902 "arrayElementType": {
1903 "$ref": "Type",
1904 "description": "If code == ARRAY, then `array_element_type`\ nis the type of the array elements."
1905 },
1906 "code": { 1644 "code": {
1907 "description": "Required. The TypeCode for this type.", 1645 "description": "Required. The TypeCode for this type.",
1908 "enum": [ 1646 "enum": [
1909 "TYPE_CODE_UNSPECIFIED", 1647 "TYPE_CODE_UNSPECIFIED",
1910 "BOOL", 1648 "BOOL",
1911 "INT64", 1649 "INT64",
1912 "FLOAT64", 1650 "FLOAT64",
1913 "TIMESTAMP", 1651 "TIMESTAMP",
1914 "DATE", 1652 "DATE",
1915 "STRING", 1653 "STRING",
1916 "BYTES", 1654 "BYTES",
1917 "ARRAY", 1655 "ARRAY",
1918 "STRUCT" 1656 "STRUCT"
1919 ], 1657 ],
1920 "enumDescriptions": [ 1658 "enumDescriptions": [
1921 "Not specified.", 1659 "Not specified.",
1922 "Encoded as JSON `true` or `false`.", 1660 "Encoded as JSON `true` or `false`.",
1923 "Encoded as `string`, in decimal format.", 1661 "Encoded as `string`, in decimal format.",
1924 "Encoded as `number`, or the strings `\"NaN\"`, `\"Infin ity\"`, or\n`\"-Infinity\"`.", 1662 "Encoded as `number`, or the strings `\"NaN\"`, `\"Infin ity\"`, or\n`\"-Infinity\"`.",
1925 "Encoded as `string` in RFC 3339 timestamp format. The t ime zone\nmust be present, and must be `\"Z\"`.", 1663 "Encoded as `string` in RFC 3339 timestamp format. The t ime zone\nmust be present, and must be `\"Z\"`.",
1926 "Encoded as `string` in RFC 3339 date format.", 1664 "Encoded as `string` in RFC 3339 date format.",
1927 "Encoded as `string`.", 1665 "Encoded as `string`.",
1928 "Encoded as a base64-encoded `string`, as described in R FC 4648,\nsection 4.", 1666 "Encoded as a base64-encoded `string`, as described in R FC 4648,\nsection 4.",
1929 "Encoded as `list`, where the list elements are represen ted\naccording to array_element_type.", 1667 "Encoded as `list`, where the list elements are represen ted\naccording to array_element_type.",
1930 "Encoded as `list`, where list element `i` is represente d according\nto [struct_type.fields[i]][google.spanner.v1.StructType.fields]." 1668 "Encoded as `list`, where list element `i` is represente d according\nto [struct_type.fields[i]][google.spanner.v1.StructType.fields]."
1931 ], 1669 ],
1932 "type": "string" 1670 "type": "string"
1671 },
1672 "structType": {
1673 "$ref": "StructType",
1674 "description": "If code == STRUCT, then `struct_type`\nprovi des type information for the struct's fields."
1675 },
1676 "arrayElementType": {
1677 "$ref": "Type",
1678 "description": "If code == ARRAY, then `array_element_type`\ nis the type of the array elements."
1933 } 1679 }
1934 }, 1680 },
1935 "type": "object" 1681 "type": "object"
1936 }, 1682 },
1937 "PlanNode": { 1683 "PlanNode": {
1938 "description": "Node information for nodes appearing in a QueryPlan. plan_nodes.", 1684 "description": "Node information for nodes appearing in a QueryPlan. plan_nodes.",
1939 "id": "PlanNode", 1685 "id": "PlanNode",
1940 "properties": { 1686 "properties": {
1687 "metadata": {
1688 "additionalProperties": {
1689 "description": "Properties of the object.",
1690 "type": "any"
1691 },
1692 "description": "Attributes relevant to the node contained in a group of key-value pairs.\nFor example, a Parameter Reference node could have the following\ninformation in its metadata:\n\n {\n \"parameter_referen ce\": \"param1\",\n \"parameter_type\": \"array\"\n }",
1693 "type": "object"
1694 },
1695 "executionStats": {
1696 "additionalProperties": {
1697 "description": "Properties of the object.",
1698 "type": "any"
1699 },
1700 "description": "The execution statistics associated with the node, contained in a group of\nkey-value pairs. Only present if the plan was re turned as a result of a\nprofile query. For example, number of executions, numbe r of rows/time per\nexecution etc.",
1701 "type": "object"
1702 },
1703 "shortRepresentation": {
1704 "$ref": "ShortRepresentation",
1705 "description": "Condensed representation for SCALAR nodes."
1706 },
1941 "index": { 1707 "index": {
1942 "description": "The `PlanNode`'s index in node list.", 1708 "description": "The `PlanNode`'s index in node list.",
1943 "format": "int32", 1709 "format": "int32",
1944 "type": "integer" 1710 "type": "integer"
1945 }, 1711 },
1712 "displayName": {
1713 "description": "The display name for the node.",
1714 "type": "string"
1715 },
1946 "kind": { 1716 "kind": {
1947 "description": "Used to determine the type of node. May be n eeded for visualizing\ndifferent kinds of nodes differently. For example, If the node is a\nSCALAR node, it will have a condensed representation\nwhich can be u sed to directly embed a description of the node in its\nparent.", 1717 "description": "Used to determine the type of node. May be n eeded for visualizing\ndifferent kinds of nodes differently. For example, If the node is a\nSCALAR node, it will have a condensed representation\nwhich can be u sed to directly embed a description of the node in its\nparent.",
1948 "enum": [ 1718 "enum": [
1949 "KIND_UNSPECIFIED", 1719 "KIND_UNSPECIFIED",
1950 "RELATIONAL", 1720 "RELATIONAL",
1951 "SCALAR" 1721 "SCALAR"
1952 ], 1722 ],
1953 "enumDescriptions": [ 1723 "enumDescriptions": [
1954 "Not specified.", 1724 "Not specified.",
1955 "Denotes a Relational operator node in the expression tr ee. Relational\noperators represent iterative processing of rows during query ex ecution.\nFor example, a `TableScan` operation that reads rows from a table.", 1725 "Denotes a Relational operator node in the expression tr ee. Relational\noperators represent iterative processing of rows during query ex ecution.\nFor example, a `TableScan` operation that reads rows from a table.",
1956 "Denotes a Scalar node in the expression tree. Scalar no des represent\nnon-iterable entities in the query plan. For example, constants o r\narithmetic operators appearing inside predicate expressions or references\nto column names." 1726 "Denotes a Scalar node in the expression tree. Scalar no des represent\nnon-iterable entities in the query plan. For example, constants o r\narithmetic operators appearing inside predicate expressions or references\nto column names."
1957 ], 1727 ],
1958 "type": "string" 1728 "type": "string"
1959 }, 1729 },
1960 "displayName": {
1961 "description": "The display name for the node.",
1962 "type": "string"
1963 },
1964 "childLinks": { 1730 "childLinks": {
1965 "description": "List of child node `index`es and their relat ionship to this parent.", 1731 "description": "List of child node `index`es and their relat ionship to this parent.",
1966 "items": { 1732 "items": {
1967 "$ref": "ChildLink" 1733 "$ref": "ChildLink"
1968 }, 1734 },
1969 "type": "array" 1735 "type": "array"
1970 },
1971 "metadata": {
1972 "additionalProperties": {
1973 "description": "Properties of the object.",
1974 "type": "any"
1975 },
1976 "description": "Attributes relevant to the node contained in a group of key-value pairs.\nFor example, a Parameter Reference node could have the following\ninformation in its metadata:\n\n {\n \"parameter_referen ce\": \"param1\",\n \"parameter_type\": \"array\"\n }",
1977 "type": "object"
1978 },
1979 "executionStats": {
1980 "additionalProperties": {
1981 "description": "Properties of the object.",
1982 "type": "any"
1983 },
1984 "description": "The execution statistics associated with the node, contained in a group of\nkey-value pairs. Only present if the plan was re turned as a result of a\nprofile query. For example, number of executions, numbe r of rows/time per\nexecution etc.",
1985 "type": "object"
1986 },
1987 "shortRepresentation": {
1988 "$ref": "ShortRepresentation",
1989 "description": "Condensed representation for SCALAR nodes."
1990 } 1736 }
1991 }, 1737 },
1992 "type": "object" 1738 "type": "object"
1739 },
1740 "CreateInstanceMetadata": {
1741 "description": "Metadata type for the operation returned by\nCreateI nstance.",
1742 "id": "CreateInstanceMetadata",
1743 "properties": {
1744 "endTime": {
1745 "description": "The time at which this operation failed or w as completed successfully.",
1746 "format": "google-datetime",
1747 "type": "string"
1748 },
1749 "cancelTime": {
1750 "description": "The time at which this operation was cancell ed. If set, this operation is\nin the process of undoing itself (which is guaran teed to succeed) and\ncannot be cancelled again.",
1751 "format": "google-datetime",
1752 "type": "string"
1753 },
1754 "startTime": {
1755 "description": "The time at which the\nCreateInstance reques t was\nreceived.",
1756 "format": "google-datetime",
1757 "type": "string"
1758 },
1759 "instance": {
1760 "$ref": "Instance",
1761 "description": "The instance being created."
1762 }
1763 },
1764 "type": "object"
1993 }, 1765 },
1994 "AuditConfig": { 1766 "AuditConfig": {
1995 "description": "Specifies the audit configuration for a service.\nTh e configuration determines which permission types are logged, and what\nidentiti es, if any, are exempted from logging.\nAn AuditConfig must have one or more Aud itLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_t ypes\nspecified in each AuditConfig are enabled, and the exempted_members in eac h\nAuditConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices \"\n \"audit_log_configs\": [\n {\n \"log_type\ ": \"DATA_READ\",\n \"exempted_members\": [\n \"user :foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"lo g_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"fooservice.googleapis.com\"\n \"audit_log_config s\": [\n {\n \"log_type\": \"DATA_READ\",\n } ,\n {\n \"log_type\": \"DATA_WRITE\",\n \"e xempted_members\": [\n \"user:bar@gmail.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor fooservice, this pol icy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@g mail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging.", 1767 "description": "Specifies the audit configuration for a service.\nTh e configuration determines which permission types are logged, and what\nidentiti es, if any, are exempted from logging.\nAn AuditConfig must have one or more Aud itLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_t ypes\nspecified in each AuditConfig are enabled, and the exempted_members in eac h\nAuditConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices \"\n \"audit_log_configs\": [\n {\n \"log_type\ ": \"DATA_READ\",\n \"exempted_members\": [\n \"user :foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"lo g_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"fooservice.googleapis.com\"\n \"audit_log_config s\": [\n {\n \"log_type\": \"DATA_READ\",\n } ,\n {\n \"log_type\": \"DATA_WRITE\",\n \"e xempted_members\": [\n \"user:bar@gmail.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor fooservice, this pol icy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@g mail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging.",
1996 "id": "AuditConfig", 1768 "id": "AuditConfig",
1997 "properties": { 1769 "properties": {
1998 "exemptedMembers": { 1770 "exemptedMembers": {
1999 "items": { 1771 "items": {
2000 "type": "string" 1772 "type": "string"
2001 }, 1773 },
2002 "type": "array" 1774 "type": "array"
2003 }, 1775 },
2004 "service": { 1776 "service": {
2005 "description": "Specifies a service that will be enabled for audit logging.\nFor example, `storage.googleapis.com`, `cloudsql.googleapis.com `.\n`allServices` is a special value that covers all services.", 1777 "description": "Specifies a service that will be enabled for audit logging.\nFor example, `storage.googleapis.com`, `cloudsql.googleapis.com `.\n`allServices` is a special value that covers all services.",
2006 "type": "string" 1778 "type": "string"
2007 }, 1779 },
2008 "auditLogConfigs": { 1780 "auditLogConfigs": {
2009 "description": "The configuration for logging of each type o f permission.\nNext ID: 4", 1781 "description": "The configuration for logging of each type o f permission.\nNext ID: 4",
2010 "items": { 1782 "items": {
2011 "$ref": "AuditLogConfig" 1783 "$ref": "AuditLogConfig"
2012 }, 1784 },
2013 "type": "array" 1785 "type": "array"
2014 } 1786 }
2015 }, 1787 },
2016 "type": "object" 1788 "type": "object"
2017 }, 1789 },
2018 "CreateInstanceMetadata": {
2019 "description": "Metadata type for the operation returned by\nCreateI nstance.",
2020 "id": "CreateInstanceMetadata",
2021 "properties": {
2022 "endTime": {
2023 "description": "The time at which this operation failed or w as completed successfully.",
2024 "format": "google-datetime",
2025 "type": "string"
2026 },
2027 "cancelTime": {
2028 "description": "The time at which this operation was cancell ed. If set, this operation is\nin the process of undoing itself (which is guaran teed to succeed) and\ncannot be cancelled again.",
2029 "format": "google-datetime",
2030 "type": "string"
2031 },
2032 "startTime": {
2033 "description": "The time at which the\nCreateInstance reques t was\nreceived.",
2034 "format": "google-datetime",
2035 "type": "string"
2036 },
2037 "instance": {
2038 "$ref": "Instance",
2039 "description": "The instance being created."
2040 }
2041 },
2042 "type": "object"
2043 },
2044 "ChildLink": { 1790 "ChildLink": {
2045 "description": "Metadata associated with a parent-child relationship appearing in a\nPlanNode.", 1791 "description": "Metadata associated with a parent-child relationship appearing in a\nPlanNode.",
2046 "id": "ChildLink", 1792 "id": "ChildLink",
2047 "properties": { 1793 "properties": {
1794 "type": {
1795 "description": "The type of the link. For example, in Hash J oins this could be used to\ndistinguish between the build child and the probe ch ild, or in the case\nof the child being an output variable, to represent the tag associated\nwith the output variable.",
1796 "type": "string"
1797 },
2048 "variable": { 1798 "variable": {
2049 "description": "Only present if the child node is SCALAR and corresponds\nto an output variable of the parent node. The field carries the na me of\nthe output variable.\nFor example, a `TableScan` operator that reads rows from a table will\nhave child links to the `SCALAR` nodes representing the outp ut variables\ncreated for each column that is read by the operator. The correspo nding\n`variable` fields will be set to the variable names assigned to the\ncolu mns.", 1799 "description": "Only present if the child node is SCALAR and corresponds\nto an output variable of the parent node. The field carries the na me of\nthe output variable.\nFor example, a `TableScan` operator that reads rows from a table will\nhave child links to the `SCALAR` nodes representing the outp ut variables\ncreated for each column that is read by the operator. The correspo nding\n`variable` fields will be set to the variable names assigned to the\ncolu mns.",
2050 "type": "string" 1800 "type": "string"
2051 }, 1801 },
2052 "childIndex": { 1802 "childIndex": {
2053 "description": "The node to which the link points.", 1803 "description": "The node to which the link points.",
2054 "format": "int32", 1804 "format": "int32",
2055 "type": "integer" 1805 "type": "integer"
2056 },
2057 "type": {
2058 "description": "The type of the link. For example, in Hash J oins this could be used to\ndistinguish between the build child and the probe ch ild, or in the case\nof the child being an output variable, to represent the tag associated\nwith the output variable.",
2059 "type": "string"
2060 } 1806 }
2061 }, 1807 },
2062 "type": "object" 1808 "type": "object"
2063 }, 1809 },
2064 "CloudAuditOptions": { 1810 "CloudAuditOptions": {
2065 "description": "Write a Cloud Audit log", 1811 "description": "Write a Cloud Audit log",
2066 "id": "CloudAuditOptions", 1812 "id": "CloudAuditOptions",
2067 "properties": { 1813 "properties": {
2068 "logName": { 1814 "logName": {
2069 "description": "The log_name to populate in the Cloud Audit Record.", 1815 "description": "The log_name to populate in the Cloud Audit Record.",
2070 "enum": [ 1816 "enum": [
2071 "UNSPECIFIED_LOG_NAME", 1817 "UNSPECIFIED_LOG_NAME",
2072 "ADMIN_ACTIVITY", 1818 "ADMIN_ACTIVITY",
2073 "DATA_ACCESS" 1819 "DATA_ACCESS"
2074 ], 1820 ],
2075 "enumDescriptions": [ 1821 "enumDescriptions": [
2076 "Default. Should not be used.", 1822 "Default. Should not be used.",
2077 "Corresponds to \"cloudaudit.googleapis.com/activity\"", 1823 "Corresponds to \"cloudaudit.googleapis.com/activity\"",
2078 "Corresponds to \"cloudaudit.googleapis.com/data_access\ "" 1824 "Corresponds to \"cloudaudit.googleapis.com/data_access\ ""
2079 ], 1825 ],
2080 "type": "string" 1826 "type": "string"
1827 },
1828 "authorizationLoggingOptions": {
1829 "$ref": "AuthorizationLoggingOptions",
1830 "description": "Information used by the Cloud Audit Logging pipeline."
2081 } 1831 }
2082 }, 1832 },
2083 "type": "object" 1833 "type": "object"
2084 }, 1834 },
2085 "Expr": { 1835 "Expr": {
2086 "description": "Represents an expression text. Example:\n\n title : \"User account presence\"\n description: \"Determines whether the request h as a user account\"\n expression: \"size(request.user) > 0\"", 1836 "description": "Represents an expression text. Example:\n\n title : \"User account presence\"\n description: \"Determines whether the request h as a user account\"\n expression: \"size(request.user) > 0\"",
2087 "id": "Expr", 1837 "id": "Expr",
2088 "properties": { 1838 "properties": {
2089 "description": {
2090 "description": "An optional description of the expression. T his is a longer text which\ndescribes the expression, e.g. when hovered over it in a UI.",
2091 "type": "string"
2092 },
2093 "expression": { 1839 "expression": {
2094 "description": "Textual representation of an expression in\n [Common Expression Language](http://go/api-expr) syntax.\n\nThe application cont ext of the containing message determines which\nwell-known feature set of CEL is supported.", 1840 "description": "Textual representation of an expression in\n Common Expression Language syntax.\n\nThe application context of the containing message determines which\nwell-known feature set of CEL is supported.",
2095 "type": "string" 1841 "type": "string"
2096 }, 1842 },
2097 "location": { 1843 "location": {
2098 "description": "An optional string indicating the location o f the expression for error\nreporting, e.g. a file name and a position in the fi le.", 1844 "description": "An optional string indicating the location o f the expression for error\nreporting, e.g. a file name and a position in the fi le.",
2099 "type": "string" 1845 "type": "string"
2100 }, 1846 },
2101 "title": { 1847 "title": {
2102 "description": "An optional title for the expression, i.e. a short string describing\nits purpose. This can be used e.g. in UIs which allow to enter the\nexpression.", 1848 "description": "An optional title for the expression, i.e. a short string describing\nits purpose. This can be used e.g. in UIs which allow to enter the\nexpression.",
2103 "type": "string" 1849 "type": "string"
1850 },
1851 "description": {
1852 "description": "An optional description of the expression. T his is a longer text which\ndescribes the expression, e.g. when hovered over it in a UI.",
1853 "type": "string"
2104 } 1854 }
2105 }, 1855 },
2106 "type": "object" 1856 "type": "object"
2107 }, 1857 },
2108 "Delete": { 1858 "Delete": {
2109 "description": "Arguments to delete operations.", 1859 "description": "Arguments to delete operations.",
2110 "id": "Delete", 1860 "id": "Delete",
2111 "properties": { 1861 "properties": {
1862 "table": {
1863 "description": "Required. The table whose rows will be delet ed.",
1864 "type": "string"
1865 },
2112 "keySet": { 1866 "keySet": {
2113 "$ref": "KeySet", 1867 "$ref": "KeySet",
2114 "description": "Required. The primary keys of the rows withi n table to delete." 1868 "description": "Required. The primary keys of the rows withi n table to delete."
2115 },
2116 "table": {
2117 "description": "Required. The table whose rows will be delet ed.",
2118 "type": "string"
2119 } 1869 }
2120 }, 1870 },
2121 "type": "object" 1871 "type": "object"
2122 }, 1872 },
2123 "ListInstanceConfigsResponse": { 1873 "ListInstanceConfigsResponse": {
2124 "description": "The response for ListInstanceConfigs.", 1874 "description": "The response for ListInstanceConfigs.",
2125 "id": "ListInstanceConfigsResponse", 1875 "id": "ListInstanceConfigsResponse",
2126 "properties": { 1876 "properties": {
2127 "nextPageToken": { 1877 "nextPageToken": {
2128 "description": "`next_page_token` can be sent in a subsequen t\nListInstanceConfigs call to\nfetch more of the matching instance configuratio ns.", 1878 "description": "`next_page_token` can be sent in a subsequen t\nListInstanceConfigs call to\nfetch more of the matching instance configuratio ns.",
(...skipping 36 matching lines...) Expand 10 before | Expand all | Expand 10 after
2165 "description": "Execute mutations in a temporary transaction . Note that unlike\ncommit of a previously-started transaction, commit with a\nt emporary transaction is non-idempotent. That is, if the\n`CommitRequest` is sent to Cloud Spanner more than once (for\ninstance, due to retries in the applicati on, or in the\ntransport library), it is possible that the mutations are\nexecut ed more than once. If this is undesirable, use\nBeginTransaction and\nCommit ins tead." 1915 "description": "Execute mutations in a temporary transaction . Note that unlike\ncommit of a previously-started transaction, commit with a\nt emporary transaction is non-idempotent. That is, if the\n`CommitRequest` is sent to Cloud Spanner more than once (for\ninstance, due to retries in the applicati on, or in the\ntransport library), it is possible that the mutations are\nexecut ed more than once. If this is undesirable, use\nBeginTransaction and\nCommit ins tead."
2166 }, 1916 },
2167 "transactionId": { 1917 "transactionId": {
2168 "description": "Commit a previously-started transaction.", 1918 "description": "Commit a previously-started transaction.",
2169 "format": "byte", 1919 "format": "byte",
2170 "type": "string" 1920 "type": "string"
2171 } 1921 }
2172 }, 1922 },
2173 "type": "object" 1923 "type": "object"
2174 }, 1924 },
2175 "GetIamPolicyRequest": {
2176 "description": "Request message for `GetIamPolicy` method.",
2177 "id": "GetIamPolicyRequest",
2178 "properties": {},
2179 "type": "object"
2180 },
2181 "TestIamPermissionsResponse": { 1925 "TestIamPermissionsResponse": {
2182 "description": "Response message for `TestIamPermissions` method.", 1926 "description": "Response message for `TestIamPermissions` method.",
2183 "id": "TestIamPermissionsResponse", 1927 "id": "TestIamPermissionsResponse",
2184 "properties": { 1928 "properties": {
2185 "permissions": { 1929 "permissions": {
2186 "description": "A subset of `TestPermissionsRequest.permissi ons` that the caller is\nallowed.", 1930 "description": "A subset of `TestPermissionsRequest.permissi ons` that the caller is\nallowed.",
2187 "items": { 1931 "items": {
2188 "type": "string" 1932 "type": "string"
2189 }, 1933 },
2190 "type": "array" 1934 "type": "array"
2191 } 1935 }
2192 }, 1936 },
2193 "type": "object" 1937 "type": "object"
2194 }, 1938 },
2195 "CreateDatabaseMetadata": { 1939 "GetIamPolicyRequest": {
2196 "description": "Metadata type for the operation returned by\nCreateD atabase.", 1940 "description": "Request message for `GetIamPolicy` method.",
2197 "id": "CreateDatabaseMetadata", 1941 "id": "GetIamPolicyRequest",
2198 "properties": { 1942 "properties": {},
2199 "database": {
2200 "description": "The database being created.",
2201 "type": "string"
2202 }
2203 },
2204 "type": "object" 1943 "type": "object"
2205 }, 1944 },
2206 "Rule": { 1945 "Rule": {
2207 "description": "A rule to be applied in a Policy.", 1946 "description": "A rule to be applied in a Policy.",
2208 "id": "Rule", 1947 "id": "Rule",
2209 "properties": { 1948 "properties": {
1949 "description": {
1950 "description": "Human-readable description of the rule.",
1951 "type": "string"
1952 },
1953 "conditions": {
1954 "description": "Additional restrictions that must be met",
1955 "items": {
1956 "$ref": "Condition"
1957 },
1958 "type": "array"
1959 },
1960 "logConfig": {
1961 "description": "The config returned to callers of tech.iam.I AM.CheckPolicy for any entries\nthat match the LOG action.",
1962 "items": {
1963 "$ref": "LogConfig"
1964 },
1965 "type": "array"
1966 },
1967 "in": {
1968 "description": "If one or more 'in' clauses are specified, t he rule matches if\nthe PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.",
1969 "items": {
1970 "type": "string"
1971 },
1972 "type": "array"
1973 },
2210 "permissions": { 1974 "permissions": {
2211 "description": "A permission is a string of form '<service>. <resource type>.<verb>'\n(e.g., 'storage.buckets.list'). A value of '*' matches all permissions,\nand a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.", 1975 "description": "A permission is a string of form '<service>. <resource type>.<verb>'\n(e.g., 'storage.buckets.list'). A value of '*' matches all permissions,\nand a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.",
2212 "items": { 1976 "items": {
2213 "type": "string" 1977 "type": "string"
2214 }, 1978 },
2215 "type": "array" 1979 "type": "array"
2216 }, 1980 },
2217 "action": { 1981 "action": {
2218 "description": "Required", 1982 "description": "Required",
2219 "enum": [ 1983 "enum": [
(...skipping 13 matching lines...) Expand all
2233 "Matching 'Entries' tell IAM.Check callers to generate l ogs." 1997 "Matching 'Entries' tell IAM.Check callers to generate l ogs."
2234 ], 1998 ],
2235 "type": "string" 1999 "type": "string"
2236 }, 2000 },
2237 "notIn": { 2001 "notIn": {
2238 "description": "If one or more 'not_in' clauses are specifie d, the rule matches\nif the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entri es.\nThe format for in and not_in entries is the same as for members in a\nBindi ng (see google/iam/v1/policy.proto).", 2002 "description": "If one or more 'not_in' clauses are specifie d, the rule matches\nif the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entri es.\nThe format for in and not_in entries is the same as for members in a\nBindi ng (see google/iam/v1/policy.proto).",
2239 "items": { 2003 "items": {
2240 "type": "string" 2004 "type": "string"
2241 }, 2005 },
2242 "type": "array" 2006 "type": "array"
2243 },
2244 "description": {
2245 "description": "Human-readable description of the rule.",
2246 "type": "string"
2247 },
2248 "conditions": {
2249 "description": "Additional restrictions that must be met",
2250 "items": {
2251 "$ref": "Condition"
2252 },
2253 "type": "array"
2254 },
2255 "logConfig": {
2256 "description": "The config returned to callers of tech.iam.I AM.CheckPolicy for any entries\nthat match the LOG action.",
2257 "items": {
2258 "$ref": "LogConfig"
2259 },
2260 "type": "array"
2261 },
2262 "in": {
2263 "description": "If one or more 'in' clauses are specified, t he rule matches if\nthe PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.",
2264 "items": {
2265 "type": "string"
2266 },
2267 "type": "array"
2268 } 2007 }
2269 }, 2008 },
2270 "type": "object" 2009 "type": "object"
2271 }, 2010 },
2011 "CreateDatabaseMetadata": {
2012 "description": "Metadata type for the operation returned by\nCreateD atabase.",
2013 "id": "CreateDatabaseMetadata",
2014 "properties": {
2015 "database": {
2016 "description": "The database being created.",
2017 "type": "string"
2018 }
2019 },
2020 "type": "object"
2021 },
2272 "LogConfig": { 2022 "LogConfig": {
2273 "description": "Specifies what kind of log the caller must write", 2023 "description": "Specifies what kind of log the caller must write\nIn crement a streamz counter with the specified metric and field names.\n\nMetric n ames should start with a '/', generally be lowercase-only,\nand end in \"_count\ ". Field names should not contain an initial slash.\nThe actual exported metric names will have \"/iam/policy\" prepended.\n\nField names correspond to IAM requ est parameters and field values are\ntheir respective values.\n\nAt present the only supported field names are\n - \"iam_principal\", corresponding to IAMCont ext.principal;\n - \"\" (empty string), resulting in one aggretated counter wi th no field.\n\nExamples:\n counter { metric: \"/debug_access_count\" field: \ "iam_principal\" }\n ==> increment counter /iam/policy/backend_debug_access_cou nt\n {iam_principal=[value of IAMContext.principal]}\n\nA t this time we do not support:\n* multiple field names (though this may be suppo rted in the future)\n* decrementing the counter\n* incrementing it by anything o ther than 1",
2274 "id": "LogConfig", 2024 "id": "LogConfig",
2275 "properties": { 2025 "properties": {
2026 "dataAccess": {
2027 "$ref": "DataAccessOptions",
2028 "description": "Data access options."
2029 },
2276 "cloudAudit": { 2030 "cloudAudit": {
2277 "$ref": "CloudAuditOptions", 2031 "$ref": "CloudAuditOptions",
2278 "description": "Cloud audit options." 2032 "description": "Cloud audit options."
2279 }, 2033 },
2280 "counter": { 2034 "counter": {
2281 "$ref": "CounterOptions", 2035 "$ref": "CounterOptions",
2282 "description": "Counter options." 2036 "description": "Counter options."
2283 },
2284 "dataAccess": {
2285 "$ref": "DataAccessOptions",
2286 "description": "Data access options."
2287 } 2037 }
2288 }, 2038 },
2289 "type": "object" 2039 "type": "object"
2290 }, 2040 },
2291 "Session": { 2041 "Session": {
2292 "description": "A session in the Cloud Spanner API.", 2042 "description": "A session in the Cloud Spanner API.",
2293 "id": "Session", 2043 "id": "Session",
2294 "properties": { 2044 "properties": {
2295 "name": { 2045 "name": {
2296 "description": "Required. The name of the session.", 2046 "description": "Required. The name of the session.",
2297 "type": "string" 2047 "type": "string"
2298 } 2048 }
2299 }, 2049 },
2300 "type": "object" 2050 "type": "object"
2301 }, 2051 },
2302 "KeyRange": { 2052 "KeyRange": {
2303 "description": "KeyRange represents a range of rows in a table or in dex.\n\nA range has a start key and an end key. These keys can be open or\nclose d, indicating if the range includes rows with that key.\n\nKeys are represented by lists, where the ith value in the list\ncorresponds to the ith component of t he table or index primary key.\nIndividual values are encoded as described here. \n\nFor example, consider the following table definition:\n\n CREATE TABLE Us erEvents (\n UserName STRING(MAX),\n EventDate STRING(10)\n ) PRIMA RY KEY(UserName, EventDate);\n\nThe following keys name rows in this table:\n\n \"Bob\", \"2014-09-23\"\n\nSince the `UserEvents` table's `PRIMARY KEY` claus e names two\ncolumns, each `UserEvents` key has two elements; the first is the\n `UserName`, and the second is the `EventDate`.\n\nKey ranges with multiple compo nents are interpreted\nlexicographically by component using the table or index k ey's declared\nsort order. For example, the following range returns all events f or\nuser `\"Bob\"` that occurred in the year 2015:\n\n \"start_closed\": [\"B ob\", \"2015-01-01\"]\n \"end_closed\": [\"Bob\", \"2015-12-31\"]\n\nStart an d end keys can omit trailing key components. This affects the\ninclusion and exc lusion of rows that exactly match the provided key\ncomponents: if the key is cl osed, then rows that exactly match the\nprovided components are included; if the key is open, then rows\nthat exactly match are not included.\n\nFor example, th e following range includes all events for `\"Bob\"` that\noccurred during and af ter the year 2000:\n\n \"start_closed\": [\"Bob\", \"2000-01-01\"]\n \"end _closed\": [\"Bob\"]\n\nThe next example retrieves all events for `\"Bob\"`:\n\n \"start_closed\": [\"Bob\"]\n \"end_closed\": [\"Bob\"]\n\nTo retrieve ev ents before the year 2000:\n\n \"start_closed\": [\"Bob\"]\n \"end_open\": [\"Bob\", \"2000-01-01\"]\n\nThe following range includes all rows in the table :\n\n \"start_closed\": []\n \"end_closed\": []\n\nThis range returns all users whose `UserName` begins with any\ncharacter from A to C:\n\n \"start_cl osed\": [\"A\"]\n \"end_open\": [\"D\"]\n\nThis range returns all users whose `UserName` begins with B:\n\n \"start_closed\": [\"B\"]\n \"end_open\": [ \"C\"]\n\nKey ranges honor column sort order. For example, suppose a table is\nd efined as follows:\n\n CREATE TABLE DescendingSortedTable {\n Key INT64, \n ...\n ) PRIMARY KEY(Key DESC);\n\nThe following range retrieves all r ows with key values between 1\nand 100 inclusive:\n\n \"start_closed\": [\"10 0\"]\n \"end_closed\": [\"1\"]\n\nNote that 100 is passed as the start, and 1 is passed as the end,\nbecause `Key` is a descending column in the schema.", 2053 "description": "KeyRange represents a range of rows in a table or in dex.\n\nA range has a start key and an end key. These keys can be open or\nclose d, indicating if the range includes rows with that key.\n\nKeys are represented by lists, where the ith value in the list\ncorresponds to the ith component of t he table or index primary key.\nIndividual values are encoded as described here. \n\nFor example, consider the following table definition:\n\n CREATE TABLE Us erEvents (\n UserName STRING(MAX),\n EventDate STRING(10)\n ) PRIMA RY KEY(UserName, EventDate);\n\nThe following keys name rows in this table:\n\n \"Bob\", \"2014-09-23\"\n\nSince the `UserEvents` table's `PRIMARY KEY` claus e names two\ncolumns, each `UserEvents` key has two elements; the first is the\n `UserName`, and the second is the `EventDate`.\n\nKey ranges with multiple compo nents are interpreted\nlexicographically by component using the table or index k ey's declared\nsort order. For example, the following range returns all events f or\nuser `\"Bob\"` that occurred in the year 2015:\n\n \"start_closed\": [\"B ob\", \"2015-01-01\"]\n \"end_closed\": [\"Bob\", \"2015-12-31\"]\n\nStart an d end keys can omit trailing key components. This affects the\ninclusion and exc lusion of rows that exactly match the provided key\ncomponents: if the key is cl osed, then rows that exactly match the\nprovided components are included; if the key is open, then rows\nthat exactly match are not included.\n\nFor example, th e following range includes all events for `\"Bob\"` that\noccurred during and af ter the year 2000:\n\n \"start_closed\": [\"Bob\", \"2000-01-01\"]\n \"end _closed\": [\"Bob\"]\n\nThe next example retrieves all events for `\"Bob\"`:\n\n \"start_closed\": [\"Bob\"]\n \"end_closed\": [\"Bob\"]\n\nTo retrieve ev ents before the year 2000:\n\n \"start_closed\": [\"Bob\"]\n \"end_open\": [\"Bob\", \"2000-01-01\"]\n\nThe following range includes all rows in the table :\n\n \"start_closed\": []\n \"end_closed\": []\n\nThis range returns all users whose `UserName` begins with any\ncharacter from A to C:\n\n \"start_cl osed\": [\"A\"]\n \"end_open\": [\"D\"]\n\nThis range returns all users whose `UserName` begins with B:\n\n \"start_closed\": [\"B\"]\n \"end_open\": [ \"C\"]\n\nKey ranges honor column sort order. For example, suppose a table is\nd efined as follows:\n\n CREATE TABLE DescendingSortedTable {\n Key INT64, \n ...\n ) PRIMARY KEY(Key DESC);\n\nThe following range retrieves all r ows with key values between 1\nand 100 inclusive:\n\n \"start_closed\": [\"10 0\"]\n \"end_closed\": [\"1\"]\n\nNote that 100 is passed as the start, and 1 is passed as the end,\nbecause `Key` is a descending column in the schema.",
2304 "id": "KeyRange", 2054 "id": "KeyRange",
2305 "properties": { 2055 "properties": {
2056 "endOpen": {
2057 "description": "If the end is open, then the range excludes rows whose first\n`len(end_open)` key columns exactly match `end_open`.",
2058 "items": {
2059 "type": "any"
2060 },
2061 "type": "array"
2062 },
2063 "endClosed": {
2064 "description": "If the end is closed, then the range include s all rows whose\nfirst `len(end_closed)` key columns exactly match `end_closed` .",
2065 "items": {
2066 "type": "any"
2067 },
2068 "type": "array"
2069 },
2306 "startOpen": { 2070 "startOpen": {
2307 "description": "If the start is open, then the range exclude s rows whose first\n`len(start_open)` key columns exactly match `start_open`.", 2071 "description": "If the start is open, then the range exclude s rows whose first\n`len(start_open)` key columns exactly match `start_open`.",
2308 "items": { 2072 "items": {
2309 "type": "any" 2073 "type": "any"
2310 }, 2074 },
2311 "type": "array" 2075 "type": "array"
2312 }, 2076 },
2313 "startClosed": { 2077 "startClosed": {
2314 "description": "If the start is closed, then the range inclu des all rows whose\nfirst `len(start_closed)` key columns exactly match `start_c losed`.", 2078 "description": "If the start is closed, then the range inclu des all rows whose\nfirst `len(start_closed)` key columns exactly match `start_c losed`.",
2315 "items": { 2079 "items": {
2316 "type": "any" 2080 "type": "any"
2317 }, 2081 },
2318 "type": "array"
2319 },
2320 "endOpen": {
2321 "description": "If the end is open, then the range excludes rows whose first\n`len(end_open)` key columns exactly match `end_open`.",
2322 "items": {
2323 "type": "any"
2324 },
2325 "type": "array"
2326 },
2327 "endClosed": {
2328 "description": "If the end is closed, then the range include s all rows whose\nfirst `len(end_closed)` key columns exactly match `end_closed` .",
2329 "items": {
2330 "type": "any"
2331 },
2332 "type": "array" 2082 "type": "array"
2333 } 2083 }
2334 }, 2084 },
2335 "type": "object" 2085 "type": "object"
2336 }, 2086 },
2337 "ListInstancesResponse": { 2087 "ListInstancesResponse": {
2338 "description": "The response for ListInstances.", 2088 "description": "The response for ListInstances.",
2339 "id": "ListInstancesResponse", 2089 "id": "ListInstancesResponse",
2340 "properties": { 2090 "properties": {
2341 "nextPageToken": {
2342 "description": "`next_page_token` can be sent in a subsequen t\nListInstances call to fetch more\nof the matching instances.",
2343 "type": "string"
2344 },
2345 "instances": { 2091 "instances": {
2346 "description": "The list of requested instances.", 2092 "description": "The list of requested instances.",
2347 "items": { 2093 "items": {
2348 "$ref": "Instance" 2094 "$ref": "Instance"
2349 }, 2095 },
2350 "type": "array" 2096 "type": "array"
2097 },
2098 "nextPageToken": {
2099 "description": "`next_page_token` can be sent in a subsequen t\nListInstances call to fetch more\nof the matching instances.",
2100 "type": "string"
2351 } 2101 }
2352 }, 2102 },
2353 "type": "object" 2103 "type": "object"
2354 }, 2104 },
2355 "ShortRepresentation": { 2105 "ShortRepresentation": {
2356 "description": "Condensed representation of a node and its subtree. Only present for\n`SCALAR` PlanNode(s).", 2106 "description": "Condensed representation of a node and its subtree. Only present for\n`SCALAR` PlanNode(s).",
2357 "id": "ShortRepresentation", 2107 "id": "ShortRepresentation",
2358 "properties": { 2108 "properties": {
2359 "description": { 2109 "description": {
2360 "description": "A string representation of the expression su btree rooted at this node.", 2110 "description": "A string representation of the expression su btree rooted at this node.",
(...skipping 59 matching lines...) Expand 10 before | Expand all | Expand 10 after
2420 "$ref": "ReadWrite", 2170 "$ref": "ReadWrite",
2421 "description": "Transaction may write.\n\nAuthorization to b egin a read-write transaction requires\n`spanner.databases.beginOrRollbackReadWr iteTransaction` permission\non the `session` resource." 2171 "description": "Transaction may write.\n\nAuthorization to b egin a read-write transaction requires\n`spanner.databases.beginOrRollbackReadWr iteTransaction` permission\non the `session` resource."
2422 } 2172 }
2423 }, 2173 },
2424 "type": "object" 2174 "type": "object"
2425 }, 2175 },
2426 "CreateDatabaseRequest": { 2176 "CreateDatabaseRequest": {
2427 "description": "The request for CreateDatabase.", 2177 "description": "The request for CreateDatabase.",
2428 "id": "CreateDatabaseRequest", 2178 "id": "CreateDatabaseRequest",
2429 "properties": { 2179 "properties": {
2430 "createStatement": {
2431 "description": "Required. A `CREATE DATABASE` statement, whi ch specifies the ID of the\nnew database. The database ID must conform to the r egular expression\n`a-z*[a-z0-9]` and be between 2 and 30 characters in length.\ nIf the database ID is a reserved word or if it contains a hyphen, the\ndatabase ID must be enclosed in backticks (`` ` ``).",
2432 "type": "string"
2433 },
2434 "extraStatements": { 2180 "extraStatements": {
2435 "description": "An optional list of DDL statements to run in side the newly created\ndatabase. Statements can create tables, indexes, etc. Th ese\nstatements execute atomically with the creation of the database:\nif there is an error in any statement, the database is not created.", 2181 "description": "An optional list of DDL statements to run in side the newly created\ndatabase. Statements can create tables, indexes, etc. Th ese\nstatements execute atomically with the creation of the database:\nif there is an error in any statement, the database is not created.",
2436 "items": { 2182 "items": {
2437 "type": "string" 2183 "type": "string"
2438 }, 2184 },
2439 "type": "array" 2185 "type": "array"
2186 },
2187 "createStatement": {
2188 "description": "Required. A `CREATE DATABASE` statement, whi ch specifies the ID of the\nnew database. The database ID must conform to the r egular expression\n`a-z*[a-z0-9]` and be between 2 and 30 characters in length.\ nIf the database ID is a reserved word or if it contains a hyphen, the\ndatabase ID must be enclosed in backticks (`` ` ``).",
2189 "type": "string"
2440 } 2190 }
2441 }, 2191 },
2442 "type": "object" 2192 "type": "object"
2443 }, 2193 },
2444 "CreateInstanceRequest": { 2194 "CreateInstanceRequest": {
2445 "description": "The request for CreateInstance.", 2195 "description": "The request for CreateInstance.",
2446 "id": "CreateInstanceRequest", 2196 "id": "CreateInstanceRequest",
2447 "properties": { 2197 "properties": {
2198 "instanceId": {
2199 "description": "Required. The ID of the instance to create. Valid identifiers are of the\nform `a-z*[a-z0-9]` and must be between 6 and 30 characters in\nlength.",
2200 "type": "string"
2201 },
2448 "instance": { 2202 "instance": {
2449 "$ref": "Instance", 2203 "$ref": "Instance",
2450 "description": "Required. The instance to create. The name may be omitted, but if\nspecified must be `<parent>/instances/<instance_id>`." 2204 "description": "Required. The instance to create. The name may be omitted, but if\nspecified must be `<parent>/instances/<instance_id>`."
2451 },
2452 "instanceId": {
2453 "description": "Required. The ID of the instance to create. Valid identifiers are of the\nform `a-z*[a-z0-9]` and must be between 6 and 30 characters in\nlength.",
2454 "type": "string"
2455 } 2205 }
2456 }, 2206 },
2457 "type": "object" 2207 "type": "object"
2458 }, 2208 },
2459 "Condition": { 2209 "Condition": {
2460 "description": "A condition to be met.", 2210 "description": "A condition to be met.",
2461 "id": "Condition", 2211 "id": "Condition",
2462 "properties": { 2212 "properties": {
2463 "values": {
2464 "description": "The objects of the condition. This is mutual ly exclusive with 'value'.",
2465 "items": {
2466 "type": "string"
2467 },
2468 "type": "array"
2469 },
2470 "iam": {
2471 "description": "Trusted attributes supplied by the IAM syste m.",
2472 "enum": [
2473 "NO_ATTR",
2474 "AUTHORITY",
2475 "ATTRIBUTION",
2476 "SECURITY_REALM",
2477 "APPROVER",
2478 "JUSTIFICATION_TYPE"
2479 ],
2480 "enumDescriptions": [
2481 "Default non-attribute.",
2482 "Either principal or (if present) authority selector.",
2483 "The principal (even if an authority selector is present ), which\nmust only be used for attribution, not authorization.",
2484 "Any of the security realms in the IAMContext (go/securi ty-realms).\nWhen used with IN, the condition indicates \"any of the request's r ealms\nmatch one of the given values; with NOT_IN, \"none of the realms match\na ny of the given values\". It is not permitted to grant access based on\nthe *abs ence* of a realm, so realm conditions can only be used in\na \"positive\" contex t (e.g., ALLOW/IN or DENY/NOT_IN).",
2485 "An approver (distinct from the requester) that has auth orized this\nrequest.\nWhen used with IN, the condition indicates that one of th e approvers\nassociated with the request matches the specified principal, or is a\nmember of the specified group. Approvers can only grant additional\naccess, a nd are thus only used in a strictly positive context\n(e.g. ALLOW/IN or DENY/NOT _IN).",
2486 "What types of justifications have been supplied with th is request.\nString values should match enum names from tech.iam.JustificationTy pe,\ne.g. \"MANUAL_STRING\". It is not permitted to grant access based on\nthe * absence* of a justification, so justification conditions can only\nbe used in a \"positive\" context (e.g., ALLOW/IN or DENY/NOT_IN).\n\nMultiple justifications , e.g., a Buganizer ID and a manually-entered\nreason, are normal and supported. "
2487 ],
2488 "type": "string"
2489 },
2490 "op": { 2213 "op": {
2491 "description": "An operator to apply the subject with.", 2214 "description": "An operator to apply the subject with.",
2492 "enum": [ 2215 "enum": [
2493 "NO_OP", 2216 "NO_OP",
2494 "EQUALS", 2217 "EQUALS",
2495 "NOT_EQUALS", 2218 "NOT_EQUALS",
2496 "IN", 2219 "IN",
2497 "NOT_IN", 2220 "NOT_IN",
2498 "DISCHARGED" 2221 "DISCHARGED"
2499 ], 2222 ],
(...skipping 25 matching lines...) Expand all
2525 "Region of the resource", 2248 "Region of the resource",
2526 "Service name", 2249 "Service name",
2527 "Resource name", 2250 "Resource name",
2528 "IP address of the caller" 2251 "IP address of the caller"
2529 ], 2252 ],
2530 "type": "string" 2253 "type": "string"
2531 }, 2254 },
2532 "value": { 2255 "value": {
2533 "description": "DEPRECATED. Use 'values' instead.", 2256 "description": "DEPRECATED. Use 'values' instead.",
2534 "type": "string" 2257 "type": "string"
2258 },
2259 "iam": {
2260 "description": "Trusted attributes supplied by the IAM syste m.",
2261 "enum": [
2262 "NO_ATTR",
2263 "AUTHORITY",
2264 "ATTRIBUTION",
2265 "SECURITY_REALM",
2266 "APPROVER",
2267 "JUSTIFICATION_TYPE"
2268 ],
2269 "enumDescriptions": [
2270 "Default non-attribute.",
2271 "Either principal or (if present) authority selector.",
2272 "The principal (even if an authority selector is present ), which\nmust only be used for attribution, not authorization.",
2273 "Any of the security realms in the IAMContext (go/securi ty-realms).\nWhen used with IN, the condition indicates \"any of the request's r ealms\nmatch one of the given values; with NOT_IN, \"none of the realms match\na ny of the given values\". It is not permitted to grant access based on\nthe *abs ence* of a realm, so realm conditions can only be used in\na \"positive\" contex t (e.g., ALLOW/IN or DENY/NOT_IN).",
2274 "An approver (distinct from the requester) that has auth orized this\nrequest.\nWhen used with IN, the condition indicates that one of th e approvers\nassociated with the request matches the specified principal, or is a\nmember of the specified group. Approvers can only grant additional\naccess, a nd are thus only used in a strictly positive context\n(e.g. ALLOW/IN or DENY/NOT _IN).",
2275 "What types of justifications have been supplied with th is request.\nString values should match enum names from tech.iam.JustificationTy pe,\ne.g. \"MANUAL_STRING\". It is not permitted to grant access based on\nthe * absence* of a justification, so justification conditions can only\nbe used in a \"positive\" context (e.g., ALLOW/IN or DENY/NOT_IN).\n\nMultiple justifications , e.g., a Buganizer ID and a manually-entered\nreason, are normal and supported. "
2276 ],
2277 "type": "string"
2278 },
2279 "values": {
2280 "description": "The objects of the condition. This is mutual ly exclusive with 'value'.",
2281 "items": {
2282 "type": "string"
2283 },
2284 "type": "array"
2535 } 2285 }
2536 }, 2286 },
2537 "type": "object" 2287 "type": "object"
2538 }, 2288 },
2539 "AuditLogConfig": { 2289 "AuditLogConfig": {
2540 "description": "Provides the configuration for logging a type of per missions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type \": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and ' DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging.", 2290 "description": "Provides the configuration for logging a type of per missions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type \": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and ' DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging.",
2541 "id": "AuditLogConfig", 2291 "id": "AuditLogConfig",
2542 "properties": { 2292 "properties": {
2543 "exemptedMembers": {
2544 "description": "Specifies the identities that do not cause l ogging for this type of\npermission.\nFollows the same format of Binding.members .",
2545 "items": {
2546 "type": "string"
2547 },
2548 "type": "array"
2549 },
2550 "logType": { 2293 "logType": {
2551 "description": "The log type that this config enables.", 2294 "description": "The log type that this config enables.",
2552 "enum": [ 2295 "enum": [
2553 "LOG_TYPE_UNSPECIFIED", 2296 "LOG_TYPE_UNSPECIFIED",
2554 "ADMIN_READ", 2297 "ADMIN_READ",
2555 "DATA_WRITE", 2298 "DATA_WRITE",
2556 "DATA_READ" 2299 "DATA_READ"
2557 ], 2300 ],
2558 "enumDescriptions": [ 2301 "enumDescriptions": [
2559 "Default case. Should never be this.", 2302 "Default case. Should never be this.",
2560 "Admin reads. Example: CloudIAM getIamPolicy", 2303 "Admin reads. Example: CloudIAM getIamPolicy",
2561 "Data writes. Example: CloudSQL Users create", 2304 "Data writes. Example: CloudSQL Users create",
2562 "Data reads. Example: CloudSQL Users list" 2305 "Data reads. Example: CloudSQL Users list"
2563 ], 2306 ],
2564 "type": "string" 2307 "type": "string"
2308 },
2309 "exemptedMembers": {
2310 "description": "Specifies the identities that do not cause l ogging for this type of\npermission.\nFollows the same format of Binding.members .",
2311 "items": {
2312 "type": "string"
2313 },
2314 "type": "array"
2565 } 2315 }
2566 }, 2316 },
2567 "type": "object" 2317 "type": "object"
2568 }, 2318 },
2569 "ReadOnly": { 2319 "ReadOnly": {
2570 "description": "Message type to initiate a read-only transaction.", 2320 "description": "Message type to initiate a read-only transaction.",
2571 "id": "ReadOnly", 2321 "id": "ReadOnly",
2572 "properties": { 2322 "properties": {
2573 "strong": {
2574 "description": "Read at a timestamp where all previously com mitted transactions\nare visible.",
2575 "type": "boolean"
2576 },
2577 "minReadTimestamp": { 2323 "minReadTimestamp": {
2578 "description": "Executes all reads at a timestamp >= `min_re ad_timestamp`.\n\nThis is useful for requesting fresher data than some previous\ nread, or data that is fresh enough to observe the effects of some\npreviously c ommitted transaction whose timestamp is known.\n\nNote that this option can only be used in single-use transactions.", 2324 "description": "Executes all reads at a timestamp >= `min_re ad_timestamp`.\n\nThis is useful for requesting fresher data than some previous\ nread, or data that is fresh enough to observe the effects of some\npreviously c ommitted transaction whose timestamp is known.\n\nNote that this option can only be used in single-use transactions.",
2579 "format": "google-datetime", 2325 "format": "google-datetime",
2580 "type": "string" 2326 "type": "string"
2581 }, 2327 },
2582 "maxStaleness": { 2328 "maxStaleness": {
2583 "description": "Read data at a timestamp >= `NOW - max_stale ness`\nseconds. Guarantees that all writes that have committed more\nthan the sp ecified number of seconds ago are visible. Because\nCloud Spanner chooses the ex act timestamp, this mode works even if\nthe client's local clock is substantiall y skewed from Cloud Spanner\ncommit timestamps.\n\nUseful for reading the freshe st data available at a nearby\nreplica, while bounding the possible staleness if the local\nreplica has fallen behind.\n\nNote that this option can only be used in single-use\ntransactions.", 2329 "description": "Read data at a timestamp >= `NOW - max_stale ness`\nseconds. Guarantees that all writes that have committed more\nthan the sp ecified number of seconds ago are visible. Because\nCloud Spanner chooses the ex act timestamp, this mode works even if\nthe client's local clock is substantiall y skewed from Cloud Spanner\ncommit timestamps.\n\nUseful for reading the freshe st data available at a nearby\nreplica, while bounding the possible staleness if the local\nreplica has fallen behind.\n\nNote that this option can only be used in single-use\ntransactions.",
2584 "format": "google-duration", 2330 "format": "google-duration",
2585 "type": "string" 2331 "type": "string"
2586 }, 2332 },
2587 "readTimestamp": { 2333 "readTimestamp": {
2588 "description": "Executes all reads at the given timestamp. U nlike other modes,\nreads at a specific timestamp are repeatable; the same read at\nthe same timestamp always returns the same data. If the\ntimestamp is in the future, the read will block until the\nspecified timestamp, modulo the read's d eadline.\n\nUseful for large scale consistent reads such as mapreduces, or\nfor coordinating many reads against a consistent snapshot of the\ndata.", 2334 "description": "Executes all reads at the given timestamp. U nlike other modes,\nreads at a specific timestamp are repeatable; the same read at\nthe same timestamp always returns the same data. If the\ntimestamp is in the future, the read will block until the\nspecified timestamp, modulo the read's d eadline.\n\nUseful for large scale consistent reads such as mapreduces, or\nfor coordinating many reads against a consistent snapshot of the\ndata.",
2589 "format": "google-datetime", 2335 "format": "google-datetime",
2590 "type": "string" 2336 "type": "string"
2591 }, 2337 },
2592 "returnReadTimestamp": { 2338 "returnReadTimestamp": {
2593 "description": "If true, the Cloud Spanner-selected read tim estamp is included in\nthe Transaction message that describes the transaction.", 2339 "description": "If true, the Cloud Spanner-selected read tim estamp is included in\nthe Transaction message that describes the transaction.",
2594 "type": "boolean" 2340 "type": "boolean"
2595 }, 2341 },
2596 "exactStaleness": { 2342 "exactStaleness": {
2597 "description": "Executes all reads at a timestamp that is `e xact_staleness`\nold. The timestamp is chosen soon after the read is started.\n\ nGuarantees that all writes that have committed more than the\nspecified number of seconds ago are visible. Because Cloud Spanner\nchooses the exact timestamp, this mode works even if the client's\nlocal clock is substantially skewed from C loud Spanner commit\ntimestamps.\n\nUseful for reading at nearby replicas withou t the distributed\ntimestamp negotiation overhead of `max_staleness`.", 2343 "description": "Executes all reads at a timestamp that is `e xact_staleness`\nold. The timestamp is chosen soon after the read is started.\n\ nGuarantees that all writes that have committed more than the\nspecified number of seconds ago are visible. Because Cloud Spanner\nchooses the exact timestamp, this mode works even if the client's\nlocal clock is substantially skewed from C loud Spanner commit\ntimestamps.\n\nUseful for reading at nearby replicas withou t the distributed\ntimestamp negotiation overhead of `max_staleness`.",
2598 "format": "google-duration", 2344 "format": "google-duration",
2599 "type": "string" 2345 "type": "string"
2346 },
2347 "strong": {
2348 "description": "Read at a timestamp where all previously com mitted transactions\nare visible.",
2349 "type": "boolean"
2600 } 2350 }
2601 }, 2351 },
2602 "type": "object" 2352 "type": "object"
2603 }, 2353 },
2604 "ExecuteSqlRequest": { 2354 "ExecuteSqlRequest": {
2605 "description": "The request for ExecuteSql and\nExecuteStreamingSql. ", 2355 "description": "The request for ExecuteSql and\nExecuteStreamingSql. ",
2606 "id": "ExecuteSqlRequest", 2356 "id": "ExecuteSqlRequest",
2607 "properties": { 2357 "properties": {
2358 "paramTypes": {
2359 "additionalProperties": {
2360 "$ref": "Type"
2361 },
2362 "description": "It is not always possible for Cloud Spanner to infer the right SQL type\nfrom a JSON value. For example, values of type `BY TES` and values\nof type `STRING` both appear in params as JSON strings.\n\nIn t hese cases, `param_types` can be used to specify the exact\nSQL type for some or all of the SQL query parameters. See the\ndefinition of Type for more informati on\nabout SQL types.",
2363 "type": "object"
2364 },
2608 "sql": { 2365 "sql": {
2609 "description": "Required. The SQL query string.", 2366 "description": "Required. The SQL query string.",
2610 "type": "string" 2367 "type": "string"
2611 }, 2368 },
2612 "params": { 2369 "params": {
2613 "additionalProperties": { 2370 "additionalProperties": {
2614 "description": "Properties of the object.", 2371 "description": "Properties of the object.",
2615 "type": "any" 2372 "type": "any"
2616 }, 2373 },
2617 "description": "The SQL query string can contain parameter p laceholders. A parameter\nplaceholder consists of `'@'` followed by the paramete r\nname. Parameter names consist of any combination of letters,\nnumbers, and un derscores.\n\nParameters can appear anywhere that a literal value is expected. The same\nparameter name can be used more than once, for example:\n `\"WHERE id > @msg_id AND id < @msg_id + 100\"`\n\nIt is an error to execute an SQL query w ith unbound parameters.\n\nParameter values are specified using `params`, which is a JSON\nobject whose keys are parameter names, and whose values are the\ncorr esponding parameter values.", 2374 "description": "The SQL query string can contain parameter p laceholders. A parameter\nplaceholder consists of `'@'` followed by the paramete r\nname. Parameter names consist of any combination of letters,\nnumbers, and un derscores.\n\nParameters can appear anywhere that a literal value is expected. The same\nparameter name can be used more than once, for example:\n `\"WHERE id > @msg_id AND id < @msg_id + 100\"`\n\nIt is an error to execute an SQL query w ith unbound parameters.\n\nParameter values are specified using `params`, which is a JSON\nobject whose keys are parameter names, and whose values are the\ncorr esponding parameter values.",
(...skipping 14 matching lines...) Expand all
2632 "type": "string" 2389 "type": "string"
2633 }, 2390 },
2634 "transaction": { 2391 "transaction": {
2635 "$ref": "TransactionSelector", 2392 "$ref": "TransactionSelector",
2636 "description": "The transaction to use. If none is provided, the default is a\ntemporary read-only transaction with strong concurrency." 2393 "description": "The transaction to use. If none is provided, the default is a\ntemporary read-only transaction with strong concurrency."
2637 }, 2394 },
2638 "resumeToken": { 2395 "resumeToken": {
2639 "description": "If this request is resuming a previously int errupted SQL query\nexecution, `resume_token` should be copied from the last\nPa rtialResultSet yielded before the interruption. Doing this\nenables the new SQL query execution to resume where the last one left\noff. The rest of the request parameters must exactly match the\nrequest that yielded this token.", 2396 "description": "If this request is resuming a previously int errupted SQL query\nexecution, `resume_token` should be copied from the last\nPa rtialResultSet yielded before the interruption. Doing this\nenables the new SQL query execution to resume where the last one left\noff. The rest of the request parameters must exactly match the\nrequest that yielded this token.",
2640 "format": "byte", 2397 "format": "byte",
2641 "type": "string" 2398 "type": "string"
2642 }, 2399 }
2643 "paramTypes": { 2400 },
2401 "type": "object"
2402 },
2403 "Policy": {
2404 "description": "Defines an Identity and Access Management (IAM) poli cy. 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,\nG oogle domains, and service accounts. A `role` is a named list of permissions\nde fined 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.gserviceaccoun t.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).",
2405 "id": "Policy",
2406 "properties": {
2407 "etag": {
2408 "description": "`etag` is used for optimistic concurrency co ntrol as a way to help\nprevent simultaneous updates of a policy from overwritin g each other.\nIt is strongly suggested that systems make use of the `etag` in t he\nread-modify-write cycle to perform policy updates in order to avoid race\nco nditions: 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 t heir change will be applied to the same version of the policy.\n\nIf no `etag` i s provided in the call to `setIamPolicy`, then the existing\npolicy is overwritt en blindly.",
2409 "format": "byte",
2410 "type": "string"
2411 },
2412 "iamOwned": {
2413 "type": "boolean"
2414 },
2415 "rules": {
2416 "description": "If more than one rule is specified, the rule s are applied in the following\nmanner:\n- All matching LOG rules are always app lied.\n- If any DENY/DENY_WITH_LOG rule matches, permission is denied.\n Loggin g will be applied if one or more matching rule requires logging.\n- Otherwise, i f any ALLOW/ALLOW_WITH_LOG rule matches, permission is\n granted.\n Logging wi ll be applied if one or more matching rule requires logging.\n- Otherwise, if no rule applies, permission is denied.",
2417 "items": {
2418 "$ref": "Rule"
2419 },
2420 "type": "array"
2421 },
2422 "version": {
2423 "description": "Version of the `Policy`. The default version is 0.",
2424 "format": "int32",
2425 "type": "integer"
2426 },
2427 "auditConfigs": {
2428 "description": "Specifies cloud audit logging configuration for this policy.",
2429 "items": {
2430 "$ref": "AuditConfig"
2431 },
2432 "type": "array"
2433 },
2434 "bindings": {
2435 "description": "Associates a list of `members` to a `role`.\ n`bindings` with no members will result in an error.",
2436 "items": {
2437 "$ref": "Binding"
2438 },
2439 "type": "array"
2440 }
2441 },
2442 "type": "object"
2443 },
2444 "ReadRequest": {
2445 "description": "The request for Read and\nStreamingRead.",
2446 "id": "ReadRequest",
2447 "properties": {
2448 "index": {
2449 "description": "If non-empty, the name of an index on table. This index is\nused instead of the table primary key when interpreting key_set\ nand sorting result rows. See key_set for further information.",
2450 "type": "string"
2451 },
2452 "keySet": {
2453 "$ref": "KeySet",
2454 "description": "Required. `key_set` identifies the rows to b e yielded. `key_set` names the\nprimary keys of the rows in table to be yielded, unless index\nis present. If index is present, then key_set instead names\ninde x keys in index.\n\nRows are yielded in table primary key order (if index is emp ty)\nor index key order (if index is non-empty).\n\nIt is not an error for the ` key_set` to name rows that do not\nexist in the database. Read yields nothing fo r nonexistent rows."
2455 },
2456 "columns": {
2457 "description": "The columns of table to be returned for each row matching\nthis request.",
2458 "items": {
2459 "type": "string"
2460 },
2461 "type": "array"
2462 },
2463 "transaction": {
2464 "$ref": "TransactionSelector",
2465 "description": "The transaction to use. If none is provided, the default is a\ntemporary read-only transaction with strong concurrency."
2466 },
2467 "resumeToken": {
2468 "description": "If this request is resuming a previously int errupted read,\n`resume_token` should be copied from the last\nPartialResultSet yielded before the interruption. Doing this\nenables the new read to resume wher e the last read left off. The\nrest of the request parameters must exactly match the request\nthat yielded this token.",
2469 "format": "byte",
2470 "type": "string"
2471 },
2472 "table": {
2473 "description": "Required. The name of the table in the datab ase to be read.",
2474 "type": "string"
2475 },
2476 "limit": {
2477 "description": "If greater than zero, only the first `limit` rows are yielded. If `limit`\nis zero, the default is no limit.",
2478 "format": "int64",
2479 "type": "string"
2480 }
2481 },
2482 "type": "object"
2483 },
2484 "Write": {
2485 "description": "Arguments to insert, update, insert_or_update, and\n replace operations.",
2486 "id": "Write",
2487 "properties": {
2488 "table": {
2489 "description": "Required. The table whose rows will be writt en.",
2490 "type": "string"
2491 },
2492 "values": {
2493 "description": "The values to be written. `values` can conta in more than one\nlist of values. If it does, then multiple rows are written, on e\nfor each entry in `values`. Each list in `values` must have\nexactly as many entries as there are entries in columns\nabove. Sending multiple lists is equiva lent to sending multiple\n`Mutation`s, each containing one `values` entry and re peating\ntable and columns. Individual values in each list are\nencoded as descr ibed here.",
2494 "items": {
2495 "items": {
2496 "type": "any"
2497 },
2498 "type": "array"
2499 },
2500 "type": "array"
2501 },
2502 "columns": {
2503 "description": "The names of the columns in table to be writ ten.\n\nThe list of columns must contain enough columns to allow\nCloud Spanner to derive values for all primary key columns in the\nrow(s) to be modified.",
2504 "items": {
2505 "type": "string"
2506 },
2507 "type": "array"
2508 }
2509 },
2510 "type": "object"
2511 },
2512 "ReadWrite": {
2513 "description": "Message type to initiate a read-write transaction. C urrently this\ntransaction type has no options.",
2514 "id": "ReadWrite",
2515 "properties": {},
2516 "type": "object"
2517 },
2518 "DataAccessOptions": {
2519 "description": "Write a Data Access (Gin) log",
2520 "id": "DataAccessOptions",
2521 "properties": {},
2522 "type": "object"
2523 },
2524 "Operation": {
2525 "description": "This resource represents a long-running operation th at is the result of a\nnetwork API call.",
2526 "id": "Operation",
2527 "properties": {
2528 "metadata": {
2644 "additionalProperties": { 2529 "additionalProperties": {
2645 "$ref": "Type" 2530 "description": "Properties of the object. Contains field @type with type URL.",
2646 }, 2531 "type": "any"
2647 "description": "It is not always possible for Cloud Spanner to infer the right SQL type\nfrom a JSON value. For example, values of type `BY TES` and values\nof type `STRING` both appear in params as JSON strings.\n\nIn t hese cases, `param_types` can be used to specify the exact\nSQL type for some or all of the SQL query parameters. See the\ndefinition of Type for more informati on\nabout SQL types.", 2532 },
2533 "description": "Service-specific metadata associated with th e operation. It typically\ncontains progress information and common metadata su ch as create time.\nSome services might not provide such metadata. Any method t hat returns a\nlong-running operation should document the metadata type, if any. ",
2648 "type": "object" 2534 "type": "object"
2649 } 2535 },
2650 }, 2536 "done": {
2651 "type": "object" 2537 "description": "If the value is `false`, it means the operat ion is still in progress.\nIf true, the operation is completed, and either `erro r` or `response` is\navailable.",
2538 "type": "boolean"
2539 },
2540 "response": {
2541 "additionalProperties": {
2542 "description": "Properties of the object. Contains field @type with type URL.",
2543 "type": "any"
2544 },
2545 "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delet e`, the response is\n`google.protobuf.Empty`. If the original method is standar d\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmet hods, the response should have the type `XxxResponse`, where `Xxx`\nis the origi nal method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
2546 "type": "object"
2547 },
2548 "name": {
2549 "description": "The server-assigned name, which is only uniq ue within the same service that\noriginally returns it. If you use the default H TTP mapping, the\n`name` should have the format of `operations/some/unique/name` .",
2550 "type": "string"
2551 },
2552 "error": {
2553 "$ref": "Status",
2554 "description": "The error result of the operation in case of failure or cancellation."
2555 }
2556 },
2557 "type": "object"
2558 },
2559 "ResultSet": {
2560 "description": "Results from Read or\nExecuteSql.",
2561 "id": "ResultSet",
2562 "properties": {
2563 "metadata": {
2564 "$ref": "ResultSetMetadata",
2565 "description": "Metadata about the result set, such as row t ype information."
2566 },
2567 "stats": {
2568 "$ref": "ResultSetStats",
2569 "description": "Query plan and execution statistics for the query that produced this\nresult set. These can be requested by setting\nExecute SqlRequest.query_mode."
2570 },
2571 "rows": {
2572 "description": "Each element in `rows` is a row whose format is defined by\nmetadata.row_type. The ith element\nin each row matches the ith field in\nmetadata.row_type. Elements are\nencoded based on type as described\nh ere.",
2573 "items": {
2574 "items": {
2575 "type": "any"
2576 },
2577 "type": "array"
2578 },
2579 "type": "array"
2580 }
2581 },
2582 "type": "object"
2583 },
2584 "Status": {
2585 "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RP C APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is desig ned to be:\n\n- Simple to use and understand for most users\n- Flexible enough t o meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pie ces of data: error code, error message,\nand error details. The error code shoul d be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message tha t helps\ndevelopers *understand* and *resolve* the error. If a localized user-fa cing\nerror message is needed, put the localized message in the error details or \nlocalize it in the client. The optional error details may contain arbitrary\ni nformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Lang uage mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` mess age is\nexposed in different client libraries and different wire protocols, it c an be\nmapped differently. For example, it will likely be mapped to some excepti ons\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n \nThe error model and the `Status` message can be used in a variety of\nenvironm ents, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n - Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step m ay\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\ n- Asynchronous operations. If an API call embeds asynchronous operation\n re sults in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are store d in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
2586 "id": "Status",
2587 "properties": {
2588 "details": {
2589 "description": "A list of messages that carry the error deta ils. There is a common set of\nmessage types for APIs to use.",
2590 "items": {
2591 "additionalProperties": {
2592 "description": "Properties of the object. Contains f ield @type with type URL.",
2593 "type": "any"
2594 },
2595 "type": "object"
2596 },
2597 "type": "array"
2598 },
2599 "code": {
2600 "description": "The status code, which should be an enum val ue of google.rpc.Code.",
2601 "format": "int32",
2602 "type": "integer"
2603 },
2604 "message": {
2605 "description": "A developer-facing error message, which shou ld be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
2606 "type": "string"
2607 }
2608 },
2609 "type": "object"
2610 },
2611 "Binding": {
2612 "description": "Associates `members` with a `role`.",
2613 "id": "Binding",
2614 "properties": {
2615 "role": {
2616 "description": "Role that is assigned to `members`.\nFor exa mple, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
2617 "type": "string"
2618 },
2619 "condition": {
2620 "$ref": "Expr",
2621 "description": "The condition that is associated with this b inding.\nNOTE: an unsatisfied condition will not allow user access via current\n binding. Different bindings, including their conditions, are examined\nindepende ntly.\nThis field is GOOGLE_INTERNAL."
2622 },
2623 "members": {
2624 "description": "Specifies the identities requesting access f or a Cloud Platform resource.\n`members` can have the following values:\n\n* `al lUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special ident ifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a spec ific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\ n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{e mailid}`: An email address that represents a Google group.\n For example, `adm ins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that repre sents all the\n users of that domain. For example, `google.com` or `example.co m`.\n\n",
2625 "items": {
2626 "type": "string"
2627 },
2628 "type": "array"
2629 }
2630 },
2631 "type": "object"
2632 },
2633 "UpdateDatabaseDdlRequest": {
2634 "description": "Enqueues the given DDL statements to be applied, in order but not\nnecessarily all at once, to the database schema at some point (or \npoints) in the future. The server checks that the statements\nare executable ( syntactically valid, name tables that exist, etc.)\nbefore enqueueing them, but they may still fail upon\nlater execution (e.g., if a statement from another bat ch of\nstatements is applied first and it conflicts in some way, or if\nthere is some data-related problem like a `NULL` value in a column to\nwhich `NOT NULL` would be added). If a statement fails, all\nsubsequent statements in the batch a re automatically cancelled.\n\nEach batch of statements is assigned a name which can be used with\nthe Operations API to monitor\nprogress. See the\noperation_i d field for more\ndetails.",
2635 "id": "UpdateDatabaseDdlRequest",
2636 "properties": {
2637 "statements": {
2638 "description": "DDL statements to be applied to the database .",
2639 "items": {
2640 "type": "string"
2641 },
2642 "type": "array"
2643 },
2644 "operationId": {
2645 "description": "If empty, the new update request is assigned an\nautomatically-generated operation ID. Otherwise, `operation_id`\nis used to construct the name of the resulting\nOperation.\n\nSpecifying an explicit opera tion ID simplifies determining\nwhether the statements were executed in the even t that the\nUpdateDatabaseDdl call is replayed,\nor the return value is otherwis e lost: the database and\n`operation_id` fields can be combined to form the\nnam e of the resulting\nlongrunning.Operation: `<database>/operations/<operation_id> `.\n\n`operation_id` should be unique within the database, and must be\na valid identifier: `a-z*`. Note that\nautomatically-generated operation IDs always begi n with an\nunderscore. If the named operation already exists,\nUpdateDatabaseDdl returns\n`ALREADY_EXISTS`.",
2646 "type": "string"
2647 }
2648 },
2649 "type": "object"
2650 },
2651 "PartialResultSet": {
2652 "description": "Partial results from a streaming read or SQL query. Streaming reads and\nSQL queries better tolerate large result sets, large rows, and large\nvalues, but are a little trickier to consume.",
2653 "id": "PartialResultSet",
2654 "properties": {
2655 "values": {
2656 "description": "A streamed result set consists of a stream o f values, which might\nbe split into many `PartialResultSet` messages to accommo date\nlarge rows and/or large values. Every N complete values defines a\nrow, wh ere N is equal to the number of entries in\nmetadata.row_type.fields.\n\nMost va lues are encoded based on type as described\nhere.\n\nIt is possible that the la st value in values is \"chunked\",\nmeaning that the rest of the value is sent i n subsequent\n`PartialResultSet`(s). This is denoted by the chunked_value\nfield . Two or more chunked values can be merged to form a\ncomplete value as follows: \n\n * `bool/number/null`: cannot be chunked\n * `string`: concatenate the str ings\n * `list`: concatenate the lists. If the last element in a list is a\n `string`, `list`, or `object`, merge it with the first element in\n the next list by applying these rules recursively.\n * `object`: concatenate the (field name, field value) pairs. If a\n field name is duplicated, then apply these rules recursively\n to merge the field values.\n\nSome examples of merging:\n \n # Strings are concatenated.\n \"foo\", \"bar\" => \"foobar\"\n\n # L ists of non-strings are concatenated.\n [2, 3], [4] => [2, 3, 4]\n\n # Lis ts are concatenated, but the last and first elements are merged\n # because t hey are strings.\n [\"a\", \"b\"], [\"c\", \"d\"] => [\"a\", \"bc\", \"d\"]\n \n # Lists are concatenated, but the last and first elements are merged\n # because they are lists. Recursively, the last and first elements\n # of the inner lists are merged because they are strings.\n [\"a\", [\"b\", \"c\"]], [[\"d\"], \"e\"] => [\"a\", [\"b\", \"cd\"], \"e\"]\n\n # Non-overlapping obj ect fields are combined.\n {\"a\": \"1\"}, {\"b\": \"2\"} => {\"a\": \"1\", \ "b\": 2\"}\n\n # Overlapping object fields are merged.\n {\"a\": \"1\"}, { \"a\": \"2\"} => {\"a\": \"12\"}\n\n # Examples of merging objects containing lists of strings.\n {\"a\": [\"1\"]}, {\"a\": [\"2\"]} => {\"a\": [\"12\"]}\ n\nFor a more complete example, suppose a streaming SQL query is\nyielding a res ult set whose rows contain a single string\nfield. The following `PartialResultS et`s might be yielded:\n\n {\n \"metadata\": { ... }\n \"values\": [\"Hello\", \"W\"]\n \"chunked_value\": true\n \"resume_token\": \"Af6 5...\"\n }\n {\n \"values\": [\"orl\"]\n \"chunked_value\": true \n \"resume_token\": \"Bqp2...\"\n }\n {\n \"values\": [\"d\"]\n \"resume_token\": \"Zx1B...\"\n }\n\nThis sequence of `PartialResultSet `s encodes two rows, one\ncontaining the field value `\"Hello\"`, and a second c ontaining the\nfield value `\"World\" = \"W\" + \"orl\" + \"d\"`.",
2657 "items": {
2658 "type": "any"
2659 },
2660 "type": "array"
2661 },
2662 "metadata": {
2663 "$ref": "ResultSetMetadata",
2664 "description": "Metadata about the result set, such as row t ype information.\nOnly present in the first response."
2665 },
2666 "resumeToken": {
2667 "description": "Streaming calls might be interrupted for a v ariety of reasons, such\nas TCP connection loss. If this occurs, the stream of r esults can\nbe resumed by re-sending the original request and including\n`resume _token`. Note that executing any other transaction in the\nsame session invalida tes the token.",
2668 "format": "byte",
2669 "type": "string"
2670 },
2671 "stats": {
2672 "$ref": "ResultSetStats",
2673 "description": "Query plan and execution statistics for the query that produced this\nstreaming result set. These can be requested by settin g\nExecuteSqlRequest.query_mode and are sent\nonly once with the last response i n the stream."
2674 },
2675 "chunkedValue": {
2676 "description": "If true, then the final value in values is c hunked, and must\nbe combined with more values from subsequent `PartialResultSet `s\nto obtain a complete field value.",
2677 "type": "boolean"
2678 }
2679 },
2680 "type": "object"
2652 } 2681 }
2653 }, 2682 },
2654 "servicePath": "", 2683 "servicePath": "",
2655 "title": "Cloud Spanner API", 2684 "title": "Cloud Spanner API",
2656 "version": "v1" 2685 "version": "v1"
2657 } 2686 }
OLDNEW
« no previous file with comments | « discovery/googleapis/sourcerepo__v1.json ('k') | discovery/googleapis/speech__v1.json » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698